pay 3.0.16 → 3.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59b2532c5c7b00afccc1f337f22f89264a5638ce228011166f776c77487b2195
-  data.tar.gz: b67a36b2fded1ee0a28f6a32efe24c9f2d6a34611b20f6c1a4776d9424f42cfd
+  metadata.gz: fc336f11aa6bdd63887622dd48fbec5a3f52b440b41a73d63478a0239d4c787a
+  data.tar.gz: 31e98a7bbe5a0c9ba92201964aab99b3a3743cc42f15eac275f6032a9f52293f
 SHA512:
-  metadata.gz: c9594441627345f0da762497bb91c465aa37c3c54979c43b47620c5361830add4bb7cf84db1d9e3fbd0bdd8b73997ec676e6ca044a8763a8b4f33757a679c965
-  data.tar.gz: e0e9918358210d2a8a7cc49e0172c45b0a48884b9d517a73cd19addb0e4c60d4301bb9e33c1deacb8f68941e5ea81f4541c1cb1474c981e8a250f316b59063c6
+  metadata.gz: 194be2c0276670440ff121b00048eedba5f91f1a85b53be9bd0145f5147f78d14ab739e57ae90590f6a751c5b3f2013e139650201bfe2b19d455b28c40c896dc
+  data.tar.gz: 9cc1c6d63c0360ccd54b2ee0143b933b292279016618e7e3130b97c150c64350756d7663682f1235f86d7a4983c971def19a7fef13d8148124040b1fccf39c63

data/README.md

