pay 2.3.1 → 2.5.0

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/db/migrate/20200603134434_add_data_to_pay_models.rb

@@ -5,7 +5,12 @@ class AddDataToPayModels < ActiveRecord::Migration[4.2]
   end
 
   def data_column_type
-    case ActiveRecord::Base.configurations.default_hash.dig("adapter")
+    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
     when "postgresql"

data/lib/pay.rb

@@ -1,9 +1,23 @@
+require "pay/version"
 require "pay/engine"
 require "pay/billable"
 require "pay/receipts"
 require "pay/payment"
+require "pay/errors"
 
 module Pay
+  module Webhooks
+    autoload :Delegator, "pay/webhooks/delegator"
+
+    class << self
+      delegate :configure, :instrument, to: :delegator
+
+      def delegator
+        @delegator ||= Delegator.new
+      end
+    end
+  end
+
   # Define who owns the subscription
   mattr_accessor :billable_class
   mattr_accessor :billable_table
@@ -35,18 +49,14 @@ 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
 
+  mattr_accessor :default_product_name
+  @@default_product_name = "default"
+  mattr_accessor :default_plan_name
+  @@default_plan_name = "default"
+
   mattr_accessor :routes_path
   @@routes_path = "/pay"
 
@@ -101,45 +111,4 @@ module Pay
       business_address &&
       support_email
   end
-
-  class Error < StandardError
-  end
-
-  class BraintreeError < Error
-    attr_reader :result
-
-    def initialize(result = nil)
-      @result = result
-    end
-  end
-
-  class BraintreeAuthorizationError < BraintreeError
-    def message
-      "Either the data you submitted is malformed and does not match the API or the API key you used may not be authorized to perform this action."
-    end
-  end
-
-  class InvalidPaymentMethod < Error
-    attr_reader :payment
-
-    def initialize(payment)
-      @payment = payment
-    end
-
-    def message
-      "This payment attempt failed because of an invalid payment method."
-    end
-  end
-
-  class ActionRequired < Error
-    attr_reader :payment
-
-    def initialize(payment)
-      @payment = payment
-    end
-
-    def message
-      "This payment attempt failed because additional action is required before it can be completed."
-    end
-  end
 end

data/lib/pay/billable.rb

@@ -36,7 +36,7 @@ module Pay
 
     def customer
       check_for_processor
-      raise Pay::Error, "Email is required to create a customer" if email.nil?
+      raise Pay::Error, I18n.t("errors.email_required") if email.nil?
 
       customer = send("#{processor}_customer")
       update_card(card_token) if card_token.present?
@@ -52,7 +52,7 @@ module Pay
       send("create_#{processor}_charge", amount_in_cents, options)
     end
 
-    def subscribe(name: "default", plan: "default", **options)
+    def subscribe(name: Pay.default_product_name, plan: Pay.default_plan_name, **options)
       check_for_processor
       send("create_#{processor}_subscription", name, plan, options)
     end
@@ -63,7 +63,7 @@ module Pay
       send("update_#{processor}_card", token)
     end
 
-    def on_trial?(name: "default", plan: nil)
+    def on_trial?(name: Pay.default_product_name, plan: nil)
       return true if default_generic_trial?(name, plan)
 
       sub = subscription(name: name)
@@ -81,7 +81,7 @@ module Pay
       send("#{processor}_subscription", subscription_id, options)
     end
 
-    def subscribed?(name: "default", processor_plan: nil)
+    def subscribed?(name: Pay.default_product_name, processor_plan: nil)
       subscription = subscription(name: name)
 
       return false if subscription.nil?
@@ -90,13 +90,13 @@ module Pay
       subscription.active? && subscription.processor_plan == processor_plan
     end
 
-    def on_trial_or_subscribed?(name: "default", processor_plan: nil)
+    def on_trial_or_subscribed?(name: Pay.default_product_name, processor_plan: nil)
       on_trial?(name: name, plan: processor_plan) ||
         subscribed?(name: name, processor_plan: processor_plan)
     end
 
