Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

added custom events for Order/Payment/Shipment/etc

Damian Legawiec4bf87c5af12d
diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rb
index b410213ff3..9aad59df6a 100644
--- a/core/app/models/spree/gift_card.rb
+++ b/core/app/models/spree/gift_card.rb
@@ -18,11 +18,13 @@ module Spree
transition partially_redeemed: :redeemed
end
after_transition to: :redeemed, do: :after_redeem
+ after_transition to: :redeemed, do: :send_gift_card_redeemed_event
event :partial_redeem do
transition active: :partially_redeemed
transition partially_redeemed: :partially_redeemed
end
+ after_transition to: :partially_redeemed, do: :send_gift_card_partial_redeemed_event
end
#
@@ -156,6 +158,14 @@ module Spree
update!(redeemed_at: Time.current)
end
+ def send_gift_card_redeemed_event
+ publish_event('gift_card.redeem')
+ end
+
+ def send_gift_card_partial_redeemed_event
+ publish_event('gift_card.partial_redeem')
+ end
+
def ensure_can_be_deleted
return if can_be_deleted?
diff --git a/core/app/models/spree/import.rb b/core/app/models/spree/import.rb
index 2f2eba89b9..de4f8e441e 100644
--- a/core/app/models/spree/import.rb
+++ b/core/app/models/spree/import.rb
@@ -56,6 +56,7 @@ module Spree
event :complete do
transition from: :processing, to: :completed
end
+ after_transition to: :completed, do: :send_import_completed_event
after_transition to: :completed, do: :send_import_completed_email
after_transition to: :completed, do: :update_loader_in_import_view
@@ -159,6 +160,10 @@ module Spree
"#{Spree.t(type.demodulize.pluralize.downcase)} #{number}"
end
+ def send_import_completed_event
+ publish_event('import.complete')
+ end
+
def send_import_completed_email
# Spree::ImportMailer.import_done(self).deliver_later
end
diff --git a/core/app/models/spree/invitation.rb b/core/app/models/spree/invitation.rb
index 22cf274538..7c7bc384b1 100644
--- a/core/app/models/spree/invitation.rb
+++ b/core/app/models/spree/invitation.rb
@@ -46,6 +46,7 @@ module Spree
transition pending: :accepted
end
after_transition to: :accepted, do: :after_accept
+ after_transition to: :accepted, do: :send_invitation_accepted_event
end
#
@@ -92,6 +93,10 @@ module Spree
send_acceptance_notification
end
+ def send_invitation_accepted_event
+ publish_event('invitation.accept')
+ end
+
def send_invitation_email
Spree::InvitationMailer.invitation_email(self).deliver_later
end
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index 8ef06f2bb6..d5497db0d5 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -526,6 +526,8 @@ module Spree
send_order_placed_webhook
consider_risk
+
+ send_order_completed_event
end
def fulfill!
@@ -925,12 +927,14 @@ module Spree
send_cancel_email
update_with_updater!
send_order_canceled_webhook
+ send_order_canceled_event
end
def after_resume
shipments.each(&:resume!)
consider_risk
send_order_resumed_webhook
+ send_order_resumed_event
end
def use_billing?
@@ -968,5 +972,17 @@ module Spree
Spree.checkout_add_store_credit_service.call(order: self)
end
end
+
+ def send_order_completed_event
+ publish_event('order.complete')
+ end
+
+ def send_order_canceled_event
+ publish_event('order.cancel')
+ end
+
+ def send_order_resumed_event
+ publish_event('order.resume')
+ end
end
end
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index 24bea11088..b58022513d 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -114,11 +114,11 @@ module Spree
event :complete do
transition from: [:processing, :pending, :checkout], to: :completed
end
- after_transition to: :completed, do: [:after_completed, :send_payment_completed_webhook]
+ after_transition to: :completed, do: [:after_completed, :send_payment_completed_webhook, :send_payment_completed_event]
event :void do
transition from: [:pending, :processing, :completed, :checkout], to: :void
end
- after_transition to: :void, do: [:after_void, :send_payment_voided_webhook]
+ after_transition to: :void, do: [:after_void, :send_payment_voided_webhook, :send_payment_voided_event]
# when the card brand isn't supported
event :invalidate do
transition from: [:checkout], to: :invalid
@@ -286,11 +286,17 @@ module Spree
end
def after_void
- # Implement your logic here
end
def after_completed
- # Implement your logic here
+ end
+
+ def send_payment_completed_event
+ publish_event('payment.complete')
+ end
+
+ def send_payment_voided_event
+ publish_event('payment.void')
end
def has_invalid_state?
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 235b658a8b..01bd3bb669 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -262,12 +262,12 @@ module Spree
event :activate do
transition to: :active
end
- after_transition to: :active, do: [:after_activate, :send_product_activated_webhook]
+ after_transition to: :active, do: [:after_activate, :send_product_activated_webhook, :send_product_activated_event]
event :archive do
transition to: :archived
end
- after_transition to: :archived, do: [:after_archive, :send_product_archived_webhook]
+ after_transition to: :archived, do: [:after_archive, :send_product_archived_webhook, :send_product_archived_event]
event :draft do
transition to: :draft
@@ -848,5 +848,13 @@ module Spree
def after_draft
# Implement your logic here
end
+
+ def send_product_activated_event
+ publish_event('product.activate')
+ end
+
+ def send_product_archived_event
+ publish_event('product.archive')
+ end
end
end
diff --git a/core/app/models/spree/reimbursement.rb b/core/app/models/spree/reimbursement.rb
index e1d8d98d06..e08ed98e3a 100644
--- a/core/app/models/spree/reimbursement.rb
+++ b/core/app/models/spree/reimbursement.rb
@@ -76,6 +76,7 @@ module Spree
event :reimbursed do
transition to: :reimbursed, from: [:pending, :errored]
end
+ after_transition to: :reimbursed, do: :send_reimbursement_reimbursed_event
end
class << self
@@ -138,6 +139,10 @@ module Spree
private
+ def send_reimbursement_reimbursed_event
+ publish_event('reimbursement.reimbursed')
+ end
+
def validate_return_items_belong_to_same_order
if return_items.any? { |ri| ri.inventory_unit.order_id != order_id }
errors.add(:base, :return_items_order_id_does_not_match)
diff --git a/core/app/models/spree/return_authorization.rb b/core/app/models/spree/return_authorization.rb
index 1628df7c03..3a708c97aa 100644
--- a/core/app/models/spree/return_authorization.rb
+++ b/core/app/models/spree/return_authorization.rb
@@ -34,6 +34,7 @@ module Spree
state_machine initial: :authorized do
before_transition to: :canceled, do: :cancel_return_items
+ after_transition to: :canceled, do: :send_return_authorization_canceled_event
event :cancel do
transition to: :canceled, from: :authorized, if: ->(return_authorization) { return_authorization.can_cancel_return_items? }
@@ -79,6 +80,10 @@ module Spree
return_items.each { |item| item.cancel! if item.can_cancel? }
end
+ def send_return_authorization_canceled_event
+ publish_event('return_authorization.cancel')
+ end
+
def generate_expedited_exchange_reimbursements
return unless Spree::Config[:expedited_exchanges]
diff --git a/core/app/models/spree/return_item.rb b/core/app/models/spree/return_item.rb
index 6133c07318..319bf12865 100644
--- a/core/app/models/spree/return_item.rb
+++ b/core/app/models/spree/return_item.rb
@@ -85,6 +85,7 @@ module Spree
state_machine :reception_status, initial: :awaiting do
after_transition to: :received, do: :attempt_accept
after_transition to: :received, do: :process_inventory_unit!
+ after_transition to: :received, do: :send_return_item_received_event
event :receive do
transition to: :received, from: :awaiting
@@ -93,10 +94,12 @@ module Spree
event :cancel do
transition to: :cancelled, from: :awaiting
end
+ after_transition to: :cancelled, do: :send_return_item_canceled_event
event :give do
transition to: :given_to_customer, from: :awaiting
end
+ after_transition to: :given_to_customer, do: :send_return_item_given_event
end
extend DisplayMoney
@@ -270,5 +273,17 @@ module Spree
def should_restock?
resellable? && variant.should_track_inventory? && stock_item && Spree::Config[:restock_inventory]
end
+
+ def send_return_item_received_event
+ publish_event('return_item.receive')
+ end
+
+ def send_return_item_canceled_event
+ publish_event('return_item.cancel')
+ end
+
+ def send_return_item_given_event
+ publish_event('return_item.give')
+ end
end
end
diff --git a/core/app/models/spree/shipment.rb b/core/app/models/spree/shipment.rb
index c62dfbcd05..36a8c11582 100644
--- a/core/app/models/spree/shipment.rb
+++ b/core/app/models/spree/shipment.rb
@@ -82,12 +82,12 @@ module Spree
event :ship do
transition from: %i(ready canceled), to: :shipped
end
- after_transition to: :shipped, do: [:after_ship, :send_shipment_shipped_webhook]
+ after_transition to: :shipped, do: [:after_ship, :send_shipment_shipped_webhook, :send_shipment_shipped_event]
event :cancel do
transition to: :canceled, from: %i(pending ready)
end
- after_transition to: :canceled, do: :after_cancel
+ after_transition to: :canceled, do: [:after_cancel, :send_shipment_canceled_event]
event :resume do
transition from: :canceled, to: :ready, if: lambda { |shipment|
@@ -95,7 +95,7 @@ module Spree
}
transition from: :canceled, to: :pending
end
- after_transition from: :canceled, to: %i(pending ready shipped), do: :after_resume
+ after_transition from: :canceled, to: %i(pending ready shipped), do: [:after_resume, :send_shipment_resumed_event]
after_transition do |shipment, transition|
shipment.state_changes.create!(
@@ -455,6 +455,18 @@ module Spree
ShipmentHandler.factory(self).perform
end
+ def send_shipment_shipped_event
+ publish_event('shipment.ship')
+ end
+
+ def send_shipment_canceled_event
+ publish_event('shipment.cancel')
+ end
+
+ def send_shipment_resumed_event
+ publish_event('shipment.resume')
+ end
+
def can_get_rates?
return true unless order.requires_ship_address?
diff --git a/core/app/services/spree/newsletter/verify.rb b/core/app/services/spree/newsletter/verify.rb
index b9a2613411..10db8a1a88 100644
--- a/core/app/services/spree/newsletter/verify.rb
+++ b/core/app/services/spree/newsletter/verify.rb
@@ -8,6 +8,7 @@ module Spree
def call
verify_subscriber
set_user_email_marketing_to_true
+ publish_event
subscriber
end
@@ -25,6 +26,10 @@ module Spree
subscriber.user.update!(accepts_email_marketing: true)
end
+
+ def publish_event
+ subscriber.publish_event('newsletter_subscriber.verify')
+ end
end
end
end
diff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rb
index 6b3d9c872b..3794482f84 100644
--- a/core/spec/models/spree/gift_card_spec.rb
+++ b/core/spec/models/spree/gift_card_spec.rb
@@ -192,4 +192,52 @@ RSpec.describe Spree::GiftCard, type: :model do
end
end
end
+
+ describe 'custom events' do
+ let(:store) { Spree::Store.default }
+
+ describe 'gift_card.redeem' do
+ let(:gift_card) { create(:gift_card, state: :active, amount: 100, amount_used: 0, store: store) }
+
+ it 'publishes gift_card.redeem event when fully redeemed' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('gift_card.redeem') do |event|
+ received_event = event
+ end
+
+ gift_card.redeem!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::GiftCard')
+ expect(received_event.metadata['model_id']).to eq(gift_card.id.to_s)
+
+ Spree::Events.unsubscribe('gift_card.redeem', subscriber)
+ Spree::Events.reset!
+ end
+ end
+
+ describe 'gift_card.partial_redeem' do
+ let(:gift_card) { create(:gift_card, state: :active, amount: 100, amount_used: 0, store: store) }
+
+ it 'publishes gift_card.partial_redeem event when partially redeemed' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('gift_card.partial_redeem') do |event|
+ received_event = event
+ end
+
+ gift_card.partial_redeem!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::GiftCard')
+ expect(received_event.metadata['model_id']).to eq(gift_card.id.to_s)
+
+ Spree::Events.unsubscribe('gift_card.partial_redeem', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/import_spec.rb b/core/spec/models/spree/import_spec.rb
index 1f5da527cf..f342d5c825 100644
--- a/core/spec/models/spree/import_spec.rb
+++ b/core/spec/models/spree/import_spec.rb
@@ -382,4 +382,33 @@ RSpec.describe Spree::Import, :job, type: :model do
expect(Spree::Imports::Products.model_class).to eq(Spree::Product)
end
end
+
+ describe 'custom events' do
+ describe 'import.complete' do
+ before do
+ import.save!
+ import.start_mapping!
+ import.complete_mapping!
+ import.start_processing!
+ end
+
+ it 'publishes import.complete event when completed' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('import.complete') do |event|
+ received_event = event
+ end
+
+ import.complete!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::Imports::Products')
+ expect(received_event.metadata['model_id']).to eq(import.id.to_s)
+
+ Spree::Events.unsubscribe('import.complete', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/invitation_spec.rb b/core/spec/models/spree/invitation_spec.rb
index da0d3399c7..06bdd0962c 100644
--- a/core/spec/models/spree/invitation_spec.rb
+++ b/core/spec/models/spree/invitation_spec.rb
@@ -131,4 +131,28 @@ RSpec.describe Spree::Invitation, type: :model do
invitation.resend!
end
end
+
+ describe 'custom events' do
+ describe 'invitation.accept' do
+ it 'publishes invitation.accept event when accepted' do
+ invitation.invitee = create(:admin_user, :without_admin_role)
+
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('invitation.accept') do |event|
+ received_event = event
+ end
+
+ invitation.accept
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::Invitation')
+ expect(received_event.metadata['model_id']).to eq(invitation.id.to_s)
+
+ Spree::Events.unsubscribe('invitation.accept', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rb
index 34804973da..930e4403b1 100644
--- a/core/spec/models/spree/order_spec.rb
+++ b/core/spec/models/spree/order_spec.rb
@@ -221,6 +221,49 @@ describe Spree::Order, type: :model do
expect(order.payments.store_credits).to all(have_attributes(state: 'void'))
end
end
+
+ context 'events' do
+ let(:order) { create(:completed_order_with_totals, store: store) }
+ let(:received_events) { [] }
+
+ before do
+ Spree::Events.reset!
+ Spree::Events.subscribe('order.cancel', async: false) { |e| received_events << e }
+ Spree::Events.activate!
+ end
+
+ after { Spree::Events.reset! }
+
+ it 'publishes order.cancel event' do
+ order.cancel!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(order.id)
+ expect(received_events.first.payload['number']).to eq(order.number)
+ end
+ end
+ end
+
+ describe '#after_resume' do
+ let(:order) { create(:completed_order_with_totals, store: store) }
+ let(:received_events) { [] }
+
+ before do
+ Spree::Events.reset!
+ Spree::Events.subscribe('order.resume', async: false) { |e| received_events << e }
+ Spree::Events.activate!
+ order.cancel!
+ end
+
+ after { Spree::Events.reset! }
+
+ it 'publishes order.resume event' do
+ order.resume!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(order.id)
+ expect(received_events.first.payload['number']).to eq(order.number)
+ end
end
describe '#canceled_by' do
@@ -367,6 +410,28 @@ describe Spree::Order, type: :model do
end
end
end
+
+ context 'events' do
+ let(:order) { create(:order_with_line_items, store: store) }
+ let(:received_events) { [] }
+
+ before do
+ Spree::Events.reset!
+ Spree::Events.subscribe('order.complete', async: false) { |e| received_events << e }
+ Spree::Events.activate!
+ order.update_column(:state, 'complete')
+ end
+
+ after { Spree::Events.reset! }
+
+ it 'publishes order.complete event' do
+ order.finalize!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(order.id)
+ expect(received_events.first.payload['number']).to eq(order.number)
+ end
+ end
end
context 'insufficient_stock_lines' do
diff --git a/core/spec/models/spree/payment_spec.rb b/core/spec/models/spree/payment_spec.rb
index c1ccfb509b..674b458d56 100644
--- a/core/spec/models/spree/payment_spec.rb
+++ b/core/spec/models/spree/payment_spec.rb
@@ -1291,4 +1291,44 @@ describe Spree::Payment, type: :model do
expect(payment.gateway_processing_error_messages).to eq(['Gateway processing error', 'Another gateway processing error'])
end
end
+
+ describe 'events' do
+ let(:received_events) { [] }
+
+ before do
+ Spree::Events.reset!
+ Spree::Events.activate!
+ end
+
+ after { Spree::Events.reset! }
+
+ describe 'completed state transition' do
+ before do
+ Spree::Events.subscribe('payment.complete', async: false) { |e| received_events << e }
+ end
+
+ it 'publishes payment.complete event' do
+ payment.started_processing!
+ payment.complete!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(payment.id)
+ end
+ end
+
+ describe 'void state transition' do
+ before do
+ Spree::Events.subscribe('payment.void', async: false) { |e| received_events << e }
+ payment.started_processing!
+ payment.pend!
+ end
+
+ it 'publishes payment.void event' do
+ payment.void!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(payment.id)
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rb
index 60cdc6e7f1..cde01492f2 100644
--- a/core/spec/models/spree/product_spec.rb
+++ b/core/spec/models/spree/product_spec.rb
@@ -1654,4 +1654,50 @@ describe Spree::Product, type: :model do
end
end
end
+
+ describe 'custom events' do
+ describe 'product.activate' do
+ let(:product) { create(:product, status: 'draft', stores: [store]) }
+
+ it 'publishes product.activate event when activated' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('product.activate') do |event|
+ received_event = event
+ end
+
+ product.activate!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::Product')
+ expect(received_event.metadata['model_id']).to eq(product.id.to_s)
+
+ Spree::Events.unsubscribe('product.activate', subscriber)
+ Spree::Events.reset!
+ end
+ end
+
+ describe 'product.archive' do
+ let(:product) { create(:product, status: 'active', stores: [store]) }
+
+ it 'publishes product.archive event when archived' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('product.archive') do |event|
+ received_event = event
+ end
+
+ product.archive!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::Product')
+ expect(received_event.metadata['model_id']).to eq(product.id.to_s)
+
+ Spree::Events.unsubscribe('product.archive', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/reimbursement_spec.rb b/core/spec/models/spree/reimbursement_spec.rb
index 4fee23812b..7b4d36f6c0 100644
--- a/core/spec/models/spree/reimbursement_spec.rb
+++ b/core/spec/models/spree/reimbursement_spec.rb
@@ -212,4 +212,40 @@ describe Spree::Reimbursement, type: :model do
expect(subject.customer_return).to eq customer_return
end
end
+
+ describe 'custom events' do
+ describe 'reimbursement.reimbursed' do
+ let(:order) { create(:shipped_order, line_items_count: 1, line_items_price: BigDecimal(10), shipment_cost: 0, store: store) }
+ let(:line_item) { order.line_items.first }
+ let(:inventory_unit) { line_item.inventory_units.first }
+ let(:customer_return) { build(:customer_return, return_items: [return_item], store: store) }
+ let(:return_item) { build(:return_item, inventory_unit: inventory_unit) }
+ let(:reimbursement) { create(:reimbursement, customer_return: customer_return, order: order, return_items: [return_item]) }
+
+ let!(:default_refund_reason) { Spree::RefundReason.find_or_create_by!(name: Spree::RefundReason::RETURN_PROCESSING_REASON, mutable: false) }
+
+ before do
+ customer_return.save!
+ return_item.accept!
+ end
+
+ it 'publishes reimbursement.reimbursed event when performed' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('reimbursement.reimbursed') do |event|
+ received_event = event
+ end
+
+ reimbursement.perform!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::Reimbursement')
+ expect(received_event.metadata['model_id']).to eq(reimbursement.id.to_s)
+
+ Spree::Events.unsubscribe('reimbursement.reimbursed', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/return_authorization_spec.rb b/core/spec/models/spree/return_authorization_spec.rb
index 0e85f3233f..ecef33e79e 100644
--- a/core/spec/models/spree/return_authorization_spec.rb
+++ b/core/spec/models/spree/return_authorization_spec.rb
@@ -235,4 +235,28 @@ describe Spree::ReturnAuthorization, type: :model do
it { is_expected.to eq true }
end
end
+
+ describe 'custom events' do
+ describe 'return_authorization.cancel' do
+ let(:return_authorization) { create(:return_authorization) }
+
+ it 'publishes return_authorization.cancel event when canceled' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('return_authorization.cancel') do |event|
+ received_event = event
+ end
+
+ return_authorization.cancel!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::ReturnAuthorization')
+ expect(received_event.metadata['model_id']).to eq(return_authorization.id.to_s)
+
+ Spree::Events.unsubscribe('return_authorization.cancel', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/return_item_spec.rb b/core/spec/models/spree/return_item_spec.rb
index deefd3818a..70459f4b58 100644
--- a/core/spec/models/spree/return_item_spec.rb
+++ b/core/spec/models/spree/return_item_spec.rb
@@ -768,4 +768,77 @@ describe Spree::ReturnItem, type: :model do
end
end
end
+
+ describe 'custom events' do
+ describe 'return_item.receive' do
+ let(:inventory_unit) { create(:inventory_unit, state: 'shipped') }
+ let(:return_item) { create(:return_item, inventory_unit: inventory_unit, reception_status: 'awaiting') }
+
+ before do
+ allow(return_item).to receive(:eligible_for_return?).and_return(true)
+ end
+
+ it 'publishes return_item.receive event when received' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('return_item.receive') do |event|
+ received_event = event
+ end
+
+ return_item.receive!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::ReturnItem')
+ expect(received_event.metadata['model_id']).to eq(return_item.id.to_s)
+
+ Spree::Events.unsubscribe('return_item.receive', subscriber)
+ Spree::Events.reset!
+ end
+ end
+
+ describe 'return_item.cancel' do
+ let(:return_item) { create(:return_item, reception_status: 'awaiting') }
+
+ it 'publishes return_item.cancel event when canceled' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('return_item.cancel') do |event|
+ received_event = event
+ end
+
+ return_item.cancel!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::ReturnItem')
+ expect(received_event.metadata['model_id']).to eq(return_item.id.to_s)
+
+ Spree::Events.unsubscribe('return_item.cancel', subscriber)
+ Spree::Events.reset!
+ end
+ end
+
+ describe 'return_item.give' do
+ let(:return_item) { create(:return_item, reception_status: 'awaiting') }
+
+ it 'publishes return_item.give event when given to customer' do
+ Spree::Events.activate!
+
+ received_event = nil
+ subscriber = Spree::Events.subscribe('return_item.give') do |event|
+ received_event = event
+ end
+
+ return_item.give!
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::ReturnItem')
+ expect(received_event.metadata['model_id']).to eq(return_item.id.to_s)
+
+ Spree::Events.unsubscribe('return_item.give', subscriber)
+ Spree::Events.reset!
+ end
+ end
+ end
end
diff --git a/core/spec/models/spree/shipment_spec.rb b/core/spec/models/spree/shipment_spec.rb
index bb38ca843a..ecdecd05d3 100644
--- a/core/spec/models/spree/shipment_spec.rb
+++ b/core/spec/models/spree/shipment_spec.rb
@@ -1038,4 +1038,61 @@ describe Spree::Shipment, type: :model do
expect(subject).not_to include(*shipped_shipments)
end
end
+
+ describe 'events' do
+ let(:order) { create(:order_ready_to_ship) }
+ let(:shipment) { order.shipments.first }
+ let(:received_events) { [] }
+
+ before do
+ Spree::Events.reset!
+ Spree::Events.activate!
+ end
+
+ after { Spree::Events.reset! }
+
+ describe 'shipped state transition' do
+ before do
+ Spree::Events.subscribe('shipment.ship', async: false) { |e| received_events << e }
+ shipment.update_column(:tracking, 'TRACK123')
+ end
+
+ it 'publishes shipment.ship event' do
+ shipment.ship!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(shipment.id)
+ expect(received_events.first.payload['number']).to eq(shipment.number)
+ end
+ end
+
+ describe 'canceled state transition' do
+ before do
+ Spree::Events.subscribe('shipment.cancel', async: false) { |e| received_events << e }
+ end
+
+ it 'publishes shipment.cancel event' do
+ shipment.cancel!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(shipment.id)
+ expect(received_events.first.payload['number']).to eq(shipment.number)
+ end
+ end
+
+ describe 'resume state transition' do
+ before do
+ Spree::Events.subscribe('shipment.resume', async: false) { |e| received_events << e }
+ shipment.cancel!
+ end
+
+ it 'publishes shipment.resume event' do
+ shipment.resume!
+
+ expect(received_events.size).to eq(1)
+ expect(received_events.first.payload['id']).to eq(shipment.id)
+ expect(received_events.first.payload['number']).to eq(shipment.number)
+ end
+ end
+ end
end
diff --git a/core/spec/services/spree/newsletter/verify_spec.rb b/core/spec/services/spree/newsletter/verify_spec.rb
index f2dfcdbafb..fa2baffca5 100644
--- a/core/spec/services/spree/newsletter/verify_spec.rb
+++ b/core/spec/services/spree/newsletter/verify_spec.rb
@@ -37,5 +37,27 @@ module Spree
and change { subscriber.reload.verification_token }.to(nil)
end
end
+
+ describe 'custom events' do
+ let(:user) { nil }
+
+ it 'publishes newsletter_subscriber.verify event when verified' do
+ Spree::Events.activate!
+
+ received_event = nil
+ event_subscriber = Spree::Events.subscribe('newsletter_subscriber.verify') do |event|
+ received_event = event
+ end
+
+ service
+
+ expect(received_event).to be_present
+ expect(received_event.metadata['model_class']).to eq('Spree::NewsletterSubscriber')
+ expect(received_event.metadata['model_id']).to eq(subscriber.id.to_s)
+
+ Spree::Events.unsubscribe('newsletter_subscriber.verify', event_subscriber)
+ Spree::Events.reset!
+ end
+ end
end
end