stripe-ruby-mock 2.5.8 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a15c09639e0a93df5b15cc5a45646c0fb189460e
-  data.tar.gz: b8cdf0692aba8099229f66e1906e691dd40075aa
+  metadata.gz: 83e0a13431e08fd71904300dbc7717e48deead7f
+  data.tar.gz: 481c5c3a5d1643107ddf35fbaf14e0f8bdd36f72
 SHA512:
-  metadata.gz: 9d70a5de8ae26c090632d00c1013d5ca63933fee41e40561b2e713b511a1c1347b21485b1d1c4eb8ee6837b6f4ec9a9f8e857a7bfa0785ac2182b8190180bfbb
-  data.tar.gz: 542f7a6f6c8743269e0337c1fc0b4fabef97003fe4d945c077ab4e16fe908bf7c21996dcb8c25ade7a4975a273a51972621d8d997e35a86f00dcb5287ae63d89
+  metadata.gz: 46c6533cfb41b36eaa7be7ac93a54e2d7f3f5c74eb2e48c1473c21f88c49b65011153719c2b9f62cf5f1157a6e7938ea3a84ff133c363445a5212e9dc6a59682
+  data.tar.gz: 1d09905741e5fa10537abfedb94db03b5c9475db967476b5c8e87c460ae46821e07d89455f008ba7c902b61adcf751b16ed812c9fd5bf949c5f4de3336b32491

data/.gitignore

@@ -5,4 +5,4 @@ stripe-mock-server.pid
 Gemfile.lock
 stripe-mock-server.log
 .idea
-.ruby-version
+.ruby-version

data/.travis.yml

@@ -3,13 +3,12 @@ group: deprecated-2017Q2
 sudo: required
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 before_install:
   - rvm 2.1.10 do gem install mime-types -v 2.6.2
-  - gem install bundler
+  - gem install bundler -v '< 2'
 before_script:
   - "sudo touch /var/log/stripe-mock-server.log"
   - "sudo chown travis /var/log/stripe-mock-server.log"
@@ -17,7 +16,7 @@ script: "bundle exec rspec && bundle exec rspec -t live"
 
 env:
   global:
-    - IS_TRAVIS=true STRIPE_TEST_SECRET_KEY_A=sk_test_Ut2MSlZANdT3iDALdGhyLymy STRIPE_TEST_SECRET_KEY_B=sk_test_JXtzss9tHOG1ofIyEZgoUP4Q STRIPE_TEST_SECRET_KEY_C=sk_test_ZR5nVz9p3ivsqVa7mYB0sFep STRIPE_TEST_SECRET_KEY_D=sk_test_ZR5nVz9p3ivsqVa7mYB0sFep
+    - IS_TRAVIS=true STRIPE_TEST_SECRET_KEY_A=sk_test_BsztzqQjzd7lqkgo1LjEG5DF00KzH7tWKF STRIPE_TEST_SECRET_KEY_B=sk_test_rKCEu0x8jzg6cKPqoey8kUPQ00usQO3KYE STRIPE_TEST_SECRET_KEY_C=sk_test_qeaB7R6Ywp8sC9pzd1ZIABH700YLC7nhmZ
 
 notifications:
   webhooks:
@@ -26,3 +25,4 @@ notifications:
     on_success: change  # options: [always|never|change] default: always
     on_failure: always  # options: [always|never|change] default: always
     on_start: false     # default: false
+

data/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:

data/lib/stripe_mock.rb

@@ -65,6 +65,9 @@ require 'stripe_mock/request_handlers/plans.rb'
 require 'stripe_mock/request_handlers/recipients.rb'
 require 'stripe_mock/request_handlers/refunds.rb'
 require 'stripe_mock/request_handlers/transfers.rb'
+require 'stripe_mock/request_handlers/payment_intents.rb'
+require 'stripe_mock/request_handlers/payment_methods.rb'
+require 'stripe_mock/request_handlers/setup_intents.rb'
 require 'stripe_mock/request_handlers/payouts.rb'
 require 'stripe_mock/request_handlers/subscriptions.rb'
 require 'stripe_mock/request_handlers/subscription_items.rb'

data/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,28 +14,30 @@ module StripeMock
   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])
-      }
+    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)
+      end
     end
 
     def self.get_decline_code(code)
@@ -50,16 +51,18 @@ module StripeMock
       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

data/lib/stripe_mock/api/webhooks.rb

@@ -75,6 +75,9 @@ module StripeMock
         'plan.created',
         'plan.updated',
         'plan.deleted',
+        'product.created',
+        'product.updated',
+        'product.deleted',
         'coupon.created',
         'coupon.deleted',
         'transfer.created',

data/lib/stripe_mock/data.rb

