pay 2.0.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 300877c7b5a4a24f3796a7fe32c6deff0c2851a9a43d2c30ea86b69892384865
-  data.tar.gz: 6c6a7b986a3fe4fd2731dcf21ee9d3adb1a4fb05f6cc07060b51a0aa50566459
+  metadata.gz: ba84d79847e4ef8659bcf7fce74b966c07bb93fa8e2f29f902a243c9d6e5c8bf
+  data.tar.gz: 78e829fc4d218aabee2544a969b184e29e2621bf0d965318d1b33e4e750ebae4
 SHA512:
-  metadata.gz: 2b0b709fb6e3a3f51b3f74774908775af8a9ef3ab71ca8b2981c9fc010ede85cf0b71d779659e0e3dfb185ba20dcc16d90b71140992bc5e7241711be9334add2
-  data.tar.gz: e22547e8e914cb70cc75d95bfd8414d1c5ca203e2cc7a8717416296c538b2123762499841b34aff655d74d7c7548a71d3f5de9f467af91acf6ee36d223f3b7d1
+  metadata.gz: 2c044f842d680969455c49a24124c48e2e80a1b06486db11782032ebdd0db810c1836151f97087bb1e06e083106524e9250520768a96462ff24fdc0723a4c5dd
+  data.tar.gz: 7dbe7db2d4c6161b9516f73a1496092b6ffb9ebf2c5471fe061ccfd79b1335bc0a3238c1e407f621e3717cbd0cf28496790153b884a8540557428b6cf33c665c

data/README.md

@@ -1,10 +1,8 @@
-<p align="center"><img src="logo.png"></p>
+<p align="center"><img src="docs/logo.svg" height="50px"></p>
 
-## Pay
+## Pay - Payments engine for Ruby on Rails
 
