pay 2.6.0 → 2.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f67175eed41645fc10868070414e33e205dc6970be39038715fbde5c18496932
-  data.tar.gz: bd725f34c55707aaf30c1e46ecc111a9c00b69f8275d87c7d94f8640b24d84c2
+  metadata.gz: a8d82f8b92018a0af540a835677d44a4b364bc37472ceb2869e6f78b81cb88df
+  data.tar.gz: 369d7fdc1dd186a8ab6ac4c964fb3983db4f5d1bc7ab856669b65c3f4696f658
 SHA512:
-  metadata.gz: 47b06c20aef2c34454f40bb734c4d1bdd648e9f9f4380c7b5c8d246357036f46b92511bc36ebf7b3b1ec00234700848ad3b12b1eb76c2e274a420e5bc650608b
-  data.tar.gz: 033e3b12a1a1a6f9b7b7bb2e447cb4a1acfb0cf3d35da7d5f00e187f6301d5cc59a9a3bec0d1577f8a6764286d93dbfefe16553939fc8c83213ee1c6668b09b9
+  metadata.gz: afb95708b3a2e08b44f6236e1ff51268b8287691206ce8a050bea609d88555f87feb295ed14d1dfa671982a365d0a7099a7cee6cd0b191cbae60647cf1097505
+  data.tar.gz: 05bc21e7a17c88c1d6ecaae86afd1f36c3e90ffd0e6f200cc9c360b5d5a400dfd28ac75c361eccd9d3e6ee8d52f3862044fed40da3eebf8ff101d591d35ffe0c

data/README.md

@@ -1,16 +1,19 @@
-<p align="center"><img src="docs/logo.svg" height="50px"></p>
+<p align="center"><img src="docs/images/logo.svg" height="50px"></p>
 
 ## Pay - Payments engine for Ruby on Rails
 