@@ -128,11 +128,17 @@ module StripeMock
         created: 1372126710,
         id: cus_id,
         name: nil,
+        preferred_locales: [],
         livemode: false,
         delinquent: false,
         discount: nil,
         account_balance: 0,
         currency: currency,
+        invoice_settings: {
+          default_payment_method: nil,
+          custom_fields: nil,
+          footer: nil
+        },
         sources: {
           object: "list",
           total_count: sources.size,
@@ -199,7 +205,7 @@ module StripeMock
           data: []
         },
         transfer: nil,
-        balance_transaction: "txn_2dyYXXP90MN26R",
+        balance_transaction: params[:balance_transaction] || "txn_2dyYXXP90MN26R",
         failure_message: nil,
         failure_code: nil,
         amount_refunded: 0,
@@ -342,7 +348,8 @@ module StripeMock
         quantity: 1,
         tax_percent: nil,
         discount: nil,
-        metadata: {}
+        metadata: {},
+        default_tax_rates: nil
       }, params)
     end
 
@@ -358,6 +365,7 @@ module StripeMock
         created: 1349738950,
         period_end: 1349738950,
         period_start: 1349738950,
+        due_date: nil,
         lines: {
           object: "list",
           total_count: lines.count,
@@ -385,7 +393,7 @@ module StripeMock
         amount_paid: 0,
         currency: currency,
         starting_balance: 0,
-        ending_balance: nil,
+        ending_balance: 0,
         next_payment_attempt: 1349825350,
         charge: nil,
         discount: nil,
@@ -399,6 +407,7 @@ module StripeMock
       end
       due = invoice[:total] + invoice[:starting_balance]
       invoice[:amount_due] = due < 0 ? 0 : due
+      invoice[:ending_balance] = invoice[:starting_balance] + invoice[:total] if invoice[:amount_due] == 0
       invoice
     end
 
@@ -521,33 +530,49 @@ module StripeMock
     def self.mock_plan(params={})
       currency = params[:currency] || StripeMock.default_currency
       {
-        id: "2",
+        id: "mock_plan_123",
         object: "plan",
+        active: true,
+        aggregate_usage: nil,
         amount: 2300,
+        billing_scheme: "per_unit",
         created: 1466698898,
         currency: currency,
         interval: "month",
         interval_count: 1,
         livemode: false,
         metadata: {},
-        name: "The Basic Plan",
-        statement_descriptor: nil,
-        trial_period_days: nil
+        nickname: "My Mock Plan",
+        product: "mock_prod_NONEXIST", # override this with your own existing product id
+        tiers: nil,
+        tiers_mode: nil,
+        transform_usage: nil,
+        trial_period_days: nil,
+        usage_type: "licensed"
       }.merge(params)
     end
 
-    def self.mock_product(params = {})
+    def self.mock_product(params={})
       {
-        id: "default_test_prod",
+        id: "mock_prod_abc123",
         object: "product",
         active: true,
-        created: 1556896214,
+        attributes:[],
+        caption: nil,
+        created: 1466698000,
+        deactivate_on: [],
+        description: nil,
+        images: [],
         livemode: false,
         metadata: {},
-        name: "Default Test Product",
-        statement_descriptor: "PRODUCT",
+        name: "The Mock Product",
+        package_dimensions: nil,
+        shippable: nil,
+        statement_descriptor: nil,
         type: "service",
-        updated: 1556918200,
+        unit_label: "my_unit",
+        updated: 1537939442,
+        url: nil
       }.merge(params)
     end
 
@@ -1088,5 +1113,107 @@ module StripeMock
         secret: "ek_test_default"
       }
     end
