Class: Effective::Order

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/effective/order.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(atts = nil, &block) ⇒ Order

Effective::Order.new(items: Product.first) Effective::Order.new(items: [Product.first, Product.second], user: User.first) Effective::Order.new(items: Product.first, user: User.first, billing_address: Effective::Address.new, shipping_address: Effective::Address.new)



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'app/models/effective/order.rb', line 288

def initialize(atts = nil, &block)
  super(status: :pending) # Initialize with status pending

  return self unless atts.present?

  if atts.kind_of?(Hash)
    items = Array(atts[:item]) + Array(atts[:items])

    self.user = atts[:user] || items.first.try(:user)

    if (address = atts[:billing_address]).present?
      self.billing_address = address
      self.billing_address.full_name ||= user.to_s.presence
    end

    if (address = atts[:shipping_address]).present?
      self.shipping_address = address
      self.shipping_address.full_name ||= user.to_s.presence
    end

    atts.except(:item, :items, :user, :billing_address, :shipping_address).each do |key, value|
      self.send("#{key}=", value)
    end

    add(items) if items.present?
  else # Attributes are not a Hash
    self.user = atts.user if atts.respond_to?(:user)
    add(atts)
  end

  self
end

Instance Attribute Details

#confirmed_checkout ⇒ Object

Set on the Checkout Step 1



43
44
45
 
# File 'app/models/effective/order.rb', line 43

def confirmed_checkout
  @confirmed_checkout
end

#current_user ⇒ Object

Set by the checkout controller for non-admin users



40
41
42
 
# File 'app/models/effective/order.rb', line 40

def current_user
  @current_user
end

#send_mark_as_paid_email_to_buyer ⇒ Object

Set by Admin::Orders#mark_as_paid



47
48
49
 
# File 'app/models/effective/order.rb', line 47

def send_mark_as_paid_email_to_buyer
  @send_mark_as_paid_email_to_buyer
end

#send_payment_request_to_buyer ⇒ Object

Settings in the /admin action forms



46
47
48
 
# File 'app/models/effective/order.rb', line 46

def send_payment_request_to_buyer
  @send_payment_request_to_buyer
end

#skip_buyer_validations ⇒ Object

Set by Admin::Orders#create



48
49
50
 
# File 'app/models/effective/order.rb', line 48

def skip_buyer_validations
  @skip_buyer_validations
end

#terms_and_conditions ⇒ Object

Yes, I agree to the terms and conditions



42
43
44
 
# File 'app/models/effective/order.rb', line 42

def terms_and_conditions
  @terms_and_conditions
end

Instance Method Details

#add(*items, quantity: 1) ⇒ Object

Items can be an Effective::Cart, an Effective::order, a single acts_as_purchasable, or multiple acts_as_purchasables add(Product.first) => returns an Effective::OrderItem add(Product.first, current_cart) => returns an array of Effective::OrderItems



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'app/models/effective/order.rb', line 347

def add(*items, quantity: 1)
  raise 'unable to alter a purchased order' if purchased?
  raise 'unable to alter a declined order' if declined?

  cart_items = items.flatten.flat_map do |item|
    if item.kind_of?(Effective::Cart)
      item.cart_items.to_a
    elsif item.kind_of?(ActsAsPurchasable)
      Effective::CartItem.new(quantity: quantity, purchasable: item)
    elsif item.kind_of?(Effective::Order)
      # Duplicate an existing order
      self.note_to_buyer ||= item.note_to_buyer
      self.note_internal ||= item.note_internal
      self.cc ||= item.cc

      item.order_items.select { |oi| oi.purchasable.kind_of?(Effective::Product) }.map do |oi|
        purchasable = oi.purchasable

        product = Effective::Product.new(name: purchasable.purchasable_name, price: purchasable.price, tax_exempt: purchasable.tax_exempt)

        # Copy over any extended attributes that may have been created
        atts = purchasable.dup.attributes.except('name', 'price', 'tax_exempt', 'purchased_order_id').compact

        atts.each do |k, v|
          next unless product.respond_to?("#{k}=") && product.respond_to?(k)
          product.send("#{k}=", v) if product.send(k).blank?
        end

        Effective::CartItem.new(quantity: oi.quantity, purchasable: product)
      end
    else
      raise 'add() expects one or more acts_as_purchasable objects, or an Effective::Cart'
    end
  end.compact

  # Make sure to reset stored aggregates
  assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, amount_owing: nil, surcharge_percent: nil, surcharge: nil, total: nil)

  retval = cart_items.map do |item|
    order_items.build(
      name: item.name,
      quantity: item.quantity,
      price: item.price,
      tax_exempt: (item.tax_exempt || false),
    ).tap { |order_item| order_item.purchasable = item.purchasable }
  end

  retval.size == 1 ? retval.first : retval
end

#amount_owing ⇒ Object 



509
510
511
 
# File 'app/models/effective/order.rb', line 509

def amount_owing
  self[:amount_owing] || get_amount_owing()
end

#assign_confirmed_if_valid! ⇒ Object

This lets us skip to the confirmed workflow for an admin…



679
680
681
682
683
684
685
686
687
688
 
# File 'app/models/effective/order.rb', line 679

def assign_confirmed_if_valid!
  return unless pending?

  assign_attributes(status: :confirmed)
  return true if valid?

  self.errors.clear
  assign_attributes(status: :pending)
  false
end

#billing_first_name ⇒ Object 



453
454
455
 
# File 'app/models/effective/order.rb', line 453

def billing_first_name
  billing_name.to_s.split(' ').first
end

#billing_last_name ⇒ Object 



457
458
459
 
# File 'app/models/effective/order.rb', line 457

def billing_last_name
  Array(billing_name.to_s.split(' ')[1..-1]).join(' ')
end

#confirm! ⇒ Object

Used by admin checkout only



673
674
675
676
 
# File 'app/models/effective/order.rb', line 673

def confirm!
  return false if purchased?
  confirmed!
end

#custom_order? ⇒ Boolean

A custom order is one that was created by an admin We allow custom orders to have their order items updated

Returns:

  • (Boolean) 


471
472
473
 
# File 'app/models/effective/order.rb', line 471

def custom_order?
  order_items.all? { |oi| oi.purchasable_type == 'Effective::Product' }
end

#decline!(payment: 'none', provider: 'none', card: 'none', validate: true, email: false) ⇒ Object

We only turn on the email when done by a delayed payment or from a rake script.



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'app/models/effective/order.rb', line 841

def decline!(payment: 'none', provider: 'none', card: 'none', validate: true, email: false)
  return false if declined?
  raise('order already purchased') if purchased?

  assign_attributes(
    skip_buyer_validations: true,

    status: :declined,
    purchased_at: nil,
    purchased_by: nil,

    payment: payment_to_h(payment),
    payment_provider: provider,
    payment_card: (card.presence || 'none')
  )

  if current_user&.email.present?
    assign_attributes(email: current_user.email)
  end

  error = nil

  Effective::Order.transaction do
    begin
      run_purchasable_callbacks(:before_decline)
      save!(validate: validate)
      run_purchasable_callbacks(:after_decline)
    rescue => e
      self.status = status_was
      error = e.message
    end
  end

  raise "Failed to decline order: #{error || errors.full_messages.to_sentence}" unless error.nil?

  send_declined_notifications! if email

  true
end

#declined_reason ⇒ Object 



881
882
883
884
885
 
# File 'app/models/effective/order.rb', line 881

def declined_reason
  return unless declined?

  delayed_payment_purchase_result.presence || 'credit card declined'
end

#defer!(provider: 'none', email: true, validate: true) ⇒ Object 



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'app/models/effective/order.rb', line 796

def defer!(provider: 'none', email: true, validate: true)
  raise('order already purchased') if purchased?

  # Assign attributes
  assign_attributes(
    payment_provider: provider,

    status: :deferred,
    purchased_at: nil,
    purchased_by: nil,

    deferred_at: (deferred_at.presence || Time.zone.now),
    deferred_by: (deferred_by.presence || current_user)
  )

  # Went from delayed to cheque
  if delayed_payment? && !delayed_payment_provider?
    assign_attributes(delayed_payment: false, delayed_payment_date: nil, delayed_payment_intent: nil, delayed_payment_total: nil)
  end

  if current_user&.email.present?
    assign_attributes(email: current_user.email)
  end

  error = nil

  begin
    Effective::Order.transaction do
      run_purchasable_callbacks(:before_defer)
      save!(validate: validate)
      run_purchasable_callbacks(:after_defer)
    end
  rescue => e
    self.status = status_was
    error = e.message
  end

  raise "Failed to defer order: #{error || errors.full_messages.to_sentence}" unless error.nil?

  send_pending_order_invoice_to_buyer! if email

  true