@@ -23,11 +23,11 @@ Our supported payment processors are:
 - Stripe ([SCA Compatible](https://stripe.com/docs/strong-customer-authentication) using API version `2020-08-27`)
 - Paddle (SCA Compatible & supports PayPal)
 - Braintree (supports PayPal)
-- [Fake Processor](docs/fake_processor.md) (used for generic trials without cards, free subscriptions, testing, etc)
+- [Fake Processor](docs/fake_processor/1_overview.md) (used for generic trials without cards, free subscriptions, testing, etc)
 
 Want to add a new payment provider? Contributions are welcome.
 
-> We make our best attempt to standardize the different payment providers. They function differently so keep that in mind if you plan on doing more complex payments. It would be best to stick witha single payment provider in that case so you don't run into discrepancies.
+> We make our best attempt to standardize the different payment providers. They function differently so keep that in mind if you plan on doing more complex payments. It would be best to stick with a single payment provider in that case so you don't run into discrepancies.
 
 ## 📚 Docs
 

data/app/mailers/pay/user_mailer.rb

@@ -23,11 +23,7 @@ module Pay
     private
 
     def to
-      if params[:billable].respond_to?(:customer_name)
-        "#{params[:billable].customer_name} <#{params[:billable].email}>"
-      else
-        params[:billable].email
-      end
+      "#{params[:pay_customer].customer_name} <#{params[:pay_customer].email}>"
     end
   end
 end

data/app/models/pay/subscription.rb

@@ -70,6 +70,10 @@ module Pay
       self.trial_ends_at = nil
     end
 
+    def generic_trial?
+      fake_processor? && trial_ends_at?
+    end
+
     def on_trial?
       trial_ends_at? && Time.zone.now < trial_ends_at
     end
@@ -128,6 +132,12 @@ module Pay
       processor_subscription(expand: ["latest_invoice.payment_intent"]).latest_invoice.payment_intent
     end
 
+    def paddle_paused_from
+      if (timestamp = super)
+        Time.zone.parse(timestamp)
+      end
+    end
+
     private
 
     def cancel_if_active

data/app/views/pay/user_mailer/receipt.html.erb

@@ -10,7 +10,7 @@ Amount: <%= params[:charge].amount_with_currency %><br/>
 Charged to: <%= params[:charge].charged_to %><br/>
 Transaction ID: <%= params[:charge].id %><br/>
 Date: <%= params[:charge].created_at %><br/>
-<% if params[:charge].customer.owner.extra_billing_info? %>
+<% if params[:charge].customer.owner.try(:extra_billing_info?) %>
 <%= params[:charge].customer.owner.extra_billing_info %><br/>
 <% end %>
 <br/>

data/app/views/pay/user_mailer/refund.html.erb

@@ -11,7 +11,7 @@ Amount: <%= params[:charge].amount_refunded_with_currency %><br/>
 Refunded to: <%= params[:charge].charged_to %><br/>
 Transaction ID: <%= params[:charge].id %><br/>
 Date: <%= params[:charge].created_at %><br/>
-<% if params[:charge].customer.owner.extra_billing_info? %>
+<% if params[:charge].customer.owner.try(:extra_billing_info?) %>
 <%= params[:charge].customer.owner.extra_billing_info %><br/>
 <% end %>
 <br/>

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

@@ -12,10 +12,10 @@ module Pay
           return unless pay_subscription.present?
 
           pay_customer = pay_subscription.customer
-          charge = Pay::Braintree::Billable.new(pay_customer).save_transaction(subscription.transactions.first)
+          pay_charge = Pay::Braintree::Billable.new(pay_customer).save_transaction(subscription.transactions.first)
 
-          if Pay.send_emails
-            Pay::UserMailer.with(billable: pay_customer.owner, charge: charge).receipt.deliver_later
+          if pay_charge && Pay.send_emails
+            Pay::UserMailer.with(pay_customer: pay_customer, charge: pay_charge).receipt.deliver_later
           end
         end
       end

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

@@ -11,11 +11,11 @@ module Pay
           pay_subscription = Pay::Subscription.find_by_processor_and_id(:braintree, subscription.id)
           return unless pay_subscription.present?
 
-          # billable = pay_subscription.owner
-          # charge = Pay::Braintree::Billable.new(billable).save_transaction(subscription.transactions.first)
+          # pay_customer = pay_subscription.customer
+          # pay_charge = Pay::Braintree::Billable.new(pay_customer).save_transaction(subscription.transactions.first)
 
           # if Pay.send_emails
-          #  Pay::UserMailer.with(billable: billable, charge: charge).receipt.deliver_later
+          #  Pay::UserMailer.with(pay_customer: pay_charge.customer, charge: pay_charge).receipt.deliver_later
           # end
         end
       end

data/lib/pay/paddle/subscription.rb

@@ -75,9 +75,19 @@ module Pay
       end
 
       def cancel
-        ends_at = on_trial? ? trial_ends_at : processor_subscription.next_payment[:date]
+        ends_at = if on_trial?
+          trial_ends_at
+        elsif paused?
+          paddle_paused_from
+        else
+          processor_subscription.next_payment&.fetch(:date) || Time.current
+        end
+
         PaddlePay::Subscription::User.cancel(processor_id)
         pay_subscription.update(status: :canceled, ends_at: ends_at)
+
+        # Remove payment methods since customer cannot be reused after cancelling
+        Pay::PaymentMethod.where(customer_id: pay_subscription.customer_id).destroy_all
       rescue ::PaddlePay::PaddlePayError => e
         raise Pay::Paddle::Error, e
       end
@@ -85,6 +95,9 @@ module Pay
       def cancel_now!
         PaddlePay::Subscription::User.cancel(processor_id)
         pay_subscription.update(status: :canceled, ends_at: Time.current)
+
+        # Remove payment methods since customer cannot be reused after cancelling
+        Pay::PaymentMethod.where(customer_id: pay_subscription.customer_id).destroy_all
       rescue ::PaddlePay::PaddlePayError => e
         raise Pay::Paddle::Error, e
       end
@@ -100,7 +113,7 @@ module Pay
       def pause
         attributes = {pause: true}
         response = PaddlePay::Subscription::User.update(processor_id, attributes)
-        pay_subscription.update(paddle_paused_from: Time.zone.parse(response[:next_payment][:date]))
+        pay_subscription.update(paddle_paused_from: Time.zone.parse(response.dig(:next_payment, :date)))
       rescue ::PaddlePay::PaddlePayError => e
         raise Pay::Paddle::Error, e
       end

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

@@ -13,7 +13,7 @@ module Pay
           pay_subscription.update!(ends_at: Time.zone.parse(event.cancellation_effective_date)) if pay_subscription.ends_at.blank? && event.cancellation_effective_date.present?
 
           # Paddle doesn't allow reusing customers, so we should remove their payment methods
-          pay_subscription.customer.payment_methods.destroy_all
+          Pay::PaymentMethod.where(customer_id: pay_subscription.customer_id).destroy_all
         end
       end
     end

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

@@ -3,16 +3,13 @@ module Pay
     module Webhooks
       class SubscriptionPaymentRefunded
         def call(event)
-          charge = Pay::Charge.find_by_processor_and_id(:paddle, event.subscription_payment_id)
-          return unless charge.present?
+          pay_charge = Pay::Charge.find_by_processor_and_id(:paddle, event.subscription_payment_id)
+          return unless pay_charge.present?
 
-          charge.update(amount_refunded: (event.gross_refund.to_f * 100).to_i)
-          notify_user(charge.customer.owner, charge)
-        end
+          pay_charge.update(amount_refunded: (event.gross_refund.to_f * 100).to_i)
 
-        def notify_user(billable, charge)
           if Pay.send_emails
-            Pay::UserMailer.with(billable: billable, charge: charge).refund.deliver_later
+            Pay::UserMailer.with(pay_customer: pay_charge.customer, charge: pay_charge).refund.deliver_later
           end
         end
       end

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

@@ -18,7 +18,7 @@ module Pay
           return if pay_customer.charges.where(processor_id: event.subscription_payment_id).any?
 
           charge = create_charge(pay_customer, event)
-          notify_user(pay_customer.owner, charge)
+          notify_user(charge)
         end
 
         def create_charge(pay_customer, event)
@@ -42,9 +42,9 @@ module Pay
           charge
         end
 
-        def notify_user(billable, charge)
-          if Pay.send_emails && charge.respond_to?(:receipt)
-            Pay::UserMailer.with(billable: billable, charge: charge).receipt.deliver_later
+        def notify_user(pay_charge)
+          if Pay.send_emails
+            Pay::UserMailer.with(pay_customer: pay_charge.customer, charge: pay_charge).receipt.deliver_later
           end
         end
       end

data/lib/pay/receipts.rb

@@ -21,7 +21,7 @@ module Pay
         [I18n.t("pay.receipt.amount"), Pay::Currency.format(amount, currency: currency)],
         [I18n.t("pay.receipt.charged_to"), charged_to]
       ]
-      line_items << [I18n.t("pay.receipt.additional_info"), customer.owner.extra_billing_info] if customer.owner.extra_billing_info?
+      line_items << [I18n.t("pay.receipt.additional_info"), customer.owner.extra_billing_info] if customer.owner.try(:extra_billing_info?)
       line_items << [I18n.t("pay.receipt.refunded"), Pay::Currency.format(amount_refunded, currency: currency)] if refunded?
 
       defaults = {
@@ -49,7 +49,7 @@ module Pay
 
     def invoice_pdf(**options)
       bill_to = [customer.owner.name]
-      bill_to += [customer.owner.extra_billing_info] if customer.owner.extra_billing_info?
+      bill_to += [customer.owner.extra_billing_info] if customer.owner.try(:extra_billing_info?)
       bill_to += [nil, customer.owner.email]
 
       total = Pay::Currency.format(amount, currency: currency)

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

@@ -4,12 +4,9 @@ module Pay
       class ChargeRefunded
         def call(event)
           pay_charge = Pay::Stripe::Charge.sync(event.data.object.id, stripe_account: event.try(:account))
-          notify_user(pay_charge.customer.owner, pay_charge) if pay_charge
-        end
 
-        def notify_user(billable, charge)
-          if Pay.send_emails
-            Pay::UserMailer.with(billable: billable, charge: charge).refund.deliver_later
+          if pay_charge && Pay.send_emails
+            Pay::UserMailer.with(pay_customer: pay_charge.customer, charge: pay_charge).refund.deliver_later
           end
         end
       end

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

@@ -4,12 +4,9 @@ module Pay
       class ChargeSucceeded
         def call(event)
           pay_charge = Pay::Stripe::Charge.sync(event.data.object.id, stripe_account: event.try(:account))
-          notify_user(pay_charge.customer.owner, pay_charge) if pay_charge
-        end
 
-        def notify_user(billable, charge)
-          if Pay.send_emails && charge.respond_to?(:receipt)
-            Pay::UserMailer.with(billable: billable, charge: charge).receipt.deliver_later
+          if pay_charge && Pay.send_emails
+            Pay::UserMailer.with(pay_customer: pay_charge.customer, charge: pay_charge).receipt.deliver_later
           end
         end
       end

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

@@ -10,14 +10,13 @@ module Pay
 
           subscription = Pay::Subscription.find_by_processor_and_id(:stripe, object.subscription)
           return if subscription.nil?
-          billable = subscription.customer.owner
 
-          notify_user(billable, event.data.object.payment_intent, subscription)
-        end
-
-        def notify_user(billable, payment_intent_id, subscription)
           if Pay.send_emails
-            Pay::UserMailer.with(billable: billable, payment_intent_id: payment_intent_id, subscription: subscription).payment_action_required.deliver_later
+            Pay::UserMailer.with(
+              pay_customer: subscription.customer,
+              payment_intent_id: event.data.object.payment_intent,
+              subscription: subscription
+            ).payment_action_required.deliver_later
           end
         end
       end

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

@@ -18,12 +18,12 @@ module Pay
           interval = price.recurring.interval
           return unless interval == "year"
 
-          notify_user(subscription.customer.owner, subscription, Time.zone.at(event.data.object.next_payment_attempt))
-        end
-
-        def notify_user(billable, subscription, date)
           if Pay.send_emails
-            Pay::UserMailer.with(billable: billable, subscription: subscription, date: date).subscription_renewing.deliver_later
+            Pay::UserMailer.with(
+              pay_customer: subscription.customer,
+              subscription: subscription,
+              date: Time.zone.at(event.data.object.next_payment_attempt)
+            ).subscription_renewing.deliver_later
           end
         end
       end

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "3.0.16"
+  VERSION = "3.0.20"
 end

data/lib/pay.rb

@@ -54,12 +54,4 @@ module Pay
   def self.setup
     yield self
   end
-
-  def self.receipts_supported?
-    charge_model.respond_to?(:receipt) &&
-      application_name.present? &&
-      business_name &&
-      business_address &&
-      support_email
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 3.0.16
+  version: 3.0.20
 platform: ruby
 authors:
 - Jason Charnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-11 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,14 +123,7 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/1_create_pay_tables.rb
-- lib/generators/active_record/billable_generator.rb
-- lib/generators/active_record/merchant_generator.rb
-- lib/generators/active_record/templates/billable_migration.rb
-- lib/generators/active_record/templates/merchant_migration.rb
-- lib/generators/pay/billable_generator.rb
 - lib/generators/pay/email_views_generator.rb
-- lib/generators/pay/merchant_generator.rb
-- lib/generators/pay/orm_helpers.rb
 - lib/generators/pay/views_generator.rb
 - lib/pay.rb
 - lib/pay/adapter.rb

data/lib/generators/active_record/billable_generator.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/active_record"
-require "generators/pay/orm_helpers"
-
-module ActiveRecord
-  module Generators
-    class BillableGenerator < ActiveRecord::Generators::Base
-      include Pay::Generators::OrmHelpers
-      source_root File.expand_path("../templates", __FILE__)
-
-      def copy_pay_billable_migration
-        if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
-          migration_template "billable_migration.rb", "#{migration_path}/add_pay_billable_to_#{table_name}.rb", migration_version: migration_version
-        else
-          say "#{model_path} does not exist.", :red
-          say "⚠️  Make sure the #{name} model exists before running this generator."
-        end
-      end
-
-      # If the file already contains the contents, the user will receive this warning:
-      #
-      #   File unchanged! The supplied flag value not found!
-      #
-      # This can be ignored as it just means the contents already exist and the file is unchanged.
-      # Thor will be updated to improve this message: https://github.com/rails/thor/issues/706
-      def inject_pay_billable_content
-        return unless model_exists?
-
-        content = model_contents
-        class_path = (namespaced? ? class_name.to_s.split("::") : [class_name])
-        indent_depth = class_path.size - 1
-        content = content.split("\n").map { |line| "  " * indent_depth + line }.join("\n") << "\n"
-        inject_into_class(model_path, class_path.last, content)
-      end
-
-      private
-
-      def model_contents
-        "  include Pay::Billable"
-      end
-    end
-  end
-end

data/lib/generators/active_record/merchant_generator.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/active_record"
-require "generators/pay/orm_helpers"
-
-module ActiveRecord
-  module Generators
-    class MerchantGenerator < ActiveRecord::Generators::Base
-      include Pay::Generators::OrmHelpers
-      source_root File.expand_path("../templates", __FILE__)
-
-      def copy_pay_merchant_migration
-        if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
-          migration_template "merchant_migration.rb", "#{migration_path}/add_pay_merchant_to_#{table_name}.rb", migration_version: migration_version
-        else
-          say "#{model_path} does not exist.", :red
-          say "⚠️  Make sure the #{name} model exists before running this generator."
-        end
-      end
-
-      # If the file already contains the contents, the user will receive this warning:
-      #
-      #   File unchanged! The supplied flag value not found!
-      #
-      # This can be ignored as it just means the contents already exist and the file is unchanged.
-      # Thor will be updated to improve this message: https://github.com/rails/thor/issues/706
-      def inject_pay_merchant_content
-        return unless model_exists?
-
-        content = model_contents
-        class_path = (namespaced? ? class_name.to_s.split("::") : [class_name])
-        indent_depth = class_path.size - 1
-        content = content.split("\n").map { |line| "  " * indent_depth + line }.join("\n") << "\n"
-        inject_into_class(model_path, class_path.last, content)
-      end
-
-      private
-
-      def model_contents
-        "  include Pay::Merchant"
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-class AddPayBillableTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
-  def change
-    change_table :<%= table_name %>, bulk: true do |t|
-      t.string :processor
-      t.string :processor_id
-      t.public_send(Pay::Adapter.json_column_type, :pay_data)
-      t.datetime :trial_ends_at
-      t.string :card_type
-      t.string :card_last4
-      t.string :card_exp_month
-      t.string :card_exp_year
-      t.text :extra_billing_info
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-class AddPayMerchantTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
-  def change
-    add_column table_name, :merchant_processor, :string
-
-    # We may already have the pay_data column if a Pay::Billable object is also a Pay::Merchant
-    unless ActiveRecord::Base.connection.column_exists?(table_name, :pay_data)
-      add_column :<%= table_name %>, :pay_data, Pay::Adapter.json_column_type
-    end
-  end
-end

data/lib/generators/pay/billable_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-
-module Pay
-  module Generators
-    class BillableGenerator < Rails::Generators::NamedBase
-      include Rails::Generators::ResourceHelpers
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      desc "Generates a migration to add Pay::Billable fields to a model."
-
-      hook_for :orm
-    end
-  end
-end

data/lib/generators/pay/merchant_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-
-module Pay
-  module Generators
-    class MerchantGenerator < Rails::Generators::NamedBase
-      include Rails::Generators::ResourceHelpers
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      desc "Generates a migration to add Pay::Merchant fields to a model."
-
-      hook_for :orm
-    end
-  end
-end

data/lib/generators/pay/orm_helpers.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Pay
-  module Generators
-    module OrmHelpers
-      private
-
-      def model_exists?
-        File.exist?(File.join(destination_root, model_path))
-      end
-
-      def migration_exists?(table_name)
-        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_devise_to_#{table_name}.rb$/).first
-      end
-
-      def migration_path
-        if Rails.version >= "5.0.3"
-          db_migrate_path
-        else
-          @migration_path ||= File.join("db", "migrate")
-        end
-      end
-
-      def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
-      end
-
-      def migration_version
-        if rails5_and_up?
-          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-        end
-      end
-
-      def rails5_and_up?
-        Rails::VERSION::MAJOR >= 5
-      end
-    end
-  end
-end