pay 2.6.7 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8901d69060546acd46c628f40bad3c72f0353e37dd0feff1ef94593d56c07f74
-  data.tar.gz: 8f5d3e21c8c17904483ee98e6996186a9e15ce368d4161c024464b4731db4a15
+  metadata.gz: d696d24ee2bb2b4827f6d6e31db738752ebb2eadca4ea0e79144518fc9375be9
+  data.tar.gz: 8aad550b117bee7e28c9231832f4f344c37054db4f1a7d0176f034c780d0abed
 SHA512:
-  metadata.gz: 2e2b6490e777ecfff88673c295ee91367125a18d7e49ef5127827dff080bfec151b34f832617aef06512c3630ac0bcec936cc9ffdcddfaec80a80a7ccb865b60
-  data.tar.gz: 5f0962f4ecb9cfafa8dfeed0e437e801eaa8dc239481477fdf8b689f359383bef0c9907f1ad0b1d7475ccc87391355fcdc1548229cc2bdf3c45cb03ce17f26be
+  metadata.gz: 5dc610b8d7b67ed4073fea783b290d3cd6ada3f4df1ed7bac26a0c4770f4a5ab854bf492fe6541f14b069ae61b10369024689a9f832d625ba2201a14deb24fc1
+  data.tar.gz: 3801e3d1da5a833869ed46d28e04d633df5e1b55e51900bcae1a8b437663b93ee1b5ab45698cb54e00a145fb1752cb4c195ec877070b367b79d8c3b03ce81e8d

data/README.md

@@ -64,6 +64,9 @@ To add the migrations to your application, run the following migration:
 
 `bin/rails pay:install:migrations`
 
+>If your models rely on non integer ids (uuids for example) you will need to alter the `create_pay_subscriptions` and `create_pay_charges` migrations to ensure the `owner_id` column's type matches the model's id's format.
+> As commented in the migrations adding a type parameter to the `t.references :owner` line will ensure the `owner_id` column is of the correct type.
+
 We also need to run migrations to add Pay to the User, Account, Team, etc models that we want to make payments in our app.
 
 `bin/rails g pay User`

data/app/models/pay.rb

@@ -0,0 +1,5 @@
+module Pay
+  def self.table_name_prefix
+    "pay_"
+  end
+end

data/app/models/pay/charge.rb

@@ -7,6 +7,7 @@ module Pay
 
     # Associations
     belongs_to :owner, polymorphic: true
+    belongs_to :subscription, optional: true, class_name: "Pay::Subscription", foreign_key: :pay_subscription_id
 
     # Scopes
     scope :sorted, -> { order(created_at: :desc) }
@@ -19,6 +20,7 @@ module Pay
     validates :card_type, presence: true
 
     store_accessor :data, :paddle_receipt_url
+    store_accessor :data, :stripe_account
 
     # Helpers for payment processors
     %w[braintree stripe paddle fake_processor].each do |processor_name|

data/app/models/pay/subscription.rb

@@ -9,6 +9,7 @@ module Pay
 
     # Associations
     belongs_to :owner, polymorphic: true
+    has_many :charges, class_name: "Pay::Charge", foreign_key: :pay_subscription_id
 
     # Validations
     validates :name, presence: true
@@ -31,6 +32,7 @@ module Pay
     store_accessor :data, :paddle_update_url
     store_accessor :data, :paddle_cancel_url
     store_accessor :data, :paddle_paused_from
+    store_accessor :data, :stripe_account
 
     attribute :prorate, :boolean, default: true
 
@@ -94,6 +96,11 @@ module Pay
       past_due? || incomplete?
     end
 
+    def change_quantity(quantity)
+      payment_processor.change_quantity(quantity)
+      update(quantity: quantity)
+    end
+
     def resume
       payment_processor.resume
       update(ends_at: nil, status: "active")
@@ -110,8 +117,8 @@ module Pay
       owner.invoice!(subscription_id: processor_id)
     end
 
-    def processor_subscription(options = {})
-      owner.processor_subscription(processor_id, options)
+    def processor_subscription(**options)
+      payment_processor.subscription(**options)
     end
 
     def latest_payment