end

#deferred_payment_provider? ⇒ Boolean

Returns:

  • (Boolean) 


557
558
559
 
# File 'app/models/effective/order.rb', line 557

def deferred_payment_provider?
  payment_provider.present? && EffectiveOrders.deferred_providers.include?(payment_provider)
end

#delay!(payment:, payment_intent:, provider:, card:, email: false, validate: true) ⇒ Object

This was submitted via the deluxe_delayed provider checkout This is a special case of a deferred provider. We require the payment_intent and payment info



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'app/models/effective/order.rb', line 780

def delay!(payment:, payment_intent:, provider:, card:, email: false, validate: true)
  raise('expected payment intent to be a String') unless payment_intent.kind_of?(String)
  raise('expected a delayed payment provider') unless EffectiveOrders.delayed_providers.include?(provider)
  raise('expected a delayed payment order with a delayed_payment_date') unless delayed_payment? && delayed_payment_date.present?

  assign_attributes(
    delayed_payment_intent: payment_intent, 
    delayed_payment_total: total(),

    payment: payment_to_h(payment),
    payment_card: (card.presence || 'none')
  )

  defer!(provider: provider, email: email, validate: validate)
end

#delayed? ⇒ Boolean

A new order is created. If the delayed_payment and delayed_payment date are set, it’s a delayed order A delayed order is one in which we have to capture a payment intent for the amount of the order. Once it’s delayed and deferred we can purchase it at anytime.

Returns:

  • (Boolean) 


565
566
567
 
# File 'app/models/effective/order.rb', line 565

def delayed?
  delayed_payment? && delayed_payment_date.present?
end

#delayed_payment_date_past? ⇒ Boolean

Returns:

  • (Boolean) 


587
588
589
590
 
# File 'app/models/effective/order.rb', line 587

def delayed_payment_date_past?
  return false unless delayed?
  delayed_payment_date <= Time.zone.now.to_date
end

#delayed_payment_date_today? ⇒ Boolean

Returns:

  • (Boolean) 


598
599
600
601
 
# File 'app/models/effective/order.rb', line 598

def delayed_payment_date_today?
  return false unless delayed?
  delayed_payment_date == Time.zone.now.to_date
end

#delayed_payment_date_upcoming? ⇒ Boolean

This is checked by an effective_orders view helper. When upcoming we only collect card info.

Returns:

  • (Boolean) 


593
594
595
596
 
# File 'app/models/effective/order.rb', line 593

def delayed_payment_date_upcoming?
  return false unless delayed?
  delayed_payment_date > Time.zone.now.to_date
end

#delayed_payment_info ⇒ Object 



580
581
582
583
584
585
 
# File 'app/models/effective/order.rb', line 580

def delayed_payment_info
  return unless delayed? && deferred? && delayed_payment_provider?
  return unless delayed_payment_date_upcoming?

  "Your #{delayed_payment_method} will be charged $#{'%0.2f' % total_to_f} on #{delayed_payment_date.strftime('%F')}"
end

#delayed_payment_method ⇒ Object 



440
441
442
 
# File 'app/models/effective/order.rb', line 440

def delayed_payment_method
  payment_method_value if delayed?
end

#delayed_payment_provider? ⇒ Boolean

Returns:

  • (Boolean) 


553
554
555
 
# File 'app/models/effective/order.rb', line 553

def delayed_payment_provider?
  payment_provider.present? && EffectiveOrders.delayed_providers.include?(payment_provider)
end

#delayed_ready_to_purchase? ⇒ Boolean

Returns:

  • (Boolean) 


569
570
571
572
573
574
575
576
577
578
 
# File 'app/models/effective/order.rb', line 569

def delayed_ready_to_purchase?
  return false unless delayed? 
  return false unless deferred?
  return false unless delayed_payment_provider?
  return false unless delayed_payment_intent.present?
  return false if delayed_payment_date_upcoming?
  return false if delayed_payment_purchase_ran_at.present? # We ran before and probably failed

  true
end

#deluxe_delayed_purchase! ⇒ Object 



897
898
899
900
901
902
903
904
 
# File 'app/models/effective/order.rb', line 897

