stripe-rails 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc13abc0e868f9694a9709777de1a94365d1fd3b
-  data.tar.gz: 732785e90b16d15ce68c61767db21cabf3b6b062
+  metadata.gz: ac50cc61a92527aeb62ea99d1c288dd9057e2796
+  data.tar.gz: a499347e24515c8d7ccddc7b961e62abf633e9a6
 SHA512:
-  metadata.gz: 9a07835744d0b8c03439916e5ab39a8afb0bedcc614bfa55fef0a06a6ef13530c1e6f6c1252c1a6c14975c3669647203818896d996486332de41c5f2cdcac832
-  data.tar.gz: 9285d16a3d4eabd200a5c73f76ff0ddb065cd7a2d4a8b0a68b5beac7a0a22ece7f09081125a6a68f6d99fed289199b889264161006cd0b607dd09d531e642955
+  metadata.gz: 077e01fe7390da6d0c3facab63783dc89d71fe9d91ba14bddc7b6b765855379d832857d2b17630898d9d9cd5be618cac8ce676cddd99e29e5a1d761846118c62
+  data.tar.gz: 3a506cbec7767db9a96b5bf4b7c30b81dcc9f833d0904f049afee2b9aae64082e1da346a8902379e884869b473d18ca639506121cac1e10afbb4e0c3f79da50e

data/.travis.yml

@@ -4,10 +4,6 @@ rvm:
   - 2.3.4
   - 2.2.7
   - 2.1.9
-notifications:
-  email:
-    recipients:
-      - cowboyd@thefrontside.net
 env:
   global:
     - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
@@ -33,4 +29,4 @@ matrix:
     - rvm: 2.1.9
       gemfile: Gemfile
     - rvm: 2.1.9
-      gemfile: gemfiles/rails5.gemfile
+      gemfile: gemfiles/rails5.gemfile

data/Changelog.md

@@ -1,3 +1,9 @@
+## 1.1.0 (2017-08-29)
+
+* Adds a testing module for testing callbacks (thanks @Pyo25)
+* Fixes loading with ActionController::API (thanks @gaffneyc)
+* Fixes `NoMethodError: NoMethodError (undefined method `object' for #ActionController::Parameters` (thanks to a whole bunch of people for reporting this)
+
 ## 1.0.2 (2017-08-15)
 
 * Remove authenticity token check (thanks @lewispb)

data/README.md

@@ -358,6 +358,30 @@ end
 
 See the [complete listing of all stripe events][5], and the [webhook tutorial][6] for more great information on this subject.
 