-    def subscription(name: "default")
-      subscriptions.for_name(name).last
+    def subscription(name: Pay.default_product_name)
+      subscriptions.loaded? ? subscriptions.reverse.detect { |s| s.name == name } : subscriptions.for_name(name).last
     end
 
     def invoice!(options = {})
@@ -123,14 +123,14 @@ module Pay
       processor == "paddle"
     end
 
-    def has_incomplete_payment?(name: "default")
+    def has_incomplete_payment?(name: Pay.default_product_name)
       subscription(name: name)&.has_incomplete_payment?
     end
 
     private
 
     def check_for_processor
-      raise StandardError, "No payment processor selected. Make sure to set the #{self.class.name}'s `processor` attribute to either 'stripe' or 'braintree'." unless 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

data/lib/pay/braintree.rb

@@ -2,6 +2,7 @@ require "pay/env"
 require "pay/braintree/billable"
 require "pay/braintree/charge"
 require "pay/braintree/subscription"
+require "pay/braintree/webhooks"
 
 module Pay
   module Braintree

data/lib/pay/braintree/billable.rb

@@ -20,7 +20,7 @@ module Pay
             last_name: try(:last_name),
             payment_method_nonce: card_token
           )
-          raise BraintreeError.new(result), result.message unless result.success?
+          raise Pay::Braintree::Error, result unless result.success?
 
           update(processor: "braintree", processor_id: result.customer.id)
 
@@ -33,7 +33,7 @@ module Pay
       rescue ::Braintree::AuthorizationError
         raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise BraintreeError, e.message
+        raise Pay::Braintree::Error, e
       end
 
       # Handles Billable#charge
@@ -47,13 +47,13 @@ module Pay
         }.merge(options)
 
         result = gateway.transaction.sale(args)
-        raise BraintreeError.new(result), result.message unless result.success?
+        raise Pay::Braintree::Error, result unless result.success?
 
         save_braintree_transaction(result.transaction)
       rescue ::Braintree::AuthorizationError
-        raise BraintreeAuthorizationError
+        raise Pay::Braintree::AuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise BraintreeError, e.message
+        raise Pay::Braintree::Error, e
       end
 
       # Handles Billable#subscribe
@@ -74,13 +74,13 @@ module Pay
         )
 
         result = gateway.subscription.create(subscription_options)
-        raise BraintreeError.new(result), result.message unless result.success?
+        raise Pay::Braintree::Error, result unless result.success?
 
         create_subscription(result.subscription, "braintree", name, plan, status: :active)
       rescue ::Braintree::AuthorizationError
-        raise BraintreeAuthorizationError
+        raise Pay::Braintree::AuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise BraintreeError, e.message
+        raise Pay::Braintree::Error, e
       end
 
       # Handles Billable#update_card
@@ -95,15 +95,15 @@ module Pay
             verify_card: true
           }
         )
-        raise BraintreeError.new(result), result.message unless result.success?
+        raise Pay::Braintree::Error, result unless result.success?
 
         update_braintree_card_on_file result.payment_method
         update_subscriptions_to_payment_method(result.payment_method.token)
         true
       rescue ::Braintree::AuthorizationError
-        raise BraintreeAuthorizationError
+        raise Pay::Braintree::AuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise BraintreeError, e.message
+        raise Pay::Braintree::Error, e
       end
 
       def update_braintree_email!

data/lib/pay/braintree/charge.rb

@@ -13,8 +13,8 @@ module Pay
 
       def braintree_charge
         Pay.braintree_gateway.transaction.find(processor_id)
-      rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+      rescue ::Braintree::Braintree::Error => e
+        raise Pay::Braintree::Error, e
       end
 
       def braintree_refund!(amount_to_refund)
@@ -22,7 +22,7 @@ module Pay
 
         update(amount_refunded: amount_to_refund)
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise Pay::Braintree::Error, e
       end
     end
   end

data/lib/pay/braintree/subscription.rb

@@ -3,14 +3,6 @@ module Pay
     module Subscription
       extend ActiveSupport::Concern
 
-      included do
-        scope :braintree, -> { where(processor: :braintree) }
-      end
-
-      def braintree?
-        processor == "braintree"
-      end
-
       def braintree_cancel
         subscription = processor_subscription
 
