stripe-rails 1.8.2 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3458e73514e9d287513ab9ff1192ccc37f7eed53681d407027f8a828c4e629
-  data.tar.gz: 3cf53318d3cc31fac81c7d4ea4e5d981138eb1a0266dcc4a261fd8a49ddb014b
+  metadata.gz: 73acf591d97fe139b79c035da2794c439658693ad685e109e538c9e43d06fb8d
+  data.tar.gz: 18ffadcb37501896be79ee56f57c48a8a3213b9330bca42d5edc17de92f5a3ba
 SHA512:
-  metadata.gz: c4283ef2ffddcddda494634e58cdda112f26dc82fc14428eaa8130e4d94b138862cdf6b8aa04886ad3291dd67788d75780420f4e00847845a59a1016d4ac7c4f
-  data.tar.gz: 2ea2f1dc27ab45a92e4ba49b67430bb1b0b51a3379e192740ec4bc9eb7bb068004c9b9d213937727cc95718328e4c9786611969d515e5e9db5b3fa306c2698ed
+  metadata.gz: 29d167609bc9a3dd383acce2f4aaf1a833fe17158d12dfc08e87d164cd58e1da2a141009b6de127e04f8a03186e44f88f1bfffc019a93bfb45ff47545a57f77c
+  data.tar.gz: 72c31c0977018cdd1fe81134aef5e888c2820ae7264d1c263f90a6521dd904ea7cfe9a3c1d8e4fa0982059365ff0c311649aec807534a607d018b2d0fe74e202

data/.github/workflows/ruby.yml

@@ -0,0 +1,45 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [2.4.x, 2.5.x, 2.6.x, 2.7.x]
+        gemfile: [Gemfile, gemfiles/rails51.gemfile, gemfiles/rails52.gemfile, gemfiles/rails4.gemfile]
+        exclude:
+          - ruby: 2.7.x
+            gemfile: gemfiles/rails4.gemfile
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Set up Code Climate
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+    - name: Build and Test
+      env:
+        BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        RUBY_VERSION: ${{ matrix.ruby }}
+      run: |
+        gem uninstall bundler
+        gem install bundler -v 1.17.3
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+        if [ `basename $BUNDLE_GEMFILE` == "Gemfile" ] && [ $RUBY_VERSION == "2.7.x" ] && [ ! -z ${CC_TEST_REPORTER_ID} ] ;
+          then ./cc-test-reporter after-build --exit-code $? ;
+        fi

data/Changelog.md

@@ -1,3 +1,25 @@
+## Unreleased
+
+## 1.10.2 (2020-09-18)
+
+- adds missing callback `invoice.paid`. Thanks @SyborgStudios.
+
+## 1.10.1 (2020-05-29)
+
+- adds missing callbacks for `payment_intent`. Thanks @klapperkopp .
+
+## 1.10.0 (2020-03-31)
+
+- Adds support for using multiple tiers in a plan, thanks @cpsoinos
+
+## 1.9.1 (2019-10-28)
+
+- Fixes issue with `rake stripe:verify` thanks @Millariel !
+
+## 1.9.0 (2019-09-01)
+
+- Adds support for multiple signing secrets. Thanks again @jacobcsmith !
+
 ## 1.8.2 (2019-08-31)
 
 - adds missing callbacks for `payment_intent`, `payment_method` and `setup_intent`. Thanks @jacobcsmith !

data/Gemfile

@@ -11,12 +11,12 @@ end
 
 group :test do
   gem 'mocha'
-  gem 'simplecov', require: false
+  gem 'simplecov', '< 0.18', require: false
   gem 'stripe-ruby-mock'
   gem 'webmock'
   # Required for system tests
   gem 'capybara'
-  gem 'chromedriver-helper'
+  gem 'webdrivers'
   gem 'puma'
   gem 'selenium-webdriver'
 end

data/README.md

@@ -1,6 +1,6 @@
 # Stripe::Rails: A Rails Engine for use with [stripe.com](https://stripe.com)