+
+    def self.mock_payment_intent(params = {})
+      payment_intent_id = params[:id] || "pi_1EwXFB2eZvKYlo2CggNnFBo8"
+      amount = params[:amount] || 49900
+      currency = params[:currency] || StripeMock.default_currency
+      {
+          id: payment_intent_id,
+          object: "payment_intent",
+          amount: amount,
+          amount_capturable: 0,
+          amount_received: 0,
+          application: nil,
+          application_fee_amount: nil,
+          canceled_at: nil,
+          cancellation_reason: nil,
+          capture_method: "automatic",
+          charges: {
+              object: "list",
+              data: [],
+              has_more: false,
+              total_count: 1,
+              url: "/v1/charges?payment_intent=pi_1EwXFB2eZvKYlo2CggNnFBo8"
+          },
+          client_secret: "pi_1EwXFB2eZvKYlo2CggNnFBo8_secret_vOMkpqZu8ca7hxhfiO80tpT3v",
+          confirmation_method: "manual",
+          created: 1563208901,
+          currency: currency,
+          customer: nil,
+          description: nil,
+          invoice: nil,
+          last_payment_error: nil,
+          livemode: false,
+          metadata: {},
+          next_action: { type: "use_stripe_sdk" },
+          on_behalf_of: nil,
+          payment_method: nil,
+          payment_method_types: [
+              "card"
+          ],
+          receipt_email: nil,
+          review: nil,
+          setup_future_usage: nil,
+          shipping: nil,
+          source: nil,
+          statement_descriptor: nil,
+          status: "requires_action",
+          transfer_data: nil,
+          transfer_group: nil
+      }.merge(params)
+    end
+
+    def self.mock_payment_method(params = {})
+      payment_method_id = params[:id] || "pm_1ExEuFL2DI6wht39WNJgbybl"
+      {
+          id: payment_method_id,
+          object: "payment_method",
+          type: "card",
+          billing_details: {},
+          card: {
+              brand: "visa",
+              checks: { address_line1_check: nil, address_postal_code_check: nil, cvc_check: "pass" },
+              country: "FR",
+              exp_month: 2,
+              exp_year: 2022,
+              fingerprint: "Hr3Ly5z5IYxsokWA",
+              funding: "credit",
+              last4: "3155",
+              three_d_secure_usage: { supported: true }
+          },
+          customer: params[:customer] || nil,
+          metadata: {
+            "order_id": "123456789"
+          }
+
+      }.merge(params)
+    end
+
+    def self.mock_setup_intent(params = {})
+      setup_intent_id = params[:id] || "seti_1F96eK2aLAadsDqo0AVIyPmC"
+      {
+        :id => setup_intent_id,
+        :object => "setup_intent",
+        :application => nil,
+        :cancellation_reason => nil,
+        :client_secret => "seti_1F96eK2aLAadsDqo0AVIyPmC_secret_FePTYgOoPFxDOUL53fFMSoTAyiXsWAV",
+        :created => 1566204936,
+        :customer => nil,
+        :description => nil,
+        :last_setup_error => nil,
+        :livemode => false,
+        :metadata => {},
+        :next_action => nil,
+        :on_behalf_of => nil,
+        :payment_method => nil,
+        :payment_method_options => {
+          "card": {"request_three_d_secure":"automatic"}
+        },
+        :payment_method_types => ["card"],
+        :status => "requires_payment_method",
+        :usage => "off_session"
+      }.merge(params)
+    end
   end
 end

data/lib/stripe_mock/instance.rb

@@ -20,6 +20,9 @@ module StripeMock
       @@handlers.find {|h| method_url =~ h[:route] }
     end
 
+    include StripeMock::RequestHandlers::PaymentIntents
+    include StripeMock::RequestHandlers::PaymentMethods
+    include StripeMock::RequestHandlers::SetupIntents
     include StripeMock::RequestHandlers::ExternalAccounts
     include StripeMock::RequestHandlers::Accounts
     include StripeMock::RequestHandlers::Balance
@@ -48,9 +51,9 @@ module StripeMock
     include StripeMock::RequestHandlers::TaxRates
 
     attr_reader :accounts, :balance, :balance_transactions, :bank_tokens, :charges, :coupons, :customers,
-                :disputes, :events, :invoices, :invoice_items, :orders, :plans, :recipients,
-                :refunds, :transfers, :payouts, :subscriptions, :country_spec, :subscriptions_items,
-                :products, :tax_rates
+                :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
 
     attr_accessor :error_queue, :debug, :conversion_rate, :account_balance
 
@@ -62,12 +65,16 @@ module StripeMock
       @card_tokens = {}
       @customers = {}
       @charges = {}
+      @payment_intents = {}
+      @payment_methods = {}
+      @setup_intents = {}
       @coupons = {}
       @disputes = Data.mock_disputes(['dp_05RsQX2eZvKYlo2C0FRTGSSA','dp_15RsQX2eZvKYlo2C0ERTYUIA', 'dp_25RsQX2eZvKYlo2C0ZXCVBNM', 'dp_35RsQX2eZvKYlo2C0QAZXSWE', 'dp_45RsQX2eZvKYlo2C0EDCVFRT', 'dp_55RsQX2eZvKYlo2C0OIKLJUY', 'dp_65RsQX2eZvKYlo2C0ASDFGHJ', 'dp_75RsQX2eZvKYlo2C0EDCXSWQ', 'dp_85RsQX2eZvKYlo2C0UJMCDET', 'dp_95RsQX2eZvKYlo2C0EDFRYUI'])
       @events = {}
       @invoices = {}
       @invoice_items = {}
       @orders = {}
+      @payment_methods = {}
       @plans = {}
       @products = {}
       @recipients = {}