Class: Pay::Subscription

Inherits:
ApplicationRecord show all
Defined in:
app/models/pay/subscription.rb

Constant Summary collapse

STATUSES =
%w[incomplete incomplete_expired trialing active past_due canceled unpaid paused]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.find_by_processor_and_id(processor, processor_id) ⇒ Object



53
54
55
# File 'app/models/pay/subscription.rb', line 53

def self.find_by_processor_and_id(processor, processor_id)
  joins(:customer).find_by(processor_id: processor_id, pay_customers: {processor: processor})
end

.pay_processor_for(name) ⇒ Object



57
58
59
# File 'app/models/pay/subscription.rb', line 57

def self.pay_processor_for(name)
  "Pay::#{name.to_s.classify}::Subscription".constantize
end

Instance Method Details

#active?Boolean

Returns:

  • (Boolean)


89
90
91
# File 'app/models/pay/subscription.rb', line 89

def active?
  ["trialing", "active"].include?(status) && (ends_at.nil? || on_grace_period? || on_trial?)
end

#canceled?Boolean

Returns:

  • (Boolean)


81
82
83
# File 'app/models/pay/subscription.rb', line 81

def canceled?
  ends_at?
end

#cancelled?Boolean

Returns:

  • (Boolean)


85
86
87
# File 'app/models/pay/subscription.rb', line 85

def cancelled?
  canceled?
end

#change_quantity(quantity) ⇒ Object



105
106
107
108
# File 'app/models/pay/subscription.rb', line 105

def change_quantity(quantity)
  payment_processor.change_quantity(quantity)
  update(quantity: quantity)
end

#generic_trial?Boolean

Returns:

  • (Boolean)


73
74
75
# File 'app/models/pay/subscription.rb', line 73

def generic_trial?
  fake_processor? && trial_ends_at?
end

#has_incomplete_payment?Boolean

Returns:

  • (Boolean)


101
102
103
# File 'app/models/pay/subscription.rb', line 101

def has_incomplete_payment?
  past_due? || incomplete?
end

#incomplete?Boolean

Returns:

  • (Boolean)


97
98
99
# File 'app/models/pay/subscription.rb', line 97

def incomplete?
  status == "incomplete"
end

#latest_paymentObject



131
132
133
# File 'app/models/pay/subscription.rb', line 131

def latest_payment
  processor_subscription(expand: ["latest_invoice.payment_intent"]).latest_invoice.payment_intent
end

#no_prorateObject



65
66
67
# File 'app/models/pay/subscription.rb', line 65

def no_prorate
  self.prorate = false
end

#on_trial?Boolean

Returns:

  • (Boolean)


77
78
79
# File 'app/models/pay/subscription.rb', line 77

def on_trial?
  trial_ends_at? && Time.zone.now < trial_ends_at
end

#paddle_paused_fromObject



135
136
137
138
139
# File 'app/models/pay/subscription.rb', line 135

def paddle_paused_from
  if (timestamp = super)
    Time.zone.parse(timestamp)
  end
end

#past_due?Boolean

Returns:

  • (Boolean)


93
94
95
# File 'app/models/pay/subscription.rb', line 93

def past_due?
  status == "past_due"
end

#payment_processorObject



61
62
63
# File 'app/models/pay/subscription.rb', line 61

def payment_processor
  @payment_processor ||= self.class.pay_processor_for(customer.processor).new(self)
end

#processor_subscription(**options) ⇒ Object



127
128
129
# File 'app/models/pay/subscription.rb', line 127

def processor_subscription(**options)
  payment_processor.subscription(**options)
end

#resumeObject



110
111
112
113
114
# File 'app/models/pay/subscription.rb', line 110

def resume
  payment_processor.resume
  update(ends_at: nil, status: :active)
  self
end

#skip_trialObject



69
70
71
# File 'app/models/pay/subscription.rb', line 69

def skip_trial
  self.trial_ends_at = nil
end

#swap(plan) ⇒ Object

Raises:

  • (ArgumentError)


116
117
118
119
120
# File 'app/models/pay/subscription.rb', line 116

def swap(plan)
  raise ArgumentError, "plan must be a string. Got `#{plan.inspect}` instead." unless plan.is_a?(String)
  payment_processor.swap(plan)
  update(processor_plan: plan, ends_at: nil, status: :active)
end

#swap_and_invoice(plan) ⇒ Object



122
123
124
125
# File 'app/models/pay/subscription.rb', line 122

def swap_and_invoice(plan)
  swap(plan)
  owner.invoice!(subscription_id: processor_id)
end