stripe-ruby-mock 2.5.8 → 3.0.0

data/lib/stripe_mock/request_handlers/subscriptions.rb

@@ -102,7 +102,7 @@ module StripeMock
           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)
+        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)
         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)
@@ -133,6 +133,11 @@ module StripeMock
           end
         end
 
+        if params[:cancel_at_period_end]
+          subscription[:cancel_at_period_end] = true
+          subscription[:canceled_at] = Time.now.utc.to_i
+        end
+
         subscriptions[subscription[:id]] = subscription
         add_subscription_to_customer(customer, subscription)
 
@@ -191,17 +196,24 @@ module StripeMock
             raise Stripe::InvalidRequestError.new("No such coupon: #{coupon_id}", 'coupon', http_status: 400)
           end
         end
-        verify_card_present(customer, subscription_plans.first, subscription)
 
-        if subscription[:cancel_at_period_end]
+        if params[:cancel_at_period_end]
+          subscription[:cancel_at_period_end] = true
+          subscription[:canceled_at] = Time.now.utc.to_i
+        elsif params.has_key?(:cancel_at_period_end)
           subscription[:cancel_at_period_end] = false
           subscription[:canceled_at] = nil
         end
 
         params[:current_period_start] = subscription[:current_period_start]
         params[:trial_end] = params[:trial_end] || subscription[:trial_end]
+
+        plan_amount_was = subscription.dig(:plan, :amount)
+
         subscription = resolve_subscription_changes(subscription, subscription_plans, customer, params)
 
+        verify_card_present(customer, subscription_plans.first, subscription, params) if plan_amount_was == 0 && subscription.dig(:plan, :amount) && subscription.dig(:plan, :amount) > 0
+
         # delete the old subscription, replace with the new subscription
         customer[:subscriptions][:data].reject! { |sub| sub[:id] == subscription[:id] }
         customer[:subscriptions][:data] << subscription
@@ -261,6 +273,7 @@ module StripeMock
       # 3) has billing set to send invoice
       def verify_card_present(customer, plan, subscription, params={})
         return if customer[:default_source]
+        return if customer[:invoice_settings][:default_payment_method]
         return if customer[:trial_end]
         return if params[:trial_end]
 
@@ -281,7 +294,7 @@ module StripeMock
 
         return if params[:billing] == 'send_invoice'
 
-        raise Stripe::InvalidRequestError.new('You must supply a valid card xoxo', nil, http_status: 400)
+        raise Stripe::InvalidRequestError.new('This customer has no attached payment source', nil, http_status: 400)
       end
 
       def verify_active_status(subscription)

data/lib/stripe_mock/request_handlers/validators/param_validators.rb

@@ -2,26 +2,112 @@ module StripeMock
   module RequestHandlers
     module ParamValidators
 
-      def validate_create_plan_params(params)
+      def already_exists_message(obj_class)
+        "#{obj_class.to_s.split("::").last} already exists."
+      end
+
+      def not_found_message(obj_class, obj_id)
+        "No such #{obj_class.to_s.split("::").last.downcase}: #{obj_id}"
+      end
+
+      def missing_param_message(attr_name)
+        "Missing required param: #{attr_name}."
+      end
+
+      def invalid_integer_message(my_val)
+        "Invalid integer: #{my_val}"
+      end
+
+      #
+      # ProductValidator
+      #
+
+
+      def validate_create_product_params(params)
         params[:id] = params[:id].to_s
+        @base_strategy.create_product_params.keys.reject{ |k,_| k == :id }.each do |k|
+          raise Stripe::InvalidRequestError.new(missing_param_message(k), k) if params[k].nil?
+        end
+
+        if !%w[good service].include?(params[:type])
+          raise Stripe::InvalidRequestError.new("Invalid type: must be one of good or service", :type)
+        end
+
+        if products[ params[:id] ]
+          raise Stripe::InvalidRequestError.new(already_exists_message(Stripe::Product), :id)
+        end
+      end
+
+      #
+      # PlanValidator
+      #
 
