pay 2.7.0 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d696d24ee2bb2b4827f6d6e31db738752ebb2eadca4ea0e79144518fc9375be9
-  data.tar.gz: 8aad550b117bee7e28c9231832f4f344c37054db4f1a7d0176f034c780d0abed
+  metadata.gz: 2cb954b3125acb413cdebfcf57687b4ff9f33987c0500dd72f350c293f491322
+  data.tar.gz: b4f9b23d452a3ab76b21902ebcad03b2c927a7e7eb17f58c9ac06d3df22232a3
 SHA512:
-  metadata.gz: 5dc610b8d7b67ed4073fea783b290d3cd6ada3f4df1ed7bac26a0c4770f4a5ab854bf492fe6541f14b069ae61b10369024689a9f832d625ba2201a14deb24fc1
-  data.tar.gz: 3801e3d1da5a833869ed46d28e04d633df5e1b55e51900bcae1a8b437663b93ee1b5ab45698cb54e00a145fb1752cb4c195ec877070b367b79d8c3b03ce81e8d
+  metadata.gz: 60d31163be2531db82eb4eb1cd6218f83e3b88d4a2a18821f4f88f19465f9e6bf2c7215f4a3ac00348582f98b3122f3820a54bdb6d19e338d6d37e68b14e0803
+  data.tar.gz: 6cc782accfeea3325fb93c6c15d3044efb08de166a07c90f868fc202cbc99d6fd9eda5d07db8cb97f14edff4c1d257be6261d408deafc8d967e399b6107e1cf5

data/README.md

@@ -2,7 +2,7 @@
 
 ## 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">
 
@@ -51,61 +51,49 @@ 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.
+Next, we need to add migrations to your application, run the following migration:
 
-```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:
-
-`bin/rails pay:install:migrations`
+````bash
+bin/rails pay:install:migrations
+````
 
->If your models rely on non integer ids (uuids for example) you will need to alter the `create_pay_subscriptions` and `create_pay_charges` migrations to ensure the `owner_id` column's type matches the model's id's format.
-> As commented in the migrations adding a type parameter to the `t.references :owner` line will ensure the `owner_id` column is of the correct type.
+>If your models rely on non integer ids (uuids for example) you will need to alter the `create_pay_subscriptions` and `create_pay_charges` 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.
 
-`bin/rails g pay User`
+```bash
+bin/rails g pay:billable 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.
 
-Finally, run the migrations
-
-`rake db:migrate`
+**Note:** An `email` attribute or method on your `Billable` model is required.
 
-####  Getting NoMethodError?
+To sync 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.
 
-`NoMethodError (undefined method 'stripe_customer' for #<User:0x00007fbc34b9bf20>)`
+Finally, run the migrations
 
-Fully restart your Rails application `bin/spring stop && rails s`
+```bash
+bin/rails db:migrate
+```
 
-## Usage
+> If you run into `NoMethodError (undefined method 'stripe_customer' for #<User:0x00007fbc34b9bf20>)`, fully restart your Rails application `bin/spring stop && rails s`
 
-The `Pay::Billable` module should be included in the models you want to make payments and subscriptions.
+Lastly, make sure you've configured your ActionMailer default_url_options so Pay can generate links to for features like Stripe Checkout.
 
 ```ruby
-# app/models/user.rb
-class User < ActiveRecord::Base
-  include Pay::Billable
-end
+# config/application.rb
+config.action_mailer.default_url_options = { host: "example.com" }
 ```
 
-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
 
 Need to make some changes to how Pay is used? You can create an initializer `config/initializers/pay.rb`
 
 ```ruby
 Pay.setup do |config|
-  config.chargeable_class = 'Pay::Charge'
-  config.chargeable_table = 'pay_charges'
+  # config.chargeable_class = 'Pay::Charge'
+  # config.chargeable_table = 'pay_charges'
 
   # For use in the receipt/refund/renewal mailers
   config.business_name = "Business Name"
@@ -139,29 +127,63 @@ end
 
 ### Credentials
 
-You'll need to add your private Stripe API key to your Rails secrets `config/secrets.yml`, credentials `rails credentials:edit`
+Pay automatically looks up credentials for each payment provider. We recommend storing them in the Rails credentials.
+
+##### Rails Credentials & Secrets
+
+You'll need to add your API keys to your Rails credentials. You can do this by running:
+
+```bash
+bin/rails credentials:edit --environment=development
+```
+
+They should be formatted like the following:
+
+```yaml
+stripe:
+  private_key: sk_test_xxxx
+  public_key: pk_test_yyyy
+  signing_secret: whsec_zzzz
+
+braintree:
+  private_key: xxxx
+  public_key: yyyy
+  merchant_id: aaaa
+  environment: sandbox
+
+paddle:
+  vendor_id: xxxx
+  vendor_auth_code: yyyy
+  public_key_base64: MII...==
+  environment: sandbox
+```
+
+You can also nest these credentials under the Rails environment if using a shared credentials file or secrets.
 
 ```yaml
 development:
   stripe:
