stripe-rails 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4925781be88d86f0b3e1aa2811bd6498a03f68a0d85c0cac7f2135ebee3d4e14
-  data.tar.gz: c3d71a7f8d057b3c5a4a715907842dbf44512ddd508a1baf81f0ee74b8348e4f
+  metadata.gz: f24ac8d0b91f140510d25e7c614a14e2f2574ea8f3b280c052691f088d5aa9bf
+  data.tar.gz: ce0d05dde985042654708e2701012dfd7c74d38f22c19df4a2cc703effa582b0
 SHA512:
-  metadata.gz: c6fea8783eb4b7c18231c061317c48595c9d0504481d1766c0c584365dd86482738ae47a301c08eeca46535778f68d0a4d88c777a3fcdaae856f0a322e2a2f96
-  data.tar.gz: 910d3aa144e182e9e0972eb363497fd0587ad59ceaee6576ec32507941e03799cad3b1013e16fdfeb1c6b870bab16d2e8fb970f86f0d570fe2c404b78e1012cd
+  metadata.gz: 6353b526babcf9e9e5a5a36282470167aa6a794242038ad78bfabcef3bba00ea76c4aefee7891de01d12f1d0dd52470c1e614f454c5e88e13bc63173258e58b3
+  data.tar.gz: 4b7045a4a6f1abbaafa970ad55c24b96ec31e8d4e1caa1b2ca41dc90346b10f21f3fadbc2cec102087c733f716d39eb79b83a6f2f401d22aeacff7ecfb1f65a8

data/Changelog.md

@@ -1,3 +1,8 @@
+## 1.7.0 (2019-05-09)
+
+* [New Feature] add support for Plan to use a constant name different from plan id thanks @alexagranov !
+* Add checkout.session.completed webhook thanks @Nitrino !
+
 ## 1.6.1 (2019-03-04)
 
 * Add new invoice webhooks thanks @noahezekwugo !

data/README.md

@@ -194,6 +194,25 @@ Stripe::Plans::SILVER # => 'silver: ACME Silver'
 Stripe::Plans::GOLD # => 'gold: ACME Gold'
 ```
 
+If you have to support an existing plan with a Stripe plan id that can not
+be used as a Ruby constant, provide the plan id as a symbol when
+defining the plan, but provide the name for the constant to define with `constant_name`:
+
+```ruby
+Stripe.plan "Silver-Plan".to_sym do |plan|
+  plan.constant_name = 'SILVER_PLAN'
+end
+
+Stripe::Plans::SILVER_PLAN # => will be defined
+# Will map to plan :id => "Silver-Plan" on Stripe
+```
+
+**Note** - If you're planning on running `rake stripe:prepare` to
+  create your subscription plans, Stripe will restrict plan ids to match
+  this regexp (`/\A[a-zA-Z0-9_\-]+\z/`) when created via API but still
+  allows creation of plan ids that don't follow this restriction when
+  manually created on stripe.com.
+
 Coupons are created in much the same way:
 
 ```ruby

data/lib/stripe/callbacks.rb

@@ -25,6 +25,7 @@ module Stripe
     callback 'charge.dispute.funds_withdrawn'
     callback 'charge.dispute.updated'
     callback 'charge.refund.updated'
+    callback 'checkout.session.completed'
     callback 'coupon.created'
     callback 'coupon.deleted'
     callback 'coupon.updated'

data/lib/stripe/configuration_builder.rb

@@ -68,8 +68,9 @@ module Stripe
       end
 
       def globalize!
-        @stripe_configuration_class[@id.to_s] = self
-        @stripe_configuration_class.const_set(@id.to_s.upcase, self)
+        id_to_use = @constant_name || @id
+        @stripe_configuration_class[id_to_use.to_s.downcase] = self
+        @stripe_configuration_class.const_set(id_to_use.to_s.upcase, self)
       end
 
       def put!

data/lib/stripe/plans.rb

@@ -7,6 +7,7 @@ module Stripe
                     :aggregate_usage,
                     :amount,
                     :billing_scheme,
+                    :constant_name,
                     :currency,
                     :interval,
                     :interval_count,
