pay 2.4.4 → 2.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84a6d0c51681591ba02b3736bf1009096dc9ebf2c7ae7fa9e7c3771afff96b3
-  data.tar.gz: '089b14e73b7dffd8ee7e1ea4891adb23ad24fc0eb553a95f9a3e39d59392ffc1'
+  metadata.gz: 429e92c76a90f5de0cec18dce219479de7ea172d6807c3b0d86d0a2fe4994b77
+  data.tar.gz: 85b9e46b65d4ea0fa0e7255cc47e1e5c60e55e14f18fee9c567c4befb0e1dac7
 SHA512:
-  metadata.gz: 2686b43a90c36dd93cfc2539255af98faf9e8eb1bbf53090639a1446c7561a42fd3f734f01fbff047cf6ac4e34abdd13db2b980616e385f18e8608767d4406ce
-  data.tar.gz: 308341a4541afae134c4cbe581cd67faff65d0dd3bee7b48d563db00a6d0b63c81dcc501a0adcd840d202bf869ec3bfef15a69ee0e2fee5cd4458f1d0e4b8c9e
+  metadata.gz: 577c6792e5ff3f60e01a02de38bdc414aa0c6178ec0927c6b5766051224f632f83d551a787888d196ac57cf7d4299786a5f1afbcfc0376b10b9115ca97c74dc7
+  data.tar.gz: dc0da5b5df00f672cc621acf89168f7b3c8c1f419aaa7c5802f015cfb3a4c6cf95284310fc776ca67e51da69c803a24d9c66b50407bd08044492abff1444eb00

data/README.md

@@ -8,9 +8,9 @@ Pay is a payments engine for Ruby on Rails 4.2 and higher.
 
 **Current Payment Providers**
 