@@ -24,17 +16,33 @@ module Pay
           update(status: :canceled, ends_at: subscription.billing_period_end_date.to_date)
         end
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise Pay::Braintree::Error, e
       end
 
       def braintree_cancel_now!
         gateway.subscription.cancel(processor_subscription.id)
         update(status: :canceled, ends_at: Time.zone.now)
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise Pay::Braintree::Error, e
+      end
+
+      def braintree_on_grace_period?
+        canceled? && Time.zone.now < ends_at
+      end
+
+      def braintree_paused?
+        false
+      end
+
+      def braintree_pause
+        raise NotImplementedError, "Braintree does not support pausing subscriptions"
       end
 
       def braintree_resume
+        unless on_grace_period?
+          raise StandardError, "You can only resume subscriptions within their grace period."
+        end
+
         if canceled? && on_trial?
           duration = trial_ends_at.to_date - Date.today
 
@@ -57,7 +65,7 @@ module Pay
 
         update(status: :active)
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise Pay::Braintree::Error, e
       end
 
       def braintree_swap(plan)
@@ -96,7 +104,7 @@ module Pay
           raise Error, "Braintree failed to swap plans: #{result.message}"
         end
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise Pay::Braintree::Error, e
       end
 
       private
@@ -174,7 +182,7 @@ module Pay
 
         cancel_now!
 
-        owner.subscribe(options.merge(name: name, plan: plan.id))
+        owner.subscribe(**options.merge(name: name, plan: plan.id))
       end
     end
   end

data/lib/pay/braintree/webhooks.rb

@@ -0,0 +1,11 @@
+Dir[File.join(__dir__, "webhooks", "**", "*.rb")].sort.each { |file| require file }
+
+Pay::Webhooks.configure do |events|
+  events.subscribe "braintree.subscription_canceled", Pay::Braintree::Webhooks::SubscriptionCanceled.new
+  events.subscribe "braintree.subscription_charged_successfully", Pay::Braintree::Webhooks::SubscriptionChargedSuccessfully.new
+  events.subscribe "braintree.subscription_charged_unsuccessfully", Pay::Braintree::Webhooks::SubscriptionChargedUnsuccessfully.new
+  events.subscribe "braintree.subscription_expired", Pay::Braintree::Webhooks::SubscriptionExpired.new
+  events.subscribe "braintree.subscription_trial_ended", Pay::Braintree::Webhooks::SubscriptionTrialEnded.new
+  events.subscribe "braintree.subscription_went_active", Pay::Braintree::Webhooks::SubscriptionWentActive.new
+  events.subscribe "braintree.subscription_went_past_due", Pay::Braintree::Webhooks::SubscriptionWentPastDue.new
+end

data/lib/pay/braintree/webhooks/subscription_canceled.rb

@@ -0,0 +1,19 @@
+# A subscription is canceled.
+
+module Pay
+  module Braintree
+    module Webhooks
+      class SubscriptionCanceled
+        def call(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!(ends_at: Time.current, status: :canceled)
+        end
+      end
+    end
+  end
+end

data/lib/pay/braintree/webhooks/subscription_charged_successfully.rb

@@ -0,0 +1,24 @@
+# A subscription successfully moves to the next billing cycle. This will also occur when either a new transaction is created mid-cycle due to proration on an upgrade or a billing cycle is skipped due to the presence of a negative balance that covers the cost of the subscription.
+
+module Pay
+  module Braintree
+    module Webhooks
+      class SubscriptionChargedSuccessfully
+        def call(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
+      end
+    end
+  end
+end

data/lib/pay/braintree/webhooks/subscription_charged_unsuccessfully.rb

@@ -0,0 +1,24 @@
+# A subscription successfully moves to the next billing cycle. This will also occur when either a new transaction is created mid-cycle due to proration on an upgrade or a billing cycle is skipped due to the presence of a negative balance that covers the cost of the subscription.
+
+module Pay
+  module Braintree
+    module Webhooks
+      class SubscriptionChargedUnsuccessfully
+        def call(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
+      end
+    end
+  end
+end