Module: SpreeCmCommissioner::OrderStateMachine

Extended by:
ActiveSupport::Concern
Defined in:
app/models/concerns/spree_cm_commissioner/order_state_machine.rb

Overview

rubocop:disable Metrics/ModuleLength

Instance Method Summary collapse

Instance Method Details

#accepted_by(user) ⇒ Object

allow authorized user to accept all requested line items



145
146
147
148
149
150
151
152
153
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 145

def accepted_by(user)
  transaction do
    accept!

    line_items.each do |line_item|
      line_item.accepted_by(user)
    end
  end
end

#allocate_resources ⇒ Object 



369
370
371
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 369

def allocate_resources
  SpreeCmCommissioner::VotingCreditAllocationJob.perform_later(order_id: id)
end

#can_accept_all? ⇒ Boolean

can_accepted? already use by ransack/visitor.rb

Returns:

  • (Boolean) 


257
258
259
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 257

def can_accept_all?
  approved? && requested?
end

#can_alert_request_to_vendor? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 265

def can_alert_request_to_vendor?
  !accepted? && approved? && need_confirmation?
end

#can_reject_all? ⇒ Boolean

Returns:

  • (Boolean) 


261
262
263
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 261

def can_reject_all?
  approved? && requested?
end

#clear_cancellation_details ⇒ Object

Reset the cancellation info when an order is resumed. We only assign the values here; the resume transition already saves the order, so they get saved together with it (one validated save, no update_columns).



380
381
382
383
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 380

def clear_cancellation_details
  self.canceled_at = nil
  self.canceler_id = nil
end

#de_allocate_resources ⇒ Object 



373
374
375
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 373

def de_allocate_resources
  SpreeCmCommissioner::VotingCreditDeAllocationJob.perform_later(order_id: id)
end

#decrement_user_request_orders_count ⇒ Object 



95
96
97
98
99
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 95

def decrement_user_request_orders_count
  return if user.nil?

  SpreeCmCommissioner::UserCountersService.decrement_request_orders_count(user)
end

#deliver_order_confirmation_email ⇒ Object

override



82
83
84
85
86
87
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 82

def deliver_order_confirmation_email
  return if requested?
  return if any_app_only_products?

  super
end

#finalize_guests_and_bibs ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 203

def finalize_guests_and_bibs
  ActiveRecord::Base.transaction do
    line_items.each do |line_item|
      line_item.generate_remaining_guests

      line_item.guests.each do |guest|
        result = SpreeCmCommissioner::Guests::Finalize.call(
          guest: guest,
          user: user,
          event: line_item.event,
          variant: line_item.variant
        )

        unless result.success?
          guest.errors.add(:base, result.error.value || result.error.to_s)
          raise(ActiveRecord::RecordInvalid, guest)
        end
      end
    end
  end

  true
rescue ActiveRecord::RecordInvalid => e
  e.record.errors.each do |msg|
    errors.add(:guests, msg)
  end

  false
end

#generate_completion_steps! ⇒ Object

This is called before complete, which is already wrapped by the transaction of unstock_inventory!



106
107
108
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 106

def generate_completion_steps!
  line_items.each(&:generate_completion_steps!)
end

#guest_incomplete?(guest) ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
158
159
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 155

def guest_incomplete?(guest)
  (guest.pre_registration_fields? && !guest.pre_registration_completed?) ||
    (guest.post_registration_fields? && !guest.post_registration_completed?) ||
    (guest.during_check_in_fields? && !guest.check_in_completed?)
end

#has_incomplete_guest_info? ⇒ Boolean

rubocop:disable Naming/PredicateName

Returns:

  • (Boolean) 


136
137
138
139
140
141
142
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 136

def has_incomplete_guest_info? # rubocop:disable Naming/PredicateName
  line_items.any? do |line_item|
    line_item.guests.any? do |guest|
      guest_incomplete?(guest)
    end
  end
end

#increment_user_request_orders_count ⇒ Object 



89
90
91
92
93
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 89

def increment_user_request_orders_count
  return if user.nil?

  SpreeCmCommissioner::UserCountersService.increment_request_orders_count(user)
end

#mark_user_as_has_incomplete_guest_info ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 121

def mark_user_as_has_incomplete_guest_info
  user&.public_metadata&.[]=('has_incomplete_guest_info', true)
  user&.save!

  line_items.each do |line_item|
    line_item.guests.each do |guest|
      guest.user ||= user
      guest.save!(validate: false) if guest.changed?
      guest.save_and_move_to_next_stage
      # send notification only for guests that still have incomplete dynamic fields
      SpreeCmCommissioner::GuestDynamicFieldNotificationSender.call(guest: guest) if guest_incomplete?(guest)
    end
  end