-[![Gem Version](https://badge.fury.io/rb/stripe-rails.png)](http://badge.fury.io/rb/stripe-rails)
-[![Build Status](https://travis-ci.org/tansengming/stripe-rails.png?branch=master)](https://travis-ci.org/tansengming/stripe-rails)
+[![Gem Version](https://badge.fury.io/rb/stripe-rails.svg)](https://badge.fury.io/rb/stripe-rails)
+[![Build Status](https://travis-ci.org/tansengming/stripe-rails.svg?branch=master)](https://travis-ci.org/tansengming/stripe-rails)
 [![Code Climate](https://codeclimate.com/github/tansengming/stripe-rails/badges/gpa.svg)](https://codeclimate.com/github/tansengming/stripe-rails)
 [![Test Coverage](https://codeclimate.com/github/tansengming/stripe-rails/badges/coverage.svg)](https://codeclimate.com/github/tansengming/stripe-rails/coverage)
 [![Tidelift](https://tidelift.com/badges/github/tansengming/stripe-rails)](#)
@@ -188,6 +188,23 @@ Stripe.plan :bronze do |plan|
   plan.product_id = 'prod_XXXXXXXXXXXXXX'
   plan.amount = 999 # $9.99
   plan.interval = 'month'
+
+  # Use graduated pricing tiers
+  # ref: https://stripe.com/docs/api/plans/object#plan_object-tiers
+  plan.tiers = [
+    {
+      unit_amount: 1500,
+      up_to: 10
+    },
+    {
+      unit_amount: 1000,
+      up_to: 'inf'
+    }
+  ]
+  plan.tiers_mode = 'graduated'
+
+  # set the usage type to 'metered'
+  plan.usage_type = 'metered'
 end
 ```
 
@@ -310,29 +327,32 @@ Your new webhook URL would then be `http://myproductionapp/payment/stripe-integr
 ### Signed Webhooks
 
 Validation of your webhook's signature uses your webhook endpoint signing secret.
-Before you can verify signatures, you need to retrieve your endpoint’s secret your
+Before you can verify signatures, you need to retrieve your endpoint’s secret from your
 Stripe Dashboard. Select an endpoint for which you want to obtain
 the secret, then select the Click to reveal button.
 
 ```ruby
 # config/application.rb
 # ...
-config.stripe.signing_secret = 'whsec_XXXYYYZZZ'
+config.stripe.signing_secrets = ['whsec_XXXYYYZZZ']
 ```
 
-Each secret is unique to the endpoint to which it corresponds. If you use multiple endpoints,
+Each secret is unique to the endpoint to which it corresponds. If you use multiple endpoint,
 you must obtain a secret for each one. After this setup, Stripe starts to sign each webhook
-it sends to the endpoint. Because of this, we recommend setting this variable with an environment
-variable:
+it sends to the endpoint. Because of this, we recommend setting this variable with environment
+variables:
 
 ```sh
 export STRIPE_SIGNING_SECRET=whsec_XXXYYYZZZ
+export STRIPE_CONNECT_SIGNING_SECRET=whsec_AAABBBCCC
 ```
 
 ```ruby
-config.stripe.signing_secret = ENV.fetch('STRIPE_SIGNING_SECRET')
+config.stripe.signing_secrets = [ENV.fetch('STRIPE_SIGNING_SECRET'), ENV.fetch('STRIPE_CONNECT_SIGNING_SECRET')]
 ```
 
+The first secret that successfully matches for each incoming webhook will be used to verify the incoming events.
+
 #### Testing Signed Webhooks Locally
 
 In order to test signed webhooks, you'll need to trigger test webhooks from your Stripe dashboard,
@@ -351,7 +371,7 @@ as documented above:
 ```ruby
 # config/application.rb
 # ...
-config.stripe.signing_secret = 'whsec_XXXYYYZZZ'
+config.stripe.signing_secrets = ['whsec_XXXYYYZZZ']
 ```
 
 And you'll need to restart your rails server with:

data/app/models/stripe/event_dispatch.rb

@@ -11,15 +11,27 @@ module Stripe
       id = request['id']
       body = request.body.read
       sig_header = request.headers['HTTP_STRIPE_SIGNATURE']
-      endpoint_secret = ::Rails.application.config.stripe.signing_secret
+      endpoint_secrets = ::Rails.application.config.stripe.signing_secrets
 
-      if Object.const_defined?('Stripe::Webhook') && sig_header && endpoint_secret
-        event = ::Stripe::Webhook.construct_event(body, sig_header, endpoint_secret)
+      if Object.const_defined?('Stripe::Webhook') && sig_header && endpoint_secrets
+        event = webhook_event(body, sig_header, endpoint_secrets)
       else
         event = Stripe::Event.retrieve(id)
       end
 
       yield event
     end
+
+    private
+
+    def webhook_event(body, sig_header, endpoint_secrets)
+      endpoint_secrets.each_with_index do |secret, i|
+        begin
+          return ::Stripe::Webhook.construct_event(body, sig_header, secret.to_s)
+        rescue ::Stripe::SignatureVerificationError
+          raise if i == endpoint_secrets.length - 1
+        end
+      end
+    end
   end
 end

data/gemfiles/rails4.gemfile

@@ -1,6 +1,7 @@
 source :rubygems
 
 gem 'rails', '~> 4.2'
+gem 'sprockets', '< 4'
 
 gem 'rake'
 gem 'responders', '~> 2.0' # to support Rails 4.2
@@ -13,7 +14,7 @@ group :test do
   gem 'webmock'
   # Required for system tests
   gem 'capybara'
-  gem 'chromedriver-helper'
+  gem 'webdrivers'
   gem 'puma'                
   gem 'selenium-webdriver'
 end

data/gemfiles/rails51.gemfile

@@ -0,0 +1,20 @@
+source :rubygems
+
+gem 'rails', '~> 5.1.0'
+
+gem 'rake'
+gem 'responders'
+gem 'sprockets', '< 4'
+gem 'stripe'
+
+group :test do
+  gem 'mocha'
+  gem 'simplecov', require: false
+  gem 'stripe-ruby-mock'
+  gem 'webmock'
+  # Required for system tests
+  gem 'capybara'
+  gem 'puma'
+  gem 'selenium-webdriver'
+  gem 'webdrivers'
+end

data/gemfiles/rails52.gemfile

@@ -0,0 +1,20 @@
+source :rubygems
+
+gem 'rails', '~> 5.2.0'
+
+gem 'rake'
+gem 'responders'
+gem 'sprockets', '< 4'
+gem 'stripe'
+
+group :test do
+  gem 'mocha'
+  gem 'simplecov', require: false
+  gem 'stripe-ruby-mock'
+  gem 'webmock'
+  # Required for system tests
+  gem 'capybara'
+  gem 'puma'
+  gem 'selenium-webdriver'
+  gem 'webdrivers'
+end

data/lib/generators/templates/products.rb

@@ -11,9 +11,9 @@
 #   product.type = 'service'
 # end
 
-# Once you have your productss defined, you can run
+# Once you have your products defined, you can run
 #
 #   rake stripe:prepare
 #
-# This will export any new plans to stripe.com so that you can
+# This will export any new products to stripe.com so that you can
 # begin using them in your API calls.

data/lib/stripe/billing_tier.rb

@@ -0,0 +1,34 @@
+module Stripe
+  module Plans
+    class BillingTier
+      include ActiveModel::Validations
+
+      validates_presence_of :up_to
+      validates_presence_of :flat_amount, if: ->(tier) { tier.unit_amount.nil? },
+        message: 'one of `flat_amount` or `unit_amount` must be specified!'
+      validates_presence_of :unit_amount, if: ->(tier) { tier.flat_amount.nil? },
+        message: 'one of `flat_amount` or `unit_amount` must be specified!'
+      validates_absence_of :flat_amount, if: ->(tier) { tier.unit_amount.present? },
+        message: 'only one of `flat_amount` or `unit_amount` should be specified!'
+      validates_absence_of :unit_amount, if: ->(tier) { tier.flat_amount.present? },
+        message: 'only one of `flat_amount` or `unit_amount` should be specified!'
+
+      attr_accessor :up_to, :flat_amount, :unit_amount
+
+      def initialize(attrs)
+        @up_to = attrs[:up_to]
+        @flat_amount = attrs[:flat_amount]
+        @unit_amount = attrs[:unit_amount]
+      end
+
+      def to_h
+        {
+          up_to: up_to,
+          flat_amount: flat_amount,
+          unit_amount: unit_amount
+        }.compact
+      end
+
+    end
+  end
+end

data/lib/stripe/callbacks.rb

@@ -47,6 +47,7 @@ module Stripe
     callback 'invoice.created'
     callback 'invoice.finalized'
     callback 'invoice.marked_uncollectible'
+    callback 'invoice.paid'
     callback 'invoice.payment_action_required'
     callback 'invoice.payment_failed'
     callback 'invoice.payment_succeeded'
@@ -63,8 +64,10 @@ module Stripe
     callback 'order.updated'
     callback 'order_return.created'
     callback 'payment_intent.amount_capturable_updated'
+    callback 'payment_intent.canceled'
     callback 'payment_intent.created'
     callback 'payment_intent.payment_failed'
+    callback 'payment_intent.processing'
     callback 'payment_intent.succeeded'
     callback 'payment_method.attached'
     callback 'payment_method.card_automatically_updated'

data/lib/stripe/engine.rb

@@ -8,7 +8,16 @@ module Stripe
       attr_accessor :testing
     end
 
-    stripe_config = config.stripe = Struct.new(:api_base, :api_version, :secret_key, :verify_ssl_certs, :signing_secret, :publishable_key, :endpoint, :debug_js, :auto_mount, :eager_load, :open_timeout, :read_timeout).new
+    stripe_config = config.stripe = Struct.new(:api_base, :api_version, :secret_key, :verify_ssl_certs, :signing_secret, :signing_secrets, :publishable_key, :endpoint, :debug_js, :auto_mount, :eager_load, :open_timeout, :read_timeout) do
+      # for backwards compatibility treat signing_secret as an alias for signing_secrets
+      def signing_secret=(value)
+        self.signing_secrets = Array(value)
+      end
+  
+      def signing_secret
+        self.signing_secrets && self.signing_secrets.first
+      end
+    end.new
 
     def stripe_config.api_key=(key)
       warn "[DEPRECATION] to align with stripe nomenclature, stripe.api_key has been renamed to config.stripe.secret_key"

data/lib/stripe/plans.rb

@@ -12,16 +12,20 @@ module Stripe
                     :interval,
                     :interval_count,
                     :metadata,
-                    :name, 
+                    :name,
                     :nickname,
                     :product_id,
                     :statement_descriptor,
+                    :tiers,
                     :tiers_mode,
+                    :transform_usage,
                     :trial_period_days,
                     :usage_type
 
-      validates_presence_of :id, :amount, :currency
-
+      validates_presence_of :id, :currency
+      validates_presence_of :amount, unless: ->(p) { p.billing_scheme == 'tiered' }
+      validates_absence_of :transform_usage, if: ->(p) { p.billing_scheme == 'tiered' }
+      validates_presence_of :tiers_mode, if: ->(p) { p.billing_scheme == 'tiered' }
       validates_inclusion_of  :interval,
                               in: %w(day week month year),
                               message: "'%{value}' is not one of 'day', 'week', 'month' or 'year'"
@@ -38,6 +42,11 @@ module Stripe
       validate :aggregate_usage_must_be_metered, if: ->(p) { p.aggregate_usage.present? }
       validate :valid_constant_name, unless: ->(p) { p.constant_name.nil? }
 
+      # validations for when using tiered billing
+      validate :tiers_must_be_array, if: ->(p) { p.tiers.present? }
+      validate :billing_scheme_must_be_tiered, if: ->(p) { p.tiers.present? }
+      validate :validate_tiers, if: ->(p) { p.billing_scheme == 'tiered' }
+
       def initialize(*args)
         super(*args)
         @currency = 'usd'
@@ -54,6 +63,22 @@ module Stripe
         errors.add(:base, 'must have a product_id or a name') unless (@product_id.present? ^ @name.present?)
       end
 
+      def billing_scheme_must_be_tiered
+        errors.add(:billing_scheme, 'must be set to `tiered` when specifying `tiers`') unless billing_scheme == 'tiered'
+      end
+
+      def tiers_must_be_array
+        errors.add(:tiers, 'must be an Array') unless tiers.is_a?(Array)
+      end
+
+      def billing_tiers
+        @billing_tiers = tiers.map { |t| Stripe::Plans::BillingTier.new(t) } if tiers
+      end
+
+      def validate_tiers
+        billing_tiers.all?(&:valid?)
+      end
+
       module ConstTester; end
       def valid_constant_name
         ConstTester.const_set(constant_name.to_s.upcase, constant_name)
@@ -82,8 +107,11 @@ module Stripe
           usage_type: usage_type,
           aggregate_usage: aggregate_usage,
           billing_scheme: billing_scheme,
-          nickname: nickname
-        }
+          nickname: nickname,
+          tiers: tiers ? tiers.map(&:to_h) : nil,
+          tiers_mode: tiers_mode,
+          transform_usage: transform_usage
+        }.compact
       end
 
       def product_options

data/lib/stripe/products.rb

@@ -11,6 +11,7 @@ module Stripe
                     :caption,
                     :metadata,
                     :shippable,
+                    :unit_label,
                     :url,
                     :statement_descriptor
 
@@ -42,6 +43,7 @@ module Stripe
           caption: caption,
           metadata: metadata,
           shippable: shippable,
+          unit_label: unit_label,
           url: url,
           statement_descriptor: statement_descriptor
         }