Class: Pay::Braintree::Billable

Inherits:
Object
  • Object
show all
Defined in:
lib/pay/braintree/billable.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pay_customer) ⇒ Billable

Returns a new instance of Billable.


14
15
16
# File 'lib/pay/braintree/billable.rb', line 14

def initialize(pay_customer)
  @pay_customer = pay_customer
end

Instance Attribute Details

#pay_customerObject (readonly)

Returns the value of attribute pay_customer.


4
5
6
# File 'lib/pay/braintree/billable.rb', line 4

def pay_customer
  @pay_customer
end

Instance Method Details

#add_payment_method(token, default: false) ⇒ Object


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/pay/braintree/billable.rb', line 126

def add_payment_method(token, default: false)
  customer unless processor_id?

  result = gateway.payment_method.create(
    customer_id: processor_id,
    payment_method_nonce: token,
    options: {
      make_default: default,
      verify_card: true
    }
  )
  raise Pay::Braintree::Error, result unless result.success?

  pay_payment_method = save_payment_method(result.payment_method, default: default)

  # Update existing subscriptions to the new payment method
  pay_customer.subscriptions.each do |subscription|
    if subscription.active?
      gateway.subscription.update(subscription.processor_id, {payment_method_token: token})
    end
  end

  pay_payment_method
rescue ::Braintree::AuthorizationError => e
  raise Pay::Braintree::AuthorizationError, e
rescue ::Braintree::BraintreeError => e
  raise Pay::Braintree::Error, e
end

#card_details_for_braintree_transaction(transaction) ⇒ Object


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/pay/braintree/billable.rb', line 241

def card_details_for_braintree_transaction(transaction)
  case transaction.payment_instrument_type
  when "android_pay_card", "apple_pay_card", "credit_card", "google_pay_card", "samsung_pay_card", "visa_checkout_card"
    # Lookup the attribute with the payment method details by name
    attribute_name = transaction.payment_instrument_type

    # The attribute name for Apple and Google Pay don't include _card for some reason
    if ["apple_pay_card", "google_pay_card"].include?(transaction.payment_instrument_type)
      attribute_name = attribute_name.split("_card").first

    # Android Pay was renamed to Google Pay, but test nonces still use android_pay_card
    elsif attribute_name == "android_pay_card"
      attribute_name = "google_pay"
    end

    # Retrieve payment method details from transaction
    payment_method = transaction.send("#{attribute_name}_details")

    {
      payment_method_type: :card,
      brand: payment_method.card_type,
      last4: payment_method.last_4,
      exp_month: payment_method.expiration_month,
      exp_year: payment_method.expiration_year
    }

  when "paypal_account"
    {
      payment_method_type: :paypal,
      brand: "PayPal",
      last4: transaction.paypal_details.payer_email,
      exp_month: nil,
      exp_year: nil
    }

  when "venmo_account"
    {
      payment_method_type: :venmo,
      brand: "Venmo",
      last4: transaction..username,
      exp_month: nil,
      exp_year: nil
    }

  else
    {payment_method_type: "unknown"}
  end
end

#charge(amount, options = {}) ⇒ Object


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/pay/braintree/billable.rb', line 75

def charge(amount, options = {})
  args = {
    amount: amount.to_i / 100.0,
    customer_id: customer.id,
    options: {submit_for_settlement: true},
    custom_fields: options.delete(:metadata)
  }.merge(options)

  result = gateway.transaction.sale(args)
  raise Pay::Braintree::Error, result unless result.success?

  save_transaction(result.transaction)
rescue ::Braintree::AuthorizationError => e
  raise Pay::Braintree::AuthorizationError, e
rescue ::Braintree::BraintreeError => e
  raise Pay::Braintree::Error, e
end

#customerObject

Retrieve the Braintree::Customer object

  • If no processor_id is present, creates a Customer.

  • When 'payment_method_token' is present, it will also set the default payment method


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/pay/braintree/billable.rb', line 40

def customer
  if processor_id?
    customer = gateway.customer.find(processor_id)

    if payment_method_token?
      add_payment_method(payment_method_token, default: true)
      pay_customer.payment_method_token = nil
    end

    customer
  else
    result = gateway.customer.create(customer_attributes.merge(payment_method_nonce: payment_method_token))
    raise Pay::Braintree::Error, result unless result.success?
    pay_customer.update!(processor_id: result.customer.id)

    if payment_method_token?
      save_payment_method(result.customer.payment_methods.last, default: true)
      pay_customer.payment_method_token = nil
    end

    result.customer
  end
rescue ::Braintree::AuthorizationError => e
  raise Pay::Braintree::AuthorizationError, e
rescue ::Braintree::BraintreeError => e
  raise Pay::Braintree::Error, e
end

#customer_attributesObject

Returns a hash of attributes for the Stripe::Customer object


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/pay/braintree/billable.rb', line 19

def customer_attributes
  owner = pay_customer.owner

  attributes = case owner.class.pay_braintree_customer_attributes
  when Symbol
    owner.send(owner.class.pay_braintree_customer_attributes, pay_customer)
  when Proc
    owner.class.pay_braintree_customer_attributes.call(pay_customer)
  end

  # Guard against attributes being returned nil
  attributes ||= {}

  first_name, last_name = customer_name.split(" ", 2)
  {email: email, first_name: first_name, last_name: last_name}.merge(attributes)
end

#gatewayObject


184
185
186
# File 'lib/pay/braintree/billable.rb', line 184

def gateway
  Pay.braintree_gateway
end

#processor_subscription(subscription_id, options = {}) ⇒ Object


161
162
163
# File 'lib/pay/braintree/billable.rb', line 161

def processor_subscription(subscription_id, options = {})
  gateway.subscription.find(subscription_id)
end

#save_payment_method(payment_method, default:) ⇒ Object


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
232
233
234
235
236
237
238
239
# File 'lib/pay/braintree/billable.rb', line 188

def save_payment_method(payment_method, default:)
  attributes = case payment_method
  when ::Braintree::CreditCard, ::Braintree::ApplePayCard, ::Braintree::GooglePayCard, ::Braintree::SamsungPayCard, ::Braintree::VisaCheckoutCard
    {
      payment_method_type: :card,
      brand: payment_method.card_type,
      last4: payment_method.last_4,
      exp_month: payment_method.expiration_month,
      exp_year: payment_method.expiration_year
    }

  when ::Braintree::PayPalAccount
    {
      payment_method_type: :paypal,
      brand: "PayPal",
      email: payment_method.email
    }
  when ::Braintree::VenmoAccount
    {
      payment_method_type: :venmo,
      brand: "Venmo",
      username: payment_method.username
    }
  when ::Braintree::UsBankAccount
    {
      payment_method_type: "us_bank_account",
      bank: payment_method.bank_name,
      last4: payment_method.last_4
    }
  else
    {
      payment_method_type: payment_method.class.name.demodulize.underscore,
      brand: payment_method.try(:card_type),
      last4: payment_method.try(:last_4),
      exp_month: payment_method.try(:expiration_month),
      exp_year: payment_method.try(:expiration_year),
      bank: payment_method.try(:bank_name),
      username: payment_method.try(:username),
      email: payment_method.try(:email)
    }
  end

  pay_payment_method = pay_customer.payment_methods.where(processor_id: payment_method.token).first_or_initialize

  pay_customer.payment_methods.update_all(default: false) if default
  pay_payment_method.update!(attributes.merge(default: default))

  # Reload the Rails association
  pay_customer.reload_default_payment_method if default

  pay_payment_method
end

#save_transaction(transaction) ⇒ Object


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/pay/braintree/billable.rb', line 165

def save_transaction(transaction)
  attrs = card_details_for_braintree_transaction(transaction)
  attrs[:amount] = transaction.amount.to_f * 100
  attrs[:metadata] = transaction.custom_fields
  attrs[:currency] = transaction.currency_iso_code
  attrs[:application_fee_amount] = transaction.service_fee_amount

  # Associate charge with subscription if we can
  if transaction.subscription_id
    pay_subscription = pay_customer.subscriptions.find_by(processor_id: transaction.subscription_id)
    attrs[:subscription] = pay_subscription
    attrs[:metadata] = pay_subscription.
  end

  charge = pay_customer.charges.find_or_initialize_by(processor_id: transaction.id)
  charge.update!(attrs)
  charge
end

#subscribe(name: Pay.default_product_name, plan: Pay.default_plan_name, **options) ⇒ Object


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/pay/braintree/billable.rb', line 93

def subscribe(name: Pay.default_product_name, plan: Pay.default_plan_name, **options)
  token = customer.payment_methods.find(&:default?).try(:token)
  raise Pay::Error, "Customer has no default payment method" if token.nil?

  # Standardize the trial period options
  if (trial_period_days = options.delete(:trial_period_days)) && trial_period_days > 0
    options.merge!(trial_period: true, trial_duration: trial_period_days, trial_duration_unit: :day)
  end

   = options.delete(:metadata)
  subscription_options = options.merge(
    payment_method_token: token,
    plan_id: plan
  )

  result = gateway.subscription.create(subscription_options)
  raise Pay::Braintree::Error, result unless result.success?

  pay_customer.subscriptions.create!(
    name: name,
    processor_id: result.subscription.id,
    processor_plan: plan,
    status: :active,
    trial_ends_at: trial_end_date(result.subscription),
    ends_at: nil,
    metadata: 
  )
rescue ::Braintree::AuthorizationError => e
  raise Pay::Braintree::AuthorizationError, e
rescue ::Braintree::BraintreeError => e
  raise Pay::Braintree::Error, e
end

#trial_end_date(subscription) ⇒ Object


155
156
157
158
159
# File 'lib/pay/braintree/billable.rb', line 155

def trial_end_date(subscription)
  return unless subscription.trial_period
  # Braintree returns dates without time zones, so we'll assume they're UTC
  subscription.first_billing_date.end_of_day
end

#update_customer!(**attributes) ⇒ Object

Syncs name and email to Braintree::Customer You can also pass in other attributes that will be merged into the default attributes


70
71
72
73
# File 'lib/pay/braintree/billable.rb', line 70

def update_customer!(**attributes)
  customer unless processor_id?
  gateway.customer.update(processor_id, customer_attributes.merge(attributes))
end