def deluxe_delayed_purchase!
  raise('expected a delayed order') unless delayed?
  raise('expected a deferred order') unless deferred?
  raise('expected delayed payment intent') unless delayed_payment_intent.present?
  raise('expected a deluxe_delayed payment provider') unless payment_provider == 'deluxe_delayed'

  Effective::DeluxeApi.new().purchase_delayed_orders!(self)
end

#done? ⇒ Boolean

Returns:

  • (Boolean) 


465
466
467
 
# File 'app/models/effective/order.rb', line 465

def done?
  persisted? && (purchased? || declined? || voided? || abandoned?)
end

#duplicate ⇒ Object 



444
445
446
 
# File 'app/models/effective/order.rb', line 444

def duplicate
  Effective::Order.new(self)
end

#emails ⇒ Object

These are all the emails we send all notifications to



907
908
909
 
# File 'app/models/effective/order.rb', line 907

def emails
  ([purchased_by.try(:email)] + [email] + [user.try(:email)] + Array(organization.try(:billing_emails))).map(&:presence).compact.uniq
end

#emails_send_to ⇒ Object

Doesn’t control anything. Purely for the flash messaging



912
913
914
 
# File 'app/models/effective/order.rb', line 912

def emails_send_to
  (emails + [cc.presence]).compact.uniq.to_sentence
end

#free? ⇒ Boolean

Returns:

  • (Boolean) 


545
546
547
 
# File 'app/models/effective/order.rb', line 545

def free?
  total == 0
end

#in_progress? ⇒ Boolean

Returns:

  • (Boolean) 


461
462
463
 
# File 'app/models/effective/order.rb', line 461

def in_progress?
  pending? || confirmed? || deferred?
end

#label ⇒ Object 



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'app/models/effective/order.rb', line 418

def label
  if refund? && purchased?
    'Refund'
  elsif purchased?
    'Receipt'
  elsif refund? && (pending? || confirmed?)
    'Pending Refund'
  elsif (pending? || confirmed?)
    'Pending Order'
  else
    'Order'
  end
end

#mark_as_purchased! ⇒ Object

Call this as a way to skip over non consequential orders And mark some purchasables purchased This is different than the Mark as Paid payment processor



705
706
707
 
# File 'app/models/effective/order.rb', line 705

def mark_as_purchased!
  purchase!(skip_buyer_validations: true, email: false, skip_quickbooks: true)
end

#num_items ⇒ Object 



610
611
612
 
# File 'app/models/effective/order.rb', line 610

def num_items
  present_order_items.map { |oi| oi.quantity }.sum
end

#payment ⇒ Object 



541
542
543
 
# File 'app/models/effective/order.rb', line 541

def payment
  Hash(self[:payment])
end

#payment_method ⇒ Object 



436
437
438
 
# File 'app/models/effective/order.rb', line 436

def payment_method
  payment_method_value if purchased?
end

#pending! ⇒ Object

This is called from admin/orders#create This is intended for use as an admin action only It skips any address or bad user validations It’s basically the same as save! on a new order, except it might send the payment request to buyer



658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'app/models/effective/order.rb', line 658

def pending!
  return false if purchased?

  assign_attributes(status: :pending)
  self.addresses.clear if addresses.any? { |address| address.valid? == false }
  save!

  if send_payment_request_to_buyer?
    after_commit { send_payment_request_to_buyer! }
  end

  true
end

#pending_refund? ⇒ Boolean

Returns:

  • (Boolean) 


603
604
605
606
607
608
 
# File 'app/models/effective/order.rb', line 603

def pending_refund?
  return false if EffectiveOrders.buyer_purchases_refund?
  return false if purchased?

  refund?
end

#purchasables ⇒ Object 



493
494
495
 
# File 'app/models/effective/order.rb', line 493

def purchasables
  present_order_items.map { |order_item| order_item.purchasable }.compact
end

#purchase!(payment: nil, provider: nil, card: nil, email: true, skip_buyer_validations: false, skip_quickbooks: false) ⇒ Object

Effective::Order.new(items: Product.first, user: User.first).purchase!(email: false)



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'app/models/effective/order.rb', line 710

def purchase!(payment: nil, provider: nil, card: nil, email: true, skip_buyer_validations: false, skip_quickbooks: false)
  return true if purchased?

  raise('unable to purchase voided order') if voided?

  # Assign attributes
  assign_attributes(
    skip_buyer_validations: skip_buyer_validations,

    status: :purchased,
    purchased_at: (purchased_at.presence || Time.zone.now),
    purchased_by: (purchased_by.presence || current_user),

    payment: payment_to_h(payment.presence || 'none'),
    payment_provider: (provider.presence || 'none'),
    payment_card: (card.presence || 'none'),

    delayed_payment_intent: nil # Do not store the delayed payment intent any longer
  )

  if current_user&.email.present?
    assign_attributes(email: current_user.email)
  end

  # Updates surcharge and total based on payment_provider
  assign_order_charges()

  begin
    Effective::Order.transaction do
      run_purchasable_callbacks(:before_purchase)

      save!
      update_purchasables_purchased_order!

      run_purchasable_callbacks(:after_purchase)
    end
  rescue => e
    Effective::Order.transaction do
      save!(validate: false)
      update_purchasables_purchased_order!
    end

    raise(e)
  end

  send_order_receipts! if email
  after_commit { sync_quickbooks!(skip: skip_quickbooks) }

  true
end

#purchased?(provider = nil) ⇒ Boolean

Returns:

  • (Boolean) 


475
476
477
478
479
 
# File 'app/models/effective/order.rb', line 475

def purchased?(provider = nil)
  return false if (status.to_sym != :purchased)
  return true if provider.nil? || payment_provider == provider.to_s
  false
end

#purchased_or_deferred? ⇒ Boolean

Returns:

  • (Boolean) 


481
482
483
 
# File 'app/models/effective/order.rb', line 481

def purchased_or_deferred?
  purchased? || deferred?
end

#purchased_with_credit_card? ⇒ Boolean

Returns:

  • (Boolean) 


485
486
487
 
# File 'app/models/effective/order.rb', line 485

def purchased_with_credit_card?
  purchased? && EffectiveOrders.credit_card_payment_providers.include?(payment_provider)
end

#purchased_without_credit_card? ⇒ Boolean

Returns:

  • (Boolean) 


489
490
491
 
# File 'app/models/effective/order.rb', line 489

def purchased_without_credit_card?
  purchased? && EffectiveOrders.credit_card_payment_providers.exclude?(payment_provider)
end

#refund? ⇒ Boolean

Returns:

  • (Boolean) 


549
550
551
 
# File 'app/models/effective/order.rb', line 549

def refund?
  total.to_i < 0
end

#remove(*items) ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'app/models/effective/order.rb', line 321

def remove(*items)
  raise 'unable to alter a purchased order' if purchased?
  raise 'unable to alter a declined order' if declined?

  removed = items.map do |item|
    order_item = if item.kind_of?(Effective::OrderItem)
      order_items.find { |oi| oi == item }
    else
      order_items.find { |oi| oi.purchasable == item }
    end

    raise("Unable to find order item for #{item}") if order_item.blank?
    order_item
  end

  removed.each { |order_item| order_item.mark_for_destruction }

  # Make sure to reset stored aggregates
  assign_attributes(subtotal: nil, tax_rate: nil, tax: nil, amount_owing: nil, surcharge_percent: nil, surcharge: nil, total: nil)

  removed.length == 1 ? removed.first : removed
end

#reportable_scopes ⇒ Object

effective_reports



168
169
170
 
# File 'app/models/effective/order.rb', line 168

def reportable_scopes
  { purchased: nil, not_purchased: nil, deferred: nil, refunds: nil, pending_refunds: nil }
end

#send_declined_notifications! ⇒ Object 



922
923
924
925
 
# File 'app/models/effective/order.rb', line 922

def send_declined_notifications!
  send_order_declined_to_admin! if send_order_declined_to_admin?
  send_order_declined_to_buyer! if send_order_declined_to_buyer?
end

#send_mark_as_paid_email_to_buyer? ⇒ Boolean

Returns:

  • (Boolean) 


646
647
648
 
# File 'app/models/effective/order.rb', line 646

def send_mark_as_paid_email_to_buyer?
  EffectiveResources.truthy?(send_mark_as_paid_email_to_buyer)
end

#send_order_declined_to_admin! ⇒ Object 



927
928
929
 
# File 'app/models/effective/order.rb', line 927

def send_order_declined_to_admin!
  EffectiveOrders.send_email(:order_declined_to_admin, self) if declined?
end

#send_order_declined_to_admin? ⇒ Boolean

Returns:

  • (Boolean) 


624
625
626
627
 
# File 'app/models/effective/order.rb', line 624

