stripe-rails 1.10.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f634d5d4a82d22c99a17ecc2bfdb313564c161d9fb8113cee4046b545b056f
-  data.tar.gz: 62628badc191b1f737fdcbf1608e5d36cbfd264399dc94da98e9a59a2c07ff6f
+  metadata.gz: 15856817d5ce2ac1b96f1ad4f6f93602b5b80f0790cfbbd56ae87c0d89654571
+  data.tar.gz: 602743d7695c49114426acf961c7c7df1fd7e6d959cb1d00c860a729913847c3
 SHA512:
-  metadata.gz: 99cab9c0756eae42185a33ca6a62f9ff3038e912b7f10492a9fa400b18663576cac483441041e805c34b603f38d67763bb639323bdb238033ff043d03c512a26
-  data.tar.gz: 8969c43692b09fd949fbb0d6bb810e79fa7a1efab27c73e9147edf2ded0d16da1cc295ec09a7ddef8832932ce8460c50650f16a602766f299e97e0d04fcd1693
+  metadata.gz: 29127701ac3cccb96aa0bd215f616fa83b41d55cfc40d41aaafd56ca0ca0a479822b4c473bfbe3d9fdb3dfac6d0061dd93e237a7a412811358952d0c97f51f60
+  data.tar.gz: '07384662c64848e9e86bc592501b705e7879c8a8222dae408195b5b3b6fd8ef9e23cc6379d3f9dcd382dbe6806448a8978108f449984605de0232c81763c0423'

data/.github/pull_request_template.md

@@ -1,4 +1,15 @@
 <!--
-  Please give us ~1 week to get back to you.
+  Thanks a bunch for helping out with the project!
+
+  Please remember to,
+
+  1. Add tests if they do not exist, fix em if they are breaking
+  2. Fix any issues that are stopping Code Climate from passing
+  2. Add a short description of the feature and tag yourself on Changelog.md
+
+  That's it!
+
+  Please give me ~1 week to get back to you.
+
   If you'd like to receive occasional updates, sign up for our newsletter at http://tinyletter.com/stripe-rails
 -->

data/.github/workflows/ruby.yml

@@ -14,9 +14,8 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [2.4.x, 2.5.x, 2.6.x]
-        gemfile: [Gemfile, gemfiles/rails51.gemfile, gemfiles/rails52.gemfile, gemfiles/rails4.gemfile]
-
+        ruby: [2.5.x, 2.6.x, 2.7.x]
+        gemfile: [Gemfile, gemfiles/rails51.gemfile, gemfiles/rails52.gemfile]
     steps:
     - uses: actions/checkout@v1
     - name: Set up Ruby
@@ -34,10 +33,11 @@ jobs:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         RUBY_VERSION: ${{ matrix.ruby }}
       run: |
-        gem uninstall bundler
-        gem install bundler -v 1.17.3
+        if [ $RUBY_VERSION == "2.5.x" ] ;
+          then gem install bundler
+        fi
         bundle install --jobs 4 --retry 3
         bundle exec rake
-        if [ `basename $BUNDLE_GEMFILE` == "Gemfile" ] && [ $RUBY_VERSION == "2.6.x" ] && [ ! -z ${CC_TEST_REPORTER_ID} ] ;
+        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,6 +1,27 @@
-## Unreleased
+## 2.2.0 (2020-12-06)
 
--
+- Add Prices as a configuration object. Thanks @jamesprior!
+
+## 2.1.0 (2020-10-18)
+
+- Added option to ignore missing API key and don't show any warning. Thanks @ndbroadbent!
+- Handle passing nil to signing_secret= and add tests. Thanks @martron!
+
+## 2.0.0 (2020-09-18)
+
+- Everything from on the 2.0.0.pre release
+- includes changes from the 1.10.2 release
+
+## 1.10.2 (2020-09-18)
+
+- adds missing callback `invoice.paid`. Thanks @SyborgStudios.
+
+## 2.0.0.pre (2020-05-29)
+
+* [Breaking] Updated to work only with Rails >= 5.1
+* [Breaking] It'll only be tested on Ruby 2.7, 2.6 and 2.5.
+* [Breaking] Supports the Stripe gem => 3.15.0 (from 2 years ago)
+* [Breaking] Removes Stripe::PingsController controller.
 
 ## 1.10.1 (2020-05-29)
 

data/Gemfile