-[![Build Status](https://github.com/pay-rails/pay/workflows/Tests/badge.svg)](https://github.com/pay-rails/pay/actions) [![Gem Version](https://badge.fury.io/rb/pay.svg)](https://badge.fury.io/rb/pay)
+[![Build Status](https://github.com/pay-rails/pay/workflows/Tests/badge.svg)](https://github.com/pay-rails/pay/actions) [![Gem Version](https://badge.fury.io/rb/pay.svg)](https://badge.fury.io/rb/pay) 
+
+<img src="docs/images/stripe_partner_badge.svg" height="26px">
 
 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`)
+- Stripe ([SCA Compatible](https://stripe.com/docs/strong-customer-authentication) using API version `2020-08-27`)
+- Paddle (SCA Compatible & supports PayPal)
 - Braintree (supports PayPal)
-- Paddle (supports PayPal)
+- [Fake Processor](docs/fake_processor.md)
 
 Want to add a new payment provider? Contributions are welcome and the instructions [are here](https://github.com/jasoncharnes/pay/wiki/New-Payment-Provider).
 
@@ -36,7 +39,7 @@ gem 'stripe', '< 6.0', '>= 2.8'
 gem 'braintree', '< 3.0', '>= 2.92.0'
 
 # To use Paddle, also include:
-gem 'paddle_pay', '~> 0.0.1'
+gem 'paddle_pay', '~> 0.1'
 
 # To use Receipts
 gem 'receipts', '~> 1.0.0'
@@ -48,6 +51,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:
@@ -143,11 +153,12 @@ development:
     vendor_id: xxxx
     vendor_auth_code: yyyy
     public_key_base64: MII...==
+    environment: sandbox
 ```
 
 For Stripe, you can also use the `STRIPE_PUBLIC_KEY`, `STRIPE_PRIVATE_KEY` and `STRIPE_SIGNING_SECRET` environment variables.
 For Braintree, you can also use `BRAINTREE_MERCHANT_ID`, `BRAINTREE_PUBLIC_KEY`, `BRAINTREE_PRIVATE_KEY`, and `BRAINTREE_ENVIRONMENT` environment variables.
-For Paddle, you can also use `PADDLE_VENDOR_ID`, `PADDLE_VENDOR_AUTH_CODE` and `PADDLE_PUBLIC_KEY_BASE64` environment variables.
+For Paddle, you can also use `PADDLE_VENDOR_ID`, `PADDLE_VENDOR_AUTH_CODE`, `PADDLE_PUBLIC_KEY_BASE64` and `PADDLE_ENVIRONMENT` environment variables.
 
 ### Generators
 
@@ -613,6 +624,7 @@ development:
     vendor_id: xxxx
     vendor_auth_code: yyyy
     public_key_base64: MII...==
+    environment: sandbox
 ```
 
 Paddle receipts can be retrieved by a charge receipt URL.
@@ -678,6 +690,12 @@ If you'd like to change the views of the payment confirmation page, you can inst
 
 [<img src="https://d1jfzjx68gj8xs.cloudfront.net/items/2s3Z0J3Z3b1J1v2K2O1a/Screen%20Shot%202019-10-10%20at%2012.56.32%20PM.png?X-CloudApp-Visitor-Id=51470" alt="Stripe SCA Payment Confirmation" style="zoom: 25%;" />](https://d1jfzjx68gj8xs.cloudfront.net/items/2s3Z0J3Z3b1J1v2K2O1a/Screen%20Shot%202019-10-10%20at%2012.56.32%20PM.png)
 
+If you use the default views for payment confirmations, and also have a Content Security Policy in place for your application, make sure to add the following domains to their respective configurations in your `content_security_policy.rb` (otherwise these views won't load properly):
+
+* `style_src`: `https://unpkg.com`
+* `script_src`: `https://cdn.jsdelivr.net` and `https://js.stripe.com`
+* `frame_src`: `https://js.stripe.com`
+
 #### Background jobs
 
 If a user's email is updated and they have a `processor_id` set, Pay will enqueue a background job (EmailSyncJob) to sync the email with the payment processor.

data/app/models/pay/charge.rb

@@ -21,7 +21,7 @@ module Pay
     store_accessor :data, :paddle_receipt_url
 
     # Helpers for payment processors
-    %w[braintree stripe paddle].each do |processor_name|
+    %w[braintree stripe paddle fake_processor].each do |processor_name|
       define_method "#{processor_name}?" do
         processor == processor_name
       end
@@ -50,20 +50,8 @@ module Pay
       "#{card_type} (**** **** **** #{card_last4})"
     end
 
-    def stripe?
-      processor == "stripe"
-    end
-
-    def braintree?
-      processor == "braintree"
-    end
-
     def paypal?
       braintree? && card_type == "PayPal"
     end
-
-    def paddle?
-      processor == "paddle"
-    end
   end
 end

data/app/models/pay/subscription.rb

@@ -35,7 +35,7 @@ module Pay
     attribute :prorate, :boolean, default: true
 
     # Helpers for payment processors
-    %w[braintree stripe paddle].each do |processor_name|
+    %w[braintree stripe paddle fake_processor].each do |processor_name|
       define_method "#{processor_name}?" do
         processor == processor_name
       end

data/lib/pay.rb

@@ -10,6 +10,7 @@ module Pay
 
   # Payment processors
   autoload :Braintree, "pay/braintree"
+  autoload :FakeProcessor, "pay/fake_processor"
   autoload :Paddle, "pay/paddle"
   autoload :Stripe, "pay/stripe"
 

data/lib/pay/billable.rb

@@ -24,6 +24,9 @@ module Pay
       attribute :plan, :string
       attribute :quantity, :integer
       attribute :card_token, :string
+      attribute :pay_fake_processor_allowed, :boolean, default: false
+
+      validate :pay_fake_processor_is_allowed, if: :processor_changed?
     end
 
     def payment_processor
@@ -31,6 +34,7 @@ module Pay
     end
 
     def payment_processor_for(name)
+      raise Error, "No payment processor set. Assign a payment processor with 'object.processor = :stripe' or any supported processor." if name.blank?
       "Pay::#{name.to_s.classify}::Billable".constantize
     end
 
@@ -42,7 +46,7 @@ module Pay
     end
 
     def processor
-      super.inquiry
+      super&.inquiry
     end
 
     delegate :charge, to: :payment_processor
@@ -112,10 +116,12 @@ module Pay
     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
 
@@ -124,6 +130,7 @@ module Pay
     end
 
     def paddle?
+      ActiveSupport::Deprecation.warn("This will be removed in the next release. Use `@billable.processor.paddle?` instead.")
       processor == "paddle"
     end
 
@@ -152,5 +159,10 @@ module Pay
       # Generic trials don't have plans or custom names
       plan.nil? && name == "default" && on_generic_trial?
     end
+
+    def pay_fake_processor_is_allowed
+      return unless processor == "fake_processor"
+      errors.add(:processor, "must be a valid payment processor") unless pay_fake_processor_allowed?
+    end
   end
 end

data/lib/pay/braintree/billable.rb

@@ -37,8 +37,8 @@ module Pay
 
           result.customer
         end
-      rescue ::Braintree::AuthorizationError
-        raise Pay::Braintree::AuthorizationError
+      rescue ::Braintree::AuthorizationError => e
+        raise Pay::Braintree::AuthorizationError, e
       rescue ::Braintree::BraintreeError => e
         raise Pay::Braintree::Error, e
       end
@@ -57,8 +57,8 @@ module Pay
         raise Pay::Braintree::Error, result unless result.success?
 
         save_transaction(result.transaction)
-      rescue ::Braintree::AuthorizationError
-        raise Pay::Braintree::AuthorizationError
+      rescue ::Braintree::AuthorizationError => e
+        raise Pay::Braintree::AuthorizationError, e
       rescue ::Braintree::BraintreeError => e
         raise Pay::Braintree::Error, e
       end
@@ -84,8 +84,8 @@ module Pay
         raise Pay::Braintree::Error, result unless result.success?
 
         billable.create_pay_subscription(result.subscription, "braintree", name, plan, status: :active)
-      rescue ::Braintree::AuthorizationError
-        raise Pay::Braintree::AuthorizationError
+      rescue ::Braintree::AuthorizationError => e
+        raise Pay::Braintree::AuthorizationError, e
       rescue ::Braintree::BraintreeError => e
         raise Pay::Braintree::Error, e
       end
@@ -94,6 +94,8 @@ module Pay
       #
       # Returns true if successful
       def update_card(token)
+        customer unless processor_id?
+
         result = gateway.payment_method.create(
           customer_id: processor_id,
           payment_method_nonce: token,
@@ -107,8 +109,8 @@ module Pay
         update_card_on_file result.payment_method
         update_subscriptions_to_payment_method(result.payment_method.token)
         true
-      rescue ::Braintree::AuthorizationError
-        raise Pay::Braintree::AuthorizationError
+      rescue ::Braintree::AuthorizationError => e
+        raise Pay::Braintree::AuthorizationError, e
       rescue ::Braintree::BraintreeError => e
         raise Pay::Braintree::Error, e
       end

data/lib/pay/braintree/charge.rb

@@ -17,7 +17,6 @@ module Pay
 
       def refund!(amount_to_refund)
         Pay.braintree_gateway.transaction.refund(processor_id, amount_to_refund / 100.0)
-
         pay_charge.update(amount_refunded: amount_to_refund)
       rescue ::Braintree::BraintreeError => e
         raise Pay::Braintree::Error, e

data/lib/pay/braintree/error.rb

@@ -1,8 +1,22 @@
 module Pay
   module Braintree
     class Error < Pay::Error
-      def message
-        result.message
+      # For any manually raised Braintree error results (for failure responses)
+      # we can raise this exception manually but treat it as if we wrapped an exception
+
+      attr_reader :result
+
+      def initialize(result)
+        if result.is_a?(::Braintree::ErrorResult)
+          super(result.message)
+          @result = result
+        else
+          super
+        end
+      end
+
+      def cause
+        super || result
       end
     end
   end

data/lib/pay/braintree/subscription.rb

@@ -9,13 +9,13 @@ module Pay
         :name,
         :on_trial?,
         :owner,
-        :processor_subscription,
         :processor_id,
+        :processor_plan,
+        :processor_subscription,
         :prorate,
         :prorate?,
-        :processor_plan,
-        :quantity?,
         :quantity,
+        :quantity?,
         :trial_ends_at,
         to: :pay_subscription
 

data/lib/pay/errors.rb

@@ -1,10 +1,6 @@
 module Pay
+  # https://avdi.codes/exception-causes-in-ruby-2-1/
   class Error < StandardError
-    attr_reader :result
-
-    def initialize(result = nil)
-      @result = result
-    end
   end
 
   class PaymentError < StandardError

data/lib/pay/fake_processor.rb

@@ -0,0 +1,8 @@
+module Pay
+  module FakeProcessor
+    autoload :Billable, "pay/fake_processor/billable"
+    autoload :Charge, "pay/fake_processor/charge"
+    autoload :Subscription, "pay/fake_processor/subscription"
+    autoload :Error, "pay/fake_processor/error"
+  end
+end

data/lib/pay/fake_processor/billable.rb

@@ -0,0 +1,60 @@
+module Pay
+  module FakeProcessor
+    class Billable
+      attr_reader :billable
+
+      delegate :processor_id,
+        :processor_id?,
+        :email,
+        :customer_name,
+        :card_token,
+        to: :billable
+
+      def initialize(billable)
+        @billable = billable
+      end
+
+      def customer
+        billable
+      end
+
+      def charge(amount, options = {})
+        billable.charges.create(
+          processor: :fake_processor,
+          processor_id: rand(100_000_000),
+          amount: amount,
+          card_type: :fake,
+          card_last4: 1234,
+          card_exp_month: Date.today.month,
+          card_exp_year: Date.today.year
+        )
+      end
+
+      def subscribe(name: Pay.default_product_name, plan: Pay.default_plan_name, **options)
+        subscription = OpenStruct.new id: rand(1_000_000)
+        billable.create_pay_subscription(subscription, :fake_processor, name, plan, status: :active, quantity: options.fetch(:quantity, 1))
+      end
+
+      def update_card(payment_method_id)
+        billable.update(
+          card_type: :fake,
+          card_last4: 1234,
+          card_exp_month: Date.today.month,
+          card_exp_year: Date.today.year
+        )
+      end
+
+      def update_email!
+        # pass
+      end
+
+      def processor_subscription(subscription_id, options = {})
+        billable.subscriptions.find_by(processor: :fake_processor, processor_id: subscription_id)
+      end
+
+      def trial_end_date(subscription)
+        Date.today
+      end
+    end
+  end
+end

data/lib/pay/fake_processor/charge.rb

@@ -0,0 +1,21 @@
+module Pay
+  module FakeProcessor
+    class Charge
+      attr_reader :pay_charge
+
+      delegate :processor_id, :owner, to: :pay_charge
+
+      def initialize(pay_charge)
+        @pay_charge = pay_charge
+      end
+
+      def charge
+        pay_charge
+      end
+
+      def refund!(amount_to_refund)
+        pay_charge.update(amount_refunded: amount_to_refund)
+      end
+    end
+  end
+end

data/lib/pay/fake_processor/error.rb

@@ -0,0 +1,6 @@
+module Pay
+  module FakeProcessor
+    class Error < Pay::Error
+    end
+  end
+end

data/lib/pay/fake_processor/subscription.rb

@@ -0,0 +1,55 @@
+module Pay
+  module FakeProcessor
+    class Subscription
+      attr_reader :pay_subscription
+
+      delegate :canceled?,
+        :ends_at,
+        :on_trial?,
+        :owner,
+        :processor_subscription,
+        :processor_id,
+        :prorate,
+        :processor_plan,
+        :quantity?,
+        :quantity,
+        to: :pay_subscription
+
+      def initialize(pay_subscription)
+        @pay_subscription = pay_subscription
+      end
+
+      def cancel
+        pay_subscription.update(ends_at: Time.current.end_of_month)
+      end
+
+      def cancel_now!
+        pay_subscription.update(ends_at: Time.current, status: :canceled)
+      end
+
+      def on_grace_period?
+        canceled? && Time.zone.now < ends_at
+      end
+
+      def paused?
+        false
+      end
+
+      def pause
+        raise NotImplementedError, "FakeProcessor does not support pausing subscriptions"
+      end
+
+      def resume
+        unless on_grace_period?
+          raise StandardError, "You can only resume subscriptions within their grace period."
+        end
+
+        pay_subscription.update(ends_at: nil, status: :active)
+      end
+
+      def swap(plan)
+        pay_subscription.update(processor_plan: plan)
+      end
+    end
+  end
+end

data/lib/pay/paddle.rb

@@ -19,6 +19,7 @@ module Pay
     def self.setup
       ::PaddlePay.config.vendor_id = vendor_id
       ::PaddlePay.config.vendor_auth_code = vendor_auth_code
+      ::PaddlePay.config.environment = environment
 
       configure_webhooks
     end
@@ -31,6 +32,10 @@ module Pay
       find_value_by_name(:paddle, :vendor_auth_code)
     end
 
+    def self.environment
+      find_value_by_name(:paddle, :environment) || "production"
+    end
+
     def self.public_key_base64
       find_value_by_name(:paddle, :public_key_base64)
     end

data/lib/pay/paddle/error.rb

@@ -2,7 +2,7 @@ module Pay
   module Paddle
     class Error < Pay::Error
       def message
-        I18n.t("errors.paddle.#{result.code}", default: result.message)
+        I18n.t("errors.paddle.#{cause.code}", default: cause.message)
       end
     end
   end

data/lib/pay/paddle/subscription.rb

@@ -3,8 +3,10 @@ module Pay
     class Subscription
       attr_reader :pay_subscription
 
-      delegate :canceled?,
+      delegate :active?,
+        :canceled?,
         :ends_at,
+        :name,
         :on_trial?,
         :owner,
         :paddle_paused_from,
@@ -12,8 +14,10 @@ module Pay
         :processor_plan,
         :processor_subscription,
         :prorate,
+        :prorate?,
         :quantity,
         :quantity?,
+        :trial_ends_at,
         to: :pay_subscription
 
       def initialize(pay_subscription)

data/lib/pay/stripe/billable.rb

@@ -14,7 +14,7 @@ module Pay
 
       class << self
         def default_url_options
-          Rails.application.config.action_mailer.default_url_options
+          Rails.application.config.action_mailer.default_url_options || {}
         end
       end
 
@@ -194,6 +194,7 @@ module Pay
       #
       def checkout(**options)
         args = {
+          customer: processor_id,
           payment_method_types: ["card"],
           mode: "payment",
           # These placeholder URLs will be replaced in a following step.
@@ -232,6 +233,14 @@ module Pay
           **options
         )
       end
+
+      def billing_portal(**options)
+        args = {
+          customer: processor_id,
+          return_url: options[:return_url] || root_url
+        }
+        ::Stripe::BillingPortal::Session.create(args.merge(options))
+      end
     end
   end
 end

data/lib/pay/stripe/error.rb

@@ -2,7 +2,7 @@ module Pay
   module Stripe
     class Error < Pay::Error
       def message
-        I18n.t("errors.stripe.#{result.code}", default: result.message)
+        I18n.t("errors.stripe.#{cause.code}", default: cause.message)
       end
     end
   end

data/lib/pay/stripe/merchant.rb

@@ -0,0 +1,28 @@
+module Pay
+  module Stripe
+    module Merchant
+      included do
+        store_accessor :stripe_connect_account_id
+      end
+
+      def create_account(**options)
+        defaults = {
+          type: "standard"
+        }
+
+        stripe_account = ::Stripe::Account.create(defaults.merge(options))
+        update(stripe_connect_account_id: stripe_account.id)
+        stripe_account
+      end
+
+      def account_link(refresh_url:, return_url:, type: "account_onboarding", **options)
+        Stripe::AccountLink.create({
+          account: stripe_connect_account_id,
+          refresh_url: refresh_url,
+          return_url: return_url,
+          type: type,
+        })
+      end
+    end
+  end
+end

data/lib/pay/stripe/subscription.rb

@@ -3,16 +3,20 @@ module Pay
     class Subscription
       attr_reader :pay_subscription
 
-      delegate :canceled?,
+      delegate :active?,
+        :canceled?,
         :ends_at,
+        :name,
         :on_trial?,
         :owner,
-        :processor_subscription,
         :processor_id,
-        :prorate,
         :processor_plan,
-        :quantity?,
+        :processor_subscription,
+        :prorate,
+        :prorate?,
         :quantity,
+        :quantity?,
+        :trial_ends_at,
         to: :pay_subscription
 
       def initialize(pay_subscription)

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

@@ -9,7 +9,7 @@ module Pay
           # Couldn't find user, we can skip
           return unless billable.present?
 
-          billable.sync_card_from_stripe
+          Pay::Stripe::Billable.new(billable).sync_card_from_stripe
         end
       end
     end

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

@@ -9,7 +9,7 @@ module Pay
           # Couldn't find user, we can skip
           return unless billable.present?
 
-          billable.sync_card_from_stripe
+          Pay::Stripe::Billable.new(billable).sync_card_from_stripe
         end
       end
     end

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "2.6.0"
+  VERSION = "2.6.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.5
 platform: ruby
 authors:
 - Jason Charnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -166,6 +166,11 @@ files:
 - lib/pay/engine.rb
 - lib/pay/env.rb
 - lib/pay/errors.rb
+- lib/pay/fake_processor.rb
+- lib/pay/fake_processor/billable.rb
+- lib/pay/fake_processor/charge.rb
+- lib/pay/fake_processor/error.rb
+- lib/pay/fake_processor/subscription.rb
 - lib/pay/paddle.rb
 - lib/pay/paddle/billable.rb
 - lib/pay/paddle/charge.rb
@@ -183,6 +188,7 @@ files:
 - lib/pay/stripe/billable.rb
 - lib/pay/stripe/charge.rb
 - lib/pay/stripe/error.rb
+- lib/pay/stripe/merchant.rb
 - lib/pay/stripe/subscription.rb
 - lib/pay/stripe/webhooks/charge_refunded.rb
 - lib/pay/stripe/webhooks/charge_succeeded.rb