data/app/views/pay/stripe/_checkout_button.html.erb

@@ -13,7 +13,7 @@
         sessionId: '<%= session.id %>'
       }).then(function (result) {
         if (result.error) {
-            document.getElementById('error-message').innerText = result.error.message;
+            document.getElementById("error-for-#{session.id}").innerText = result.error.message;
           }
       });
     });

data/db/migrate/20200603134434_add_data_to_pay_models.rb

@@ -5,18 +5,11 @@ class AddDataToPayModels < ActiveRecord::Migration[4.2]
   end
 
   def data_column_type
-    default_hash = ActiveRecord::Base.configurations.default_hash
-
-    # Rails 6.1 uses a symbol key instead of a string
-    adapter = default_hash.dig(:adapter) || default_hash.dig("adapter")
-
-    case adapter
-    when "mysql2"
-      :json
+    case Pay::Adapter.current_adapter
     when "postgresql"
       :jsonb
     else
-      :text
+      :json
     end
   end
 end

data/db/migrate/20210309004259_add_data_to_pay_billable.rb

@@ -0,0 +1,19 @@
+class AddDataToPayBillable < ActiveRecord::Migration[4.2]
+  def change
+    # Load all the billable models
+    Rails.application.eager_load!
+
+    Pay.billable_models.each do |model|
+      add_column model.table_name, :pay_data, data_column_type
+    end
+  end
+
+  def data_column_type
+    case Pay::Adapter.current_adapter
+    when "postgresql"
+      :jsonb
+    else
+      :json
+    end
+  end
+end

data/db/migrate/20210406215234_add_currency_to_pay_charges.rb

@@ -0,0 +1,5 @@
+class AddCurrencyToPayCharges < ActiveRecord::Migration[4.2]
+  def change
+    add_column :pay_charges, :currency, :string
+  end
+end

data/db/migrate/20210406215506_add_application_fee_to_pay_models.rb

@@ -0,0 +1,7 @@
+class AddApplicationFeeToPayModels < ActiveRecord::Migration[4.2]
+  def change
+    add_column :pay_charges, :application_fee_amount, :integer
+    add_column :pay_subscriptions, :application_fee_percent, :decimal, precision: 8, scale: 2
+    add_column :pay_charges, :pay_subscription_id, :integer
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -2,7 +2,7 @@
 
 class AddPayBillableTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def change
-    change_table :<%= table_name %> do |t|
+    change_table :<%= table_name %>, bulk: true do |t|
 <%= migration_data -%>
     end
   end

data/lib/pay.rb

@@ -1,10 +1,12 @@
 require "pay/version"
 require "pay/engine"
 require "pay/errors"
+require "pay/adapter"
 
 module Pay
   autoload :Billable, "pay/billable"
   autoload :Env, "pay/env"
+  autoload :Merchant, "pay/merchant"
   autoload :Payment, "pay/payment"
   autoload :Receipts, "pay/receipts"
 
@@ -66,6 +68,26 @@ module Pay
     Pay::Billable.includers
   end
 
+  def self.merchant_models
+    Pay::Merchant.includers
+  end
+
+  def self.find_merchant(account_key, account_value)
+    merchant_models.each do |model|
+      case Pay::Adapter.current_adapter
+      when "postgresql"
+        return model.find_by("pay_data @> ?", {account_key.to_sym => account_value}.to_json)
+      when "mysql2"
+        return model.find_by("JSON_CONTAINS(pay_data, ?)", {account_key.to_sym => account_value}.to_json)
+      when "sqlite3"
+        return model.find_by("json_extract(pay_data, ?) =?", "$.#{account_key}", account_value)
+      else
+        model.find_by(pay_data: {account_key.to_sym => account_value})
+      end
+    end
+    nil
+  end
+
   def self.find_billable(processor:, processor_id:)
     billable_models.each do |model|
       if (record = model.find_by(processor: processor, processor_id: processor_id))

data/lib/pay/adapter.rb