@@ -14,9 +14,9 @@ group :test do
   gem 'simplecov', '< 0.18', require: false
   gem 'stripe-ruby-mock'
   gem 'webmock'
-  # Required for system tests
+  # System tests
   gem 'capybara'
-  gem 'webdrivers'
   gem 'puma'
   gem 'selenium-webdriver'
-end
+  gem 'webdrivers'
+end

data/README.md

@@ -9,7 +9,7 @@ This gem can help your rails application integrate with Stripe in the following
 
 * manage stripe configurations in a single place.
 * makes stripe.js available from the asset pipeline.
-* manage plans and coupons from within your app.
+* manage product, prices, plans and coupons from within your app.
 * painlessly receive and validate webhooks from stripe.
 
 [📫 Sign up for the Newsletter](http://tinyletter.com/stripe-rails) to receive occasional updates.
@@ -137,6 +137,14 @@ you prefer to environment variables, you can also set `STRIPE_PUBLISHABLE_KEY`:
 export STRIPE_PUBLISHABLE_KEY=pk_test_XXXYYYZZZ
 ```
 
+If no API key is provided, `stripe-rails` will show a warning: "No stripe.com API key was configured ...". You can silence this warning by setting the `ignore_missing_secret_key` option to `true`:
+
+```ruby
+# config/environments/production.rb
+# ...
+config.stripe.ignore_missing_secret_key = true
+```
+
 ### Manually set your API version (optional)
 
 If you need to test a new API version in development, you can override the version number manually.
@@ -162,6 +170,7 @@ this will generate the configuration files containing your plan and coupon defin
 ```console
 create  config/stripe/products.rb
 create  config/stripe/plans.rb
+create  config/stripe/prices.rb
 create  config/stripe/coupons.rb
 ```
 
@@ -259,17 +268,46 @@ Stripe.product :primo do |product|
 end
 ```
 
-To upload your plans and coupons onto stripe.com, run:
+And Prices:
+
+```ruby
+Stripe.price :bronze do |price|
+  # Use an existing product id to prevent a new product from
+  # getting created
+  price.product_id = Stripe::Products::PRIMO.id
+  price.billing_scheme = 'tiered'
+  price.recurring = {
+    interval: 'month',
+    usage_type: 'metered'
+  }
+
+  # Use graduated pricing tiers
+  # ref: https://stripe.com/docs/api/prices/object#price_object-tiers
+  price.tiers = [
+    {
+      unit_amount: 1500,
+      up_to: 10
+    },
+    {
+      unit_amount: 1000,
+      up_to: 'inf'
+    }
+  ]
+  price.tiers_mode = 'graduated'
+end
+````
+
+To upload your plans, products, prices and coupons onto stripe.com, run:
 
 ```sh
 rake stripe:prepare
 ```
 
-This will create any plans and coupons that do not currently exist, and treat as a NOOP any
-plans that do, so you can run this command safely as many times as you wish. Now you can
-use any of these plans in your application.
+This will create any plans, products, prices and coupons that do not currently exist, and treat as a NOOP any
+objects that already exist, so you can run this command safely as many times as you wish. Now you can
+use any of these objects in your application.
 
-NOTE: You must destroy plans manually from your stripe dashboard.
+NOTE: You must destroy plans and prices manually from your stripe dashboard.
 
 ## Stripe Elements
 

data/config/routes.rb

@@ -5,6 +5,5 @@ Rails.application.routes.draw do
 end
 
 Stripe::Engine.routes.draw do
-  resource  :ping, only: :show
   resources :events, only: :create
 end

data/lib/generators/stripe/install_generator.rb

@@ -6,6 +6,7 @@ module Stripe
     def copy_plans_file
       copy_file "products.rb", "config/stripe/products.rb"
       copy_file "plans.rb", "config/stripe/plans.rb"
+      copy_file "prices.rb", "config/stripe/prices.rb"
       copy_file "coupons.rb", "config/stripe/coupons.rb"
     end
   end

data/lib/generators/templates/prices.rb

@@ -0,0 +1,46 @@
+# This file contains descriptions of all your stripe prices
+
+# Example
+# Stripe::Prices::LITE.lookup_key #=> 'lite'
+
+# Prices will have a stripe generated id.  The lookup_key will match the
+# configuration below.  You can fetch the ID or object from stripe:
+#
+#    Stripe::Prices::LITE.stripe_id #=> 'price_0000sdfs2qfsdf'
+#    Stripe::Prices::LITE.stripe_object #=> #<Stripe::Price:0x3584 id=price_0000sdfs2qfsdf>...
+
+# Prices are not deletable via the API, the `reset!` method will instead
+# create a new price and transfer the lookup key to the new price.
+
+# Stripe.price :lite do |price|
+#   # Prices may belong to a product, this will create a product along with the price
+#   price.name = 'Acme as a service LITE'
+
+#   # You can also specify an existing product ID
+#   # price.product_id = Stripe::Products::PRIMO.id
+#
+#   # amount in cents. This is 6.99
+#   price.unit_amount = 699
+#
+#   # currency to use for the price (default 'usd')
+#   price.currency = 'usd'
+#
+#   price.recurring = {
+#     # interval must be either 'day', 'week', 'month' or 'year'
+#     interval: 'month',
+#     # only bill once every three months (default 1)
+#     interval_count: 3,
+#     # Must be either 'metered' or 'licensed'
+#     usage_type: 'metered',
+#     # Specifies a usage aggregation strategy for metered usage
+#     aggregate_usage: 'sum'
+#   }
+#
+# end
+
+# Once you have your prices defined, you can run
+#
+#   rake stripe:prepare
+#
+# This will export any new prices to stripe.com so that you can
+# begin using them in your API calls.

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'
@@ -105,10 +106,6 @@ module Stripe
     callback 'ping'
     callback 'stripe.event'
 
-    # Deprecated
-    callback 'transfer.failed' # https://stripe.com/docs/upgrades#2017-04-06
-    callback 'transfer.paid'   # https://stripe.com/docs/upgrades#2017-04-06
-
     class << self
       def run_callbacks(evt, target)
         _run_callbacks evt.type, evt, target

data/lib/stripe/engine.rb

@@ -8,12 +8,12 @@ module Stripe
       attr_accessor :testing
     end
 
-    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
+    stripe_config = config.stripe = Struct.new(:api_base, :api_version, :secret_key, :ignore_missing_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)
+        self.signing_secrets = value.nil? ? value : Array(value)
       end
-  
+
       def signing_secret
         self.signing_secrets && self.signing_secrets.first
       end
@@ -43,7 +43,7 @@ module Stripe
       end
       secret_key = app.config.stripe.secret_key
       Stripe.api_key = secret_key unless secret_key.nil?
-      $stderr.puts <<-MSG unless Stripe.api_key
+      $stderr.puts <<-MSG unless Stripe.api_key || app.config.stripe.ignore_missing_secret_key
 No stripe.com API key was configured for environment #{::Rails.env}! this application will be
 unable to interact with stripe.com. You can set your API key with either the environment
 variable `STRIPE_SECRET_KEY` (recommended) or by setting `config.stripe.secret_key` in your
@@ -89,7 +89,7 @@ environment file directly.
     end
 
     initializer 'stripe.plans_and_coupons' do |app|
-      for configuration in %w(products plans coupons)
+      for configuration in %w(products plans coupons prices)
         path = app.root.join("config/stripe/#{configuration}.rb")
         load path if path.exist?
       end

data/lib/stripe/prices.rb

@@ -0,0 +1,189 @@
+module Stripe
+  module Prices
+    include ConfigurationBuilder
+    VALID_TIME_UNITS = %i(day week month year)
+
+    configuration_for :price do
+      attr_reader   :lookup_key
+      attr_accessor :active,
+                    :billing_scheme,
+                    :constant_name,
+                    :currency,
+                    :metadata,
+                    :name,
+                    :nickname,
+                    :object,
+                    :product_id,
+                    :recurring,
+                    :statement_descriptor,
+                    :tiers,
+                    :tiers_mode,
+                    :transform_quantity,
+                    :type,
+                    :unit_amount
+
+      validates_presence_of :id, :currency
+      validates_presence_of :unit_amount, unless: ->(p) { p.billing_scheme == 'tiered' }
+      validates_absence_of :transform_quantity, if: ->(p) { p.billing_scheme == 'tiered' }
+      validates_presence_of :tiers_mode, :tiers, if: ->(p) { p.billing_scheme == 'tiered' }
+
+      validates_numericality_of :recurring_interval_count, allow_nil: true
+
+      validates_inclusion_of  :recurring_interval,
+                              in: VALID_TIME_UNITS.collect(&:to_s),
+                              message: "'%{value}' is not one of #{VALID_TIME_UNITS.to_sentence(last_word_connector: ', or ')}",
+                              if: ->(p) { p.recurring.present? }
+
+      validates :statement_descriptor, length: { maximum: 22 }
+
+      validates :active,                    inclusion: { in: [true, false] }, allow_nil: true
+      validates :billing_scheme,            inclusion: { in: %w{ per_unit tiered } }, allow_nil: true
+      validates :recurring_aggregate_usage, inclusion: { in: %w{ sum last_during_period last_ever max } }, allow_nil: true
+      validates :recurring_usage_type,      inclusion: { in: %w{ metered licensed } }, allow_nil: true
+      validates :tiers_mode,                inclusion: { in: %w{ graduated volume } }, allow_nil: true
+
+      validate :name_or_product_id
+      validate :recurring_aggregate_usage_must_be_metered, if: ->(p) { p.recurring_aggregate_usage.present? }
+      validate :recurring_interval_count_maximum, if: ->(p) { p.recurring_interval_count.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'
+        @lookup_key = @id.to_s
+        @recurring = (recurring || {}).symbolize_keys
+      end
+
+      # We're overriding a handful of the Configuration methods so that
+      # we find and create by lookup_key instead of by ID.  The ID is assigned
+      # by stripe and out of our control
+      def put!
+        if exists?
+          puts "[EXISTS] - #{@stripe_class}:#{@id}:#{stripe_id}" unless Stripe::Engine.testing
+        else
+          object = @stripe_class.create({:lookup_key => @lookup_key}.merge compact_create_options)
+          puts "[CREATE] - #{@stripe_class}:#{object}" unless Stripe::Engine.testing
+        end
+      end
+
+      # You can't delete prices, but you can transfer the lookup key to a new price
+      def reset!
+        object = @stripe_class.create(reset_options)
+        puts "[RESET] - #{@stripe_class}:#{object}" unless Stripe::Engine.testing
+      end
+
+      def exists?
+        stripe_object.presence
+      rescue Stripe::InvalidRequestError
+        false
+      end
+
+      def stripe_object
+        @stripe_class.list({lookup_keys: [@lookup_key]}).data.first.presence || nil
+      rescue Stripe::InvalidRequestError
+        nil
+      end
+
+      def stripe_id
+        @stripe_id ||= stripe_object.try(:id)
+      end
+
+      def recurring_interval
+        recurring[:interval]
+      end
+
+      def recurring_aggregate_usage
+        recurring[:aggregate_usage]
+      end
+
+      def recurring_usage_type
+        recurring[:usage_type]
+      end
+
+      def recurring_interval_count
+        recurring[:interval_count]
+      end
+
+      private
+      def recurring_aggregate_usage_must_be_metered
+        errors.add(:recurring_aggregate_usage, 'recurring[:usage_type] must be metered') unless (recurring_usage_type == 'metered')
+      end
+
+      def recurring_interval_count_maximum
+        time_unit = recurring_interval.to_sym
+
+        return unless VALID_TIME_UNITS.include?(time_unit) && recurring_interval_count.respond_to?(time_unit)
+        too_long = recurring_interval_count.send(time_unit) > 1.year
+
+        errors.add(:recurring_interval_count, 'recurring[:interval_count] Maximum is one year (1 year, 12 months, or 52 weeks') if too_long
+      end
+
+      def name_or_product_id
+        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)
+        ConstTester.send(:remove_const, constant_name.to_s.upcase.to_sym)
+      rescue NameError
+        errors.add(:constant_name, 'is not a valid Ruby constant name.')
+      end
+
+      def reset_options
+        existing_object = stripe_object
+        # Lookup and set the existing product ID if unset
+        @product_id ||= existing_object.product if existing_object.present?
+
+        { transfer_lookup_key: existing_object.present? }.merge(compact_create_options)
+      end
+
+      def create_options
+        {
+          currency: currency,
+          unit_amount: unit_amount,
+          active: active,
+          metadata: metadata,
+          nickname: nickname.presence || @lookup_key,
+          recurring: recurring.compact,
+          tiers: tiers ? tiers.map(&:to_h) : nil,
+          tiers_mode: tiers_mode,
+          billing_scheme: billing_scheme,
+          lookup_key: @lookup_key,
+          transform_quantity: transform_quantity,
+        }.merge(product_options).compact
+      end
+
+      def product_options
+        if product_id.present?
+          { product: product_id }
+        else
+          {
+            product_data: { name: name, statement_descriptor: statement_descriptor }
+          }
+        end
+      end
+    end
+  end
+end