def send_order_declined_to_admin?
  return false if free? && !EffectiveOrders.send_order_receipts_when_free
  EffectiveOrders.send_order_declined_to_admin
end

#send_order_declined_to_buyer! ⇒ Object 



931
932
933
 
# File 'app/models/effective/order.rb', line 931

def send_order_declined_to_buyer!
  EffectiveOrders.send_email(:order_declined_to_buyer, self) if declined?
end

#send_order_declined_to_buyer? ⇒ Boolean

Returns:

  • (Boolean) 


629
630
631
632
 
# File 'app/models/effective/order.rb', line 629

def send_order_declined_to_buyer?
  return false if free? && !EffectiveOrders.send_order_receipts_when_free
  EffectiveOrders.send_order_declined_to_buyer
end

#send_order_receipt_to_admin! ⇒ Object 



935
936
937
 
# File 'app/models/effective/order.rb', line 935

def send_order_receipt_to_admin!
  EffectiveOrders.send_email(:order_receipt_to_admin, self) if purchased?
end

#send_order_receipt_to_admin? ⇒ Boolean

Returns:

  • (Boolean) 


614
615
616
617
 
# File 'app/models/effective/order.rb', line 614

def send_order_receipt_to_admin?
  return false if free? && !EffectiveOrders.send_order_receipts_when_free
  EffectiveOrders.send_order_receipt_to_admin
end

#send_order_receipt_to_buyer! ⇒ Object Also known as: send_buyer_receipt! 



939
940
941
 
# File 'app/models/effective/order.rb', line 939

def send_order_receipt_to_buyer!
  EffectiveOrders.send_email(:order_receipt_to_buyer, self) if purchased?
end

#send_order_receipt_to_buyer? ⇒ Boolean

Returns:

  • (Boolean) 


619
620
621
622
 
# File 'app/models/effective/order.rb', line 619

def send_order_receipt_to_buyer?
  return false if free? && !EffectiveOrders.send_order_receipts_when_free
  EffectiveOrders.send_order_receipt_to_buyer
end

#send_order_receipts! ⇒ Object 



916
917
918
919
920
 
# File 'app/models/effective/order.rb', line 916

def send_order_receipts!
  send_order_receipt_to_admin! if send_order_receipt_to_admin?
  send_order_receipt_to_buyer! if send_order_receipt_to_buyer?
  send_refund_notification! if send_refund_notification_to_admin?
end

#send_payment_request_to_buyer! ⇒ Object 



944
945
946
 
# File 'app/models/effective/order.rb', line 944

def send_payment_request_to_buyer!
  EffectiveOrders.send_email(:payment_request_to_buyer, self) unless purchased?
end

#send_payment_request_to_buyer? ⇒ Boolean

Returns:

  • (Boolean) 


634
635
636
637
638
639
 
# File 'app/models/effective/order.rb', line 634

def send_payment_request_to_buyer?
  return false if free? && !EffectiveOrders.send_order_receipts_when_free
  return false if refund?

  EffectiveResources.truthy?(send_payment_request_to_buyer)
end

#send_pending_order_invoice_to_buyer! ⇒ Object 



948
949
950
 
# File 'app/models/effective/order.rb', line 948

def send_pending_order_invoice_to_buyer!
  EffectiveOrders.send_email(:pending_order_invoice_to_buyer, self) unless purchased?
end

#send_refund_notification! ⇒ Object 



952
953
954
 
# File 'app/models/effective/order.rb', line 952

def send_refund_notification!
  EffectiveOrders.send_email(:refund_notification_to_admin, self) if refund?
end

#send_refund_notification_to_admin? ⇒ Boolean

Returns:

  • (Boolean) 


641
642
643
644
 
# File 'app/models/effective/order.rb', line 641

def send_refund_notification_to_admin?
  return false unless refund?
  EffectiveOrders.send_refund_notification_to_admin
end

#skip_buyer_validations? ⇒ Boolean

Returns:

  • (Boolean) 


650
651
652
 
# File 'app/models/effective/order.rb', line 650

def skip_buyer_validations?
  EffectiveResources.truthy?(skip_buyer_validations)
end

#skip_quickbooks! ⇒ Object 



774
775
776
 
# File 'app/models/effective/order.rb', line 774

def skip_quickbooks!
  sync_quickbooks!(skip: true)
end

#subtotal ⇒ Object 



497
498
499
 
# File 'app/models/effective/order.rb', line 497

def subtotal
  self[:subtotal] || get_subtotal()