-- Stripe ([supports SCA](https://stripe.com/docs/strong-customer-authentication) using API version `2020-08-27`)
-- Braintree
-- Paddle
+- Stripe ([SCA Compatible](https://stripe.com/docs/strong-customer-authentication) using API version `2020-08-27`)
+- Paddle (SCA Compatible & supports PayPal)
+- Braintree (supports PayPal)
 
 Want to add a new payment provider? Contributions are welcome and the instructions [are here](https://github.com/jasoncharnes/pay/wiki/New-Payment-Provider).
 
@@ -31,7 +31,6 @@ gem 'pay', '~> 2.0'
 
 # To use Stripe, also include:
 gem 'stripe', '< 6.0', '>= 2.8'
-gem 'stripe_event', '~> 2.3'
 
 # To use Braintree + PayPal, also include:
 gem 'braintree', '< 3.0', '>= 2.92.0'
@@ -49,6 +48,13 @@ And then execute:
 bundle
 ```
 
+Make sure you've configured your ActionMailer default_url_options so Pay can generate links to for features like Stripe Checkout.
+
+```ruby
+# config/application.rb
+config.action_mailer.default_url_options = { host: "example.com" }
+```
+
 #### Migrations
 
 To add the migrations to your application, run the following migration:

data/app/controllers/pay/webhooks/braintree_controller.rb

@@ -6,66 +6,20 @@ module Pay
       end
 
       def create
-        case webhook_notification.kind
-        when "subscription_charged_successfully"
-          subscription_charged_successfully(webhook_notification)
-        when "subscription_canceled"
-          subscription_canceled(webhook_notification)
-        when "subscription_trial_ended"
-          subscription_trial_ended(webhook_notification)
-        end
-
-        render json: {success: true}, status: :ok
-      rescue ::Braintree::InvalidSignature
+        delegate_event(verified_event)
         head :ok
+      rescue ::Braintree::InvalidSignature
+        head :bad_request
       end
 
       private
 
-      def subscription_charged_successfully(event)
-        subscription = event.subscription
-        return if subscription.nil?
-
-        pay_subscription = Pay.subscription_model.find_by(processor: :braintree, processor_id: subscription.id)
-        return unless pay_subscription.present?
-
-        billable = pay_subscription.owner
-        charge = billable.save_braintree_transaction(subscription.transactions.first)
-
-        if Pay.send_emails
-          Pay::UserMailer.with(billable: billable, charge: charge).receipt.deliver_later
-        end
-      end
-
-      def subscription_canceled(event)
-        subscription = event.subscription
-        return if subscription.nil?
-
-        pay_subscription = Pay.subscription_model.find_by(processor: :braintree, processor_id: subscription.id)
-        return unless pay_subscription.present?
-
-        billable = pay_subscription.owner
-        return if billable.nil?
-
-        # User canceled or failed to make payments
-        billable.update(braintree_subscription_id: nil)
-      end
-
-      def subscription_trial_ended(event)
-        subscription = event.subscription
-        return if subscription.nil?
-
-        pay_subscription = Pay.subscription_model.find_by(processor: :braintree, processor_id: subscription.id)
-        return unless pay_subscription.present?
-
-        pay_subscription.update(trial_ends_at: Time.zone.now)
+      def delegate_event(event)
+        Pay::Webhooks.instrument type: "braintree.#{event.kind}", event: event
       end
 
-      def webhook_notification
-        @webhook_notification ||= Pay.braintree_gateway.webhook_notification.parse(
-          params[:bt_signature],
-          params[:bt_payload]
-        )
+      def verified_event
+        Pay.braintree_gateway.webhook_notification.parse(params[:bt_signature], params[:bt_payload])
       end
     end
   end

data/app/controllers/pay/webhooks/paddle_controller.rb

@@ -6,28 +6,29 @@ module Pay
       end
 
       def create
-        verifier = Pay::Paddle::Webhooks::SignatureVerifier.new(check_params.as_json)
-        if verifier.verify
-          case params["alert_name"]
-          when "subscription_created"
-            Pay::Paddle::Webhooks::SubscriptionCreated.new(check_params.as_json)
-          when "subscription_updated"
-            Pay::Paddle::Webhooks::SubscriptionUpdated.new(check_params.as_json)
-          when "subscription_cancelled"
-            Pay::Paddle::Webhooks::SubscriptionCancelled.new(check_params.as_json)
-          when "subscription_payment_succeeded"
-            Pay::Paddle::Webhooks::SubscriptionPaymentSucceeded.new(check_params.as_json)
-          when "subscription_payment_refunded"
-            Pay::Paddle::Webhooks::SubscriptionPaymentRefunded.new(check_params.as_json)
-          end
-          render json: {success: true}, status: :ok
-        else
-          head :ok
-        end
+        delegate_event(verified_event)
+        head :ok
+      rescue Pay::Paddle::Error
+        head :bad_request
       end
 
       private
 
+      def delegate_event(event)
+        Pay::Webhooks.instrument type: "paddle.#{type}", event: event
+      end
+
+      def type
+        params[:alert_name]
+      end
+
+      def verified_event
+        event = check_params.as_json
+        verifier = Pay::Paddle::Webhooks::SignatureVerifier.new(event)
+        return event if verifier.verify
+        raise Pay::Paddle::Error, "Unable to verify Paddle webhook event"
+      end
+
       def check_params
         params.except(:action, :controller).permit!
       end

data/app/controllers/pay/webhooks/stripe_controller.rb

@@ -0,0 +1,47 @@
+module Pay
+  module Webhooks
+    class StripeController < Pay::ApplicationController
+      if Rails.application.config.action_controller.default_protect_from_forgery
+        skip_before_action :verify_authenticity_token
+      end
+
+      def create
+        delegate_event(verified_event)
+        head :ok
+      rescue ::Stripe::SignatureVerificationError => e
+        log_error(e)
+        head :bad_request
+      end
+
+      private
+
+      def delegate_event(event)
+        Pay::Webhooks.instrument type: "stripe.#{event.type}", event: event
+      end
+
+      def verified_event
+        payload = request.body.read
+        signature = request.headers["Stripe-Signature"]
+        possible_secrets = secrets(payload, signature)
+
+        possible_secrets.each_with_index do |secret, i|
+          return ::Stripe::Webhook.construct_event(payload, signature, secret.to_s)
+        rescue ::Stripe::SignatureVerificationError
+          raise if i == possible_secrets.length - 1
+          next
+        end
+      end
+
+      def secrets(payload, signature)
+        secret = Pay::Stripe.signing_secret
+        return Array.wrap(secret) if secret
+        raise ::Stripe::SignatureVerificationError.new("Cannot verify signature without a Stripe signing secret", signature, http_body: payload)
+      end
+
+      def log_error(e)
+        logger.error e.message
+        e.backtrace.each { |line| logger.error "  #{line}" }
+      end
+    end
+  end
+end

data/app/models/pay/charge.rb

@@ -1,5 +1,5 @@
 module Pay
-  class Charge < ApplicationRecord
+  class Charge < Pay::ApplicationRecord
     self.table_name = Pay.chargeable_table
 
     # Only serialize for non-json columns
@@ -18,13 +18,32 @@ module Pay
     validates :processor_id, presence: true
     validates :card_type, presence: true
 
+    store_accessor :data, :paddle_receipt_url
+
+    # Helpers for payment processors
+    %w[braintree stripe paddle].each do |processor_name|
+      define_method "#{processor_name}?" do
+        processor == processor_name
+      end
+
+      scope processor_name, -> { where(processor: processor_name) }
+    end
+
+    def payment_processor
+      @payment_processor ||= payment_processor_for(processor).new(self)
+    end
+
+    def payment_processor_for(name)
+      "Pay::#{name.to_s.classify}::Charge".constantize
+    end
+
     def processor_charge
-      send("#{processor}_charge")
+      payment_processor.charge
     end
 
     def refund!(refund_amount = nil)
       refund_amount ||= amount
-      send("#{processor}_refund!", refund_amount)
+      payment_processor.refund!(refund_amount)
     end
 
     def charged_to

data/app/models/pay/subscription.rb

@@ -1,5 +1,5 @@
 module Pay
-  class Subscription < ApplicationRecord
+  class Subscription < Pay::ApplicationRecord
     self.table_name = Pay.subscription_table
 
     STATUSES = %w[incomplete incomplete_expired trialing active past_due canceled unpaid paused]
@@ -27,6 +27,11 @@ module Pay
     scope :incomplete, -> { where(status: :incomplete) }
     scope :past_due, -> { where(status: :past_due) }
 
+    # TODO: Include these with a module
+    store_accessor :data, :paddle_update_url
+    store_accessor :data, :paddle_cancel_url
+    store_accessor :data, :paddle_paused_from
+
     attribute :prorate, :boolean, default: true
 
     # Helpers for payment processors
@@ -38,6 +43,21 @@ module Pay
       scope processor_name, -> { where(processor: processor_name) }
     end
 
+    def payment_processor
+      @payment_processor ||= payment_processor_for(processor).new(self)
+    end
+
+    def payment_processor_for(name)
+      "Pay::#{name.to_s.classify}::Subscription".constantize
+    end
+
+    delegate :on_grace_period?,
+      :paused?,
+      :pause,
+      :cancel,
+      :cancel_now!,
+      to: :payment_processor
+
     def no_prorate
       self.prorate = false
     end
@@ -58,11 +78,6 @@ module Pay
       canceled?
     end
 
-    def on_grace_period?
-      return unless processor?
-      send("#{processor}_on_grace_period?")
-    end
-
     def active?
       ["trialing", "active"].include?(status) && (ends_at.nil? || on_grace_period? || on_trial?)
     end
@@ -79,30 +94,14 @@ module Pay
       past_due? || incomplete?
     end
 
-    def paused?
-      send("#{processor}_paused?")
-    end
-
-    def pause
-      send("#{processor}_pause")
-    end
-
-    def cancel
-      send("#{processor}_cancel")
-    end
-
-    def cancel_now!
-      send("#{processor}_cancel_now!")
-    end
-
     def resume
-      send("#{processor}_resume")
+      payment_processor.resume
       update(ends_at: nil, status: "active")
       self
     end
 
     def swap(plan)
-      send("#{processor}_swap", plan)
+      payment_processor.swap(plan)
       update(processor_plan: plan, ends_at: nil)
     end
 

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

@@ -0,0 +1,21 @@
+<%= button_tag title,
+  id: "checkout-#{session.id}",
+  class: local_assigns[:class],
+  style: (local_assigns[:class] || local_assigns[:style]) ? local_assigns[:style] : 'background-color:#6772E5;color:#FFF;padding:8px 12px;border:0;border-radius:4px;font-size:1em'
+%>
+<%= tag.div id: "error-for-#{session.id}" %>
+
+<script>
+  (() => {
+    const checkoutButton = document.getElementById("checkout-<%= session.id %>");
+    checkoutButton.addEventListener('click', function () {
+      Stripe("<%= Pay::Stripe.public_key %>").redirectToCheckout({
+        sessionId: '<%= session.id %>'
+      }).then(function (result) {
+        if (result.error) {
+            document.getElementById('error-message').innerText = result.error.message;
+          }
+      });
+    });
+  })()
+</script>

data/config/routes.rb

@@ -2,7 +2,7 @@
 
 Pay::Engine.routes.draw do
   resources :payments, only: [:show], module: :pay
-  post "webhooks/stripe", to: "stripe_event/webhook#event"
+  post "webhooks/stripe", to: "pay/webhooks/stripe#create"
   post "webhooks/braintree", to: "pay/webhooks/braintree#create"
   post "webhooks/paddle", to: "pay/webhooks/paddle#create"
 end

data/lib/pay.rb

@@ -1,11 +1,20 @@
 require "pay/version"
 require "pay/engine"
-require "pay/billable"
-require "pay/receipts"
-require "pay/payment"
 require "pay/errors"
 
 module Pay
+  autoload :Billable, "pay/billable"
+  autoload :Env, "pay/env"
+  autoload :Payment, "pay/payment"
+  autoload :Receipts, "pay/receipts"
+
+  # Payment processors
+  autoload :Braintree, "pay/braintree"
+  autoload :Paddle, "pay/paddle"
+  autoload :Stripe, "pay/stripe"
+
+  autoload :Webhooks, "pay/webhooks"
+
   # Define who owns the subscription
   mattr_accessor :billable_class
   mattr_accessor :billable_table
@@ -37,15 +46,6 @@ module Pay
   mattr_accessor :send_emails
   @@send_emails = true
 
-  mattr_accessor :email_receipt_subject
-  @@email_receipt_subject = "Payment receipt"
-  mattr_accessor :email_refund_subject
-  @@email_refund_subject = "Payment refunded"
-  mattr_accessor :email_renewing_subject
-  @@email_renewing_subject = "Your upcoming subscription renewal"
-  mattr_accessor :email_action_required_subject
-  @@email_action_required_subject = "Confirm your payment"
-
   mattr_accessor :automount_routes
   @@automount_routes = true
 

data/lib/pay/billable.rb

@@ -17,9 +17,6 @@ module Pay
 
     included do |base|
       include Pay::Billable::SyncEmail
-      include Pay::Stripe::Billable if defined? ::Stripe
-      include Pay::Braintree::Billable if defined? ::Braintree
-      include Pay::Paddle::Billable if defined? ::PaddlePay
 
       has_many :charges, class_name: Pay.chargeable_class, foreign_key: :owner_id, inverse_of: :owner, as: :owner
       has_many :subscriptions, class_name: Pay.subscription_class, foreign_key: :owner_id, inverse_of: :owner, as: :owner
@@ -29,17 +26,34 @@ module Pay
       attribute :card_token, :string
     end
 
+    def payment_processor
+      @payment_processor ||= payment_processor_for(processor).new(self)
+    end
+
+    def payment_processor_for(name)
+      "Pay::#{name.to_s.classify}::Billable".constantize
+    end
+
+    # Reset the payment processor when it changes
     def processor=(value)
       super(value)
       self.processor_id = nil if processor_changed?
+      @payment_processor = nil
     end
 
+    def processor
+      super&.inquiry
+    end
+
+    delegate :charge, to: :payment_processor
+    delegate :subscribe, to: :payment_processor
+    delegate :update_card, to: :payment_processor
+
     def customer
-      check_for_processor
       raise Pay::Error, I18n.t("errors.email_required") if email.nil?
 
-      customer = send("#{processor}_customer")
-      update_card(card_token) if card_token.present?
+      customer = payment_processor.customer
+      payment_processor.update_card(card_token) if card_token.present?
       customer
     end
 
@@ -47,20 +61,9 @@ module Pay
       [try(:first_name), try(:last_name)].compact.join(" ")
     end
 
-    def charge(amount_in_cents, options = {})
-      check_for_processor
-      send("create_#{processor}_charge", amount_in_cents, options)
-    end
-
-    def subscribe(name: Pay.default_product_name, plan: Pay.default_plan_name, **options)
-      check_for_processor
-      send("create_#{processor}_subscription", name, plan, options)
-    end
-
-    def update_card(token)
-      check_for_processor
-      customer if processor_id.nil?
-      send("update_#{processor}_card", token)
+    def create_setup_intent
+      ActiveSupport::Deprecation.warn("This method will be removed in the next release. Use `@billable.payment_processor.create_setup_intent` instead.")
+      payment_processor.create_setup_intent
     end
 
     def on_trial?(name: Pay.default_product_name, plan: nil)
@@ -77,8 +80,7 @@ module Pay
     end
 
     def processor_subscription(subscription_id, options = {})
-      check_for_processor
-      send("#{processor}_subscription", subscription_id, options)
+      payment_processor.processor_subscription(subscription_id, options)
     end
 
     def subscribed?(name: Pay.default_product_name, processor_plan: nil)
@@ -100,26 +102,31 @@ module Pay
     end
 
     def invoice!(options = {})
-      send("#{processor}_invoice!", options)
+      ActiveSupport::Deprecation.warn("This will be removed in the next release. Use `@billable.payment_processor.invoice!` instead.")
+      payment_processor.invoice!(options)
     end
 
     def upcoming_invoice
-      send("#{processor}_upcoming_invoice")
+      ActiveSupport::Deprecation.warn("This will be removed in the next release. Use `@billable.payment_processor.upcoming_invoice` instead.")
+      payment_processor.upcoming_invoice
     end
 
     def stripe?
+      ActiveSupport::Deprecation.warn("This will be removed in the next release. Use `@billable.processor.stripe?` instead.")
       processor == "stripe"
     end
 
     def braintree?
+      ActiveSupport::Deprecation.warn("This will be removed in the next release. Use `@billable.processor.braintree?` instead.")
       processor == "braintree"
     end
 
     def paypal?
-      braintree? && card_type == "PayPal"
+      card_type == "PayPal"
     end
 
     def paddle?
+      ActiveSupport::Deprecation.warn("This will be removed in the next release. Use `@billable.processor.paddle?` instead.")
       processor == "paddle"
     end
 
@@ -127,14 +134,8 @@ module Pay
       subscription(name: name)&.has_incomplete_payment?
     end
 
-    private
-
-    def check_for_processor
-      raise StandardError, I18n.t("errors.no_processor", class_name: self.class.name) unless processor
-    end
-
     # Used for creating a Pay::Subscription in the database
-    def create_subscription(subscription, processor, name, plan, options = {})
+    def create_pay_subscription(subscription, processor, name, plan, options = {})
       options[:quantity] ||= 1
 
       options.merge!(
@@ -142,12 +143,14 @@ module Pay
         processor: processor,
         processor_id: subscription.id,
         processor_plan: plan,
-        trial_ends_at: send("#{processor}_trial_end_date", subscription),
+        trial_ends_at: payment_processor.trial_end_date(subscription),
         ends_at: nil
       )
       subscriptions.create!(options)
     end
 
+    private
+
     def default_generic_trial?(name, plan)
       # Generic trials don't have plans or custom names
       plan.nil? && name == "default" && on_generic_trial?