stripe-rails 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb58cd2c4b57bfb766859f950ea819137df7d25df3064654877db23a853fc181
-  data.tar.gz: b93b09f34648ff133397a56606a37bb5067130d19aef9007c823e13b993a4cfe
+  metadata.gz: 15856817d5ce2ac1b96f1ad4f6f93602b5b80f0790cfbbd56ae87c0d89654571
+  data.tar.gz: 602743d7695c49114426acf961c7c7df1fd7e6d959cb1d00c860a729913847c3
 SHA512:
-  metadata.gz: 39ff75adfde760950733e00324423c99506d53f9cee614a7adc0ec61a2ea14758e9d9a1dc49a4cd2ceac83ed7c7597c8c276cb0cb169ba813c7e2de9da7fe237
-  data.tar.gz: 861343d690279311225fda2091e0d318c08c2c4c33e98d4fb73f9e528750a6751e7b0f07a2b1c43341da8a4011e4ff3618c3cee799445a38dd720bfab6d6b250
+  metadata.gz: 29127701ac3cccb96aa0bd215f616fa83b41d55cfc40d41aaafd56ca0ca0a479822b4c473bfbe3d9fdb3dfac6d0061dd93e237a7a412811358952d0c97f51f60
+  data.tar.gz: '07384662c64848e9e86bc592501b705e7879c8a8222dae408195b5b3b6fd8ef9e23cc6379d3f9dcd382dbe6806448a8978108f449984605de0232c81763c0423'

data/.github/workflows/ruby.yml

@@ -33,6 +33,9 @@ jobs:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         RUBY_VERSION: ${{ matrix.ruby }}
       run: |
+        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.7.x" ] && [ ! -z ${CC_TEST_REPORTER_ID} ] ;

data/Changelog.md

