pay 4.0.4 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6659a95f47cd229375f090cb734b440ca8484cd9672b88bd482dede070fa6819
-  data.tar.gz: 408ef1cbfd3364d30d7e7bbfd78c58b585034c54e65346db92f1e9a7cf3ab279
+  metadata.gz: 21dbf64c59853ff5226ba4896f3d25c29625182637cc4ac43f9eaffb60433ec7
+  data.tar.gz: e0cd4bfa462306aa0ddf15244a2d536c36a97e45b2d4acb2564cee9c8143351b
 SHA512:
-  metadata.gz: 8ffbc4d1d685f994a1dc3e45d8b7f20a4a4d4f8852cd3ca7d349d2af5cc22445c2c526eef8906305aa80b8d37ae82c6f0101b271a121b66d4bc4624f82446480
-  data.tar.gz: 12332883526b3e321e70e8b30445b40dfa85715f3a7a7bfece32940fb857f8f747b586d48245f760b9e3866a54d2532d9ca9dce8b0da55441f3b619cec14072f
+  metadata.gz: e3b007b3190cb534dec8953486a21fca0b9fe82d26a1caa80dc27a405f835bbb8424c034508e8adc5f36ce3d9ae526a4334d1a5a315b43ebba472dc60f0772f1
+  data.tar.gz: 0f0390f51f53fad304ceb5866d1f68a3a5af7272ce33403c27b0362e916d0ad20de756f77a3375f466ec8866d0d2a97e006a15c6dd3f18ac221fb4fc10d3f467

data/app/models/pay/charge.rb

@@ -41,6 +41,8 @@ module Pay
     store_accessor :data, :discounts # array of discount IDs applied to the Stripe Invoice
     store_accessor :data, :total_discount_amounts # array of discount details
     store_accessor :data, :total_tax_amounts # array of tax details for each jurisdiction
+    store_accessor :data, :credit_notes # array of credit notes for the Stripe Invoice
+    store_accessor :data, :refunds # array of refunds
 
     # Helpers for payment processors
     %w[braintree stripe paddle fake_processor].each do |processor_name|

data/app/models/pay/subscription.rb

@@ -11,7 +11,9 @@ module Pay
     scope :on_trial, -> { where.not(trial_ends_at: nil).where("#{table_name}.trial_ends_at > ?", Time.zone.now) }
     scope :cancelled, -> { where.not(ends_at: nil) }
     scope :on_grace_period, -> { cancelled.where("#{table_name}.ends_at > ?", Time.zone.now) }
-    scope :active, -> { where(status: ["trialing", "active"], ends_at: nil).or(on_grace_period).or(on_trial) }
+    # Stripe considers paused subscriptions to be active, therefore we reflect that in this scope and
+    # make it consistent across all processors
+    scope :active, -> { where(status: ["trialing", "active", "paused"], ends_at: nil).or(on_grace_period).or(on_trial) }
     scope :incomplete, -> { where(status: :incomplete) }
     scope :past_due, -> { where(status: :past_due) }
     scope :with_active_customer, -> { joins(:customer).merge(Customer.active) }
@@ -49,6 +51,18 @@ module Pay
       scope processor_name, -> { joins(:customer).where(pay_customers: {processor: processor_name}) }
     end
 
+    def self.active_without_paused
+      case Pay::Adapter.current_adapter
+      when "postgresql", "postgis"
+        active.where("data->>'pause_behavior' IS NULL AND status != 'paused'")
+      when "mysql2"
+        active.where("data->>'$.pause_behavior' IS NULL AND status != 'paused'")
+      when "sqlite3"
+        # sqlite 3.38 supports ->> syntax, however, sqlite 3.37 is what ships with Ubuntu 22.04.
+        active.where("json_extract(data, '$.pause_behavior') IS NULL AND status != 'paused'")
+      end
+    end
+
     def self.with_metered_items
       case Pay::Adapter.current_adapter
       when "sqlite3"
@@ -108,7 +122,7 @@ module Pay
     end
 
     def active?
-      ["trialing", "active"].include?(status) && (ends_at.nil? || on_grace_period? || on_trial?)
+      ["trialing", "active", "paused"].include?(status) && (ends_at.nil? || on_grace_period? || on_trial?)
     end
 
     def past_due?

data/config/locales/en.yml