+## Unit testing
+
+If you want to test your callbacks, you can use the `Stripe::Testing` module to send mocked Stripe events.
+
+```ruby
+test "my callback handles new subscription" do
+  Stripe::Testing.send_event "customer.subscription.created"
+  # Assertions
+end
+```
+
+You can also overwrite some event properties: ([More info](https://github.com/rebelidealist/stripe-ruby-mock#customizing-webhooks))
+
+```ruby
+test "my callback handles new subscription" do
+  Stripe::Testing.send_event "customer.subscription.created", {
+    :email => "john@doe.com",
+    :account_balance => 40
+  }
+  # Assertions
+end
+```
+
+The default fixtures come from [the `stripe-ruby-mock` gem](https://github.com/rebelidealist/stripe-ruby-mock/tree/master/lib/stripe_mock/webhook_fixtures).
 
 ## Thanks
 

data/app/models/stripe/event_dispatch.rb

@@ -11,7 +11,7 @@ module Stripe
     def retrieve_stripe_event(params)
       id = params['id']
       if id == 'evt_00000000000000' #this is a webhook test
-        yield Stripe::Event.construct_from(params)
+        yield Stripe::Event.construct_from(params.to_unsafe_h)
       else
         yield Stripe::Event.retrieve(id)
       end

data/gemfiles/rails4.gemfile

@@ -9,6 +9,7 @@ gem 'mocha'
 gem 'pry'
 gem 'responders', '~> 2.0' # to support Rails 4.2
 gem 'stripe'
+gem 'stripe-ruby-mock', '~> 2.4'
 
 group :test do
   gem 'simplecov', require: false

data/gemfiles/rails5.gemfile

@@ -9,6 +9,7 @@ gem 'mocha'
 gem 'pry'
 gem 'responders', '~> 2.0' # to support Rails 4.2
 gem 'stripe'
+gem 'stripe-ruby-mock', '~> 2.4'
 
 group :test do
   gem 'simplecov', require: false

data/lib/stripe/engine.rb

@@ -55,7 +55,10 @@ environment file directly.
 
     initializer 'stripe.javascript_helper' do
       ActiveSupport.on_load :action_controller do
-        helper Stripe::JavascriptHelper
+        # ActionController::API does not have a helper method
+        if respond_to?(:helper)
+          helper Stripe::JavascriptHelper
+        end
       end
     end
 

data/lib/stripe/rails.rb

@@ -1,6 +1,8 @@
+require 'responders'
 require "stripe/rails/version"
 require 'stripe/engine'
 require 'stripe/configuration_builder'
 require 'stripe/plans'
 require 'stripe/coupons'
-require 'stripe/callbacks'
+require 'stripe/callbacks'
+require 'stripe/testing'

data/lib/stripe/rails/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module Rails
-    VERSION = '1.0.2'
+    VERSION = '1.1.0'
   end
 end

data/lib/stripe/testing.rb

@@ -0,0 +1,12 @@
+require 'stripe_mock'
+require 'stripe/callbacks'
+
+module Stripe
+  module Testing
+    def self.send_event(event, properties = {})
+      evt = StripeMock.mock_webhook_event(event, properties)
+      target = evt.data.object
+      ::Stripe::Callbacks.run_callbacks(evt, target)
+    end
+  end
+end

data/stripe-rails.gemspec

@@ -1,9 +1,8 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/stripe/rails/version', __FILE__)
+require File.expand_path('lib/stripe/rails/version', __dir__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Charles Lowell", "Nola Stowe"]
-  gem.email         = ["cowboyd@frontside.io"]
+  gem.authors       = ["Charles Lowell", "Nola Stowe", "SengMing Tan"]
+  gem.email         = ["sengming@sanemen.com"]
   gem.description   = "A gem to integrate stripe into your rails app"
   gem.summary       = "A gem to integrate stripe into your rails app"
   gem.homepage      = "https://github.com/Everapps/stripe-rails"
@@ -18,4 +17,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rails', '>= 3'
   gem.add_dependency 'stripe'
   gem.add_dependency 'responders'
+  gem.add_dependency 'stripe-ruby-mock', '~> 2.4'
 end

data/test/callbacks_spec.rb

@@ -5,8 +5,8 @@ describe Stripe::Callbacks do
   include CallbackHelpers
 
   let(:app)       { Rails.application }
-  let(:event)     { JSON.parse(File.read File.expand_path('../event.json', __FILE__)) }
-  let(:invoice)   { JSON.parse(File.read File.expand_path('../invoice.json', __FILE__)) }
+  let(:event)     { JSON.parse(File.read File.expand_path('event.json', __dir__)) }
+  let(:invoice)   { JSON.parse(File.read File.expand_path('invoice.json', __dir__)) }
   let(:content)   { event }
   let(:observer)  { Class.new }
 
@@ -53,6 +53,12 @@ describe Stripe::Callbacks do
         ->{ subject }.must_raise RuntimeError
       end
     end
+
+    describe 'when run from a Stripe webhook test' do
+      before { event['id'] = 'evt_00000000000000' }
+
+      it { subject } # must_not raise error
+    end
   end
 
   describe 'defined without a bang and raising an exception' do

data/test/dummy/app/controllers/apis_controller.rb

@@ -0,0 +1,7 @@
+ApiControllerKlass = defined?(ActionController::API) ? ActionController::API : ApplicationController
+
+class ApisController < ApiControllerKlass
+  def index
+    render json: :ok
+  end
+end

data/test/dummy/config/routes.rb

@@ -1,5 +1,6 @@
 Dummy::Application.routes.draw do
   resources :stripes, only: :new
+  resources :apis, only: :index
   # The priority is based upon order of creation:
   # first created -> highest priority.
 

data/test/dummy_apis_controller_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ApisController do
+  include Rack::Test::Methods
+
+  let(:app) { Rails.application }
+  before do
+    header 'Accept', 'application/json'
+    header 'Content-Type', 'application/json'
+  end
+
+  describe 'the ping interface' do
+    subject { get '/apis/' }
+
+    it { subject.must_be :ok? }
+  end
+end

data/test/spec_helper.rb

@@ -9,17 +9,17 @@ require 'minitest/autorun'
 ENV["RAILS_ENV"] = "test"
 ENV['STRIPE_SECRET_KEY'] = 'XYZ'
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require File.expand_path("dummy/config/environment.rb", __dir__)
 require "rails/test_help"
 
 Rails.backtrace_cleaner.remove_silencers!
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{__dir__}/support/**/*.rb"].each { |f| require f }
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.method_defined?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__)
 end
 
 Stripe::Engine.testing = true

data/test/support/application_system_test_case.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../null_system_test_case",  __FILE__)
+require File.expand_path("null_system_test_case", __dir__)
 require "capybara/poltergeist"
 require 'phantomjs/poltergeist'
 

data/test/testing_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe "Testing" do
+  let(:observer)  { Class.new }
+  let(:event)     { observer.instance_variable_get :@event }
+  let(:target)    { observer.instance_variable_get :@target }
+
+  before do
+    StripeMock.start
+
+    observer.include Stripe::Callbacks
+    observer.class_eval do
+      after_invoice_payment_succeeded! { |target, event| @event, @target = event, target }
+    end
+  end
+  
+  after do
+    ::Stripe::Callbacks.clear_callbacks!
+    StripeMock.stop
+  end
+
+  describe '.send_event' do
+    subject { Stripe::Testing.send_event event_name }
+
+    describe 'when forwarding the event to the callback' do
+      let(:event_name) { "invoice.payment_succeeded" }
+
+      it 'the callback must run' do
+        subject
+        event.wont_be_nil
+        event.type.must_equal "invoice.payment_succeeded"
+      end
+    end
+
+    describe 'when forwarding the event to another callback' do
+      let(:event_name) { 'customer.created' }
+
+      it 'the callback must not run' do
+        subject
+        event.must_be_nil
+      end
+    end
+
+    describe 'when overwriting event properties' do
+      subject { Stripe::Testing.send_event event_name, params }
+      let(:event_name) { "invoice.payment_succeeded" }
+      let(:params)     { { subtotal: 500, total: 1000, currency: "eur" } }
+
+      it 'the callback should run with overwritten properties' do
+        subject
+        event.wont_be_nil
+        event.type.must_equal "invoice.payment_succeeded"
+        target.subtotal.must_equal 500
+        target.total.must_equal 1000
+        target.currency.must_equal "eur"
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stripe-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Charles Lowell
 - Nola Stowe
+- SengMing Tan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,9 +54,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: stripe-ruby-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: A gem to integrate stripe into your rails app
 email:
-- cowboyd@frontside.io
+- sengming@sanemen.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -93,6 +108,7 @@ files:
 - lib/stripe/rails.rb
 - lib/stripe/rails/tasks.rake
 - lib/stripe/rails/version.rb
+- lib/stripe/testing.rb
 - stripe-rails.gemspec
 - test/all.rb
 - test/callbacks_spec.rb
@@ -101,6 +117,7 @@ files:
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/apis_controller.rb
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/stripes_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -134,6 +151,7 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/script/rails
+- test/dummy_apis_controller_spec.rb
 - test/dummy_stripes_controller_spec.rb
 - test/event.json
 - test/invoice.json
@@ -145,6 +163,7 @@ files:
 - test/support/application_system_test_case.rb
 - test/support/callback_helpers.rb
 - test/support/null_system_test_case.rb
+- test/testing_spec.rb
 homepage: https://github.com/Everapps/stripe-rails
 licenses:
 - MIT
@@ -165,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A gem to integrate stripe into your rails app
@@ -177,6 +196,7 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/apis_controller.rb
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/stripes_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -210,6 +230,7 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/script/rails
+- test/dummy_apis_controller_spec.rb
 - test/dummy_stripes_controller_spec.rb
 - test/event.json
 - test/invoice.json
@@ -221,3 +242,4 @@ test_files:
 - test/support/application_system_test_case.rb
 - test/support/callback_helpers.rb
 - test/support/null_system_test_case.rb
+- test/testing_spec.rb