-        @base_strategy.create_plan_params.keys.each do |name|
+      def missing_plan_amount_message
+        "Plans require an `amount` parameter to be set."
+      end
+
+      SUPPORTED_PLAN_INTERVALS = ["month", "year", "week", "day"]
+
+      def invalid_plan_interval_message
+        "Invalid interval: must be one of day, month, week, or year"
+      end
+
+      SUPPORTED_CURRENCIES = [
+        "usd", "aed", "afn", "all", "amd", "ang", "aoa", "ars", "aud", "awg", "azn", "bam", "bbd", "bdt", "bgn",
+        "bif", "bmd", "bnd", "bob", "brl", "bsd", "bwp", "bzd", "cad", "cdf", "chf", "clp", "cny", "cop", "crc",
+        "cve", "czk", "djf", "dkk", "dop", "dzd", "egp", "etb", "eur", "fjd", "fkp", "gbp", "gel", "gip", "gmd",
+        "gnf", "gtq", "gyd", "hkd", "hnl", "hrk", "htg", "huf", "idr", "ils", "inr", "isk", "jmd", "jpy", "kes",
+        "kgs", "khr", "kmf", "krw", "kyd", "kzt", "lak", "lbp", "lkr", "lrd", "lsl", "mad", "mdl", "mga", "mkd",
+        "mmk", "mnt", "mop", "mro", "mur", "mvr", "mwk", "mxn", "myr", "mzn", "nad", "ngn", "nio", "nok", "npr",
+        "nzd", "pab", "pen", "pgk", "php", "pkr", "pln", "pyg", "qar", "ron", "rsd", "rub", "rwf", "sar", "sbd",
+        "scr", "sek", "sgd", "shp", "sll", "sos", "srd", "std", "szl", "thb", "tjs", "top", "try", "ttd", "twd",
+        "tzs", "uah", "ugx", "uyu", "uzs", "vnd", "vuv", "wst", "xaf", "xcd", "xof", "xpf", "yer", "zar", "zmw",
+        "eek", "lvl", "svc", "vef", "ltl"
+      ]
+
+      def invalid_currency_message(my_val)
+        "Invalid currency: #{my_val.downcase}. Stripe currently supports these currencies: #{SUPPORTED_CURRENCIES.join(", ")}"
+      end
+
+      def validate_create_plan_params(params)
+        plan_id = params[:id].to_s
+        product_id = params[:product]
+
+        @base_strategy.create_plan_params.keys.each do |attr_name|
           message =
-            if name == :amount
-              "Plans require an `#{name}` parameter to be set."
+            if attr_name == :amount
+              "Plans require an `#{attr_name}` parameter to be set."
             else
-              "Missing required param: #{name}."
+              "Missing required param: #{attr_name}."
             end
-          raise Stripe::InvalidRequestError.new(message, name) if params[name].nil?
+          raise Stripe::InvalidRequestError.new(message, attr_name) if params[attr_name].nil?
+        end
+
+        if plans[plan_id]
+          message = already_exists_message(Stripe::Plan)
+          raise Stripe::InvalidRequestError.new(message, :id)
+        end
+
+        unless products[product_id]
+          message = not_found_message(Stripe::Product, product_id)
+          raise Stripe::InvalidRequestError.new(message, :product)
+        end
+
+        unless SUPPORTED_PLAN_INTERVALS.include?(params[:interval])
+          message = invalid_plan_interval_message
+          raise Stripe::InvalidRequestError.new(message, :interval)
         end
 
-        if plans[ params[:id] ]
-          raise Stripe::InvalidRequestError.new("Plan already exists.", :id)
+        unless SUPPORTED_CURRENCIES.include?(params[:currency])
+          message = invalid_currency_message(params[:currency])
+          raise Stripe::InvalidRequestError.new(message, :currency)
         end
 
         unless params[:amount].integer?
