stripe-rails 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b69dd28ba0f7e285499222f566f1a3d94792a3d928c07e6f820231758a1076f2
-  data.tar.gz: 20001b39f130cf45f32b4418acd4a7b25c2f855eb4c82150af7a0efdd1761b01
+  metadata.gz: eb58cd2c4b57bfb766859f950ea819137df7d25df3064654877db23a853fc181
+  data.tar.gz: b93b09f34648ff133397a56606a37bb5067130d19aef9007c823e13b993a4cfe
 SHA512:
-  metadata.gz: a5ca715db15caf73a7261911590c31e8155bf65769ca5d28b3c2c548ddb76f5560ce2a56e45241daf8d614de0a4bfa2fd6c9b5f45d5909cdee8ef224cf7ae727
-  data.tar.gz: 5883ebce3e32917174404c92c9114e683de9e63bde4bb8c23c8a2d5bfe13ee8586a545bcc9a5c853289cf8be4812a14db0890eff795243f2aaef55a2ee548c4c
+  metadata.gz: 39ff75adfde760950733e00324423c99506d53f9cee614a7adc0ec61a2ea14758e9d9a1dc49a4cd2ceac83ed7c7597c8c276cb0cb169ba813c7e2de9da7fe237
+  data.tar.gz: 861343d690279311225fda2091e0d318c08c2c4c33e98d4fb73f9e528750a6751e7b0f07a2b1c43341da8a4011e4ff3618c3cee799445a38dd720bfab6d6b250

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/Changelog.md

@@ -1,4 +1,7 @@
-## Unreleased
+## 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)
 

data/README.md

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

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

data/lib/stripe/rails/version.rb

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

data/test/events_controller_spec.rb

@@ -10,6 +10,10 @@ describe Stripe::EventsController do
   end
 
   describe 'the events interface' do
+    subject { post '/stripe/events', params.to_json }
+
+    before { stripe_events_stub }
+
     let(:params) {
       {
         id: 'evt_00000000000000',
@@ -17,14 +21,29 @@ describe Stripe::EventsController do
         data: {object: 'customer'},
       }
     }
-
-    before do
+    let(:stripe_events_stub) do
       stub_request(:get, "https://api.stripe.com/v1/events/evt_00000000000000").
         to_return(status: 200, body: Stripe::Event.construct_from(params).to_json, headers: {})
     end
-    subject { post '/stripe/events', params.to_json }
 
     it { _(subject).must_be :ok? }
+
+    it 'should call the stripe_events_stub' do
+      subject
+      assert_requested(stripe_events_stub)
+    end
+
+    describe 'when signing_secret is nil' do
+      before do
+        header 'Stripe-Signature', 't=1537832721,v1=123,v0=123'
+        app.config.stripe.signing_secret = nil
+      end
+
+      it 'should call the stripe_events_stub' do
+        subject
+        assert_requested(stripe_events_stub)
+      end
+    end
   end
 
   describe 'signed webhooks' do

data/test/stripe_initializers_spec.rb

@@ -12,9 +12,10 @@ describe "Configuring the stripe engine" do
   def rerun_initializers!; initializers.each{|init| init.run(app) }; end
 
   after do
-    Stripe.api_version = nil
-    Stripe.api_base    = 'https://api.stripe.com'
-    Stripe.api_key     = 'XYZ'
+    Stripe.api_version       = nil
+    Stripe.api_base          = 'https://api.stripe.com'
+    Stripe.api_key           = 'XYZ'
+    ENV['STRIPE_SECRET_KEY'] = 'XYZ'
   end
 
   describe 'Stripe configurations' do
@@ -40,7 +41,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
@@ -56,6 +57,16 @@ describe "Configuring the stripe engine" do
       _(app.config.stripe.signing_secrets.length).must_equal 1
     end
 
+    it "supports nil signing_secret" do
+      subject
+
+      app.config.stripe.signing_secret    = nil
+      rerun_initializers!
+
+      _(app.config.stripe.signing_secret).must_equal nil
+      _(app.config.stripe.signing_secrets).must_equal nil
+    end
+
     it "supports multiple signing secrets" do
       subject
 
@@ -90,4 +101,36 @@ describe "Configuring the stripe engine" do
       _(-> { subject }).must_output '', warning_msg
     end
   end
+
+  describe 'missing stripe.secret_key' do
+    subject do
+      ENV['STRIPE_SECRET_KEY'] = nil
+      Stripe.api_key = nil
+      app.config.stripe.secret_key = nil
+      rerun_initializers!
+    end
+    let(:warning_msg) { /No stripe.com API key was configured for environment test!/ }
+
+    it 'should output a warning' do
+      _(-> { subject }).must_output '', warning_msg
+    end
+  end
+
+  describe 'stripe.ignore_missing_secret_key' do
+    subject do
+      ENV['STRIPE_SECRET_KEY'] = nil
+      Stripe.api_key = nil
+      app.config.stripe.secret_key = nil
+      app.config.stripe.ignore_missing_secret_key = true
+      rerun_initializers!
+    end
+
+    after do
+      app.config.stripe.ignore_missing_secret_key = false
+    end
+
+    it 'should not output a warning' do
+      _(-> { subject }).must_output '', ''
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Charles Lowell
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails