Module: EffectiveOrders

Includes:
EffectiveGem
Defined in:
lib/effective_orders.rb,
lib/effective_orders/engine.rb,
lib/effective_orders/version.rb,
lib/generators/effective_orders/install_generator.rb

Defined Under Namespace

Modules: Generators Classes: Engine, SoldOutException

Constant Summary collapse

ACTIVE =

Subscription statuses (as per stripe)

'active'
PAST_DUE = 
'past_due'
TRIALING = 
'trialing'
CANCELED = 
'canceled'
STATUSES = 
{ ACTIVE => ACTIVE, PAST_DUE => PAST_DUE, CANCELED => CANCELED, TRIALING => TRIALING }
VERSION = 
'6.32.4'.freeze

Class Method Summary collapse

Class Method Details

.admin_payment_providers ⇒ Object

For the Admin Mark as Paid screen



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/effective_orders.rb', line 191

def self.admin_payment_providers
  [
    ('cheque' if mark_as_paid?),
    ('credit card' if mark_as_paid?),
    ('deluxe' if deluxe?),
    ('etransfer' if etransfer?),
    ('helcim' if helcim?),
    #('free' if free?),
    ('moneris' if moneris?),
    ('moneris_checkout' if moneris_checkout?),
    ('paypal' if paypal?),
    ('phone' if mark_as_paid?),
    #('pretend' if pretend?),
    #('refund' if refund?),
    ('stripe' if stripe?),
    ('other (non credit card)' if mark_as_paid?),
    'none'
  ].compact
end

.buyer_purchases_refund? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/effective_orders.rb', line 149

def self.buyer_purchases_refund?
  buyer_purchases_refund == true
end

.can_skip_checkout_step1? ⇒ Boolean

Returns:

  • (Boolean) 


284
285
286
287
288
289
290
 
# File 'lib/effective_orders.rb', line 284

def self.can_skip_checkout_step1?
  return false if require_billing_address
  return false if require_shipping_address
  return false if collect_note
  return false if terms_and_conditions
  true
end

.cheque? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/effective_orders.rb', line 85

def self.cheque?
  cheque.kind_of?(Hash)
end

.config_keys ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/effective_orders.rb', line 16

def self.config_keys
  [
    :orders_table_name, :order_items_table_name, :carts_table_name, :cart_items_table_name,
    :customers_table_name, :subscriptions_table_name, :products_table_name, :item_names_table_name,
    :layout,
    :orders_collection_scope, :order_tax_rate_method,
    :obfuscate_order_ids, :use_item_names, :require_item_names,
    :use_effective_qb_sync, :use_effective_qb_online, 
    :tax_label,
    :billing_address, :shipping_address,
    :collect_note, :collect_note_required, :collect_note_message,
    :terms_and_conditions, :terms_and_conditions_label, :minimum_charge,
    :credit_card_surcharge_percent, :credit_card_surcharge_qb_item_name,

    # Organization mode
    :organization_enabled, :organization_class_name,

    # Mailer
    :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject,

    # Emails
    :send_order_receipt_to_admin, :send_order_receipt_to_buyer, 
    :send_order_declined_to_admin, :send_order_declined_to_buyer, 
    :send_payment_request_to_admin, :send_payment_request_to_buyer,
    :send_order_receipts_when_mark_as_paid, :send_order_receipts_when_free,
    :send_subscription_events,
    :send_subscription_trialing, :send_subscription_trial_expired,
    :send_refund_notification_to_admin,

    # Quickbooks Online
    :qb_online_sync_free_orders, :qb_online_customer_display_name_format,

    # Quickbooks Online Error Emails
    :send_qb_online_sync_error, :qb_online_sync_error_recipients,

    # reCAPTCHA. Hash|true|false
    :recaptcha,

    # Features
    :free_enabled, :mark_as_paid_enabled, :pretend_enabled, :pretend_message, :buyer_purchases_refund,

    # Payment processors. false or Hash
    :cheque, :deluxe, :deluxe_delayed, :etransfer, :helcim, :moneris, :moneris_checkout, :paypal, :phone, :refund, :stripe, :subscriptions, :trial
  ]
end

.credit_card_payment_providers ⇒ Object 



220
221
222
 
# File 'lib/effective_orders.rb', line 220

def self.credit_card_payment_providers
  ['credit card', 'deluxe', 'helcim', 'moneris', 'moneris_checkout', 'paypal', 'stripe']
end

.deferred? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/effective_orders.rb', line 105

def self.deferred?
  deferred_providers.present?
end

.deferred_providers ⇒ Object

Should not include delayed providers



212
213
214
 
# File 'lib/effective_orders.rb', line 212

def self.deferred_providers
  [('cheque' if cheque?), ('etransfer' if etransfer?), ('phone' if phone?)].compact
end

.delayed? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/effective_orders.rb', line 109

def self.delayed?
  delayed_providers.present?
end

.delayed_providers ⇒ Object 



216
217
218
 
# File 'lib/effective_orders.rb', line 216

def self.delayed_providers
  [('deluxe_delayed' if deluxe_delayed?)].compact
end

.deluxe? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/effective_orders.rb', line 97

def self.deluxe?
  deluxe.kind_of?(Hash)
end

.deluxe_delayed? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/effective_orders.rb', line 101

def self.deluxe_delayed?
  deluxe_delayed.kind_of?(Hash)
end

.deluxe_script_url ⇒ Object 



381
382
383
384
385
386
387
 
# File 'lib/effective_orders.rb', line 381

def self.deluxe_script_url
  case EffectiveOrders.deluxe.fetch(:environment)
  when 'production' then 'https://hostedpaymentform.deluxe.com/v2/deluxe.js'
  when 'sandbox' then 'https://hostedform2.deluxe.com/V2/deluxe.js'
  else raise('unexpected EffectiveOrders.deluxe :environment key. Please check your config/initializers/effective_orders.rb file')
  end
end

.etransfer? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/effective_orders.rb', line 89

def self.etransfer?
  etransfer.kind_of?(Hash)
end

.fee_saver? ⇒ Boolean

Returns:

  • (Boolean) 


256
257
258
 
# File 'lib/effective_orders.rb', line 256

def self.fee_saver?
  helcim? && helcim[:fee_saver] == true
end

.free? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/effective_orders.rb', line 93

def self.free?
  free_enabled == true
end

.helcim? ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/effective_orders.rb', line 113

def self.helcim?
  helcim.kind_of?(Hash)
end

.helcim_script_url ⇒ Object 



389
390
391
 
# File 'lib/effective_orders.rb', line 389

def self.helcim_script_url
  "https://secure.helcim.app/helcim-pay/services/start.js"
end

.mailer_class ⇒ Object 



280
281
282
 
# File 'lib/effective_orders.rb', line 280

def self.mailer_class
  mailer&.constantize || Effective::OrdersMailer
end

.mark_as_paid? ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/effective_orders.rb', line 117

def self.mark_as_paid?
  mark_as_paid_enabled == true
end

.moneris? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/effective_orders.rb', line 121

def self.moneris?
  moneris.kind_of?(Hash)
end

.moneris_checkout? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/effective_orders.rb', line 125

def self.moneris_checkout?
  moneris_checkout.kind_of?(Hash)
end

.moneris_checkout_script_url ⇒ Object 



393
394
395
396
397
398
399
 
# File 'lib/effective_orders.rb', line 393

def self.moneris_checkout_script_url
  case EffectiveOrders.moneris_checkout.fetch(:environment)
  when 'prod' then 'https://gateway.moneris.com/chktv2/js/chkt_v2.00.js'
  when 'qa' then 'https://gatewayt.moneris.com/chktv2/js/chkt_v2.00.js'
  else raise('unexpected EffectiveOrders.moneris_checkout :environment key. Please check your config/initializers/effective_orders.rb file')
  end
end

.moneris_request_url ⇒ Object 



401
402
403
404
405
406
407
 
# File 'lib/effective_orders.rb', line 401

def self.moneris_request_url
  case EffectiveOrders.moneris_checkout.fetch(:environment)
  when 'prod' then 'https://gateway.moneris.com/chktv2/request/request.php'
  when 'qa' then 'https://gatewayt.moneris.com/chktv2/request/request.php'
  else raise('unexpected EffectiveOrders.moneris_checkout :environment key. Please check your config/initializers/effective_orders.rb file')
  end
end

.no_refund? ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/effective_orders.rb', line 145

def self.no_refund?
  !refund?
end

.Organization ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/effective_orders.rb', line 77

def self.Organization
  klass = organization_class_name&.constantize
  klass ||= (EffectiveMemberships.Organization if defined?(EffectiveMemberships))
  raise('Please set the effective_orders config.organization_class_name') if klass.blank?

  klass
end

.organization_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/effective_orders.rb', line 73

def self.organization_enabled?
  organization_enabled == true
end

.payment_providers ⇒ Object

The Effective::Order.payment_provider value must be in this collection



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/effective_orders.rb', line 170

def self.payment_providers
  [
    ('cheque' if cheque?),
    ('credit card' if mark_as_paid?),
    ('deluxe' if deluxe?),
    ('etransfer' if etransfer?),
    ('free' if free?),
    ('helcim' if helcim?),
    ('moneris' if moneris?),
    ('moneris_checkout' if moneris_checkout?),
    ('paypal' if paypal?),
    ('phone' if phone?),
    ('pretend' if pretend?),
    ('refund' if refund?),
    ('stripe' if stripe?),
    ('other' if mark_as_paid?),
    'none'
  ].compact
end

.payment_restriction(payment_provider, order) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/effective_orders.rb', line 292

def self.payment_restriction(payment_provider, order)
  provider = try(payment_provider)
  raise("Unexpected payment provider: #{payment_provider || 'nil'}") unless provider.kind_of?(Hash)

  if (price = provider[:min_price]).present? && order.total < provider[:min_price]
    return "is only available for invoices over $#{'%0.2f' % (price / 100.00)}"
  end

  if (price = provider[:max_price]).present? && order.total > provider[:max_price]
    return "is only available for invoices up to $#{'%0.2f' % (price / 100.00)}"
  end

  # No restrictions
  nil
end

.paypal? ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/effective_orders.rb', line 129

def self.paypal?
  paypal.kind_of?(Hash)
end

.permitted_params ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'lib/effective_orders.rb', line 64

def self.permitted_params
  @permitted_params ||= [
    :cc, :note, :terms_and_conditions, :confirmed_checkout,
    billing_address: EffectiveAddresses.permitted_params,
    shipping_address: EffectiveAddresses.permitted_params,
    subscripter: [:stripe_plan_id, :stripe_token]
  ]
end

.phone? ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/effective_orders.rb', line 133

def self.phone?
  phone.kind_of?(Hash)
end

.pretend? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/effective_orders.rb', line 137

def self.pretend?
  pretend_enabled == true
end

.qb_online? ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
 
# File 'lib/effective_orders.rb', line 228

def self.qb_online?
  use_effective_qb_online && defined?(EffectiveQbOnline)
end

.qb_online_sync_free_orders? ⇒ Boolean

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/effective_orders.rb', line 232

def self.qb_online_sync_free_orders?
  qb_online_sync_free_orders != false
end

.qb_sync? ⇒ Boolean

Returns:

  • (Boolean) 


224
225
226
 
# File 'lib/effective_orders.rb', line 224

def self.qb_sync?
  use_effective_qb_sync && defined?(EffectiveQbSync)
end

.quickbooks? ⇒ Boolean

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/effective_orders.rb', line 248

def self.quickbooks?
  use_effective_qb_sync || use_effective_qb_online
end

.recaptcha? ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/effective_orders.rb', line 260

def self.recaptcha?
  (recaptcha.kind_of?(Hash) || recaptcha == true) && defined?(::Recaptcha)
end

.recaptcha_secret_key ⇒ Object 



272
273
274
275
276
277
278
 
# File 'lib/effective_orders.rb', line 272

def self.recaptcha_secret_key
  if recaptcha.kind_of?(Hash)
    recaptcha[:secret_key]
  elsif recaptcha == true
    ::Recaptcha.configuration.secret_key!
  end
end

.recaptcha_site_key ⇒ Object 



264
265
266
267
268
269
270
 
# File 'lib/effective_orders.rb', line 264

def self.recaptcha_site_key
  if recaptcha.kind_of?(Hash)
    recaptcha[:site_key]
  elsif recaptcha == true
    ::Recaptcha.configuration.site_key!
  end
