pay 6.4.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4633aee05e88559e1433e3cb2078d693db0acd19bf605e9de91c6c4fff5f182
-  data.tar.gz: b60f17927b33068b19b4890b2b484d120e096ac8cff44de6e32974617ce92183
+  metadata.gz: 48b9300fb2d1eaaff0b5f8f52a7e16483e1b528e31eaa142f6ce6715cb49b29e
+  data.tar.gz: 4c67d04f2e0e04e723f7af6314ced1e3edbd57dd6b41d4eceb579db5f5ec3d8c
 SHA512:
-  metadata.gz: 340aad778f4df4390481a3e1afdd38427410d31343e739a86ed1f14491f4d4ada04c1027ce1f82621a408b277f47d58b3366c59ed4266caed046f5e43ad0714e
-  data.tar.gz: 467739d756394085a5f0113ee2be78ab477f61f25982eb77342e549e525ab8907abf43860674d0ecc3299c46dad859d8b889fbcfa95c33093dc769aaf3c253c9
+  metadata.gz: 2859a3b93d305d940d21518a7684db3f80dce911a787728fbfbd6dfb99703647be2097b66a02662c230889c44087131fe0576680fd39f44ada37bda33fbc44da
+  data.tar.gz: ab54ba319c7143fafe7d2b2bad7d6c84431ec1c07fa630350e5fde3967fb75422677a8ca96b2838dec4e444fc5e8b0aada38be104c50e49a5eadffc10eb3c3d6

data/app/models/pay/subscription.rb

@@ -104,23 +104,6 @@ module Pay
       ends_at? && ends_at <= Time.current
     end
 
-    def on_grace_period?
-      (ends_at? && ends_at > Time.current) ||
-        ((status == "paused" || pause_behavior == "void") && will_pause?)
-    end
-
-    def will_pause?
-      pause_starts_at? && Time.current < pause_starts_at
-    end
-
-    def pause_active?
-      if status == "paused" # Paddle
-        true
-      elsif pause_behavior == "void"
-        pause_starts_at.nil? || Time.current.after?(pause_starts_at)
-      end
-    end
-
     # If you cancel during a trial, you should still retain access until the end of the trial
     # Otherwise a subscription is active unless it has ended or is currently paused
     # Check the subscription status so we don't accidentally consider "incomplete", "past_due", or other statuses as active

data/lib/pay/attributes.rb

@@ -18,6 +18,8 @@ module Pay
         has_one :payment_processor, -> { where(default: true, deleted_at: nil) }, class_name: "Pay::Customer", as: :owner, inverse_of: :owner
 
         after_commit :cancel_active_pay_subscriptions!, on: [:destroy]
+
+        Pay::Stripe.model_names << name if Pay::Stripe.enabled?
       end
 
       # Changes a user's payment processor

data/lib/pay/braintree/subscription.rb

@@ -5,7 +5,7 @@ module Pay
 
       delegate :active?,
         :canceled?,
-        :on_grace_period?,
+        :ends_at?,
         :customer,
         :ends_at,
         :name,
@@ -100,6 +100,10 @@ module Pay
         raise NotImplementedError, "Braintree does not support setting quantity on subscriptions"
       end
 
+      def on_grace_period?
+        ends_at? && ends_at > Time.current
+      end
+
       def paused?
         false
       end

data/lib/pay/fake_processor/subscription.rb

@@ -8,6 +8,7 @@ module Pay
         :on_grace_period?,
         :on_trial?,
         :ends_at,
+        :ends_at?,
         :owner,
         :processor_subscription,
         :processor_id,
@@ -49,7 +50,7 @@ module Pay
       end
 
       def on_grace_period?
-        canceled? && Time.current < ends_at
+        ends_at? && ends_at > Time.current
       end
 
       def paused?

data/lib/pay/paddle/billable.rb

@@ -49,8 +49,10 @@ module Pay
         # pass
       end
 
-      def add_payment_method(token, default: true)
-        Pay::Paddle::PaymentMethod.sync(self)
+      # Paddle does not use payment method tokens. The method signature has it here
+      # to have a uniform API with the other payment processors.
+      def add_payment_method(token = nil, default: true)
+        Pay::Paddle::PaymentMethod.sync(pay_customer: pay_customer)
       end
 
       def trial_end_date(subscription)

data/lib/pay/paddle/subscription.rb

@@ -11,6 +11,7 @@ module Pay
         :name,
         :owner,
         :pause_starts_at,
+        :pause_starts_at?,
         :processor_id,
         :processor_plan,
         :processor_subscription,
@@ -107,8 +108,10 @@ module Pay
         raise NotImplementedError, "Paddle does not support setting quantity on subscriptions"
       end
 
+      # A subscription could be set to cancel or pause in the future
+      # It is considered on grace period until the cancel or pause time begins
       def on_grace_period?
-        canceled? && Time.current < ends_at || paused? && Time.current < paddle_paused_from
+        (canceled? && Time.current < ends_at) || (paused? && pause_starts_at? && Time.current < pause_starts_at)
       end
 
       def paused?

data/lib/pay/stripe/subscription.rb

@@ -6,10 +6,12 @@ module Pay
 
       delegate :active?,
         :canceled?,
-        :on_grace_period?,
+        :ends_at?,
         :ends_at,
         :name,
         :on_trial?,
