stripe-ruby-mock 2.4.0 → 2.5.8

data/lib/stripe_mock/data.rb

@@ -3,7 +3,7 @@ module StripeMock
 
     def self.mock_account(params = {})
       id = params[:id] || 'acct_103ED82ePvKYlo2C'
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: id,
         email: "bob@example.com",
@@ -12,7 +12,7 @@ module StripeMock
         timezone: "US/Pacific",
         details_submitted: false,
         charges_enabled: false,
-        transfers_enabled: false,
+        payouts_enabled: false,
         currencies_supported: [
           "usd"
         ],
@@ -101,9 +101,25 @@ module StripeMock
       }.merge(params)
     end
 
+    def self.mock_tax_rate(params)
+      {
+        id: 'test_cus_default',
+        object: 'tax_rate',
+        active: true,
+        created: 1559079603,
+        description: nil,
+        display_name: 'VAT',
+        inclusive: false,
+        jurisdiction: 'EU',
+        livemode: false,
+        metadata: {},
+        percentage: 21.0
+      }.merge(params)
+    end
+
     def self.mock_customer(sources, params)
       cus_id = params[:id] || "test_cus_default"
-      currency = params[:currency] || nil
+      currency = params[:currency] || StripeMock.default_currency
       sources.each {|source| source[:customer] = cus_id}
       {
         email: 'stripe_mock@example.com',
@@ -111,6 +127,7 @@ module StripeMock
         object: "customer",
         created: 1372126710,
         id: cus_id,
+        name: nil,
         livemode: false,
         delinquent: false,
         discount: nil,
@@ -134,7 +151,7 @@ module StripeMock
 
     def self.mock_charge(params={})
       charge_id = params[:id] || "ch_1fD6uiR9FAA2zc"
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: charge_id,
         object: "charge",
@@ -196,7 +213,7 @@ module StripeMock
     end
 
     def self.mock_refund(params={})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: "re_4fWhgUh5si7InF",
         amount: 1,
@@ -207,7 +224,8 @@ module StripeMock
         metadata: {},
         charge: "ch_4fWhYjzQ23UFWT",
         receipt_number: nil,
-        status: "succeeded"
+        status: "succeeded",
+        reason: "requested_by_customer"
       }.merge(params)
     end
 
@@ -242,12 +260,13 @@ module StripeMock
         cvc_check: nil,
         address_line1_check: nil,
         address_zip_check: nil,
-        tokenization_method: nil
+        tokenization_method: nil,
+        metadata: {}
       }, params)
     end
 
     def self.mock_bank_account(params={})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: "test_ba_default",
         object: "bank_account",
@@ -260,7 +279,8 @@ module StripeMock
         status: 'new',
         account_holder_name: 'John Doe',
         account_holder_type: 'individual',
-        fingerprint: "aBcFinGerPrINt123"
+        fingerprint: "aBcFinGerPrINt123",
+        metadata: {}
       }.merge(params)
     end
 