@@ -35,6 +35,7 @@ en:
       payment_method: "Payment Method"
       amount_paid: "Amount paid"
       refunded: "Refunded"
+      refunded_on: "Refunded on %{date}"
     invoice:
       number: "Invoice Number"
       date: "Date"

data/lib/pay/paddle/subscription.rb

@@ -107,13 +107,13 @@ module Pay
       end
 
       def paused?
-        paddle_paused_from.present?
+        pay_subscription.status == "paused"
       end
 
       def pause
         attributes = {pause: true}
         response = PaddlePay::Subscription::User.update(processor_id, attributes)
-        pay_subscription.update(paddle_paused_from: Time.zone.parse(response.dig(:next_payment, :date)))
+        pay_subscription.update(status: :paused, paddle_paused_from: Time.zone.parse(response.dig(:next_payment, :date)))
       rescue ::PaddlePay::PaddlePayError => e
         raise Pay::Paddle::Error, e
       end

data/lib/pay/receipts.rb

@@ -86,16 +86,29 @@ module Pay
       "#{tax_rate["display_name"]} - #{tax_rate["jurisdiction"]} (#{percent})"
     end
 
-    def receipt_pdf(**options)
-      receipt_line_items = pdf_line_items
+    def receipt_line_items
+      line_items = pdf_line_items
 
       # Include total paid
-      receipt_line_items << [nil, nil, I18n.t("pay.receipt.amount_paid"), Pay::Currency.format(amount, currency: currency)]
+      line_items << [nil, nil, I18n.t("pay.receipt.amount_paid"), Pay::Currency.format(amount, currency: currency)]
 
       if refunded?
-        receipt_line_items << [nil, nil, I18n.t("pay.receipt.refunded_on"), Pay::Currency.format(amount_refunded, currency: currency)]
+        # If we have a list of individual refunds, add each entry
+        if refunds&.any?
+          refunds.each do |refund|
+            next unless refund["status"] == "succeeded"
+            refunded_at = Time.at(refund["created"]).to_date
+            line_items << [nil, nil, I18n.t("pay.receipt.refunded_on", date: I18n.l(refunded_at, format: :long)), Pay::Currency.format(refund["amount"], currency: refund["currency"])]
+          end
+        else
+          line_items << [nil, nil, I18n.t("pay.receipt.refunded"), Pay::Currency.format(amount_refunded, currency: currency)]
+        end
       end
 
+      line_items
+    end
+
+    def receipt_pdf(**options)
       defaults = {
         details: receipt_details,
         recipient: [

data/lib/pay/stripe/charge.rb

@@ -22,6 +22,9 @@ module Pay
         pay_customer = Pay::Customer.find_by(processor: :stripe, processor_id: object.customer)
         return unless pay_customer
 
+        refunds = []
+        object.refunds.auto_paging_each { |refund| refunds << refund }
+
         payment_method = object.payment_method_details.send(object.payment_method_details.type)
         attrs = {
           amount: object.amount,
@@ -42,7 +45,8 @@ module Pay
           payment_method_type: object.payment_method_details.type,
           stripe_account: pay_customer.stripe_account,
           stripe_receipt_url: object.receipt_url,
-          total_tax_amounts: []
+          total_tax_amounts: [],
+          refunds: refunds.sort_by! { |r| r["created"] }
         }
 
         # Associate charge with subscription if we can
@@ -75,7 +79,6 @@ module Pay
               period_end: Time.at(line_item.period.end)
             }
           end
-
         # Charges without invoices
         else
           attrs[:period_start] = Time.at(object.created)

data/lib/pay/stripe/subscription.rb

@@ -100,7 +100,15 @@ module Pay
 
       # Common expand options for all requests that create, retrieve, or update a Stripe Subscription
       def self.expand_options
-        {expand: ["pending_setup_intent", "latest_invoice.payment_intent", "latest_invoice.charge"]}
+        {
+          expand: [
+            "pending_setup_intent",
+            "latest_invoice.payment_intent",
+            "latest_invoice.charge",
+            "latest_invoice.total_discount_amounts.discount",
+            "latest_invoice.total_tax_amounts.tax_rate"
+          ]
+        }
       end
 
       def initialize(pay_subscription)

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "4.0.4"
+  VERSION = "4.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 4.2.0
 platform: ruby
 authors:
 - Jason Charnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails