pay 2.1.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 026eec665e0972815526e10a0f8082c9dc7de99c8df6dfe890aa34630f902828
-  data.tar.gz: 44a6a608fcc55f9d235191716b78a55b1d3f595e8e9233f630ecdd1b3ca0d3e8
+  metadata.gz: 6b0dc3430e6f89e4c1516a122bde97173ee5bdb1bfa835bb968b36083b633c4f
+  data.tar.gz: 0dbd1c62002fa67fbf9e78591f52199c9322e6d52868fb443e640f93dd2863d0
 SHA512:
-  metadata.gz: cb4cf20991b9ff113c6cad8d86df842bae567c4dc24d0a0c8b862ef8430380d36adfda3dfaaceaa0f28e2b84904cd35ee832981ec3a71c822e0f00ac008a17ad
-  data.tar.gz: 507a29aa827680ffb1dc36cf66142ad94d96f8aa25ead267dfb96fbbda9e431687eae4d410bd6bf7f3ecf8bc07a4d8ca4bf05441795f657a10ba713470b3c1e8
+  metadata.gz: d6e108e2377cfabdd8da381f225094d4f8f2e0fb25ca28dbadf0cfbfaad1bbafbbb1f4613c92ac0bd8dc0d87c4de14b21d32004ab31ab572588bef4926746f92
+  data.tar.gz: 68ebaeed4f068419a51860d853bd914ba6c5076e590bac85005feb431a404bb7ea8c3fbbe113876e0f6ec56ad539d43e698504b99aa5951bc76894d18961f8c6

data/README.md

@@ -2,17 +2,19 @@
 
 ## 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)