@@ -0,0 +1,13 @@
+module Pay
+  module Adapter
+    extend ActiveSupport::Concern
+
+    def self.current_adapter
+      if ActiveRecord::Base.respond_to?(:connection_db_config)
+        ActiveRecord::Base.connection_db_config.adapter
+      else
+        ActiveRecord::Base.connection_config[:adapter]
+      end
+    end
+  end
+end

data/lib/pay/billable.rb

@@ -26,6 +26,10 @@ module Pay
       attribute :card_token, :string
       attribute :pay_fake_processor_allowed, :boolean, default: false
 
+      # Account(s) for marketplace payments
+      store_accessor :pay_data, :stripe_account
+      store_accessor :pay_data, :braintree_account
+
       validate :pay_fake_processor_is_allowed, if: :processor_changed?
     end
 

data/lib/pay/braintree/billable.rb

@@ -19,7 +19,9 @@ module Pay
       # Returns Braintree::Customer
       def customer
         if processor_id?
-          gateway.customer.find(processor_id)
+          customer = gateway.customer.find(processor_id)
+          update_card card_token if card_token.present?
+          customer
         else
           result = gateway.customer.create(
             email: email,
@@ -149,9 +151,16 @@ module Pay
         attrs = card_details_for_braintree_transaction(transaction)
         attrs[:amount] = transaction.amount.to_f * 100
 
+        # Associate charge with subscription if we can
+        if transaction.subscription_id
+          attrs[:subscription] = Pay::Subscription.find_by(processor: :braintree, processor_id: transaction.subscription_id)
+        end
+
         charge = billable.charges.find_or_initialize_by(
           processor: :braintree,
-          processor_id: transaction.id
+          processor_id: transaction.id,
+          currency: transaction.currency_iso_code,
+          application_fee_amount: transaction.service_fee_amount
         )
         charge.update(attrs)
         charge

data/lib/pay/braintree/subscription.rb

@@ -23,6 +23,10 @@ module Pay
         @pay_subscription = pay_subscription
       end
 
+      def subscription(**options)
+        gateway.subscription.find(processor_id)
+      end
+
       def cancel
         subscription = processor_subscription
 

data/lib/pay/fake_processor/subscription.rb

@@ -19,6 +19,10 @@ module Pay
         @pay_subscription = pay_subscription
       end
 
+      def subscription(**options)
+        pay_subscription
+      end
+
       def cancel
         pay_subscription.update(ends_at: Time.current.end_of_month)
       end

data/lib/pay/merchant.rb

@@ -0,0 +1,37 @@
+module Pay
+  module Merchant
+    extend ActiveSupport::Concern
+
+    # Keep track of which Merchant models we have
+    class << self
+      attr_reader :includers
+    end
+
+    def self.included(base = nil, &block)
+      @includers ||= []
+      @includers << base if base
+      super
+    end
+
+    included do
+      store_accessor :pay_data, :stripe_connect_account_id
+      store_accessor :pay_data, :onboarding_complete
+    end
+
+    def merchant
+      @merchant ||= merchant_processor_for(merchant_processor).new(self)
+    end
+
+    def merchant_processor_for(name)
+      "Pay::#{name.to_s.classify}::Merchant".constantize
+    end
+
+    def stripe_connect_account_id?
+      !!stripe_connect_account_id
+    end
+
+    def onboarding_complete?
+      !!onboarding_complete
+    end
+  end
+end

data/lib/pay/paddle.rb

@@ -44,6 +44,13 @@ module Pay
       options.merge(owner_sgid: owner.to_sgid.to_s).to_json
     end
 
+    def self.owner_from_passthrough(passthrough)
+      passthrough_json = JSON.parse(passthrough)
+      GlobalID::Locator.locate_signed(passthrough_json["owner_sgid"])
+    rescue JSON::ParserError
+      nil
+    end
+
     def self.configure_webhooks
       Pay::Webhooks.configure do |events|
         events.subscribe "paddle.subscription_created", Pay::Paddle::Webhooks::SubscriptionCreated.new

data/lib/pay/paddle/subscription.rb

@@ -24,6 +24,13 @@ module Pay
         @pay_subscription = pay_subscription
       end
 
+      def subscription(**options)
+        hash = PaddlePay::Subscription::User.list({subscription_id: processor_id}, options).try(:first)
+        OpenStruct.new(hash)
+      rescue ::PaddlePay::PaddlePayError => e
+        raise Pay::Paddle::Error, e
+      end
+
       def cancel
         subscription = processor_subscription
         PaddlePay::Subscription::User.cancel(processor_id)

data/lib/pay/paddle/webhooks/subscription_created.rb

@@ -13,7 +13,7 @@ module Pay
             owner = Pay.find_billable(processor: :paddle, processor_id: event["user_id"])
 
             if owner.nil?
-              owner = owner_by_passtrough(event["passthrough"], event["subscription_plan_id"])
+              owner = Pay::Paddle.owner_from_passthrough(event["passthrough"])
               owner&.update!(processor: "paddle", processor_id: event["user_id"])
             end
 
@@ -44,15 +44,6 @@ module Pay
 
           subscription.save!
         end
-
-        private
-
-        def owner_by_passtrough(passthrough, product_id)
-          passthrough_json = JSON.parse(passthrough)
-          GlobalID::Locator.locate_signed(passthrough_json["owner_sgid"])
-        rescue JSON::ParserError
-          nil
-        end
       end
     end
   end

data/lib/pay/paddle/webhooks/subscription_payment_succeeded.rb

@@ -4,7 +4,17 @@ module Pay
       class SubscriptionPaymentSucceeded
         def call(event)
           billable = Pay.find_billable(processor: :paddle, processor_id: event["user_id"])
-          return unless billable.present?
+
+          if billable.nil?
+            billable = Pay::Paddle.owner_from_passthrough(event["passthrough"])
+            billable&.update!(processor: "paddle", processor_id: event["user_id"])
+          end
+
+          if billable.nil?
+            Rails.logger.error("[Pay] Unable to find Pay::Billable with owner: '#{event["passthrough"]}'. Searched these models: #{Pay.billable_models.join(", ")}")
+            return
+          end
+
           return if billable.charges.where(processor_id: event["subscription_payment_id"]).any?
 
           charge = create_charge(billable, event)
@@ -20,8 +30,10 @@ module Pay
           params = {
             amount: Integer(event["sale_gross"].to_f * 100),
             card_type: event["payment_method"],
+            created_at: Time.zone.parse(event["event_time"]),
+            currency: event["currency"],
             paddle_receipt_url: event["receipt_url"],
-            created_at: Time.zone.parse(event["event_time"])
+            subscription: Pay::Subscription.find_by(processor: :paddle, processor_id: event["subscription_id"])
           }
 
           payment_information = Pay::Paddle::Billable.new(user).payment_information(event["subscription_id"])

data/lib/pay/stripe.rb

@@ -4,8 +4,10 @@ module Pay
     autoload :Charge, "pay/stripe/charge"
     autoload :Subscription, "pay/stripe/subscription"
     autoload :Error, "pay/stripe/error"
+    autoload :Merchant, "pay/stripe/merchant"
 
     module Webhooks
+      autoload :AccountUpdated, "pay/stripe/webhooks/account_updated"
       autoload :ChargeRefunded, "pay/stripe/webhooks/charge_refunded"
       autoload :ChargeSucceeded, "pay/stripe/webhooks/charge_succeeded"
       autoload :CustomerDeleted, "pay/stripe/webhooks/customer_deleted"
@@ -81,6 +83,9 @@ module Pay
         events.subscribe "stripe.payment_method.updated", Pay::Stripe::Webhooks::PaymentMethodUpdated.new
         events.subscribe "stripe.payment_method.card_automatically_updated", Pay::Stripe::Webhooks::PaymentMethodUpdated.new
         events.subscribe "stripe.payment_method.detached", Pay::Stripe::Webhooks::PaymentMethodUpdated.new
+
+        # If an account is updated in stripe, we should update it as well
+        events.subscribe "stripe.account.updated", Pay::Stripe::Webhooks::AccountUpdated.new
       end
     end
   end

data/lib/pay/stripe/billable.rb

@@ -10,6 +10,7 @@ module Pay
         :email,
         :customer_name,
         :card_token,
+        :stripe_account,
         to: :billable
 
       class << self
@@ -26,23 +27,22 @@ module Pay
       #
       # Returns Stripe::Customer
       def customer
-        if processor_id?
-          ::Stripe::Customer.retrieve(processor_id)
+        stripe_customer = if processor_id?
+          ::Stripe::Customer.retrieve(processor_id, {stripe_account: stripe_account})
         else
-          stripe_customer = ::Stripe::Customer.create(email: email, name: customer_name)
-          billable.update(processor: :stripe, processor_id: stripe_customer.id)
-
-          # Update the user's card on file if a token was passed in
-          if card_token.present?
-            payment_method = ::Stripe::PaymentMethod.attach(card_token, {customer: stripe_customer.id})
-            stripe_customer.invoice_settings.default_payment_method = payment_method.id
-            stripe_customer.save
-
-            update_card_on_file ::Stripe::PaymentMethod.retrieve(card_token).card
-          end
+          sc = ::Stripe::Customer.create({email: email, name: customer_name}, {stripe_account: stripe_account})
+          billable.update(processor: :stripe, processor_id: sc.id, stripe_account: stripe_account)
+          sc
+        end
 
-          stripe_customer
+        # Update the user's card on file if a token was passed in
+        if card_token.present?
+          payment_method = ::Stripe::PaymentMethod.attach(card_token, {customer: stripe_customer.id}, {stripe_account: stripe_account})
+          stripe_customer = ::Stripe::Customer.update(stripe_customer.id, {invoice_settings: {default_payment_method: payment_method.id}}, {stripe_account: stripe_account})
+          update_card_on_file(payment_method.card)
         end
+
+        stripe_customer
       rescue ::Stripe::StripeError => e
         raise Pay::Stripe::Error, e
       end
@@ -61,7 +61,7 @@ module Pay
           payment_method: stripe_customer.invoice_settings.default_payment_method
         }.merge(options)
 