@@ -1,3 +1,7 @@
+## 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!

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.
@@ -170,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
 ```
 
@@ -267,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/engine.rb

@@ -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

data/lib/stripe/rails.rb

@@ -4,6 +4,7 @@ require 'stripe/engine'
 require 'stripe/configuration_builder'
 require 'stripe/current_api_version'
 require 'stripe/plans'
+require 'stripe/prices'
 require 'stripe/billing_tier'
 require 'stripe/coupons'
 require 'stripe/products'

data/lib/stripe/rails/tasks.rake

@@ -30,6 +30,15 @@ namespace :stripe do
     Stripe::Coupons.reset!
   end
 
-  desc "create all plans and coupons defined in config/stripe/{products|plans|coupons}.rb"
-  task 'prepare' => ['products:prepare', 'plans:prepare', 'coupons:prepare']
+  task 'prices:prepare' => 'environment' do
+    Stripe::Prices.put!
+  end
+
+  desc 'delete and redefine all prices defined in config/stripe/prices.rb'
+  task 'prices:reset!' => 'environment' do
+    Stripe::Prices.reset!
+  end
+
+  desc "create all plans and coupons defined in config/stripe/{products|plans|prices|coupons}.rb"
+  task 'prepare' => ['products:prepare', 'plans:prepare', 'prices:prepare', 'coupons:prepare']
 end

data/lib/stripe/rails/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module Rails
-    VERSION = '2.1.0'.freeze
+    VERSION = '2.2.0'.freeze
   end
 end

data/test/dummy/config/stripe/prices.rb

@@ -0,0 +1,59 @@
+Stripe.price :gold do |price|
+   price.name = 'Solid Gold'
+   price.unit_amount = 699
+   price.recurring = {
+     interval: 'month'
+   }
+end
+
+Stripe.price "Solid Gold".to_sym do |price|
+   price.constant_name = 'SOLID_GOLD'
+   price.name = 'Solid Gold'
+   price.unit_amount = 699
+   price.recurring = {
+     interval: 'month'
+   }
+end
+
+Stripe.price :alternative_currency do |price|
+   price.name = 'Alternative Currency'
+   price.unit_amount = 699
+   price.recurring = {
+     interval: 'month'
+   }
+   price.currency = 'cad'
+end
+
+Stripe.price :metered do |price|
+  price.name = 'Metered'
+  price.unit_amount = 699
+  price.recurring = {
+    interval: 'month',
+    aggregate_usage: 'max',
+    usage_type: 'metered'
+  }
+  price.billing_scheme = 'per_unit'
+end
+
+Stripe.price :tiered do |price|
+  price.name = 'Tiered'
+  price.billing_scheme = 'tiered'
+  # interval must be either 'day', 'week', 'month' or 'year'
+  price.recurring = {
+    interval: 'month',
+    interval_count: 2,
+    aggregate_usage: 'max',
+    usage_type: 'metered'
+  }
+  price.tiers = [
+    {
+      unit_amount: 1500,
+      up_to: 10
+    },
+    {
+      unit_amount: 1000,
+      up_to: 'inf'
+    }
+  ]
+  price.tiers_mode = 'graduated'
+end

data/test/dummy_apis_controller_spec.rb

@@ -9,7 +9,7 @@ describe ApisController do
     header 'Content-Type', 'application/json'
   end
 
-  describe 'the ping interface' do
+  describe 'the apis interface' do
     subject { get '/apis/' }
 
     it { _(subject).must_be :ok? }

data/test/fixtures/stripe_prices.json

@@ -0,0 +1,7 @@
+{
+  "object": "list",
+  "count": 0,
+  "data": [],
+  "has_more": false,
+  "url": "/v1/prices"
+}

data/test/plan_builder_spec.rb

@@ -140,7 +140,7 @@ describe 'building plans' do
       }).must_raise Stripe::InvalidConfigurationError
     end
 
-    it 'denies aggregate_usage if usage type is liecensed' do
+    it 'denies aggregate_usage if usage type is licensed' do
       _(lambda {
         Stripe.plan :broken do |plan|
           plan.name = 'Acme as a service'

data/test/price_builder_spec.rb

@@ -0,0 +1,594 @@
+require 'spec_helper'
+
+describe 'building prices' do
+  describe 'simply' do
+    before do
+      Stripe.price :lite do |price|
+        price.name = 'Acme as a service LITE'
+        price.unit_amount = 699
+        price.recurring = {
+          interval: 'month',
+          interval_count: 3,
+          usage_type: 'metered',
+          aggregate_usage: 'sum'
+        }
+        price.metadata = {:number_of_awesome_things => 5}
+        price.statement_descriptor = 'Acme Lite'
+        price.active = true
+        price.nickname = 'lite'
+        price.billing_scheme = 'per_unit'
+        price.tiers_mode = 'graduated'
+      end
+    end
+
+    after { Stripe::Prices.send(:remove_const, :LITE) }
+
+    it 'is accessible via id' do
+      _(Stripe::Prices::LITE).wont_be_nil
+    end
+
+    it 'is accessible via collection' do
+      _(Stripe::Prices.all).must_include Stripe::Prices::LITE
+    end
+
+    it 'is accessible via hash lookup (symbol/string agnostic)' do
+      _(Stripe::Prices[:lite]).must_equal Stripe::Prices::LITE
+      _(Stripe::Prices['lite']).must_equal Stripe::Prices::LITE
+    end
+
+    it 'sets the lookup key' do
+      _(Stripe::Prices::LITE.lookup_key).must_equal 'lite'
+    end
+
+    it 'accepts a billing interval of a day' do
+      Stripe.price :daily do |price|
+        price.name = 'Acme as a service daily'
+        price.unit_amount = 100
+        price.recurring = {
+          interval: 'day'
+        }
+      end
+
+      _(Stripe::Prices::DAILY).wont_be_nil
+    end
+
+    it 'denies a billing interval of a day and excessive intervals' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service daily'
+          price.unit_amount = 100
+          price.recurring = {
+            interval: 'day',
+            interval_count: 366
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'accepts a billing interval of a week' do
+      Stripe.price :weekly do |price|
+        price.name = 'Acme as a service weekly'
+        price.unit_amount = 100
+        price.recurring = {
+          interval: 'week'
+        }
+      end
+
+      _(Stripe::Prices::WEEKLY).wont_be_nil
+    end
+
+    it 'denies a billing interval of a week and excessive intervals' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service weekly'
+          price.unit_amount = 100
+          price.recurring = {
+            interval: 'week',
+            interval_count: 53
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'accepts a billing interval of a month' do
+      Stripe.price :monthly do |price|
+        price.name = 'Acme as a service monthly'
+        price.unit_amount = 400
+        price.recurring = {
+          interval: 'month'
+        }
+      end
+
+      _(Stripe::Prices::MONTHLY).wont_be_nil
+    end
+
+    it 'denies a billing interval of a month and excessive intervals' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service monthly'
+          price.unit_amount = 400
+          price.recurring = {
+            interval: 'month',
+            interval_count: 13
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'accepts a billing interval of a year' do
+      Stripe.price :yearly do |price|
+        price.name = 'Acme as a service yearly'
+        price.unit_amount = 4800
+        price.recurring = {
+          interval: 'year'
+        }
+      end
+
+      _(Stripe::Prices::YEARLY).wont_be_nil
+    end
+
+    it 'denies a billing interval of a year and excessive intervals' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service yearly'
+          price.unit_amount = 4800
+          price.recurring = {
+            interval: 'year',
+            interval_count: 2
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'denies arbitrary billing intervals' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service BROKEN'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'anything'
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'accepts empty recurring options' do
+      Stripe.price :singular do |price|
+        price.name = 'Acme as a service one time'
+        price.unit_amount = 888
+      end
+
+      _(Stripe::Prices::SINGULAR).wont_be_nil
+    end
+
+    it 'accepts a statement descriptor' do
+      Stripe.price :described do |price|
+        price.name = 'Acme as a service'
+        price.unit_amount = 999
+        price.recurring = {
+          interval: 'month'
+        }
+        price.statement_descriptor = 'ACME Monthly'
+      end
+
+      _(Stripe::Prices::DESCRIBED).wont_be_nil
+    end
+
+    it 'denies statement descriptors that are too long' do
+      _(lambda {
+        Stripe.price :described do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month'
+          }
+          price.statement_descriptor = 'ACME as a Service Monthly'
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'denies invalid values for active' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month'
+          }
+          price.active = 'whatever'
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'denies invalid values for usage_type' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month',
+            usage_type: 'whatever'
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'denies invalid values for aggregate_usage' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month',
+            aggregate_usage: 'whatever'
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'denies aggregate_usage if usage type is licensed' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month',
+            usage_type: 'licensed',
+            aggregate_usage: 'sum'
+          }
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+
+    it 'denies invalid values for billing_scheme' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month'
+          }
+          price.billing_scheme = 'whatever'
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    it 'denies invalid values for tiers_mode' do
+      _(lambda {
+        Stripe.price :broken do |price|
+          price.name = 'Acme as a service'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month'
+          }
+          price.tiers_mode = 'whatever'
+        end
+      }).must_raise Stripe::InvalidConfigurationError
+    end
+
+    describe 'name and product id validation' do
+      it 'should be valid when using just the product id' do
+        Stripe.price :prodded do |price|
+          price.product_id = 'acme'
+          price.unit_amount = 999
+          price.recurring = {
+            interval: 'month'
+          }
+        end
+        _(Stripe::Prices::PRODDED).wont_be_nil
+      end
+
+      it 'should be invalid when using both name and product id' do
+        _(lambda {
+          Stripe.price :broken do |price|
+            price.name = 'Acme as a service'
+            price.product_id = 'acme'
+            price.unit_amount = 999
+            price.recurring = {
+              interval: 'month'
+            }
+          end
+        }).must_raise Stripe::InvalidConfigurationError
+      end
+    end
+
+    describe 'uploading' do
+      include FixtureLoader
+
+      describe 'when none exists on stripe.com' do
+        before do
+          Stripe::Price.stubs(:list).returns(Stripe::Price.construct_from(data: []))
+
+          stub_request(:get, "https://api.stripe.com/v1/prices").
+            with(headers: { 'Authorization'=>'Bearer XYZ',}).
+            to_return(status: 200, body: load_request_fixture('stripe_prices.json'))
+        end
+
+        it 'creates the price online' do
+          Stripe::Price.expects(:create).with(
+            :lookup_key => 'gold',
+            :nickname => 'gold',
+            :currency => 'usd',
+            :product_data => {
+              :name => 'Solid Gold',
+              :statement_descriptor => nil
+            },
+            :unit_amount => 699,
+            :recurring => {
+              :interval => 'month'
+            }
+          )
+          Stripe::Prices::GOLD.put!
+        end
+
+        it 'creates a price with an alternative currency' do
+          Stripe::Price.expects(:create).with(
+            :lookup_key => 'alternative_currency',
+            :nickname => 'alternative_currency',
+            :currency => 'cad',
+            :product_data => {
+              :name => 'Alternative Currency',
+              :statement_descriptor => nil
+            },
+            :unit_amount => 699,
+            :recurring => {
+              :interval => 'month'
+            }
+          )
+          Stripe::Prices::ALTERNATIVE_CURRENCY.put!
+        end
+
+        it 'creates a metered price' do
+          Stripe::Price.expects(:create).with(
+            :lookup_key => 'metered',
+            :nickname => 'metered',
+            :currency => 'usd',
+            :product_data => {
+              :name => 'Metered',
+              :statement_descriptor => nil,
+            },
+            :unit_amount => 699,
+            :recurring => {
+              :interval => 'month',
+              :usage_type => 'metered',
+              :aggregate_usage => 'max',
+            },
+            :billing_scheme => 'per_unit'
+          )
+          Stripe::Prices::METERED.put!
+        end
+
+        it 'creates a tiered price' do
+          Stripe::Price.expects(:create).with(
+            :lookup_key => 'tiered',
+            :nickname => 'tiered',
+            :currency => 'usd',
+            :product_data => {
+              :name => 'Tiered',
+              :statement_descriptor => nil,
+            },
+            :recurring => {
+              :interval => 'month',
+              :interval_count => 2,
+              :usage_type => 'metered',
+              :aggregate_usage => 'max'
+            },
+            :billing_scheme => 'tiered',
+            :tiers => [
+              {
+                :unit_amount => 1500,
+                :up_to => 10
+              },
+              {
+                :unit_amount => 1000,
+                :up_to => 'inf'
+              }
+            ],
+            :tiers_mode => 'graduated'
+          )
+          Stripe::Prices::TIERED.put!
+        end
+
+        describe 'when passed invalid arguments for tiered pricing' do
+          it 'raises a Stripe::InvalidConfigurationError when billing tiers are invalid' do
+            lambda {
+              Stripe.price "Bad Tiers".to_sym do |price|
+                price.name = 'Acme as a service BAD TIERS'
+                price.constant_name = 'BAD_TIERS'
+                price.recurring = {
+                  interval: 'month',
+                  interval_count: 1,
+                  usage_type: 'metered',
+                  aggregate_usage: 'sum'
+                }
+                price.tiers_mode = 'graduated'
+                price.billing_scheme = 'per_unit'
+                price.tiers = [
+                  {
+                    unit_amount: 1500,
+                    up_to: 10
+                  },
+                  {
+                    unit_amount: 1000,
+                  }
+                ]
+              end
+            }.must_raise Stripe::InvalidConfigurationError
+          end
+
+          it 'raises a Stripe::InvalidConfigurationError when billing tiers is not an array' do
+            lambda {
+              Stripe.price "Bad Tiers".to_sym do |price|
+                price.name = 'Acme as a service BAD TIERS'
+                price.constant_name = 'BAD_TIERS'
+                price.recurring = {
+                  interval: 'month',
+                  interval_count: 1,
+                  usage_type: 'metered',
+                  aggregate_usage: 'sum'
+                }
+                price.tiers_mode = 'graduated'
+                price.billing_scheme = 'per_unit'
+                price.tiers = {
+                  unit_amount: 1500,
+                  up_to: 10
+                }
+              end
+            }.must_raise Stripe::InvalidConfigurationError
+          end
+        end
+
+        describe 'when using a product id' do
+          before do
+            Stripe::Prices::GOLD.product_id = 'prod_XXXXXXXXXXXXXX'
+            Stripe::Prices::GOLD.name = nil
+          end
+          after do
+            Stripe::Prices::GOLD.product_id = nil
+            Stripe::Prices::GOLD.name = 'Solid Gold'
+          end
+
+          it 'creates the price online with the product id' do
+            Stripe::Price.expects(:create).with(
+              :lookup_key => 'gold',
+              :nickname => 'gold',
+              :currency => 'usd',
+              :product => 'prod_XXXXXXXXXXXXXX',
+              :unit_amount => 699,
+              :recurring => {
+                :interval => 'month'
+              }
+            )
+            Stripe::Prices::GOLD.put!
+          end
+        end
+      end
+
+      describe 'when it is already present on stripe.com' do
+        before do
+          Stripe::Prices::GOLD.product_id = nil
+          Stripe::Price.stubs(:list).returns(Stripe::Price.construct_from(
+            data: [{
+              :lookup_key => 'gold',
+              :product => 'prod_XXXXXXXXXXXXXX'
+          }]))
+        end
+        after do
+          Stripe::Prices::GOLD.product_id = nil
+        end
+
+
+        it 'is a no-op on put!' do
+          Stripe::Price.expects(:create).never
+          Stripe::Prices::GOLD.put!
+        end
+
+        it 'transfers lookup key on reset!' do
+          Stripe::Price.expects(:create).with(
+            :lookup_key => 'gold',
+            :transfer_lookup_key => true,
+            :nickname => 'gold',
+            :currency => 'usd',
+            :product => 'prod_XXXXXXXXXXXXXX',
+            :unit_amount => 699,
+            :recurring => {
+              :interval => 'month'
+            }
+          )
+
+          Stripe::Prices::GOLD.reset!
+        end
+      end
+    end
+  end
+
+  describe 'with missing mandatory values' do
+    it 'raises an exception after configuring it' do
+      _(-> { Stripe.price(:bad) {} }).must_raise Stripe::InvalidConfigurationError
+    end
+  end
+
+  describe 'with custom constant name' do
+    before do
+      Stripe.price "Lite price".to_sym do |price|
+        price.name = 'Acme as a service LITE'
+        price.constant_name = 'LITE_PRICE'
+        price.unit_amount = 699
+        price.recurring = {
+          interval: 'month',
+          interval_count: 3,
+          usage_type: 'metered',
+          aggregate_usage: 'sum'
+        }
+        price.metadata = {:number_of_awesome_things => 5}
+        price.statement_descriptor = 'Acme Lite'
+        price.active = true
+        price.nickname = 'lite'
+        price.billing_scheme = 'per_unit'
+        price.tiers_mode = 'graduated'
+      end
+    end
+
+    after { Stripe::Prices.send(:remove_const, :LITE_PRICE) }
+
+    it 'is accessible via upcased constant_name' do
+      _(Stripe::Prices::LITE_PRICE).wont_be_nil
+    end
+
+    it 'is accessible via collection' do
+      _(Stripe::Prices.all).must_include Stripe::Prices::LITE_PRICE
+    end
+
+    it 'is accessible via hash lookup (symbol/string agnostic)' do
+      _(Stripe::Prices[:lite_price]).must_equal Stripe::Prices::LITE_PRICE
+      _(Stripe::Prices['lite_price']).must_equal Stripe::Prices::LITE_PRICE
+    end
+
+    describe 'constant name validation' do
+      it 'should be invalid when providing a constant name that can not be used for Ruby constant' do
+        _(lambda {
+          Stripe.price "Lite price".to_sym do |price|
+            price.name = 'Acme as a service LITE'
+            price.constant_name = 'LITE PRICE'
+            price.unit_amount = 999
+            price.recurring = {
+              interval: 'month'
+            }
+          end
+        }).must_raise Stripe::InvalidConfigurationError
+      end
+    end
+
+    describe 'uploading' do
+      include FixtureLoader
+
+      describe 'when none exists on stripe.com' do
+        before do
+          Stripe::Price.stubs(:list).returns(Stripe::Price.construct_from(data: []))
+
+          stub_request(:get, "https://api.stripe.com/v1/prices").
+            with(headers: { 'Authorization'=>'Bearer XYZ',}).
+            to_return(status: 200, body: load_request_fixture('stripe_prices.json'))
+        end
+
+        it 'creates the price online' do
+          Stripe::Price.expects(:create).with(
+            :lookup_key => "Solid Gold",
+            :nickname => "Solid Gold",
+            :currency => 'usd',
+            :product_data => {
+              :name => 'Solid Gold',
+              :statement_descriptor => nil
+            },
+            :unit_amount => 699,
+            :recurring => {
+              :interval => 'month'
+            }
+          )
+          Stripe::Prices::SOLID_GOLD.put!
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-rails
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Charles Lowell
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-18 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,6 +90,7 @@ files:
 - lib/generators/stripe/install_generator.rb
 - lib/generators/templates/coupons.rb
 - lib/generators/templates/plans.rb
+- lib/generators/templates/prices.rb
 - lib/generators/templates/products.rb
 - lib/stripe-rails.rb
 - lib/stripe/billing_tier.rb
@@ -100,6 +101,7 @@ files:
 - lib/stripe/current_api_version.rb
 - lib/stripe/engine.rb
 - lib/stripe/plans.rb
+- lib/stripe/prices.rb
 - lib/stripe/products.rb
 - lib/stripe/rails.rb
 - lib/stripe/rails/tasks.rake
@@ -138,6 +140,7 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/stripe/plans.rb
+- test/dummy/config/stripe/prices.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/lib/dummy/module_with_callbacks.rb
 - test/dummy/log/.gitkeep
@@ -153,9 +156,11 @@ files:
 - test/fixtures/stripe_plans.json
 - test/fixtures/stripe_plans_headers.json
 - test/fixtures/stripe_plans_headers_2017.json
+- test/fixtures/stripe_prices.json
 - test/invoice.json
 - test/javascript_helper_spec.rb
 - test/plan_builder_spec.rb
+- test/price_builder_spec.rb
 - test/product_builder_spec.rb
 - test/spec_helper.rb
 - test/stripe_initializers_spec.rb
@@ -182,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A gem to integrate stripe into your rails app
@@ -219,6 +224,7 @@ test_files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/stripe/plans.rb
+- test/dummy/config/stripe/prices.rb
 - test/dummy/lib/assets/.gitkeep
 - test/dummy/lib/dummy/module_with_callbacks.rb
 - test/dummy/log/.gitkeep
@@ -234,9 +240,11 @@ test_files:
 - test/fixtures/stripe_plans.json
 - test/fixtures/stripe_plans_headers.json
 - test/fixtures/stripe_plans_headers_2017.json
+- test/fixtures/stripe_prices.json
 - test/invoice.json
 - test/javascript_helper_spec.rb
 - test/plan_builder_spec.rb
+- test/price_builder_spec.rb
 - test/product_builder_spec.rb
 - test/spec_helper.rb
 - test/stripe_initializers_spec.rb