+        :pause_starts_at,
+        :pause_starts_at?,
         :processor_id,
         :processor_plan,
         :processor_subscription,
@@ -184,6 +186,18 @@ module Pay
         raise Pay::Stripe::Error, e
       end
 
+      def on_grace_period?
+        (ends_at? && ends_at > Time.current) || (paused? && will_pause?)
+      end
+
+      def pause_active?
+        paused? && (pause_starts_at.nil? || Time.current.after?(pause_starts_at))
+      end
+
+      def will_pause?
+        pause_starts_at? && Time.current < pause_starts_at
+      end
+
       def paused?
         pause_behavior == "void"
       end

data/lib/pay/stripe/webhooks/checkout_session_completed.rb

@@ -5,6 +5,9 @@ module Pay
         def call(event)
           locate_owner(event.data.object)
 
+          # By the time CheckoutSessionCompleted is fired, we probably missed the original events
+          # Instead, we can sync the payment intent or subscription during this event to ensure they're in the database
+
           if (payment_intent_id = event.data.object.payment_intent)
             payment_intent = ::Stripe::PaymentIntent.retrieve({id: payment_intent_id}, {stripe_account: event.try(:account)}.compact)
             Pay::Stripe::Charge.sync(payment_intent.latest_charge, stripe_account: event.try(:account))
@@ -18,11 +21,8 @@ module Pay
         def locate_owner(object)
           return if object.client_reference_id.nil?
 
-          # If there is a client reference ID, make sure we have a Pay::Customer record
-          owner = GlobalID::Locator.locate_signed(object.client_reference_id)
+          owner = Pay::Stripe.find_by_client_reference_id(object.client_reference_id)
           owner&.add_payment_processor(:stripe, processor_id: object.customer)
-        rescue
-          Rails.logger.debug "[Pay] Unable to locate record with SGID: #{object.client_reference_id}"
         end
       end
     end

data/lib/pay/stripe/webhooks/customer_deleted.rb

@@ -6,6 +6,9 @@ module Pay
           object = event.data.object
           pay_customer = Pay::Customer.find_by(processor: :stripe, processor_id: object.id)
 
+          # Skip processing if this customer is not in the database
+          return unless pay_customer
+
           # Mark all subscriptions as canceled
           pay_customer.subscriptions.active.update_all(ends_at: Time.current, status: "canceled")
 
@@ -13,7 +16,7 @@ module Pay
           pay_customer.payment_methods.destroy_all
 
           # Mark customer as deleted
-          pay_customer&.update!(default: false, deleted_at: Time.current)
+          pay_customer.update!(default: false, deleted_at: Time.current)
         end
       end
     end

data/lib/pay/stripe.rb

@@ -30,6 +30,10 @@ module Pay
 
     extend Env
 
+    # A list of database model names that include Pay
+    # Used for safely looking up models with client_reference_id
+    mattr_accessor :model_names, default: Set.new
+
     def self.enabled?
       return false unless Pay.enabled_processors.include?(:stripe) && defined?(::Stripe)
 
@@ -114,5 +118,24 @@ module Pay
         events.subscribe "stripe.checkout.session.async_payment_succeeded", Pay::Stripe::Webhooks::CheckoutSessionAsyncPaymentSucceeded.new
       end
     end
+
+    def self.to_client_reference_id(record)
+      raise ArgumentError, "#{record.class.name} does not include Pay. Allowed models: #{model_names.to_a.join(", ")}" unless model_names.include?(record.class.name)
+      [record.class.name, record.id].join("/")
+    end
+
+    def self.find_by_client_reference_id(client_reference_id)
+      # If there is a client reference ID, make sure we have a Pay::Customer record
+      # client_reference_id should be in the format of "User/1"
+      model_name, id = client_reference_id.split("/", 2)
+
+      # Only allow model names that use Pay
+      return unless model_names.include?(model_name)
+
+      model_name.constantize.find(id)
+    rescue ActiveRecord::RecordNotFound
+      Rails.logger.error "[Pay] Unable to locate record with: #{client_reference_id}"
+      nil
+    end
   end
 end

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "6.4.0"
+  VERSION = "6.6.0"
 end

data/lib/pay.rb

@@ -57,6 +57,9 @@ module Pay
   mattr_accessor :enabled_processors
   @@enabled_processors = [:stripe, :braintree, :paddle]
 
+  mattr_accessor :send_emails
+  @@send_emails = true
+
   mattr_accessor :emails
   @@emails = ActiveSupport::OrderedOptions.new
   @@emails.payment_action_required = true
@@ -111,12 +114,19 @@ module Pay
   end
 
   def self.send_email?(email_option, *remaining_args)
-    config_option = emails.send(email_option)
+    if resolve_option(send_emails, *remaining_args)
+      email_config_option_enabled = emails.send(email_option)
+      resolve_option(email_config_option_enabled, *remaining_args)
+    else
+      false
+    end
+  end
 
-    if config_option.respond_to?(:call)
-      config_option.call(*remaining_args)
+  def self.resolve_option(option, *remaining_args)
+    if option.respond_to?(:call)
+      option.call(*remaining_args)
     else
-      config_option
+      option
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.6.0
 platform: ruby
 authors:
 - Jason Charnes
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Payments engine for Ruby on Rails