-        payment_intent = ::Stripe::PaymentIntent.create(args)
+        payment_intent = ::Stripe::PaymentIntent.create(args, {stripe_account: stripe_account})
         Pay::Payment.new(payment_intent).validate
 
         # Create a new charge object
@@ -84,10 +84,11 @@ module Pay
         # Inherit trial from plan unless trial override was specified
         opts[:trial_from_plan] = true unless opts[:trial_period_days]
 
+        # Load the Stripe customer to verify it exists and update card if needed
         opts[:customer] = customer.id
 
-        stripe_sub = ::Stripe::Subscription.create(opts)
-        subscription = billable.create_pay_subscription(stripe_sub, "stripe", name, plan, status: stripe_sub.status, quantity: quantity)
+        stripe_sub = ::Stripe::Subscription.create(opts, {stripe_account: stripe_account})
+        subscription = billable.create_pay_subscription(stripe_sub, "stripe", name, plan, status: stripe_sub.status, quantity: quantity, stripe_account: stripe_account, application_fee_percent: stripe_sub.application_fee_percent)
 
         # No trial, card requires SCA
         if subscription.incomplete?
@@ -111,8 +112,8 @@ module Pay
 
         return true if payment_method_id == stripe_customer.invoice_settings.default_payment_method
 
-        payment_method = ::Stripe::PaymentMethod.attach(payment_method_id, customer: stripe_customer.id)
-        ::Stripe::Customer.update(stripe_customer.id, invoice_settings: {default_payment_method: payment_method.id})
+        payment_method = ::Stripe::PaymentMethod.attach(payment_method_id, {customer: stripe_customer.id}, {stripe_account: stripe_account})
+        ::Stripe::Customer.update(stripe_customer.id, {invoice_settings: {default_payment_method: payment_method.id}}, {stripe_account: stripe_account})
 
         update_card_on_file(payment_method.card)
         true
