stripe-rails 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3458e73514e9d287513ab9ff1192ccc37f7eed53681d407027f8a828c4e629
-  data.tar.gz: 3cf53318d3cc31fac81c7d4ea4e5d981138eb1a0266dcc4a261fd8a49ddb014b
+  metadata.gz: 9c6add3569f0d6ebce78539fea9a2f3bc5364779be1a2984f6fc3287ffa40ff7
+  data.tar.gz: ac4a7af14e8eaafcf73ab20143886e5d9ed7492175aaba925e70cc10d0e5f527
 SHA512:
-  metadata.gz: c4283ef2ffddcddda494634e58cdda112f26dc82fc14428eaa8130e4d94b138862cdf6b8aa04886ad3291dd67788d75780420f4e00847845a59a1016d4ac7c4f
-  data.tar.gz: 2ea2f1dc27ab45a92e4ba49b67430bb1b0b51a3379e192740ec4bc9eb7bb068004c9b9d213937727cc95718328e4c9786611969d515e5e9db5b3fa306c2698ed
+  metadata.gz: 0c9d7181d6a2ba947af2aa102b40d7547ebc3339cea5adcbf71699e16b49734dacf471f3a0b590da0fd013f645ea51c2d3a943d019395c5d91c22a986ba81287
+  data.tar.gz: 96ca6a73ea1d133cc9023a125dd658ad1258b4af030bb2478304bc442dd80527f23817825f483348e30eaac08421d6bef96e7f81515acc8284113565786208bc

data/Changelog.md

@@ -1,3 +1,7 @@
+## 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/README.md

@@ -310,29 +310,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 +354,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/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/rails/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module Rails
-    VERSION = '1.8.2'.freeze
+    VERSION = '1.9.0'.freeze
   end
 end

data/test/events_controller_spec.rb

@@ -58,4 +58,36 @@ describe Stripe::EventsController do
       subject.must_be :ok?
     end
   end
+
+  describe 'multiple signed webhooks' do
+    before do
+      header 'Stripe-Signature', 't=1537832721,v1=123,v0=123'
+      app.config.stripe.signing_secrets = ['SECRET1', 'SECRET2']
+    end
+
+    after { app.config.stripe.signing_secrets = nil }
+
+    let(:params) {
+      {
+        id: 'evt_00000000000001',
+        type: 'customer.updated',
+        data: {
+          object: 'customer',
+          fingerprint: 'xxxyyyzzz'
+        },
+      }
+    }
+
+    subject { post '/stripe/events', params.to_json }
+
+    it 'returns bad_request when invalid' do
+      Stripe::Webhook.expects(:construct_event).twice.raises(Stripe::SignatureVerificationError.new('msg', 'sig_header'))
+      subject.must_be :bad_request?
+    end
+
+    it 'returns ok when valid' do
+      Stripe::Webhook.expects(:construct_event).returns(Stripe::Event.construct_from(params))
+      subject.must_be :ok?
+    end
+  end
 end

data/test/stripe_initializers_spec.rb

@@ -40,7 +40,7 @@ describe "Configuring the stripe engine" do
       app.config.stripe.open_timeout      = 33
       app.config.stripe.read_timeout      = 88
       rerun_initializers!
-    end
+    end 
 
     it "reads values that is set in the environment" do
       subject
@@ -52,8 +52,20 @@ describe "Configuring the stripe engine" do
       Stripe.open_timeout.must_equal      33
       Stripe.read_timeout.must_equal      88
 
-      app.config.stripe.signing_secret.must_equal   'SIGNING_SECRET_XYZ'
+      app.config.stripe.signing_secret.must_equal 'SIGNING_SECRET_XYZ'
+      app.config.stripe.signing_secrets.length.must_equal 1
+    end
+
+    it "supports multiple signing secrets" do
+      subject
+
+      app.config.stripe.signing_secrets    = ['SIGNING_SECRET_XYZ', 'SIGNING_SECRET_XYZ_CONNECT']
+      rerun_initializers!
+
+      app.config.stripe.signing_secret.must_equal 'SIGNING_SECRET_XYZ'
+      app.config.stripe.signing_secrets.length.must_equal 2
     end
+
   end
 
   describe 'eager loaded callbacks' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-rails
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Charles Lowell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-31 00:00:00.000000000 Z
+date: 2019-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails