Merge branch 'master' into f/add-missing-decline-codes

Author: alexmamonchik

README.md

@@ -6,13 +6,13 @@
 
 # REQUEST: Looking for More Core Contributors
 
-This gem has unexpectedly grown in popularity and I've gotten pretty busy, so I'm currently looking for more core contributors to help me out. If you're interested, there is only one requirement: submit a significant enough pull request and have it merged into master (many of you have already done this). Afterwards, ping me in [chat](https://gitter.im/rebelidealist/stripe-ruby-mock) and I will add you as a collaborator.
+This gem has unexpectedly grown in popularity and I've gotten pretty busy, so I'm currently looking for more core contributors to help me out. If you're interested, there is only one requirement: submit a significant enough pull request and have it merged into master (many of you have already done this). Afterwards, ping [@gilbert](https://gitter.im/gilbert) in [chat](https://gitter.im/rebelidealist/stripe-ruby-mock) and I will add you as a collaborator.
 
 ## Install
 
 In your gemfile:
 
-    gem 'stripe-ruby-mock', '~> 2.5.8', :require => 'stripe_mock'
+    gem 'stripe-ruby-mock', '~> 3.0.0', :require => 'stripe_mock'
 
 ## Features
 
@@ -23,12 +23,12 @@ In your gemfile:
 
 ### Requirements
 
-* ruby >= 2.0.0
-* stripe >= 2.0.3
+* ruby >= 2.4.0
+* stripe >= 5.0.0
 
 ### Specifications
 
-**STRIPE API TARGET VERSION:** 2017-06-05 (master)
+**STRIPE API TARGET VERSION:** 2019-08-20 (master) - we try, but some features are not implemented yet.
 
 Older API version branches:
 
@@ -141,7 +141,7 @@ end
 ```
 
 ## Mocking Card Errors
-
+** Ensure you start StripeMock in a before filter `StripeMock.start`
 Tired of manually inputting fake credit card numbers to test against errors? Tire no more!
 
 ```ruby
@@ -176,7 +176,7 @@ StripeMock.prepare_card_error(:incorrect_zip)
 You can see the details of each error in [lib/stripe_mock/api/errors.rb](lib/stripe_mock/api/errors.rb)
 
 ### Specifying Card Errors
-
+** Ensure you start StripeMock in a before filter `StripeMock.start`
 By default, `prepare_card_error` only triggers for `:new_charge`, the event that happens when you run `Charge.create`. More explicitly, this is what happens by default:
 
 ```ruby
@@ -195,7 +195,7 @@ customer.cards.create
 `:new_charge` and `:create_card` are names of methods in the [StripeMock request handlers](lib/stripe_mock/request_handlers). You can also set `StripeMock.toggle_debug(true)` to see the event name for each Stripe request made in your tests.
 
 ### Custom Errors
-
+** Ensure you start StripeMock in a before filter `StripeMock.start`
 To raise an error on a specific type of request, take a look at the [request handlers folder](lib/stripe_mock/request_handlers/) and pass a method name to `StripeMock.prepare_error`.
 
 If you wanted to raise an error for creating a new customer, for instance, you would do the following:

lib/stripe_mock.rb

@@ -76,6 +76,7 @@
 require 'stripe_mock/request_handlers/ephemeral_key.rb'
 require 'stripe_mock/request_handlers/products.rb'
 require 'stripe_mock/request_handlers/tax_rates.rb'
+require 'stripe_mock/request_handlers/checkout.rb'
 require 'stripe_mock/instance'
 
 require 'stripe_mock/test_strategies/base.rb'

lib/stripe_mock/api/errors.rb

@@ -1,5 +1,4 @@
 module StripeMock
-
   def self.prepare_error(stripe_error, *handler_names)
     handler_names.push(:all) if handler_names.count == 0
 
@@ -15,31 +14,33 @@ def self.prepare_error(stripe_error, *handler_names)
   def self.prepare_card_error(code, *handler_names)
     handler_names.push(:new_charge) if handler_names.count == 0
 
-    args = CardErrors.argument_map[code]
-    raise StripeMockError.new("Unrecognized stripe card error code: #{code}") if args.nil?
-    self.prepare_error Stripe::CardError.new(*args), *handler_names
+    error = CardErrors.build_error_for(code)
+    if error.nil?
+      raise StripeMockError, "Unrecognized stripe card error code: #{code}"
+    end
+
+    prepare_error error, *handler_names
   end
 
   module CardErrors
-
-    def self.argument_map
-      @__map ||= {
-        incorrect_number: add_json_body(["The card number is incorrect", 'number', 'incorrect_number', http_status: 402]),
-        invalid_number: add_json_body(["The card number is not a valid credit card number", 'number', 'invalid_number', http_status: 402]),
-        invalid_expiry_month: add_json_body(["The card's expiration month is invalid", 'exp_month', 'invalid_expiry_month', http_status: 402]),
-        invalid_expiry_year: add_json_body(["The card's expiration year is invalid", 'exp_year', 'invalid_expiry_year', http_status: 402]),
-        invalid_cvc: add_json_body(["The card's security code is invalid", 'cvc', 'invalid_cvc', http_status: 402]),
-        expired_card: add_json_body(["The card has expired", 'exp_month', 'expired_card', http_status: 402]),
-        incorrect_cvc: add_json_body(["The card's security code is incorrect", 'cvc', 'incorrect_cvc', http_status: 402]),
-        card_declined: add_json_body(["The card was declined", nil, 'card_declined', http_status: 402]),
-        missing: add_json_body(["There is no card on a customer that is being charged.", nil, 'missing', http_status: 402]),
-        processing_error: add_json_body(["An error occurred while processing the card", nil, 'processing_error', http_status: 402]),
-        card_error: add_json_body(['The card number is not a valid credit card number.', 'number', 'invalid_number', http_status: 402]),
-        incorrect_zip: add_json_body(['The zip code you supplied failed validation.', 'address_zip', 'incorrect_zip', http_status: 402]),
-        insufficient_funds: add_json_body(["The card has insufficient funds to complete the purchase.", nil, 'insufficient_funds', http_status: 402]),
-        lost_card: add_json_body(["The payment has been declined because the card is reported lost.", nil, 'lost_card', http_status: 402]),
-        stolen_card: add_json_body(["The payment has been declined because the card is reported stolen.", nil, 'stolen_card', http_status: 402])
-      }
+    def self.build_error_for(code)
+      case code
+      when :incorrect_number then build_card_error('The card number is incorrect', 'number', code: 'incorrect_number', http_status: 402)
+      when :invalid_number then build_card_error('The card number is not a valid credit card number', 'number', code:  'invalid_number', http_status: 402)
+      when :invalid_expiry_month then build_card_error("The card's expiration month is invalid", 'exp_month', code: 'invalid_expiry_month', http_status: 402)
+      when :invalid_expiry_year then build_card_error("The card's expiration year is invalid", 'exp_year', code: 'invalid_expiry_year', http_status: 402)
+      when :invalid_cvc then build_card_error("The card's security code is invalid", 'cvc', code: 'invalid_cvc', http_status: 402)
+      when :expired_card then build_card_error('The card has expired', 'exp_month', code: 'expired_card', http_status: 402)
+      when :incorrect_cvc then build_card_error("The card's security code is incorrect", 'cvc', code: 'incorrect_cvc', http_status: 402)
+      when :card_declined then build_card_error('The card was declined', nil, code: 'card_declined', http_status: 402)
+      when :missing then build_card_error('There is no card on a customer that is being charged.', nil, code: 'missing', http_status: 402)
+      when :processing_error then build_card_error('An error occurred while processing the card', nil, code: 'processing_error', http_status: 402)
+      when :card_error then build_card_error('The card number is not a valid credit card number.', 'number', code: 'invalid_number', http_status: 402)
+      when :incorrect_zip then build_card_error('The zip code you supplied failed validation.', 'address_zip', code: 'incorrect_zip', http_status: 402)
+      when :insufficient_funds then build_card_error('The card has insufficient funds to complete the purchase.', nil, code: 'insufficient_funds', http_status: 402)
+      when :lost_card then build_card_error('The payment has been declined because the card is reported lost.', nil, code: 'lost_card', http_status: 402)
+      when :stolen_card then build_card_error('The payment has been declined because the card is reported stolen.', nil, code: 'stolen_card', http_status: 402)
+      end
     end
 
     def self.get_decline_code(code)
@@ -53,16 +54,18 @@ def self.get_decline_code(code)
       decline_code_map[code_key]
     end
 
-    def self.add_json_body(error_values)
-      error_keys = [:message, :param, :code]
-
-      json_hash = Hash[error_keys.zip error_values]
-      json_hash[:type] = 'card_error'
-      json_hash[:decline_code] = get_decline_code(json_hash[:code])
+    def self.build_card_error(message, param, **kwargs)
+      json_hash = {
+        message: message,
+        param: param,
+        code: kwargs[:code],
+        type: 'card_error',
+        decline_code: get_decline_code(kwargs[:code])
+      }
 
-      error_values.last.merge!(json_body: { error: json_hash }, http_body: { error: json_hash })
+      error_keyword_args = kwargs.merge(json_body: { error: json_hash }, http_body: { error: json_hash }.to_json)
 
-      error_values
+      Stripe::CardError.new(message, param, **error_keyword_args)
     end
   end
 end

lib/stripe_mock/data.rb

@@ -205,7 +205,7 @@ def self.mock_charge(params={})
           data: []
         },
         transfer: nil,
-        balance_transaction: "txn_2dyYXXP90MN26R",
+        balance_transaction: params[:balance_transaction] || "txn_2dyYXXP90MN26R",
         failure_message: nil,
         failure_code: nil,
         amount_refunded: 0,
@@ -1215,5 +1215,43 @@ def self.mock_setup_intent(params = {})
         :usage => "off_session"
       }.merge(params)
     end
+
+    def self.mock_checkout_session(params = {})
+      cs_id = params[:id] || "test_cs_default"
+      currency = params[:currency] || StripeMock.default_currency
+      {
+        id: cs_id,
+        object: 'checkout.session',
+        billing_address_collection: nil,
+        cancel_url: 'https://example.com/cancel',
+        client_reference_id: nil,
+        customer: nil,
+        customer_email: nil,
+        display_items: [
+          {
+            amount: 1500,
+            currency: currency,
+            custom: {
+              description: 'Comfortable cotton t-shirt',
+              images: nil,
+              name: 'T-shirt'
+            },
+            quantity: 2,
+            type: 'custom'
+          }
+        ],
+        livemode: false,
+        locale: nil,
+        mode: nil,
+        payment_intent: mock_payment_intent[:id],
+        payment_method_types: [
+          'card'
+        ],
+        setup_intent: nil,
+        submit_type: nil,
+        subscription: nil,
+        success_url: 'https://example.com/success'
+      }.merge(params)
+    end
   end
 end

lib/stripe_mock/instance.rb

@@ -49,11 +49,12 @@ def self.handler_for_method_url(method_url)
     include StripeMock::RequestHandlers::Payouts
     include StripeMock::RequestHandlers::EphemeralKey
     include StripeMock::RequestHandlers::TaxRates
+    include StripeMock::RequestHandlers::Checkout
 
     attr_reader :accounts, :balance, :balance_transactions, :bank_tokens, :charges, :coupons, :customers,
                 :disputes, :events, :invoices, :invoice_items, :orders, :payment_intents, :payment_methods,
                 :setup_intents, :plans, :recipients, :refunds, :transfers, :payouts, :subscriptions, :country_spec,
-                :subscriptions_items, :products, :tax_rates
+                :subscriptions_items, :products, :tax_rates, :checkout_sessions
 
     attr_accessor :error_queue, :debug, :conversion_rate, :account_balance
 
@@ -85,6 +86,7 @@ def initialize
       @subscriptions_items = {}
       @country_spec = {}
       @tax_rates = {}
+      @checkout_sessions = {}
 
       @debug = false
       @error_queue = ErrorQueue.new

lib/stripe_mock/request_handlers/checkout.rb

@@ -0,0 +1,15 @@
+module StripeMock
+  module RequestHandlers
+    module Checkout
+      def Checkout.included(klass)
+        klass.add_handler 'post /v1/checkout/sessions', :new_session
+      end
+
+      def new_session(route, method_url, params, headers)
+        params[:id] ||= new_id('cs')
+
+        checkout_sessions[params[:id]] = Data.mock_checkout_session(params)
+      end
+    end
+  end
+end

lib/stripe_mock/request_handlers/payment_intents.rb

@@ -31,15 +31,9 @@ def new_payment_intent(route, method_url, params, headers)
             last_payment_error: last_payment_error
           )
         )
-        if params[:confirm]
-          payment_intents[id] = succeeded_payment_intent(payment_intents[id])
-        end
-
-        bal_trans_params = { amount: params[:amount], source: id, application_fee: params[:application_fee] }
-        balance_transaction_id = new_balance_transaction('txn', bal_trans_params)
 
-        if payment_intents[id][:charges][:data].length > 0
-          payment_intents[id][:charges][:data][0][:balance_transaction] = balance_transaction_id
+        if params[:confirm] && status == 'succeeded'
+          payment_intents[id] = succeeded_payment_intent(payment_intents[id])
         end
 
         payment_intents[id].clone
@@ -172,8 +166,8 @@ def last_payment_error_generator(code: nil, message: nil, decline_code: nil)
 
       def succeeded_payment_intent(payment_intent)
         payment_intent[:status] = 'succeeded'
-        payment_intent[:charges][:data] << Data.mock_charge
-
+        btxn = new_balance_transaction('txn', { source: payment_intent[:id] })
+        payment_intent[:charges][:data] << Data.mock_charge(balance_transaction: btxn)
         payment_intent
       end
     end

lib/stripe_mock/request_handlers/subscriptions.rb

@@ -102,7 +102,7 @@ def create_subscription(route, method_url, params, headers)
           customer[:default_source] = new_card[:id]
         end
 
-        allowed_params = %w(customer application_fee_percent coupon items metadata plan quantity source tax_percent trial_end trial_period_days current_period_start created prorate billing_cycle_anchor billing days_until_due idempotency_key enable_incomplete_payments cancel_at_period_end default_tax_rates)
+        allowed_params = %w(customer application_fee_percent coupon items metadata plan quantity source tax_percent trial_end trial_period_days current_period_start created prorate billing_cycle_anchor billing days_until_due idempotency_key enable_incomplete_payments cancel_at_period_end default_tax_rates payment_behavior)
         unknown_params = params.keys - allowed_params.map(&:to_sym)
         if unknown_params.length > 0
           raise Stripe::InvalidRequestError.new("Received unknown parameter: #{unknown_params.join}", unknown_params.first.to_s, http_status: 400)

lib/stripe_mock/request_handlers/validators/param_validators.rb

@@ -49,7 +49,7 @@ def missing_plan_amount_message
       SUPPORTED_PLAN_INTERVALS = ["month", "year", "week", "day"]
 
       def invalid_plan_interval_message
-        "Invalid interval: must be one of month, year, week, or day"
+        "Invalid interval: must be one of day, month, week, or year"
       end
 
       SUPPORTED_CURRENCIES = [

lib/stripe_mock/test_strategies/base.rb

@@ -102,7 +102,7 @@ def create_coupon(params = {})
       end
 
       def delete_all_coupons
-        coupons = Stripe::Coupon.all
+        coupons = Stripe::Coupon.list
         coupons.data.map(&:delete) if coupons.data.count > 0
       end