end

#need_confirmation? ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 273

def need_confirmation?
  line_items.any?(&:need_confirmation)
end

#notify_order_complete_app_notification_to_user ⇒ Object 



301
302
303
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 301

def notify_order_complete_app_notification_to_user
  SpreeCmCommissioner::OrderCompleteNotificationSender.call(order: self)
end

#notify_order_complete_telegram_notification_to_user ⇒ Object 



305
306
307
308
309
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 305

def notify_order_complete_telegram_notification_to_user
  return unless telegram_alert_enabled?

  SpreeCmCommissioner::OrderCompleteTelegramSenderJob.perform_later(order_id: id) if user_id.present?
end

#precalculate_conversion ⇒ Object 



110
111
112
113
114
115
116
117
118
119
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 110

def precalculate_conversion
  event_ids = line_items.pluck(:event_id).compact.uniq
  event_ids.each do |event_id|
    # Just create task, CRON job will pick it up and execute.
    SpreeCmCommissioner::MaintenanceTasks::Event.pending.create_or_find_by(
      maintainable_type: 'Spree::Taxon',
      maintainable_id: event_id
    )
  end
end

#product_completion_steps_exist? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 101

def product_completion_steps_exist?
  product_completion_steps.any?
end

#rejected_by(user) ⇒ Object 



233
234
235
236
237
238
239
240
241
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 233

def rejected_by(user)
  transaction do
    reject!

    line_items.each do |line_item|
      line_item.rejected_by(user)
    end
  end
end

#requested_state? ⇒ Boolean

Returns:

  • (Boolean) 


269
270
271
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 269

def requested_state?
  request_state == 'requested'
end

#restock_inventory! ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 188

def restock_inventory!
  ActiveRecord::Base.transaction do
    restock_inventory_from_external_system!
    release_order_holds!
    restock_inventory_in_redis!
  end
rescue StandardError => e
  CmAppLogger.log(
    label: 'SpreeCmCommissioner::OrderStateMachine#restock_inventory! failed',
    data: { order_id: id, error: e.message, type: e.class.name, backtrace: e.backtrace&.first(5)&.join("\n") }
  )

  raise e
end

#run_order_complete_alerts ⇒ Object 



350
351
352
353
354
355
356
357
358
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 350

def run_order_complete_alerts
  return unless ENV['ORDER_INTEGRITY_TELEGRAM_ALERT_ENABLED'] == 'yes'
  return unless telegram_alert_enabled?

  # Allow async payment processors time to settle before checking for alerts
  SpreeCmCommissioner::TelegramAlerts::OrderIntegrityCheckJob
    .set(wait: 2.minutes)
    .perform_later(order_id: id)
end

#send_order_accepted_app_notification_to_user ⇒ Object 



315
316
317
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 315

def send_order_accepted_app_notification_to_user
  SpreeCmCommissioner::OrderAcceptedNotificationSender.call(order: self)
end

#send_order_accepted_telegram_alert_to_store ⇒ Object 



332
333
334
335
336
337
338
339
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 332

def send_order_accepted_telegram_alert_to_store
  return unless telegram_alert_enabled?

  title = '✅ --- [ORDER ACCEPTED BY VENDOR] ---'
  chat_id = store.preferred_telegram_order_request_alert_chat_id
  factory = OrderTelegramMessageFactory.new(title: title, order: self)
  TelegramNotificationSenderJob.perform_later(chat_id: chat_id, message: factory.message, parse_mode: factory.parse_mode)
end

#send_order_complete_telegram_alert_to_store ⇒ Object 



360
361
362
363
364
365
366
367
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 360

def send_order_complete_telegram_alert_to_store
  return unless telegram_alert_enabled?

  title = '🎫 --- [NEW ORDER] ---'
  chat_id = store.preferred_telegram_order_alert_chat_id
  factory = OrderTelegramMessageFactory.new(title: title, order: self)
  TelegramNotificationSenderJob.perform_later(chat_id: chat_id, message: factory.message, parse_mode: factory.parse_mode)
end

#send_order_complete_telegram_alert_to_vendors ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 288