@@ -35,6 +36,7 @@ module Stripe
 
       validate :name_or_product_id
       validate :aggregate_usage_must_be_metered, if: ->(p) { p.aggregate_usage.present? }
+      validate :valid_constant_name, unless: ->(p) { p.constant_name.nil? }
 
       def initialize(*args)
         super(*args)
@@ -52,6 +54,14 @@ module Stripe
         errors.add(:base, 'must have a product_id or a name') unless (@product_id.present? ^ @name.present?)
       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 create_options
         if CurrentApiVersion.after_switch_to_products_in_plans?
           default_create_options

data/lib/stripe/rails/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module Rails
-    VERSION = '1.6.1'
+    VERSION = '1.7.0'
   end
 end

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

@@ -4,6 +4,13 @@ Stripe.plan :gold do |plan|
    plan.interval = 'month'
 end
 
+Stripe.plan "Solid Gold".to_sym do |plan|
+   plan.constant_name = 'SOLID_GOLD'
+   plan.name = 'Solid Gold'
+   plan.amount = 699
+   plan.interval = 'month'
+end
+
 Stripe.plan :alternative_currency do |plan|
    plan.name = 'Alternative Currency'
    plan.amount = 699

data/test/plan_builder_spec.rb

@@ -346,4 +346,81 @@ describe 'building plans' do
       proc {Stripe.plan(:bad) {}}.must_raise Stripe::InvalidConfigurationError
     end
   end
+  
+  describe 'with custom constant name' do
+    before do
+      Stripe.plan "Primo Plan".to_sym do |plan|
+        plan.name = 'Acme as a service PRIMO'
+        plan.constant_name = 'PRIMO_PLAN'
+        plan.amount = 699
+        plan.interval = 'month'
+        plan.interval_count = 3
+        plan.trial_period_days = 30
+        plan.metadata = {:number_of_awesome_things => 5}
+        plan.statement_descriptor = 'Acme Primo'
+        plan.active = true
+        plan.nickname = 'primo'
+        plan.usage_type = 'metered'
+        plan.billing_scheme = 'per_unit'
+        plan.aggregate_usage = 'sum'
+        plan.tiers_mode = 'graduated'
+      end
+    end
+
+    after { Stripe::Plans.send(:remove_const, :PRIMO_PLAN) }
+
+    it 'is accessible via upcased constant_name' do
+      Stripe::Plans::PRIMO_PLAN.wont_be_nil
+    end
+
+    it 'is accessible via collection' do
+      Stripe::Plans.all.must_include Stripe::Plans::PRIMO_PLAN
+    end
+
+    it 'is accessible via hash lookup (symbol/string agnostic)' do
+      Stripe::Plans[:primo_plan].must_equal Stripe::Plans::PRIMO_PLAN
+      Stripe::Plans['primo_plan'].must_equal Stripe::Plans::PRIMO_PLAN
+    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.plan "Primo Plan".to_sym do |plan|
+            plan.name = 'Acme as a service PRIMO'
+            plan.constant_name = 'PRIMO PLAN'
+            plan.amount = 999
+            plan.interval = 'month'
+          end
+        }.must_raise Stripe::InvalidConfigurationError
+      end
+    end
+
+    describe 'uploading' do
+      include FixtureLoader
+
+      describe 'when none exists on stripe.com' do
+        let(:headers) { load_request_fixture('stripe_plans_headers_2017.json') }
+        before do
+          Stripe::Plan.stubs(:retrieve).raises(Stripe::InvalidRequestError.new("not found", "id"))
+
+          stub_request(:get, "https://api.stripe.com/v1/plans").
+            with(headers: { 'Authorization'=>'Bearer XYZ',}).
+            to_return(status: 200, body: load_request_fixture('stripe_plans.json'), headers: JSON.parse(headers))
+        end
+
+        it 'creates the plan online' do
+          Stripe::Plan.expects(:create).with(
+            :id => "Solid Gold".to_sym,
+            :currency => 'usd',
+            :name => 'Solid Gold',
+            :amount => 699,
+            :interval => 'month',
+            :interval_count => 1,
+            :trial_period_days => 0
+          )
+          Stripe::Plans::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: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Charles Lowell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A gem to integrate stripe into your rails app