@@ -283,39 +303,59 @@ module StripeMock
     #FIXME nested overrides would be better than hardcoding plan_id
     def self.mock_subscription(params={})
       StripeMock::Util.rmerge({
-        :created => 1478204116,
-        :current_period_start => 1308595038,
-        :current_period_end => 1308681468,
-        :status => "trialing",
-        :plan => {
-          :interval => "month",
-          :amount => 7500,
-          :trial_period_days => 30,
-          :object => "plan",
-          :id => '__test_plan_id__'
+        created: 1478204116,
+        billing: 'charge_automatically',
+        current_period_start: 1308595038,
+        current_period_end: 1308681468,
+        status: 'trialing',
+        trial_from_plan: false,
+        plan: {
+          interval: 'month',
+          amount: 7500,
+          trial_period_days: 30,
+          object: 'plan',
+          id: '__test_plan_id__'
+        },
+        items: {
+          object: 'list',
+          data: [{
+            id: 'si_1AwFf62eZvKYlo2C9u6Dhf9',
+            created: 1504035973,
+            metadata: {},
+            object: 'subscription_item',
+            plan: {
+              amount: 999,
+              created: 1504035972,
+              currency: StripeMock.default_currency
+            },
+            quantity: 1
+          }]
         },
-        :cancel_at_period_end => false,
-        :canceled_at => nil,
-        :ended_at => nil,
-        :start => 1308595038,
-        :object => "subscription",
-        :trial_start => 1308595038,
-        :trial_end => 1308681468,
-        :customer => "c_test_customer",
-        :quantity => 1,
-        :tax_percent => nil,
-        :discount => nil,
-        :metadata => {}
+        cancel_at_period_end: false,
+        canceled_at: nil,
+        ended_at: nil,
+        start: 1308595038,
+        object: 'subscription',
+        trial_start: 1308595038,
+        trial_end: 1308681468,
+        customer: 'c_test_customer',
+        quantity: 1,
+        tax_percent: nil,
+        discount: nil,
+        metadata: {}
       }, params)
     end
 
     def self.mock_invoice(lines, params={})
       in_id = params[:id] || "test_in_default"
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       lines << Data.mock_line_item() if lines.empty?
-      {
+      invoice = {
         id: 'in_test_invoice',
-        date: 1349738950,
+        status: 'open',
+        invoice_pdf: 'pdf_url',
+        hosted_invoice_url: 'hosted_invoice_url',
+        created: 1349738950,
         period_end: 1349738950,
         period_start: 1349738950,
         lines: {
@@ -325,7 +365,6 @@ module StripeMock
           data: lines
         },
         subtotal: lines.map {|line| line[:amount]}.reduce(0, :+),
-        total: lines.map {|line| line[:amount]}.reduce(0, :+),
         customer: "test_customer",
         object: 'invoice',
         attempted: false,
@@ -337,12 +376,13 @@ module StripeMock
         paid: false,
         receipt_number: nil,
         statement_descriptor: nil,
-        tax: nil,
+        tax: 10,
         tax_percent: nil,
         webhooks_delivered_at: 1349825350,
         livemode: false,
         attempt_count: 0,
-        amount_due: lines.map {|line| line[:amount]}.reduce(0, :+),
+        amount_due: 100,
+        amount_paid: 0,
         currency: currency,
         starting_balance: 0,
         ending_balance: nil,
@@ -351,10 +391,19 @@ module StripeMock
         discount: nil,
         subscription: nil
       }.merge(params)
+      if invoice[:discount]
+        invoice[:total] = [0, invoice[:subtotal] - invoice[:discount][:coupon][:amount_off]].max if invoice[:discount][:coupon][:amount_off]
+        invoice[:total] = invoice[:subtotal] * invoice[:discount][:coupon][:percent_off] / 100 if invoice[:discount][:coupon][:percent_off]
+      else
+        invoice[:total] = invoice[:subtotal]
+      end
+      due = invoice[:total] + invoice[:starting_balance]
+      invoice[:amount_due] = due < 0 ? 0 : due
+      invoice
     end
 
     def self.mock_line_item(params = {})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: "ii_test",
         object: "line_item",
@@ -368,6 +417,11 @@ module StripeMock
           start: 1349738920,
           end: 1349738920
         },
+        tax_amounts: [
+          {
+            amount: 10
+          }
+        ],
         quantity: nil,
         subscription: nil,
         plan: nil,
@@ -377,11 +431,11 @@ module StripeMock
     end
 
     def self.mock_invoice_item(params = {})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: "test_ii",
         object: "invoiceitem",
-        date: 1349738920,
+        created: 1349738920,
         amount: 1099,
         livemode: false,
         proration: false,
@@ -465,7 +519,7 @@ module StripeMock
     end
 
     def self.mock_plan(params={})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       {
         id: "2",
         object: "plan",
@@ -482,6 +536,21 @@ module StripeMock
       }.merge(params)
     end
 
+    def self.mock_product(params = {})
+      {
+        id: "default_test_prod",
+        object: "product",
+        active: true,
+        created: 1556896214,
+        livemode: false,
+        metadata: {},
+        name: "Default Test Product",
+        statement_descriptor: "PRODUCT",
+        type: "service",
+        updated: 1556918200,
+      }.merge(params)
+    end
+
     def self.mock_recipient(cards, params={})
       rp_id = params[:id] || "test_rp_default"
       cards.each {|card| card[:recipient] = rp_id}
@@ -566,33 +635,47 @@ module StripeMock
     end
 
     def self.mock_transfer(params={})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       id = params[:id] || 'tr_test_transfer'
       {
-        :status => 'pending',
         :amount => 100,
-        :account => {
-          :object => 'bank_account',
-          :country => 'US',
-          :bank_name => 'STRIPE TEST BANK',
-          :last4 => '6789'
-        },
-        :recipient => 'test_recipient',
-        :fee => 0,
-        :fee_details => [],
+        :amount_reversed => 0,
+        :balance_transaction => "txn_2dyYXXP90MN26R",
         :id => id,
         :livemode => false,
+        :metadata => {},
         :currency => currency,
         :object => "transfer",
-        :date => 1304114826,
+        :created => 1304114826,
         :description => "Transfer description",
         :reversed => false,
         :reversals => {
           :object => "list",
+          :data => [],
           :total_count => 0,
           :has_more => false,
           :url => "/v1/transfers/#{id}/reversals"
         },
+        :destination => "acct_164wxjKbnvuxQXGu",
+        :destination_payment => "py_164xRvKbnvuxQXGuVFV2pZo1",
+        :source_transaction => "ch_164xRv2eZvKYlo2Clu1sIJWB",
+        :source_type => "card",
+        :transfer_group => "group_ch_164xRv2eZvKYlo2Clu1sIJWB",
+      }.merge(params)
+    end
+
+    def self.mock_payout(params={})
+      currency = params[:currency] || StripeMock.default_currency
+      id = params[:id] || 'po_test_payout'
+      {
+        :amount => 100,
+        :id => id,
+        :livemode => false,
+        :metadata => {},
+        :currency => currency,
+        :object => "payout",
+        :date => 1304114826,
+        :description => "Payout description",
       }.merge(params)
     end
 
@@ -605,7 +688,8 @@ module StripeMock
     end
 
     def self.mock_dispute(params={})
-      currency = params[:currency] || 'usd'
+      @timestamp ||= Time.now.to_i
+      currency = params[:currency] || StripeMock.default_currency
       id = params[:id] || "dp_test_dispute"
       {
         :id => id,
@@ -613,7 +697,7 @@ module StripeMock
         :amount => 195,
         :balance_transactions => [],
         :charge => "ch_15RsQR2eZvKYlo2CA8IfzCX0",
-        :created => 1422915137,
+        :created => @timestamp += 1,
         :currency => currency,
         :evidence => self.mock_dispute_evidence,
         :evidence_details => self.mock_dispute_evidence_details,
@@ -884,6 +968,38 @@ module StripeMock
       }
     end
 
+    def self.mock_balance(usd_balance = 10000)
+      {
+        object: "balance",
+        available: [
+          {
+            currency: "usd",
+            amount: usd_balance,
+            source_types: {
+              card: 25907032203,
+              bank_account: 108476658,
+              bitcoin_receiver: 1545182
+            }
+          }],
+        connect_reserved: [
+          {
+            currency: "usd",
+            amount: 4700
+          }],
+        livemode: false,
+        pending: [
+          {
+            currency: "usd",
+            amount: 22738833554,
+            source_types: {
+              card: 22738826610,
+              bank_account: 0,
+              bitcoin_receiver: 6944
+            }
+          }]
+      }
+    end
+
     def self.mock_balance_transactions(ids=[])
       bts = {}
       ids.each do |id|
@@ -893,7 +1009,7 @@ module StripeMock
     end
 
     def self.mock_balance_transaction(params = {})
-      currency = params[:currency] || 'usd'
+      currency = params[:currency] || StripeMock.default_currency
       bt_id = params[:id] || 'test_txn_default'
       source = params[:source] || 'ch_test_charge'
       {
@@ -927,5 +1043,50 @@ module StripeMock
         type: "charge"
       }.merge(params)
     end
+
+    def self.mock_subscription_item(params = {})
+      iid = params[:id] || 'test_txn_default'
+      {
+        id: iid,
+        object: 'subscription_item',
+        created: 1504716183,
+        metadata: {
+      },
+        plan: {
+          id: 'PER_USER_PLAN1',
+          object: 'plan',
+          amount: 1337,
+          created: 1504716177,
+          currency: StripeMock.default_currency,
+          interval: 'month',
+          interval_count: 1,
+          livemode: false,
+          metadata: {},
+          name: 'StripeMock Default Plan ID',
+          statement_descriptor: nil,
+          trial_period_days: nil
+        },
+        quantity: 2
+      }.merge(params)
+    end
+
+    def self.mock_ephemeral_key(**params)
+      created = Time.now.to_i
+      expires = created + 34_000
+      {
+        id: "ephkey_default",
+        object: "ephemeral_key",
+        associated_objects: [
+          {
+            id: params[:customer],
+            type: "customer"
+          }
+        ],
+        created: created,
+        expires: expires,
+        livemode: false,
+        secret: "ek_test_default"
+      }
+    end
   end
 end

data/lib/stripe_mock/instance.rb

@@ -20,12 +20,15 @@ module StripeMock
       @@handlers.find {|h| method_url =~ h[:route] }
     end
 
+    include StripeMock::RequestHandlers::ExternalAccounts
     include StripeMock::RequestHandlers::Accounts
+    include StripeMock::RequestHandlers::Balance
     include StripeMock::RequestHandlers::BalanceTransactions
     include StripeMock::RequestHandlers::Charges
     include StripeMock::RequestHandlers::Cards
     include StripeMock::RequestHandlers::Sources
     include StripeMock::RequestHandlers::Subscriptions # must be before Customers
+    include StripeMock::RequestHandlers::SubscriptionItems
     include StripeMock::RequestHandlers::Customers
     include StripeMock::RequestHandlers::Coupons
     include StripeMock::RequestHandlers::Disputes
@@ -34,21 +37,26 @@ module StripeMock
     include StripeMock::RequestHandlers::InvoiceItems
     include StripeMock::RequestHandlers::Orders
     include StripeMock::RequestHandlers::Plans
+    include StripeMock::RequestHandlers::Products
     include StripeMock::RequestHandlers::Refunds
     include StripeMock::RequestHandlers::Recipients
     include StripeMock::RequestHandlers::Transfers
     include StripeMock::RequestHandlers::Tokens
     include StripeMock::RequestHandlers::CountrySpec
+    include StripeMock::RequestHandlers::Payouts
+    include StripeMock::RequestHandlers::EphemeralKey
+    include StripeMock::RequestHandlers::TaxRates
 
-
-    attr_reader :accounts, :balance_transactions, :bank_tokens, :charges, :coupons, :customers,
+    attr_reader :accounts, :balance, :balance_transactions, :bank_tokens, :charges, :coupons, :customers,
                 :disputes, :events, :invoices, :invoice_items, :orders, :plans, :recipients,
-                :refunds, :transfers, :subscriptions, :country_spec
+                :refunds, :transfers, :payouts, :subscriptions, :country_spec, :subscriptions_items,
+                :products, :tax_rates
 
-    attr_accessor :error_queue, :debug
+    attr_accessor :error_queue, :debug, :conversion_rate, :account_balance
 
     def initialize
       @accounts = {}
+      @balance = Data.mock_balance
       @balance_transactions = Data.mock_balance_transactions(['txn_05RsQX2eZvKYlo2C0FRTGSSA','txn_15RsQX2eZvKYlo2C0ERTYUIA', 'txn_25RsQX2eZvKYlo2C0ZXCVBNM', 'txn_35RsQX2eZvKYlo2C0QAZXSWE', 'txn_45RsQX2eZvKYlo2C0EDCVFRT', 'txn_55RsQX2eZvKYlo2C0OIKLJUY', 'txn_65RsQX2eZvKYlo2C0ASDFGHJ', 'txn_75RsQX2eZvKYlo2C0EDCXSWQ', 'txn_85RsQX2eZvKYlo2C0UJMCDET', 'txn_95RsQX2eZvKYlo2C0EDFRYUI'])
       @bank_tokens = {}
       @card_tokens = {}
@@ -61,22 +69,29 @@ module StripeMock
       @invoice_items = {}
       @orders = {}
       @plans = {}
+      @products = {}
       @recipients = {}
       @refunds = {}
       @transfers = {}
+      @payouts = {}
       @subscriptions = {}
+      @subscriptions_items = {}
       @country_spec = {}
+      @tax_rates = {}
 
       @debug = false
       @error_queue = ErrorQueue.new
       @id_counter = 0
       @balance_transaction_counter = 0
+      @dispute_counter = 0
+      @conversion_rate = 1.0
+      @account_balance = 10000
 
       # This is basically a cache for ParamValidators
       @base_strategy = TestStrategies::Base.new
     end
 
-    def mock_request(method, url, api_key, params={}, headers={}, api_base_url=nil)
+    def mock_request(method, url, api_key: nil, api_base: nil, params: {}, headers: {})
       return {} if method == :xtest
 
       api_key ||= (Stripe.api_key || DUMMY_API_KEY)
@@ -99,7 +114,7 @@ module StripeMock
         else
           res = self.send(handler[:name], handler[:route], method_url, params, headers)
           puts "           [res]  #{res}" if @debug == true
-          [res, api_key]
+          [to_faraday_hash(res), api_key]
         end
       else
         puts "[StripeMock] Warning : Unrecognized endpoint + method : [#{method} #{url}]"
@@ -113,12 +128,44 @@ module StripeMock
       @events[ event_data[:id] ] = symbolize_names(event_data)
     end
 
+    def upsert_stripe_object(object, attributes)
+      # Most Stripe entities can be created via the API.  However, some entities are created when other Stripe entities are
+      # created - such as when BalanceTransactions are created when Charges are created.  This method provides the ability
+      # to create these internal entities.
+      # It also provides the ability to modify existing Stripe entities.
+      id = attributes[:id]
+      if id.nil? || id == ""
+        # Insert new Stripe object
+        case object
+          when :balance_transaction
+            id = new_balance_transaction('txn', attributes)
+          when :dispute
+            id = new_dispute('dp', attributes)
+          else
+            raise UnsupportedRequestError.new "Unsupported stripe object `#{object}`"
+        end
+      else
+        # Update existing Stripe object
+        case object
+          when :balance_transaction
+            btxn = assert_existence :balance_transaction, id, @balance_transactions[id]
+            btxn.merge!(attributes)
+          when :dispute
+            dispute = assert_existence :dispute, id, @disputes[id]
+            dispute.merge!(attributes)
+          else
+            raise UnsupportedRequestError.new "Unsupported stripe object `#{object}`"
+        end
+      end
+      id
+    end
+
     private
 
     def assert_existence(type, id, obj, message=nil)
       if obj.nil?
         msg = message || "No such #{type}: #{id}"
-        raise Stripe::InvalidRequestError.new(msg, type.to_s, 404)
+        raise Stripe::InvalidRequestError.new(msg, type.to_s, http_status: 404)
       end
       obj
     end
@@ -134,15 +181,53 @@ module StripeMock
       amount = params[:amount]
       unless amount.nil?
         # Fee calculation
-        params[:fee] ||= (30 + (amount.abs * 0.029).ceil) * (amount > 0 ? 1 : -1)
+        calculate_fees(params) unless params[:fee]
+        params[:net] = amount - params[:fee]
+        params[:amount] = amount * @conversion_rate
       end
       @balance_transactions[id] = Data.mock_balance_transaction(params.merge(id: id))
       id
     end
 
+    def new_dispute(prefix, params = {})
+      id = "#{StripeMock.global_id_prefix}#{prefix}_#{@dispute_counter += 1}"
+      @disputes[id] = Data.mock_dispute(params.merge(id: id))
+      id
+    end
+
     def symbolize_names(hash)
       Stripe::Util.symbolize_names(hash)
     end
 
+    def to_faraday_hash(hash)
+      response = Struct.new(:data)
+      response.new(hash)
+    end
+
+    def calculate_fees(params)
+      application_fee = params[:application_fee] || 0
+      params[:fee] = processing_fee(params[:amount]) + application_fee
+      params[:fee_details] = [
+        {
+          amount: processing_fee(params[:amount]),
+          application: nil,
+          currency: params[:currency] || StripeMock.default_currency,
+          description: "Stripe processing fees",
+          type: "stripe_fee"
+        }
+      ]
+      if application_fee
+        params[:fee_details] << {
+          amount: application_fee,
+          currency: params[:currency] || StripeMock.default_currency,
+          description: "Application fee",
+          type: "application_fee"
+        }
+      end
+    end
+
+    def processing_fee(amount)
+      (30 + (amount.abs * 0.029).ceil) * (amount > 0 ? 1 : -1)
+    end
   end
 end