-### Payments engine for Ruby on Rails
-
-[![Build Status](https://github.com/excid3/pay/workflows/Tests/badge.svg)](https://github.com/excid3/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.
 
@@ -15,6 +13,14 @@ Pay is a payments engine for Ruby on Rails 4.2 and higher.
 
 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.
+
+<a href="https://www.youtube.com/watch?v=hYlOmqyJIgc" target="_blank"><img width="50%" src="http://i3.ytimg.com/vi/hYlOmqyJIgc/maxresdefault.jpg"></a>
+
 ## Installation
 
 Add these lines to your application's Gemfile:
@@ -39,52 +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`
+`bin/rails pay:install:migrations`
 
-This will install four migrations:
+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.
 
-- db/migrate/create_subscriptions.pay.rb
-- db/migrate/add_fields_to_users.pay.rb
-- db/migrate/create_charges.pay.rb
-- db/migrate/add_status_to_subscriptions.pay.rb
+`bin/rails g pay User`
 
-### The Billable Module
+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.
 
-To enable payments for a model, you simply include the `Pay::Billable`
-module in it. By default, we assume this is `User`.
+Finally, run the migrations
 
-If you'd like to use a different model, you can configure it in an
-initializer:
-
-```ruby
-Pay.setup do |config|
-  # Make the billable class the same name as your ActiveRecord model
-  config.billable_class = "Team"
-
-  # Make the billable table the same name as your ActiveRecord table name for the model
-  # This is optional.
-  # Once you update the billable class, the table name will use the ActiveRecord inflected table name
-  config.billable_table = "teams"
-end
-```
-
-#### Run the Migrations
-
-Finally, run the migrations with `$ rake db:migrate`
+`rake db:migrate`
 
 ####  Getting NoMethodError?
 
@@ -92,78 +67,9 @@ Finally, run the migrations with `$ rake db:migrate`
 
 Fully restart your Rails application `bin/spring stop && rails s`
 
-## Payment Providers
-
-We support both Stripe and Braintree and make our best attempt to
-standardize the two. 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.
-
-#### Braintree
-
-```yaml
-development:
-  braintree:
-    private_key: xxxx
-    public_key: yyyy
-    merchant_id: zzzz
-    environment: sandbox
-```
-
-#### Stripe
-
-You'll need to add your private Stripe API key to your Rails secrets `config/secrets.yml`, credentials `rails credentials:edit`
-
-```yaml
-development:
-  stripe:
-    private_key: xxxx
-    public_key: yyyy
-    signing_secret: zzzz
-```
-
-You can also use the `STRIPE_PRIVATE_KEY` and `STRIPE_SIGNING_SECRET` environment variables.
-
-**To see how to use Stripe Elements JS & Devise, [click here](https://github.com/jasoncharnes/pay/wiki/Using-Stripe-Elements-and-Devise).**
-
-##### 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.
-
-Subscriptions that require SCA are marked as `incomplete` by default.
-Once payment is authenticated, Stripe will send a webhook updating the
-status of the subscription. You'll need to use the [Stripe CLI](https://github.com/stripe/stripe-cli) to forward
-webhooks to your application to make sure your subscriptions work
-correctly for SCA payments.
-
-```bash
-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
-
-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.
-
-**Payment Confirmations**
-
-Sometimes you'll have a payment that requires extra authentication. In this case, Pay provides a webhook and action for handling these payments. It will automatically email the customer and provide a link with the PaymentIntent ID in the url where the customer will be asked to fill out their name and card number to confirm the payment. Once done, they'll be redirected back to your application.
-
-If you'd like to change the views of the payment confirmation page, you can install the views using the generator and modify the template.
-
-[<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)
-
-#### 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.
-
-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)
-
 ## Usage
 
-Include the `Pay::Billable` module in the model you want to know about subscriptions.
+The `Pay::Billable` module should be included in the models you want to make payments and subscriptions.
 
 ```ruby
 # app/models/user.rb
@@ -172,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
@@ -180,9 +88,6 @@ Need to make some changes to how Pay is used? You can create an initializer `con
 
 ```ruby
 Pay.setup do |config|
-  config.billable_class = 'User'
-  config.billable_table = 'users'
-
   config.chargeable_class = 'Pay::Charge'
   config.chargeable_table = 'pay_charges'
 
@@ -255,6 +160,7 @@ Emails can be enabled/disabled using the `send_emails` configuration option (ena
 - When a charge was refunded
 - When a subscription is about to renew
 
+
 ## Billable API
 
 #### Trials
@@ -310,6 +216,9 @@ You may pass optional arguments that will be directly passed on to
 either Stripe or Braintree. You can use these options to charge
 different currencies, etc.
 
+On failure, a `Pay::Error` will be raised with details about the payment
+failure.
+
 #### Creating a Subscription
 
 ```ruby
@@ -330,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
 
@@ -555,6 +471,74 @@ If you just want to modify where the engine mounts it's routes then you can chan
 config.routes_path = '/secret-webhook-path'
 ```
 
+## Payment Providers
+
+We support both Stripe and Braintree and make our best attempt to
+standardize the two. 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.
+
+#### Braintree
+
+```yaml
+development:
+  braintree:
+    private_key: xxxx
+    public_key: yyyy
+    merchant_id: zzzz
+    environment: sandbox
+```
+
+#### Stripe
+
+You'll need to add your private Stripe API key to your Rails secrets `config/secrets.yml`, credentials `rails credentials:edit`
+
+```yaml
+development:
+  stripe:
+    private_key: xxxx
+    public_key: yyyy
+    signing_secret: zzzz
+```
+
+You can also use the `STRIPE_PRIVATE_KEY` and `STRIPE_SIGNING_SECRET` environment variables.
+
+**To see how to use Stripe Elements JS & Devise, [click here](https://github.com/jasoncharnes/pay/wiki/Using-Stripe-Elements-and-Devise).**
+
+##### 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.
+
+Subscriptions that require SCA are marked as `incomplete` by default.
+Once payment is authenticated, Stripe will send a webhook updating the
+status of the subscription. You'll need to use the [Stripe CLI](https://github.com/stripe/stripe-cli) to forward
+webhooks to your application to make sure your subscriptions work
+correctly for SCA payments.
+
+```bash
+stripe listen --forward-to localhost:3000/pay/webhooks/stripe
+```
+
+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.
+
+**Payment Confirmations**
+
+Sometimes you'll have a payment that requires extra authentication. In this case, Pay provides a webhook and action for handling these payments. It will automatically email the customer and provide a link with the PaymentIntent ID in the url where the customer will be asked to fill out their name and card number to confirm the payment. Once done, they'll be redirected back to your application.
+
+If you'd like to change the views of the payment confirmation page, you can install the views using the generator and modify the template.
+
+[<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)
+
+#### 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.
+
+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)

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/webhooks/braintree_controller.rb

@@ -16,7 +16,7 @@ module Pay
         end
 
         render json: {success: true}, status: :ok
-      rescue ::Braintree::InvalidSignature => e
+      rescue ::Braintree::InvalidSignature
         head :ok
       end
 
@@ -29,11 +29,11 @@ module Pay
         pay_subscription = Pay.subscription_model.find_by(processor: :braintree, processor_id: subscription.id)
         return unless pay_subscription.present?
 
-        user = pay_subscription.owner
-        charge = user.save_braintree_transaction(subscription.transactions.first)
+        billable = pay_subscription.owner
+        charge = billable.save_braintree_transaction(subscription.transactions.first)
 
         if Pay.send_emails
-          Pay::UserMailer.receipt(user, charge).deliver_later
+          Pay::UserMailer.receipt(billable, charge).deliver_later
         end
       end
 
@@ -41,11 +41,14 @@ module Pay
         subscription = event.subscription
         return if subscription.nil?
 
-        user = Pay.user_model.find_by(processor: :braintree, processor_id: subscription.id)
-        return unless user.present?
+        pay_subscription = Pay.subscription_model.find_by(processor: :braintree, processor_id: subscription.id)
+        return unless pay_subscription.present?
+
+        billable = pay_subscription.owner
+        return if billable.nil?
 
         # User canceled or failed to make payments
-        user.update(braintree_subscription_id: nil)
+        billable.update(braintree_subscription_id: nil)
       end
 
       def subscription_trial_ended(event)

data/app/jobs/pay/email_sync_job.rb

@@ -2,11 +2,11 @@ module Pay
   class EmailSyncJob < ApplicationJob
     queue_as :default
 
-    def perform(id)
-      billable = Pay.user_model.find(id)
+    def perform(id, class_name)
+      billable = class_name.constantize.find(id)
       billable.sync_email_with_processor
     rescue ActiveRecord::RecordNotFound
-      Rails.logger.info "Couldn't find a #{Pay.billable_class} with ID = #{id}"
+      Rails.logger.info "Couldn't find a #{class_name} with ID = #{id}"
     end
   end
 end

data/app/mailers/pay/user_mailer.rb

@@ -9,7 +9,7 @@ module Pay
 
       mail(
         to: to(user),
-        subject: Pay.email_receipt_subject,
+        subject: Pay.email_receipt_subject
       )
     end
 
@@ -18,7 +18,7 @@ module Pay
 
       mail(
         to: to(user),
-        subject: Pay.email_refund_subject,
+        subject: Pay.email_refund_subject
       )
     end
 
@@ -27,7 +27,7 @@ module Pay
 
       mail(
         to: to(user),
-        subject: Pay.email_renewing_subject,
+        subject: Pay.email_renewing_subject
       )
     end
 
@@ -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/models/pay/charge.rb

@@ -3,7 +3,7 @@ module Pay
     self.table_name = Pay.chargeable_table
 
     # Associations
-    belongs_to :owner, class_name: Pay.billable_class, foreign_key: :owner_id
+    belongs_to :owner, polymorphic: true
 
     # Scopes
     scope :sorted, -> { order(created_at: :desc) }

data/app/models/pay/subscription.rb

@@ -5,7 +5,7 @@ module Pay
     STATUSES = %w[incomplete incomplete_expired trialing active past_due canceled unpaid]
 
     # Associations
-    belongs_to :owner, class_name: Pay.billable_class, foreign_key: :owner_id
+    belongs_to :owner, polymorphic: true
 
     # Validations
     validates :name, presence: true

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,7 +1,8 @@
 class CreatePayCharges < ActiveRecord::Migration[4.2]
   def change
     create_table :pay_charges do |t|
-      t.references :owner
+      # 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
       t.integer :amount, null: false

data/lib/generators/active_record/pay_generator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "rails/generators/active_record"
+require "generators/pay/orm_helpers"
+
+module ActiveRecord
+  module Generators
+    class PayGenerator < 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 "migration.rb", "#{migration_path}/add_pay_billable_to_#{table_name}.rb", migration_version: migration_version
+        end
+        # TODO: Throw error here that model should already exist if it doesn't
+      end
+
+      def inject_pay_billable_content
+        content = model_contents
+
+        class_path = if namespaced?
+          class_name.to_s.split("::")
+        else
+          [class_name]
+        end
+
+        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) if model_exists?
+      end
+
+      def migration_data
+        <<RUBY
+      t.string :processor
+      t.string :processor_id
+      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
+RUBY
+      end
+
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def migration_version
+        if rails5_and_up?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+    end
+  end
+end

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

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

data/lib/generators/pay/orm_helpers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Pay
+  module Generators
+    module OrmHelpers
+      def model_contents
+        buffer = <<-CONTENT
+  include Pay::Billable
+        CONTENT
+        buffer
+      end
+
+      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
+    end
+  end
+end

data/lib/generators/pay/pay_generator.rb

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

data/lib/pay.rb

@@ -51,7 +51,23 @@ module Pay
     yield self
   end
 
+  def self.billable_models
+    Pay::Billable.includers
+  end
+
+  def self.find_billable(processor:, processor_id:)
+    billable_models.each do |model|
+      if (record = model.find_by(processor: processor, processor_id: processor_id))
+        return record
+      end
+    end
+
+    nil
+  end
+
   def self.user_model
+    ActiveSupport::Deprecation.warn("Pay.user_model is deprecated and will be removed in v3. Instead, use `Pay.billable_models` now to support more than one billable model.")
+
     if Rails.application.config.cache_classes
       @@user_model ||= billable_class.constantize
     else
@@ -86,6 +102,20 @@ module Pay
   class Error < StandardError
   end
 
+  class BraintreeError < Error
+    attr_reader :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
 

data/lib/pay/billable.rb

@@ -4,8 +4,21 @@ module Pay
   module Billable
     extend ActiveSupport::Concern
 
-    included do
+    # Keep track of which Billable models we have
+    class << self
+      attr_reader :includers
+    end
+
+    def self.included(base = nil, &block)
+      @includers ||= []
+      @includers << base if base
+      super
+    end
+
+    included do |base|
       include Pay::Billable::SyncEmail
+      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
@@ -112,7 +125,7 @@ module Pay
     private
 
     def check_for_processor
-      raise StandardError, "No payment processor selected. Make sure to set the #{Pay.billable_class}'s `processor` attribute to either 'stripe' or 'braintree'." unless processor
+      raise StandardError, "No payment processor selected. Make sure to set the #{self.class.name}'s `processor` attribute to either 'stripe' or 'braintree'." unless processor
     end
 
     # Used for creating a Pay::Subscription in the database
@@ -125,7 +138,7 @@ module Pay
         processor_id: subscription.id,
         processor_plan: plan,
         trial_ends_at: send("#{processor}_trial_end_date", subscription),
-        ends_at: nil,
+        ends_at: nil
       )
       subscriptions.create!(options)
     end

data/lib/pay/billable/sync_email.rb

@@ -32,7 +32,7 @@ module Pay
         # Only update if the processor id is the same
         # This prevents duplicate API hits if this is their first time
         if processor_id? && !saved_change_to_processor_id? && saved_change_to_email?
-          EmailSyncJob.perform_later(id)
+          EmailSyncJob.perform_later(id, self.class.name)
         end
       end
     end

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.user_model.include Pay::Braintree::Billable
+      Pay.billable_models.each { |model| model.include Pay::Braintree::Billable }
     end
 
     def public_key

data/lib/pay/braintree/billable.rb

@@ -12,9 +12,9 @@ module Pay
             email: email,
             first_name: try(:first_name),
             last_name: try(:last_name),
-            payment_method_nonce: card_token,
+            payment_method_nonce: card_token
           )
-          raise Pay::Error.new(result.message) unless result.success?
+          raise BraintreeError.new(result), result.message unless result.success?
 
           update(processor: "braintree", processor_id: result.customer.id)
 
@@ -24,8 +24,10 @@ module Pay
 
           result.customer
         end
+      rescue ::Braintree::AuthorizationError => e
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise BraintreeError, e.message
       end
 
       # Handles Billable#charge
@@ -35,13 +37,17 @@ module Pay
         args = {
           amount: amount / 100.0,
           customer_id: customer.id,
-          options: {submit_for_settlement: true},
+          options: {submit_for_settlement: true}
         }.merge(options)
 
         result = gateway.transaction.sale(args)
-        save_braintree_transaction(result.transaction) if result.success?
-      rescue ::BraintreeError => e
-        raise Error, e.message
+        raise BraintreeError.new(result), result.message unless result.success?
+
+        save_braintree_transaction(result.transaction)
+      rescue ::Braintree::AuthorizationError => e
+        raise BraintreeAuthorizationError
+      rescue ::Braintree::BraintreeError => e
+        raise BraintreeError, e.message
       end
 
       # Handles Billable#subscribe
@@ -62,11 +68,13 @@ module Pay
         )
 
         result = gateway.subscription.create(subscription_options)
-        raise Pay::Error.new(result.message) unless result.success?
+        raise BraintreeError.new(result), result.message unless result.success?
 
         create_subscription(result.subscription, "braintree", name, plan, status: :active)
+      rescue ::Braintree::AuthorizationError => e
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise BraintreeError, e.message
       end
 
       # Handles Billable#update_card
@@ -78,23 +86,25 @@ module Pay
           payment_method_nonce: token,
           options: {
             make_default: true,
-            verify_card: true,
+            verify_card: true
           }
         )
-        raise Pay::Error.new(result.message) unless result.success?
+        raise BraintreeError.new(result), result.message unless result.success?
 
         update_braintree_card_on_file result.payment_method
         update_subscriptions_to_payment_method(result.payment_method.token)
         true
+      rescue ::Braintree::AuthorizationError => e
+        raise BraintreeAuthorizationError
       rescue ::Braintree::BraintreeError => e
-        raise Error, e.message
+        raise BraintreeError, e.message
       end
 
       def update_braintree_email!
         braintree_customer.update(
           email: email,
           first_name: try(:first_name),
-          last_name: try(:last_name),
+          last_name: try(:last_name)
         )
       end
 
@@ -171,7 +181,7 @@ module Pay
             card_type: payment_method.card_type,
             card_last4: payment_method.last_4,
             card_exp_month: payment_method.expiration_month,
-            card_exp_year: payment_method.expiration_year,
+            card_exp_year: payment_method.expiration_year
           }
 
         when "paypal_account"
@@ -179,7 +189,7 @@ module Pay
             card_type: "PayPal",
             card_last4: transaction.paypal_details.payer_email,
             card_exp_month: nil,
-            card_exp_year: nil,
+            card_exp_year: nil
           }
 
         when "android_pay_card"
@@ -188,7 +198,7 @@ module Pay
             card_type: payment_method.source_card_type,
             card_last4: payment_method.source_card_last_4,
             card_exp_month: payment_method.expiration_month,
-            card_exp_year: payment_method.expiration_year,
+            card_exp_year: payment_method.expiration_year
           }
 
         when "venmo_account"
@@ -196,7 +206,7 @@ module Pay
             card_type: "Venmo",
             card_last4: transaction.venmo_account_details.username,
             card_exp_month: nil,
-            card_exp_year: nil,
+            card_exp_year: nil
           }
 
         when "apple_pay_card"
@@ -205,7 +215,7 @@ module Pay
             card_type: payment_method.card_type,
             card_last4: payment_method.last_4,
             card_exp_month: payment_method.expiration_month,
-            card_exp_year: payment_method.expiration_year,
+            card_exp_year: payment_method.expiration_year
           }
 
         else

data/lib/pay/braintree/subscription.rb

@@ -13,7 +13,7 @@ module Pay
           update(status: :canceled, ends_at: trial_ends_at)
         else
           gateway.subscription.update(subscription.id, {
-            number_of_billing_cycles: subscription.current_billing_cycle,
+            number_of_billing_cycles: subscription.current_billing_cycle
           })
           update(status: :canceled, ends_at: subscription.billing_period_end_date.to_date)
         end
@@ -45,7 +45,7 @@ module Pay
 
           gateway.subscription.update(subscription.id, {
             never_expires: true,
-            number_of_billing_cycles: nil,
+            number_of_billing_cycles: nil
           })
         end
 
@@ -80,8 +80,8 @@ module Pay
           never_expires: true,
           number_of_billing_cycles: nil,
           options: {
-            prorate_charges: prorate?,
-          },
+            prorate_charges: prorate?
+          }
         })
 
         if result.success?
@@ -159,10 +159,10 @@ module Pay
                 {
                   inherited_from_id: "plan-credit",
                   amount: discount.amount,
-                  number_of_billing_cycles: discount.number_of_billing_cycles,
-                },
-              ],
-            },
+                  number_of_billing_cycles: discount.number_of_billing_cycles
+                }
+              ]
+            }
           }
         end
 

data/lib/pay/receipts.rb

@@ -20,7 +20,7 @@ module Pay
         company: {
           name: Pay.business_name,
           address: Pay.business_address,
-          email: Pay.support_email,
+          email: Pay.support_email
         },
         line_items: line_items
       )
@@ -32,7 +32,7 @@ module Pay
         ["Account Billed", "#{owner.name} (#{owner.email})"],
         ["Product", product],
         ["Amount", ActionController::Base.helpers.number_to_currency(amount / 100.0)],
-        ["Charged to", charged_to],
+        ["Charged to", charged_to]
       ]
       line_items << ["Additional Info", owner.extra_billing_info] if owner.extra_billing_info?
       line_items

data/lib/pay/stripe.rb

@@ -12,11 +12,11 @@ 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
       Pay.subscription_model.include Pay::Stripe::Subscription
-      Pay.user_model.include Pay::Stripe::Billable
     end
 
     def public_key

data/lib/pay/stripe/billable.rb

@@ -17,7 +17,7 @@ module Pay
       def create_setup_intent
         ::Stripe::SetupIntent.create(
           customer: processor_id,
-          usage: :off_session,
+          usage: :off_session
         )
       end
 
@@ -32,7 +32,7 @@ module Pay
           confirmation_method: :automatic,
           currency: "usd",
           customer: customer.id,
-          payment_method: customer.invoice_settings.default_payment_method,
+          payment_method: customer.invoice_settings.default_payment_method
         }.merge(options)
 
         payment_intent = ::Stripe::PaymentIntent.create(args)
@@ -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],
-          off_session: true,
+          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?

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/stripe/webhooks.rb

@@ -1,5 +1,5 @@
 require "stripe_event"
-Dir[File.join(__dir__, "webhooks", "**", "*.rb")].each { |file| require file }
+Dir[File.join(__dir__, "webhooks", "**", "*.rb")].sort.each { |file| require file }
 
 StripeEvent.configure do |events|
   # Listen to the charge event to make sure we get non-subscription

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

@@ -4,23 +4,20 @@ module Pay
       class ChargeSucceeded
         def call(event)
           object = event.data.object
-          user = Pay.user_model.find_by(
-            processor: :stripe,
-            processor_id: object.customer
-          )
+          billable = Pay.find_billable(processor: :stripe, processor_id: object.customer)
 
-          return unless user.present?
-          return if user.charges.where(processor_id: object.id).any?
+          return unless billable.present?
+          return if billable.charges.where(processor_id: object.id).any?
 
-          charge = create_charge(user, object)
-          notify_user(user, charge)
+          charge = create_charge(billable, object)
+          notify_user(billable, charge)
           charge
         end
 
         def create_charge(user, object)
           charge = user.charges.find_or_initialize_by(
             processor: :stripe,
-            processor_id: object.id,
+            processor_id: object.id
           )
 
           charge.update(

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

@@ -4,23 +4,23 @@ module Pay
       class CustomerDeleted
         def call(event)
           object = event.data.object
-          user = Pay.user_model.find_by(processor: :stripe, processor_id: object.id)
+          billable = Pay.find_billable(processor: :stripe, processor_id: object.id)
 
           # Couldn't find user, we can skip
-          return unless user.present?
+          return unless billable.present?
 
-          user.update(
+          billable.update(
             processor_id: nil,
             trial_ends_at: nil,
             card_type: nil,
             card_last4: nil,
             card_exp_month: nil,
-            card_exp_year: nil,
+            card_exp_year: nil
           )
 
-          user.subscriptions.update_all(
+          billable.subscriptions.update_all(
             trial_ends_at: nil,
-            ends_at: Time.zone.now,
+            ends_at: Time.zone.now
           )
         end
       end

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

@@ -4,12 +4,12 @@ module Pay
       class CustomerUpdated
         def call(event)
           object = event.data.object
-          user = Pay.user_model.find_by(processor: :stripe, processor_id: object.id)
+          billable = Pay.find_billable(processor: :stripe, processor_id: object.id)
 
           # Couldn't find user, we can skip
-          return unless user.present?
+          return unless billable.present?
 
-          user.sync_card_from_stripe
+          billable.sync_card_from_stripe
         end
       end
     end

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

@@ -4,12 +4,12 @@ module Pay
       class PaymentMethodUpdated
         def call(event)
           object = event.data.object
-          user = Pay.user_model.find_by(processor: :stripe, processor_id: object.customer)
+          billable = Pay.find_billable(processor: :stripe, processor_id: object.customer)
 
           # Couldn't find user, we can skip
-          return unless user.present?
+          return unless billable.present?
 
-          user.sync_card_from_stripe
+          billable.sync_card_from_stripe
         end
       end
     end

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

@@ -8,12 +8,15 @@ module Pay
           # We may already have the subscription in the database, so we can update that record
           subscription = Pay.subscription_model.find_by(processor: :stripe, processor_id: object.id)
 
+          # Create the subscription in the database if we don't have it already
           if subscription.nil?
             # The customer should already be in the database
-            owner = Pay.user_model.find_by(processor: :stripe, processor_id: object.customer)
+            owner = Pay.find_billable(processor: :stripe, processor_id: object.customer)
 
-            Rails.logger.error("[Pay] Unable to find #{Pay.user_model} with processor: :stripe and processor_id: '#{object.customer}'")
-            return if owner.nil?
+            if owner.nil?
+              Rails.logger.error("[Pay] Unable to find Pay::Billable with processor: :stripe and processor_id: '#{object.customer}'. Searched these models: #{Pay.billable_models.join(", ")}")
+              return
+            end
 
             subscription = Pay.subscription_model.new(owner: owner)
           end

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "2.0.3"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Jason Charnes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-09-01 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,10 +219,13 @@ 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
+- lib/generators/active_record/templates/migration.rb
 - lib/generators/pay/email_views_generator.rb
+- lib/generators/pay/orm_helpers.rb
+- lib/generators/pay/pay_generator.rb
 - lib/generators/pay/views_generator.rb
 - lib/pay.rb
 - lib/pay/billable.rb
@@ -284,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Ruby on Rails subscription engine.

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