-    private_key: xxxx
-    public_key: yyyy
-    signing_secret: zzzz
-  braintree:
-    private_key: xxxx
-    public_key: yyyy
-    merchant_id: aaaa
-    environment: sandbox
-  paddle:
-    vendor_id: xxxx
-    vendor_auth_code: yyyy
-    public_key_base64: MII...==
-    environment: sandbox
+    private_key: sk_test_xxxx
+    public_key: pk_test_yyyy
+    signing_secret: whsec_zzzz
+# ...
 ```
 
-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`, `PADDLE_PUBLIC_KEY_BASE64` and `PADDLE_ENVIRONMENT` environment variables.
+##### Environment Variables
+
+Pay will also check environment variables for API keys:
+
+* `STRIPE_PUBLIC_KEY`
+* `STRIPE_PRIVATE_KEY`
+* `STRIPE_SIGNING_SECRET`
+* `BRAINTREE_MERCHANT_ID`
+* `BRAINTREE_PUBLIC_KEY`
+* `BRAINTREE_PRIVATE_KEY`
+* `BRAINTREE_ENVIRONMENT`
+* `PADDLE_VENDOR_ID`
+* `PADDLE_VENDOR_AUTH_CODE`
+* `PADDLE_PUBLIC_KEY_BASE64`
+* `PADDLE_ENVIRONMENT`
 
 ### Generators
 
@@ -179,11 +201,13 @@ bin/rails generate pay:email_views
 
 ### Emails
 
-Emails can be enabled/disabled using the `send_emails` configuration option (enabled per default). When enabled, the following emails will be sent:
+Emails can be enabled/disabled using the `send_emails` configuration option (enabled by default).
 
-- When a charge succeeded
-- When a charge was refunded
-- When a subscription is about to renew
+When enabled, the following emails will be sent when:
+
+- A charge succeeded
+- A charge was refunded
+- A subscription is about to renew
 
 
 ## Billable API
@@ -588,10 +612,18 @@ If you have a catch all route (for 404s etc) and need to control where/when the
 
 ```ruby
 # config/initializers/pay.rb
-config.automount_routes = false
+Pay.setup do |config|
+  # ...
+
+  config.automount_routes = false
+end
 
 # config/routes.rb
-mount Pay::Engine, at: '/secret-webhook-path'
+Rails.application.routes.draw do
+  mount Pay::Engine, at: '/pay' # You can change the `at` path to feed your needs.
+
+  # Other routes here
+end
 ```
 
 If you just want to modify where the engine mounts it's routes then you can change the path.
@@ -599,7 +631,11 @@ If you just want to modify where the engine mounts it's routes then you can chan
 ```ruby
 # config/initializers/pay.rb
 
-config.routes_path = '/secret-webhook-path'
+Pay.setup do |config|
+  # ...
+
+  config.routes_path = '/pay'
+end
 ```
 
 ## Payment Providers

data/app/models/pay/application_record.rb

@@ -1,6 +1,7 @@
 module Pay
   class ApplicationRecord < Pay.model_parent_class.constantize
     self.abstract_class = true
+    self.table_name_prefix = "pay_"
 
     def self.json_column?(name)
       return unless connected? && table_exists?

data/app/models/pay/charge.rb

@@ -16,7 +16,7 @@ module Pay
     # Validations
     validates :amount, presence: true
     validates :processor, presence: true
-    validates :processor_id, presence: true
+    validates :processor_id, presence: true, uniqueness: {scope: :processor, case_sensitive: false}
     validates :card_type, presence: true
 
     store_accessor :data, :paddle_receipt_url

data/app/models/pay/subscription.rb

@@ -14,7 +14,7 @@ module Pay
     # Validations
     validates :name, presence: true
     validates :processor, presence: true
-    validates :processor_id, presence: true
+    validates :processor_id, presence: true, uniqueness: {scope: :processor, case_sensitive: false}
     validates :processor_plan, presence: true
     validates :quantity, presence: true
     validates :status, presence: true

data/db/migrate/20200603134434_add_data_to_pay_models.rb

@@ -1,15 +1,6 @@
 class AddDataToPayModels < ActiveRecord::Migration[4.2]
   def change
-    add_column :pay_subscriptions, :data, data_column_type
-    add_column :pay_charges, :data, data_column_type
-  end
-
-  def data_column_type
-    case Pay::Adapter.current_adapter
-    when "postgresql"
-      :jsonb
-    else
-      :json
-    end
+    add_column :pay_subscriptions, :data, Pay::Adapter.json_column_type
+    add_column :pay_charges, :data, Pay::Adapter.json_column_type
   end
 end

data/db/migrate/20210309004259_add_data_to_pay_billable.rb

@@ -4,16 +4,7 @@ class AddDataToPayBillable < ActiveRecord::Migration[4.2]
     Rails.application.eager_load!
 
     Pay.billable_models.each do |model|
-      add_column model.table_name, :pay_data, data_column_type
-    end
-  end
-
-  def data_column_type
-    case Pay::Adapter.current_adapter
-    when "postgresql"
-      :jsonb
-    else
-      :json
+      add_column model.table_name, :pay_data, Pay::Adapter.json_column_type
     end
   end
 end

data/db/migrate/20210714175351_add_uniqueness_to_pay_models.rb

@@ -0,0 +1,6 @@
+class AddUniquenessToPayModels < ActiveRecord::Migration[6.1]
+  def change
+    add_index :pay_charges, [:processor, :processor_id], unique: true
+    add_index :pay_subscriptions, [:processor, :processor_id], unique: true
+  end
+end

data/lib/generators/active_record/billable_generator.rb

@@ -0,0 +1,44 @@
+# 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

@@ -0,0 +1,44 @@
+# 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

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,12 @@
+# 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/{pay_generator.rb → billable_generator.rb}

@@ -4,13 +4,12 @@ require "rails/generators/named_base"
 
 module Pay
   module Generators
-    class PayGenerator < Rails::Generators::NamedBase
+    class BillableGenerator < 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."
+      desc "Generates a migration to add Pay::Billable fields to a model."
 
       hook_for :orm
     end