-          raise Stripe::InvalidRequestError.new("Invalid integer: #{params[:amount]}", :amount)
+          message = invalid_integer_message(params[:amount])
+          raise Stripe::InvalidRequestError.new(message, :amount)
         end
+
       end
 
       def require_param(param_name)

data/lib/stripe_mock/test_strategies/base.rb

@@ -2,19 +2,51 @@ module StripeMock
   module TestStrategies
     class Base
 
+      def list_products(limit)
+        Stripe::Product.list(limit: limit)
+      end
+
+      def create_product(params = {})
+        Stripe::Product.create create_product_params(params)
+      end
+
+      def create_product_params(params={})
+        {
+          :id => 'stripe_mock_default_product_id',
+          :name => 'Default Product',
+          :type => 'service'
+        }.merge(params)
+      end
+
+      def retrieve_product(product_id)
+        Stripe::Product.retrieve(product_id)
+      end
+
+
+      def list_plans(limit)
+        Stripe::Plan.list(limit: limit)
+      end
+
+      def create_plan(params={})
+        Stripe::Plan.create create_plan_params(params)
+      end
+
       def create_plan_params(params={})
-        currency = params[:currency] || StripeMock.default_currency
         {
           :id => 'stripe_mock_default_plan_id',
-          :product => {
-            :name => 'StripeMock Default Plan ID'
-          },
-          :amount => 1337,
-          :currency => currency,
-          :interval => 'month'
+          :interval => 'month',
+          :currency => StripeMock.default_currency,
+          :product => nil, # need to override yourself to pass validations
+          :amount => 1337
         }.merge(params)
       end
 
+
+      def list_subscriptions(limit)
+        Stripe::Subscription.list(limit: limit)
+      end
+
+
       def generate_card_token(card_params={})
         card_data = { :number => "4242424242424242", :exp_month => 9, :exp_year => (Time.now.year + 5), :cvc => "999", :tokenization_method => nil }
         card = StripeMock::Util.card_merge(card_data, card_params)
@@ -40,6 +72,7 @@ module StripeMock
         stripe_token.id
       end
 