@@ -121,33 +122,33 @@ module Pay
       end
 
       def update_email!
-        ::Stripe::Customer.update(processor_id, {email: email, name: customer_name})
+        ::Stripe::Customer.update(processor_id, {email: email, name: customer_name}, {stripe_account: stripe_account})
       end
 
       def processor_subscription(subscription_id, options = {})
-        ::Stripe::Subscription.retrieve(options.merge(id: subscription_id))
+        ::Stripe::Subscription.retrieve(options.merge(id: subscription_id), {stripe_account: stripe_account})
       end
 
       def invoice!(options = {})
         return unless processor_id?
-        ::Stripe::Invoice.create(options.merge(customer: processor_id)).pay
+        ::Stripe::Invoice.create(options.merge(customer: processor_id), {stripe_account: stripe_account}).pay
       end
 
       def upcoming_invoice
-        ::Stripe::Invoice.upcoming(customer: processor_id)
+        ::Stripe::Invoice.upcoming({customer: processor_id}, {stripe_account: stripe_account})
       end
 
       # Used by webhooks when the customer or source changes
       def sync_card_from_stripe
         if (payment_method_id = customer.invoice_settings.default_payment_method)
-          update_card_on_file ::Stripe::PaymentMethod.retrieve(payment_method_id).card
+          update_card_on_file ::Stripe::PaymentMethod.retrieve(payment_method_id, {stripe_account: stripe_account}).card
         else
           billable.update(card_type: nil, card_last4: nil)
         end
       end
 
       def create_setup_intent