def send_order_complete_telegram_alert_to_vendors
  return unless telegram_alert_enabled?

  vendor_list.each do |vendor|
    title = '🎫 --- [NEW ORDER FROM BOOKME+] ---'
    chat_id = vendor.preferred_telegram_chat_id
    if chat_id.present?
      factory = OrderTelegramMessageFactory.new(title: title, order: self, vendor: vendor)
      TelegramNotificationSenderJob.perform_later(chat_id: chat_id, message: factory.message, parse_mode: factory.parse_mode)
    end
  end
end

#send_order_rejected_app_notification_to_user ⇒ Object 



319
320
321
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 319

def send_order_rejected_app_notification_to_user
  SpreeCmCommissioner::OrderRejectedNotificationSender.call(order: self)
end

#send_order_rejected_telegram_alert_to_store ⇒ Object 



341
342
343
344
345
346
347
348
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 341

def send_order_rejected_telegram_alert_to_store
  return unless telegram_alert_enabled?

  title = '❌ --- [ORDER REJECTED BY VENDOR] ---'
  chat_id = store.preferred_telegram_order_request_alert_chat_id
  factory = OrderTelegramMessageFactory.new(title: title, order: self)
  TelegramNotificationSenderJob.perform_later(chat_id: chat_id, message: factory.message, parse_mode: factory.parse_mode)
end

#send_order_request_telegram_confirmation_alert_to_vendor ⇒ Object 



277
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 277

def send_order_request_telegram_confirmation_alert_to_vendor; end

#send_order_requested_app_notification_to_user ⇒ Object 



311
312
313
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 311

def send_order_requested_app_notification_to_user
  SpreeCmCommissioner::OrderRequestedNotificationSender.call(order: self)
end

#send_order_requested_telegram_alert_to_store ⇒ Object 



323
324
325
326
327
328
329
330
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 323

def send_order_requested_telegram_alert_to_store
  return unless telegram_alert_enabled?

  title = '🔔 --- [NEW REQUESTED BY USER] ---'
  chat_id = store.preferred_telegram_order_request_alert_chat_id
  factory = OrderTelegramMessageFactory.new(title: title, order: self)
  TelegramNotificationSenderJob.perform_later(chat_id: chat_id, message: factory.message, parse_mode: factory.parse_mode)
end

#send_transaction_email_to_user ⇒ Object 



243
244
245
246
247
248
249
250
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 243

def send_transaction_email_to_user
  line_items.each do |line_item|
    next if line_item.event.nil?
    next unless line_item.enable_social_sharing_email?

    SpreeCmCommissioner::EventTransactionalMailer.send_to_participant(line_item.event_id, user.id).deliver_later
  end
end

#telegram_alert_enabled? ⇒ Boolean

Telegram order alerts are sent unless EVERY purchased product opts out. Default is true (see product_decorator), so existing orders are unaffected. Checked at enqueue time so disabled products create no telegram jobs at all.

Returns:

  • (Boolean) 


282
283
284
285
286
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 282

def telegram_alert_enabled?
  return @telegram_alert_enabled if defined?(@telegram_alert_enabled)

  @telegram_alert_enabled = line_items.any?(&:enable_telegram_alert?)
end

#unstock_inventory! ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 161

def unstock_inventory!
  ActiveRecord::Base.transaction do
    yield if block_given? # Equal to block.call

    # After the transition is complete, the following code will execute first before proceeding to other `after_transition` callbacks.
    # This ensures that if `reserve_order_holds!` or `unstock_inventory_in_redis!` fails, the state will be rolled back,
    # and neither the `finalize!` method nor any notifications will be triggered.
    # The payment will be reversed in vPago gem, and `Spree::Checkout::Complete` will be called, which checks `order.reload.complete?`.
    # This is critical because if the order state is complete, the payment will be marked as paid.

    unstock_inventory_from_external_system!
    reserve_order_holds!
    unstock_inventory_in_redis!

    # We rollback only order state, and we keep payment state as it is.
    # We implement payment in vPago gem, and it will be reversed in the gem.
    # Some bank has api for refund, but some don't have the api to refund yet. So we keep the payment state as it is and refund manually.
  end
rescue StandardError => e
  CmAppLogger.log(
    label: 'SpreeCmCommissioner::OrderStateMachine#unstock_inventory! failed',
    data: { order_id: id, error: e.message, type: e.class.name, backtrace: e.backtrace&.first(5)&.join("\n") }
  )

  raise e
end

#user_has_email? ⇒ Boolean

Returns:

  • (Boolean) 


252
253
254
 
# File 'app/models/concerns/spree_cm_commissioner/order_state_machine.rb', line 252

def user_has_email?
  user.present? && user.email.present?
end