+
       def create_coupon_params(params = {})
         currency = params[:currency] || StripeMock.default_currency
         {
@@ -69,13 +102,14 @@ module StripeMock
       end
 
       def delete_all_coupons
-        coupons = Stripe::Coupon.all
+        coupons = Stripe::Coupon.list
         coupons.data.map(&:delete) if coupons.data.count > 0
       end
 
       def prepare_card_error
         StripeMock.prepare_card_error(:card_error, :new_customer) if StripeMock.state == 'local'
       end
+
     end
   end
 end

data/lib/stripe_mock/test_strategies/live.rb

@@ -2,6 +2,21 @@ module StripeMock
   module TestStrategies
     class Live < Base
 
+      def create_product(params={})
+        params = create_product_params(params)
+        raise "create_product requires an :id" if params[:id].nil?
+        delete_product(params[:id])
+        Stripe::Product.create params
+      end
+
+      def delete_product(product_id)
+        product = Stripe::Product.retrieve(product_id)
+        Stripe::Plan.list(product: product_id).each(&:delete) if product.type == 'service'
+        product.delete
+      rescue Stripe::StripeError => e
+        # do nothing
+      end
+
       def create_plan(params={})
         raise "create_plan requires an :id" if params[:id].nil?
         delete_plan(params[:id])
@@ -9,12 +24,10 @@ module StripeMock
       end
 
       def delete_plan(plan_id)
-        begin
-          plan = Stripe::Plan.retrieve(plan_id)
-          plan.delete
-        rescue Stripe::StripeError => e
-          # Do nothing; we just want to make sure this plan ceases to exists
-        end
+        plan = Stripe::Plan.retrieve(plan_id)
+        plan.delete
+      rescue Stripe::StripeError => e
+        # do nothing
       end
 
       def create_coupon(params={})
@@ -23,12 +36,10 @@ module StripeMock
       end
 
       def delete_coupon(id)
-        begin
-          coupon = Stripe::Coupon.retrieve(id)
-          coupon.delete
-        rescue Stripe::StripeError
-          # do nothing
-        end
+        coupon = Stripe::Coupon.retrieve(id)
+        coupon.delete
+      rescue Stripe::StripeError
+        # do nothing
       end
 
       def upsert_stripe_object(object, attributes)

data/lib/stripe_mock/test_strategies/mock.rb

@@ -2,8 +2,12 @@ module StripeMock
   module TestStrategies
     class Mock < Base
 
-      def create_plan(params={})
-        Stripe::Plan.create create_plan_params(params)
+      def delete_product(product_id)
+        if StripeMock.state == 'remote'
+          StripeMock.client.destroy_resource('products', product_id)
+        elsif StripeMock.state == 'local'
+          StripeMock.instance.products.delete(product_id)
+        end
       end
 
       def delete_plan(plan_id)

data/lib/stripe_mock/version.rb

@@ -1,4 +1,4 @@
 module StripeMock
   # stripe-ruby-mock version
-  VERSION = "2.5.8"
+  VERSION = "3.0.0"
 end

data/lib/stripe_mock/webhook_fixtures/charge.failed.json

@@ -4,53 +4,181 @@
   "id": "evt_00000000000000",
   "type": "charge.failed",
   "object": "event",
+  "request": null,
+  "pending_webhooks": 1,
+  "api_version": "2018-02-28",
   "data": {
     "object": {
       "id": "ch_00000000000000",
       "object": "charge",
-      "created": 1380933505,
+      "amount": 100,
+      "amount_refunded": 0,
+      "application": null,
+      "application_fee": null,
+      "application_fee_amount": null,
+      "balance_transaction": "txn_00000000000000",
+      "billing_details": {
+        "address": {
+          "city": null,
+          "country": null,
+          "line1": null,
+          "line2": null,
+          "postal_code": null,
+          "state": null
+        },
+        "email": null,
+        "name": "Jenny Rosen",
+        "phone": null
+      },
+      "captured": false,
+      "created": 1572389205,
+      "currency": "cad",
+      "customer": null,
+      "description": "My First Test Charge (created for API docs)",
+      "dispute": null,
+      "failure_code": null,
+      "failure_message": null,
+      "fraud_details": {},
+      "invoice": null,
       "livemode": false,
+      "metadata": {},
+      "on_behalf_of": null,
+      "order": null,
+      "outcome": null,
       "paid": false,
-      "amount": 1000,
-      "currency": "usd",
-      "refunded": false,
-      "source": {
-        "id": "cc_00000000000000",
-        "object": "card",
-        "last4": "4242",
-        "type": "Visa",
-        "brand": "Visa",
-        "funding": "credit",
-        "exp_month": 12,
-        "exp_year": 2013,
-        "fingerprint": "wXWJT135mEK107G8",
-        "customer": "cus_00000000000000",
-        "country": "US",
-        "name": "Actual Nothing",
-        "address_line1": null,
-        "address_line2": null,
-        "address_city": null,
-        "address_state": null,
-        "address_zip": null,
-        "address_country": null,
-        "cvc_check": null,
-        "address_line1_check": null,
-        "address_zip_check": null
+      "payment_intent": null,
+      "payment_method": "card_00000000000000",
+      "payment_method_details": {
+        "card": {
+          "brand": "visa",
+          "checks": {
+            "address_line1_check": null,
+            "address_postal_code_check": null,
+            "cvc_check": null
+          },
+          "country": "US",
+          "exp_month": 8,
+          "exp_year": 2019,
+          "fingerprint": "C8aRpBae2T8GeJcn",
+          "funding": "credit",
+          "installments": null,
+          "last4": "4242",
+          "network": "visa",
+          "three_d_secure": null,
+          "wallet": null
+        },
+        "type": "card"
       },
-      "captured": true,
+      "receipt_email": null,
+      "receipt_number": null,
+      "receipt_url": "https://pay.stripe.com/receipts/acct_1C0lZEHvOcc4e36o/ch_1FZ3SbHsssvOcc4e36o87NHFK7i/rcpt_G5DuglJFhskXjsEDnLzxF6ESuGQe0Qj",
+      "refunded": false,
       "refunds": {
-
+        "object": "list",
+        "data": [],
+        "has_more": false,
+        "url": "/v1/charges/ch_1FZ3SbHvOcc4e36o87NHFK7i/refunds"
       },
-      "balance_transaction": "txn_00000000000000",
-      "failure_message": null,
-      "failure_code": null,
-      "amount_refunded": 0,
-      "customer": "cus_00000000000000",
-      "invoice": "in_00000000000000",
-      "description": null,
-      "dispute": null,
-      "metadata": {
+      "review": null,
+      "shipping": null,
+      "source_transfer": null,
+      "statement_descriptor": null,
+      "statement_descriptor_suffix": null,
+      "status": "failed",
+      "transfer_data": null,
+      "transfer_group": null
+    }
+  },
+  "webhook": {
+    "created": 1326853478,
+    "livemode": false,
+    "id": "evt_00000000000000",
+    "type": "charge.failed",
+    "object": "event",
+    "request": null,
+    "pending_webhooks": 1,
+    "api_version": "2018-02-28",
+    "data": {
+      "object": {
+        "id": "ch_00000000000000",
+        "object": "charge",
+        "amount": 100,
+        "amount_refunded": 0,
+        "application": null,
+        "application_fee": null,
+        "application_fee_amount": null,
+        "balance_transaction": "txn_00000000000000",
+        "billing_details": {
+          "address": {
+            "city": null,
+            "country": null,
+            "line1": null,
+            "line2": null,
+            "postal_code": null,
+            "state": null
+          },
+          "email": null,
+          "name": "Jenny Rosen",
+          "phone": null
+        },
+        "captured": false,
+        "created": 1572389205,
+        "currency": "cad",
+        "customer": null,
+        "description": "My First Test Charge (created for API docs)",
+        "dispute": null,
+        "failure_code": null,
+        "failure_message": null,
+        "fraud_details": {},
+        "invoice": null,
+        "livemode": false,
+        "metadata": {},
+        "on_behalf_of": null,
+        "order": null,
+        "outcome": null,
+        "paid": false,
+        "payment_intent": null,
+        "payment_method": "card_00000000000000",
+        "payment_method_details": {
+          "card": {
+            "brand": "visa",
+            "checks": {
+              "address_line1_check": null,
+              "address_postal_code_check": null,
+              "cvc_check": null
+            },
+            "country": "US",
+            "exp_month": 8,
+            "exp_year": 2019,
+            "fingerprint": "C8aRpBae2T8GeJcn",
+            "funding": "credit",
+            "installments": null,
+            "last4": "4242",
+            "network": "visa",
+            "three_d_secure": null,
+            "wallet": null
+          },
+          "type": "card"
+        },
+        "receipt_email": null,
+        "receipt_number": null,
+        "receipt_url": "https://pay.stripe.com/receipts/acct_1C0lZEHvOcc4e36o/ch_1FZ3SbHvOcc4sssse36o87NHFK7i/rcpt_G5DuglJFhskXjsEDnLzxF6ESuGQe0Qj",
+        "refunded": false,
+        "refunds": {
+          "object": "list",
+          "data": [],
+          "has_more": false,
+          "url": "/v1/charges/ch_1FZ3SbHvOccssssss4e36o87NHFK7i/refunds"
+        },
+        "review": null,
+        "shipping": null,
+        "source_transfer": null,
+        "statement_descriptor": null,
+        "statement_descriptor_suffix": null,
+        "status": "failed",
+        "transfer_data": null,
+        "transfer_group": null
       }
     }
   }
-}
+}