+[![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)
 
 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), API version [2019-03-14](https://stripe.com/docs/upgrades#2019-03-14) or higher required)
+- Stripe ([supports SCA](https://stripe.com/docs/strong-customer-authentication) using API version `2020-08-27`)
 - Braintree
 
 Want to add a new payment provider? Contributions are welcome and the instructions [are here](https://github.com/jasoncharnes/pay/wiki/New-Payment-Provider).
 
+**Check the CHANGELOG for any required migrations or changes needed if you're upgrading from a previous version of Pay.**
+
 ## Tutorial
 
 Want to see how Pay works? Check out our video getting started guide.
@@ -43,37 +45,21 @@ And then execute:
 bundle
 ```
 
-Or install it yourself as:
-
-```bash
-gem install pay
-```
-
-## Setup
-
-### Migrations
-
-This engine will create a subscription model and the neccessary migrations for the model you want to make "billable." The most common use case for the billable model is a User.
+#### Migrations
 
 To add the migrations to your application, run the following migration:
 
-`$ bin/rails pay:install:migrations`
-
-This will install three migrations:
+`bin/rails pay:install:migrations`
 
-- db/migrate/create_subscriptions.pay.rb
-- db/migrate/create_charges.pay.rb
-- db/migrate/add_status_to_subscriptions.pay.rb
+We also need to run migrations to add Pay to the User, Account, Team, etc models that we want to make payments in our app.
 
-You'll also need a model that can make payments. This is called a
-`Billable` model. The `pay` generator will add fields to the model and
-add the `Pay::Billable` module to it.
+`bin/rails g pay User`
 
-`$ bin/rails g pay User`
+This will generate a migration to add Pay fields to our User model and automatically includes the `Pay::Billable` module in our `User` model. Repeat this for all the models you want to make payments in your app.
 
-#### Run the Migrations
+Finally, run the migrations
 
-Finally, run the migrations with `$ rake db:migrate`
+`rake db:migrate`
 
 ####  Getting NoMethodError?
 
@@ -92,6 +78,8 @@ class User < ActiveRecord::Base
 end
 ```
 
+An `email` attribute or method on your `Billable` model is required.
+
 To sync over customer names, your `Billable` model should respond to the `first_name` and `last_name` methods. Pay will sync these over to your Customer objects in Stripe and Braintree.
 
 ## Configuration
@@ -251,13 +239,20 @@ def subscribe(name: 'default', plan: 'default', **options)
 end
 ```
 
+For example, you can pass the `quantity` option to subscribe to a plan with for per-seat pricing.
+
+```ruby
+
+user.subscribe(name: "default", plan: "default", quantity: 3)
+```
+
 ##### Name
 
 Name is an internally used name for the subscription.
 
 ##### Plan
 
-Plan is the plan ID from the payment processor.
+Plan is the plan ID or price ID from the payment processor. For example: `plan_xxxxx` or `price_xxxxx`
 
 ##### Options
 
@@ -511,6 +506,20 @@ You can also use the `STRIPE_PRIVATE_KEY` and `STRIPE_SIGNING_SECRET` environmen
 
 **To see how to use Stripe Elements JS & Devise, [click here](https://github.com/jasoncharnes/pay/wiki/Using-Stripe-Elements-and-Devise).**
 
+You need the following event types to trigger the webhook:
+
+```
+customer.subscription.updated
+customer.subscription.deleted
+customer.subscription.created
+payment_method.updated
+invoice.payment_action_required
+customer.updated
+customer.deleted
+charge.succeeded
+charge.refunded
+```
+
 ##### Strong Customer Authentication (SCA)
 
 Our Stripe integration **requires** the use of Payment Method objects to correctly support Strong Customer Authentication with Stripe. If you've previously been using card tokens, you'll need to upgrade your Javascript integration.
@@ -525,9 +534,7 @@ correctly for SCA payments.
 stripe listen --forward-to localhost:3000/pay/webhooks/stripe
 ```
 
-You should use `stripe.handleCardSetup` on the client to collect card information anytime you want to save the card and charge them later (adding a card, then charging them on the next page for example). Use `stripe.handleCardPayment` if you'd like to charge the customer immediately (think checking out of a shopping cart).
-
-The Javascript will now need to use createPaymentMethod instead of createToken. https://stripe.com/docs/js/payment_intents/create_payment_method
+You should use `stripe.confirmCardSetup` on the client to collect card information anytime you want to save the card and charge them later (adding a card, then charging them on the next page for example). Use `stripe.confirmCardPayment` if you'd like to charge the customer immediately (think checking out of a shopping cart).
 
 The Javascript also needs to have a PaymentIntent or SetupIntent created server-side and the ID passed into the Javascript to do this. That way it knows how to safely handle the card tokenization if it meets the SCA requirements.
 
@@ -545,6 +552,7 @@ If a user's email is updated and they have a `processor_id` set, Pay will enqueu
 
 It's important you set a queue_adapter for this to happen. If you don't, the code will be executed immediately upon user update. [More information here](https://guides.rubyonrails.org/v4.2/active_job_basics.html#backends)
 
+
 ## Contributors
 
 - [Jason Charnes](https://twitter.com/jmcharnes)
@@ -558,7 +566,10 @@ If you have an issue you'd like to submit, please do so using the issue tracker
 
 If you'd like to open a PR please make sure the following things pass:
 
-- `rake test`
+```ruby
+bin/rails db:test:prepare
+bin/rails test
+```
 
 ## License
 

data/Rakefile

@@ -14,27 +14,21 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
+
 load "rails/tasks/statistics.rake"
 
-require "bundler/gem_tasks"
+unless Rails.env.test?
+  require "bundler/gem_tasks"
+end
+
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
 task default: :test
-
-task :console do
-  require "irb"
-  require "irb/completion"
-  require "pay"
-  ARGV.clear
-  IRB.start
-end

data/app/controllers/pay/payments_controller.rb

@@ -1,6 +1,7 @@
 module Pay
   class PaymentsController < ApplicationController
     def show
+      @redirect_to = params[:back].presence || root_path
       @payment = Payment.from_id(params[:id])
     end
   end

data/app/mailers/pay/user_mailer.rb

@@ -44,8 +44,8 @@ module Pay
     private
 
     def to(user)
-      if user.respond_to?(:name)
-        "#{user.name} <#{user.email}>"
+      if user.respond_to?(:customer_name)
+        "#{user.customer_name} <#{user.email}>"
       else
         user.email
       end

data/app/views/pay/payments/show.html.erb

@@ -51,7 +51,7 @@
         </div>
       <% end %>
 
-      <%= link_to t("back"), root_path, class: "inline-block w-full px-4 py-3 bg-gray-200 hover:bg-gray-300 text-center text-gray-700 rounded-lg" %>
+      <%= link_to t("back"), @redirect_to, class: "inline-block w-full px-4 py-3 bg-gray-200 hover:bg-gray-300 text-center text-gray-700 rounded-lg" %>
     </div>
 
     <p class="text-center text-gray-500 text-sm">

data/db/migrate/20170205020145_create_pay_subscriptions.rb

@@ -1,7 +1,8 @@
 class CreatePaySubscriptions < ActiveRecord::Migration[4.2]
   def change
     create_table :pay_subscriptions do |t|
-      t.references :owner
+      # Some Billable objects use string as ID, add `type: :string` if needed
+      t.references :owner, polymorphic: true
       t.string :name, null: false
       t.string :processor, null: false
       t.string :processor_id, null: false

data/db/migrate/20170727235816_create_pay_charges.rb

@@ -1,6 +1,7 @@
 class CreatePayCharges < ActiveRecord::Migration[4.2]
   def change
     create_table :pay_charges do |t|
+      # Some Billable objects use string as ID, add `type: :string` if needed
       t.references :owner, polymorphic: true
       t.string :processor, null: false
       t.string :processor_id, null: false

data/lib/generators/active_record/pay_generator.rb

@@ -26,7 +26,7 @@ module ActiveRecord
         end
 
         indent_depth = class_path.size - 1
-        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+        content = content.split("\n").map { |line| "  " * indent_depth + line }.join("\n") << "\n"
 
         inject_into_class(model_path, class_path.last, content) if model_exists?
       end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class AddPayTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+class AddPayBillableTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     change_table :<%= table_name %> do |t|
 <%= migration_data -%>

data/lib/generators/pay/orm_helpers.rb

@@ -4,10 +4,9 @@ module Pay
   module Generators
     module OrmHelpers
       def model_contents
-        buffer = <<-CONTENT
+        <<-CONTENT
   include Pay::Billable
         CONTENT
-        buffer
       end
 
       private

data/lib/pay.rb

@@ -105,11 +105,17 @@ module Pay
   class BraintreeError < Error
     attr_reader :result
 
-    def initialize(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
 
@@ -118,7 +124,7 @@ module Pay
     end
 
     def message
-      "This payment attempt failed beacuse of an invalid payment method."
+      "This payment attempt failed because of an invalid payment method."
     end
   end
 

data/lib/pay/billable.rb

@@ -20,8 +20,8 @@ module Pay
       include Pay::Stripe::Billable if defined? ::Stripe
       include Pay::Braintree::Billable if defined? ::Braintree
 
-      has_many :charges, class_name: Pay.chargeable_class, foreign_key: :owner_id, inverse_of: :owner
-      has_many :subscriptions, class_name: Pay.subscription_class, foreign_key: :owner_id, inverse_of: :owner
+      has_many :charges, class_name: Pay.chargeable_class, foreign_key: :owner_id, inverse_of: :owner, as: :owner
+      has_many :subscriptions, class_name: Pay.subscription_class, foreign_key: :owner_id, inverse_of: :owner, as: :owner
 
       attribute :plan, :string
       attribute :quantity, :integer

data/lib/pay/braintree.rb

@@ -19,7 +19,7 @@ module Pay
 
       Pay.charge_model.include Pay::Braintree::Charge
       Pay.subscription_model.include Pay::Braintree::Subscription
-      Pay.billable_models.each { |model| model.include Pay::Stripe::Billable }
+      Pay.billable_models.each { |model| model.include Pay::Braintree::Billable }
     end
 
     def public_key

data/lib/pay/braintree/billable.rb

@@ -24,6 +24,8 @@ module Pay
 
           result.customer
         end
+      rescue ::Braintree::AuthorizationError
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
         raise BraintreeError, e.message
       end
@@ -42,6 +44,8 @@ module Pay
         raise BraintreeError.new(result), result.message unless result.success?
 
         save_braintree_transaction(result.transaction)
+      rescue ::Braintree::AuthorizationError
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
         raise BraintreeError, e.message
       end
@@ -67,6 +71,8 @@ module Pay
         raise BraintreeError.new(result), result.message unless result.success?
 
         create_subscription(result.subscription, "braintree", name, plan, status: :active)
+      rescue ::Braintree::AuthorizationError
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
         raise BraintreeError, e.message
       end
@@ -88,6 +94,8 @@ module Pay
         update_braintree_card_on_file result.payment_method
         update_subscriptions_to_payment_method(result.payment_method.token)
         true
+      rescue ::Braintree::AuthorizationError
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
         raise BraintreeError, e.message
       end

data/lib/pay/stripe.rb

@@ -12,6 +12,7 @@ module Pay
 
     def setup
       ::Stripe.api_key = private_key
+      ::Stripe.api_version = "2020-08-27"
       ::StripeEvent.signing_secret = signing_secret
 
       Pay.charge_model.include Pay::Stripe::Charge

data/lib/pay/stripe/billable.rb

@@ -48,17 +48,20 @@ module Pay
       #
       # Returns Pay::Subscription
       def create_stripe_subscription(name, plan, options = {})
+        quantity = options.delete(:quantity) || 1
         opts = {
           expand: ["pending_setup_intent", "latest_invoice.payment_intent"],
-          items: [plan: plan],
+          items: [plan: plan, quantity: quantity],
           off_session: true
         }.merge(options)
 
         # Inherit trial from plan unless trial override was specified
         opts[:trial_from_plan] = true unless opts[:trial_period_days]
 
-        stripe_sub = customer.subscriptions.create(opts)
-        subscription = create_subscription(stripe_sub, "stripe", name, plan, status: stripe_sub.status)
+        opts[:customer] = stripe_customer.id
+
+        stripe_sub = ::Stripe::Subscription.create(opts)
+        subscription = create_subscription(stripe_sub, "stripe", name, plan, status: stripe_sub.status, quantity: quantity)
 
         # No trial, card requires SCA
         if subscription.incomplete?
@@ -94,7 +97,7 @@ module Pay
       def update_stripe_email!
         customer = stripe_customer
         customer.email = email
-        customer.description = customer_name
+        customer.name = customer_name
         customer.save
       end
 
@@ -134,7 +137,7 @@ module Pay
       private
 
       def create_stripe_customer
-        customer = ::Stripe::Customer.create(email: email, description: customer_name)
+        customer = ::Stripe::Customer.create(email: email, name: customer_name)
         update(processor: "stripe", processor_id: customer.id)
 
         # Update the user's card on file if a token was passed in

data/lib/pay/stripe/subscription.rb

@@ -37,7 +37,7 @@ module Pay
         subscription = processor_subscription
         subscription.cancel_at_period_end = false
         subscription.plan = plan
-        subscription.prorate = prorate
+        subscription.proration_behavior = (prorate ? "create_prorations" : "none")
         subscription.trial_end = on_trial? ? trial_ends_at.to_i : "now"
         subscription.quantity = quantity if quantity?
         subscription.save

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "2.1.1"
+  VERSION = "2.2.2"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Jason Charnes
 - Chris Oliver
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,20 +73,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -233,7 +219,6 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20170205020145_create_pay_subscriptions.rb
-- db/migrate/20170503131610_add_fields_to_billable.rb
 - db/migrate/20170727235816_create_pay_charges.rb
 - db/migrate/20190816015720_add_status_to_pay_subscriptions.rb
 - lib/generators/active_record/pay_generator.rb
@@ -273,7 +258,7 @@ homepage: https://github.com/jasoncharnes/pay
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -288,8 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Ruby on Rails subscription engine.
 test_files: []

data/db/migrate/20170503131610_add_fields_to_billable.rb

@@ -1,16 +0,0 @@
-class AddFieldsToBillable < ActiveRecord::Migration[4.2]
-  def change
-    unless ActiveRecord::Base.connection.table_exists?(Pay.billable_table)
-      create_table Pay.billable_table.to_sym
-    end
-
-    add_column Pay.billable_table, :processor, :string
-    add_column Pay.billable_table, :processor_id, :string
-    add_column Pay.billable_table, :trial_ends_at, :datetime
-    add_column Pay.billable_table, :card_type, :string
-    add_column Pay.billable_table, :card_last4, :string
-    add_column Pay.billable_table, :card_exp_month, :string
-    add_column Pay.billable_table, :card_exp_year, :string
-    add_column Pay.billable_table, :extra_billing_info, :text
-  end
-end