end

.refund? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/effective_orders.rb', line 141

def self.refund?
  refund.kind_of?(Hash)
end

.require_item_names? ⇒ Boolean

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/effective_orders.rb', line 240

def self.require_item_names?
  require_item_names == true
end

.single_payment_processor? ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/effective_orders.rb', line 165

def self.single_payment_processor?
  [deluxe?, moneris?, moneris_checkout?, paypal?, stripe?].select { |enabled| enabled }.length == 1
end

.stripe? ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/effective_orders.rb', line 153

def self.stripe?
  stripe.kind_of?(Hash)
end

.stripe_plans ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
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
 
# File 'lib/effective_orders.rb', line 319

def self.stripe_plans
  return [] unless (stripe? && subscriptions?)

  @stripe_plans ||= (
    Rails.logger.info '[STRIPE] index plans'

    plans = begin
      Stripe::Plan.respond_to?(:all) ? Stripe::Plan.all : Stripe::Plan.list
    rescue Exception => e
      raise e if Rails.env.production?
      Rails.logger.info "[STRIPE ERROR]: #{e.message}"
      Rails.logger.info "[STRIPE ERROR]: effective_orders continuing with empty stripe plans. This would fail loudly in Rails.env.production."
      []
    end

    plans = plans.map do |plan|
      description = ("$#{'%0.2f' % (plan.amount / 100.0)}" + ' ' + plan.currency.upcase + '/' +  plan.interval.to_s)

      {
        id: plan.id,
        product_id: plan.product,
        name: plan.nickname || description,
        description: description,
        amount: plan.amount,
        currency: plan.currency,
        interval: plan.interval,
        interval_count: plan.interval_count,
        trial_period_days: (plan.trial_period_days if plan.respond_to?(:trial_period_days))
      }
    end.sort do |x, y|
      val ||= (x[:interval] <=> y[:interval])
      val = nil if val == 0

      val ||= (x[:amount] <=> y[:amount])
      val = nil if val == 0

      val ||= (x[:name] <=> y[:name])
      val = nil if val == 0

      val || (x[:id] <=> y[:id])
    end

    # Calculate savings for any yearly per user plans, based on their matching monthly plans
    plans.select { |plan| plan[:interval] == 'year' }.each do |yearly|
      monthly_name = yearly[:name].downcase.gsub('year', 'month')
      monthly = plans.find { |plan| plan[:interval] == 'month' && plan[:name].downcase == monthly_name }
      next unless monthly

      savings = (monthly[:amount].to_i * 12) - yearly[:amount].to_i
      next unless savings > 0

      yearly[:savings] = savings
    end

    plans
  )
end

.stripe_plans_collection ⇒ Object 



377
378
379
 
# File 'lib/effective_orders.rb', line 377

def self.stripe_plans_collection
  stripe_plans.map { |plan| [plan[:name], plan[:id]] }
end

.stripe_script_url ⇒ Object 



409
410
411
 
# File 'lib/effective_orders.rb', line 409

def self.stripe_script_url
  "https://js.stripe.com/v3/"
end

.subscriptions? ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/effective_orders.rb', line 157

def self.subscriptions?
  subscriptions.kind_of?(Hash)
end

.surcharge? ⇒ Boolean

Returns:

  • (Boolean) 


252
253
254
 
# File 'lib/effective_orders.rb', line 252

def self.surcharge?
  credit_card_surcharge_percent.to_f > 0.0
end

.tax_label ⇒ Object 



244
245
246
 
# File 'lib/effective_orders.rb', line 244

def self.tax_label
  config[:tax_label].presence || "Tax"
end

.trial? ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/effective_orders.rb', line 161

def self.trial?
  trial.kind_of?(Hash)
end

.use_item_names? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/effective_orders.rb', line 236

def self.use_item_names?
  use_item_names != false
end

.with_stripe(&block) ⇒ Object 



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/effective_orders.rb', line 308

def self.with_stripe(&block)
  raise('expected stripe to be enabled') unless stripe?

  begin
    ::Stripe.api_key = stripe[:secret_key]
    yield
  ensure
    ::Stripe.api_key = nil
  end
end