-        ::Stripe::SetupIntent.create(customer: processor_id, usage: :off_session)
+        ::Stripe::SetupIntent.create({customer: processor_id, usage: :off_session}, {stripe_account: stripe_account})
       end
 
       def trial_end_date(stripe_sub)
@@ -170,15 +171,25 @@ module Pay
       def save_pay_charge(object)
         charge = billable.charges.find_or_initialize_by(processor: :stripe, processor_id: object.id)
 
-        charge.update(
+        attrs = {
           amount: object.amount,
           card_last4: object.payment_method_details.card.last4,
           card_type: object.payment_method_details.card.brand,
           card_exp_month: object.payment_method_details.card.exp_month,
           card_exp_year: object.payment_method_details.card.exp_year,
-          created_at: Time.zone.at(object.created)
-        )
+          created_at: Time.zone.at(object.created),
+          currency: object.currency,
+          stripe_account: stripe_account,
+          application_fee_amount: object.application_fee_amount
+        }
+
+        # Associate charge with subscription if we can
+        if object.invoice
+          invoice = (object.invoice.is_a?(::Stripe::Invoice) ? object.invoice : ::Stripe::Invoice.retrieve(object.invoice))
+          attrs[:subscription] = Pay::Subscription.find_by(processor: :stripe, processor_id: invoice.subscription)
+        end
 
+        charge.update(attrs)
         charge
       end
 
@@ -198,8 +209,8 @@ module Pay
           payment_method_types: ["card"],
           mode: "payment",
           # These placeholder URLs will be replaced in a following step.
-          success_url: root_url,
-          cancel_url: root_url
+          success_url: options.delete(:success_url) || root_url,
+          cancel_url: options.delete(:cancel_url) || root_url
         }
 
         # Line items are optional
@@ -213,7 +224,7 @@ module Pay
           }
         end
 
-        ::Stripe::Checkout::Session.create(args.merge(options))
+        ::Stripe::Checkout::Session.create(args.merge(options), {stripe_account: stripe_account})
       end
 
       # https://stripe.com/docs/api/checkout/sessions/create
@@ -221,10 +232,11 @@ module Pay
       # checkout_charge(amount: 15_00, name: "T-shirt", quantity: 2)
       #
       def checkout_charge(amount:, name:, quantity: 1, **options)
+        currency = options.delete(:currency) || "usd"
         checkout(
           line_items: {
             price_data: {
-              currency: options[:currency] || "usd",
+              currency: currency,
               product_data: {name: name},
               unit_amount: amount
             },
@@ -237,9 +249,9 @@ module Pay
       def billing_portal(**options)
         args = {
           customer: processor_id,
-          return_url: options[:return_url] || root_url
+          return_url: options.delete(:return_url) || root_url
         }
-        ::Stripe::BillingPortal::Session.create(args.merge(options))
+        ::Stripe::BillingPortal::Session.create(args.merge(options), {stripe_account: stripe_account})
       end
     end
   end