end

#surcharge ⇒ Object 



517
518
519
 
# File 'app/models/effective/order.rb', line 517

def surcharge
  self[:surcharge] || get_surcharge()
end

#surcharge_percent ⇒ Object 



513
514
515
 
# File 'app/models/effective/order.rb', line 513

def surcharge_percent
  self[:surcharge_percent] || get_surcharge_percent()
end

#surcharge_tax ⇒ Object 



521
522
523
 
# File 'app/models/effective/order.rb', line 521

def surcharge_tax
  self[:surcharge_tax] || get_surcharge_tax()
end

#sync_quickbooks!(skip:) ⇒ Object

We support two different Quickbooks synchronization gems: effective_qb_sync and effective_qb_online



762
763
764
765
766
767
768
769
770
771
772
 
# File 'app/models/effective/order.rb', line 762

def sync_quickbooks!(skip:)
  if EffectiveOrders.qb_online?
    skip ? EffectiveQbOnline.skip_order!(self) : EffectiveQbOnline.sync_order!(self)
  end

  if EffectiveOrders.qb_sync?
    skip ? EffectiveQbSync.skip_order!(self) : true # Nothing to do
  end

  true
end

#tax ⇒ Object 



505
506
507
 
# File 'app/models/effective/order.rb', line 505

def tax
  self[:tax] || get_tax()
end

#tax_rate ⇒ Object 



501
502
503
 
# File 'app/models/effective/order.rb', line 501

def tax_rate
  self[:tax_rate] || get_tax_rate()
end

#to_s ⇒ Object 



414
415
416
 
# File 'app/models/effective/order.rb', line 414

def to_s
  [label, ' #', to_param].join
end

#total ⇒ Object 



525
526
527
 
# File 'app/models/effective/order.rb', line 525

def total
  self[:total] || get_total()
end

#total_label ⇒ Object 



432
433
434
 
# File 'app/models/effective/order.rb', line 432

def total_label
  purchased? ? 'Total Paid' : 'Total Due'
end

#total_to_f ⇒ Object 



529
530
531
 
# File 'app/models/effective/order.rb', line 529

def total_to_f
  ((total || 0) / 100.0).to_f
end

#total_with_surcharge ⇒ Object 



533
534
535
 
# File 'app/models/effective/order.rb', line 533

def total_with_surcharge
  get_total_with_surcharge()
end

#total_without_surcharge ⇒ Object 



537
538
539
 
# File 'app/models/effective/order.rb', line 537

def total_without_surcharge
  get_total_without_surcharge()
end

#transaction_id ⇒ Object

For moneris and moneris_checkout. Just a unique value. Must be 50 characters or fewer or will raise moneris error.



449
450
451
 
# File 'app/models/effective/order.rb', line 449

def transaction_id
  [to_param, billing_name.to_s.parameterize.first(20).presence, Time.zone.now.to_i, rand(1000..9999)].compact.join('-')
end

#unvoid! ⇒ Object 



892
893
894
895
 
# File 'app/models/effective/order.rb', line 892

def unvoid!
  raise('order must be voided to unvoid') unless voided?
  unvoided!(skip_buyer_validations: true)
end

#update_prices! ⇒ Object 



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'app/models/effective/order.rb', line 397

def update_prices!
  raise('already purchased') if purchased?
  raise('must be pending or confirmed') unless pending? || confirmed?

  present_order_items.each do |item|
    purchasable = item.purchasable

    if purchasable.blank? || purchasable.marked_for_destruction?
      item.mark_for_destruction
    else
      item.assign_purchasable_attributes
    end
  end

  save!
end

#update_purchasable_attributes ⇒ Object

Called by effective_memberships to update prices from purchasable fees Not called internally



692
693
694
 
# File 'app/models/effective/order.rb', line 692

def update_purchasable_attributes
  present_order_items.each { |oi| oi.update_purchasable_attributes }
end

#update_purchasable_attributes! ⇒ Object 



696
697
698
699
700
 
# File 'app/models/effective/order.rb', line 696

def update_purchasable_attributes!
  raise('cannot update purchasable attributes of a purchased order') if purchased?
  update_purchasable_attributes
  save!
end

#void! ⇒ Object 



887
888
889
890
 
# File 'app/models/effective/order.rb', line 887

def void!
  raise('already voided') if voided?
  voided!(skip_buyer_validations: true)
end