stripe-ruby-mock 1.10.1.5 → 1.10.1.6

data/README.md

@@ -8,7 +8,7 @@
 
 In your gemfile:
 
-    gem 'stripe-ruby-mock', '~> 1.10.1.5'
+    gem 'stripe-ruby-mock', '~> 1.10.1.6'
 
 ## Features
 

data/lib/stripe_mock/request_handlers/customers.rb

@@ -29,7 +29,11 @@ module StripeMock
             raise Stripe::InvalidRequestError.new('You must supply a valid card', nil, 400)
           end
 
-          add_subscription_to_customer(plan, customers[params[:id]] )
+          subscription = Data.mock_subscription({ id: new_id('su') })
+          subscription.merge!(custom_subscription_params(plan, customers[ params[:id] ], params))
+          add_subscription_to_customer(customers[ params[:id] ], subscription)
+        elsif params[:trial_end]
+          raise Stripe::InvalidRequestError.new('Received unknown parameter: trial_end', nil, 400)
         end
 
         customers[ params[:id] ]

data/lib/stripe_mock/request_handlers/helpers/subscription_helpers.rb

@@ -6,25 +6,32 @@ module StripeMock
         customer[:subscriptions][:data].find{|sub| sub[:id] == sub_id }
       end
 
-      def add_subscription_to_customer(plan, cus, start_time = nil)
-        start_time ||= Time.now.utc.to_i
-        params = { id: new_id('su'), plan: plan, customer: cus[:id], current_period_start: start_time, current_period_end: get_ending_time(start_time, plan) }
+      def custom_subscription_params(plan, cus, options = {})
+        verify_trial_end(options[:trial_end]) if options[:trial_end]
 
-        if plan[:trial_period_days].nil?
-          params.merge!({status: 'active', trial_start: nil, trial_end: nil})
+        start_time = options[:current_period_start] || Time.now.utc.to_i
+        params = { plan: plan, customer: cus[:id], current_period_start: start_time }
+        params.merge! options.select {|k,v| k =~ /application_fee_percent|quantity/}
+        # TODO: Implement coupon logic
+
+        if (plan[:trial_period_days].nil? && options[:trial_end].nil?) || options[:trial_end] == "now"
+          end_time = get_ending_time(start_time, plan)
+          params.merge!({status: 'active', current_period_end: end_time, trial_start: nil, trial_end: nil})
         else
-          params.merge!({status: 'trialing', trial_start: Time.now.utc.to_i, trial_end: (Time.now.utc.to_i + plan[:trial_period_days]*86400) })
+          end_time = options[:trial_end] || (Time.now.utc.to_i + plan[:trial_period_days]*86400)
+          params.merge!({status: 'trialing', current_period_end: end_time, trial_start: start_time, trial_end: end_time})
         end
 
-        subscription = Data.mock_subscription params
+        params
+      end
 
-        cus[:subscriptions][:count] = (cus[:subscriptions][:count] ? cus[:subscriptions][:count]+1 : 1 )
-        cus[:subscriptions][:data] << subscription
-        subscription
+      def add_subscription_to_customer(cus, sub)
+        cus[:subscriptions][:count] = (cus[:subscriptions][:count] || 0) + 1
+        cus[:subscriptions][:data] << sub
       end
 
-      # intervals variable is set to 1 when calculating current_period_end from current_period_start & plan
-      # intervals variable is set to 2 when calculating Stripe::Invoice.upcoming end from current_period_start & plan
+      # `intervals` is set to 1 when calculating current_period_end from current_period_start & plan
+      # `intervals` is set to 2 when calculating Stripe::Invoice.upcoming end from current_period_start & plan
       def get_ending_time(start_time, plan, intervals = 1)
         case plan[:interval]
           when "week"
@@ -38,6 +45,18 @@ module StripeMock
         end
       end
 
+      def verify_trial_end(trial_end)
+        if trial_end != "now"
+          if !trial_end.is_a? Integer
+            raise Stripe::InvalidRequestError.new('Invalid timestamp: must be an integer', nil, 400)
+          elsif trial_end < Time.now.utc.to_i
+            raise Stripe::InvalidRequestError.new('Invalid timestamp: must be an integer Unix timestamp in the future', nil, 400)
+          elsif trial_end > Time.now.utc.to_i + 31557600*5 # five years
+            raise Stripe::InvalidRequestError.new('Invalid timestamp: can be no more than five years in the future', nil, 400)
+          end
+        end
+      end
+
     end
   end
 end

data/lib/stripe_mock/request_handlers/subscriptions.rb

@@ -22,7 +22,9 @@ module StripeMock
         # Ensure customer has card to charge if plan has no trial and is not free
         verify_card_present(customer, plan)
 
-        subscription = add_subscription_to_customer(plan, customer, params[:current_period_start])
+        subscription = Data.mock_subscription({ id: (params[:id] || new_id('su')) })
+        subscription.merge!(custom_subscription_params(plan, customer, params))
+        add_subscription_to_customer(customer, subscription)
 
         # oddly, subscription returned from 'create_subscription' does not expand plan
         subscription.merge(plan: params[:plan])
@@ -63,17 +65,14 @@ module StripeMock
         end
 
         # expand the plan for addition to the customer object
-        if params[:plan]
-          plan_name = params[:plan]
-          plan = plans[plan_name]
-          assert_existance :plan, params[:plan], plan
-          params[:plan] = plan
-        end
+        plan_name = params[:plan] || subscription[:plan][:id]
+        plan = plans[plan_name]
 
-        # Ensure customer has card to charge if plan has no trial and is not free
+        assert_existance :plan, plan_name, plan
+        params[:plan] = plan if params[:plan]
         verify_card_present(customer, plan)
 
-        subscription.merge!(params)
+        subscription.merge!(custom_subscription_params(plan, customer, params))
 
         # delete the old subscription, replace with the new subscription
         customer[:subscriptions][:data].reject! { |sub| sub[:id] == subscription[:id] }

data/lib/stripe_mock/version.rb

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

data/spec/shared_stripe_examples/customer_examples.rb

@@ -47,6 +47,75 @@ shared_examples 'Customer API' do
     expect(customer.subscriptions.first.customer).to eq(customer.id)
   end
 
+  context "create customer" do
+
+    it "with a trial when trial_end is set" do
+      plan = Stripe::Plan.create(id: 'no_trial', amount: 999)
+      trial_end = Time.now.utc.to_i + 3600
+      customer = Stripe::Customer.create(id: 'test_cus_trial_end', card: 'tk', plan: 'no_trial', trial_end: trial_end)
+
+      customer = Stripe::Customer.retrieve('test_cus_trial_end')
+      expect(customer.subscriptions.count).to eq(1)
+      expect(customer.subscriptions.data.length).to eq(1)
+
+      expect(customer.subscriptions).to_not be_nil
+      expect(customer.subscriptions.first.plan.id).to eq('no_trial')
+      expect(customer.subscriptions.first.status).to eq('trialing')
+      expect(customer.subscriptions.first.current_period_end).to eq(trial_end)
+      expect(customer.subscriptions.first.trial_end).to eq(trial_end)
+    end
+
+    it 'overrides trial period length when trial_end is set' do
+      plan = Stripe::Plan.create(id: 'silver', amount: 999, trial_period_days: 14)
+      trial_end = Time.now.utc.to_i + 3600
+      customer = Stripe::Customer.create(id: 'test_cus_trial_end', card: 'tk', plan: 'silver', trial_end: trial_end)
+
+      customer = Stripe::Customer.retrieve('test_cus_trial_end')
+      expect(customer.subscriptions.count).to eq(1)
+      expect(customer.subscriptions.data.length).to eq(1)
+
+      expect(customer.subscriptions).to_not be_nil
+      expect(customer.subscriptions.first.plan.id).to eq('silver')
+      expect(customer.subscriptions.first.current_period_end).to eq(trial_end)
+      expect(customer.subscriptions.first.trial_end).to eq(trial_end)
+    end
+
+    it "returns no trial when trial_end is set to 'now'" do
+      plan = Stripe::Plan.create(id: 'silver', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'test_cus_trial_end', card: 'tk', plan: 'silver', trial_end: "now")
+
+      customer = Stripe::Customer.retrieve('test_cus_trial_end')
+      expect(customer.subscriptions.count).to eq(1)
+      expect(customer.subscriptions.data.length).to eq(1)
+
+      expect(customer.subscriptions).to_not be_nil
+      expect(customer.subscriptions.first.plan.id).to eq('silver')
+      expect(customer.subscriptions.first.status).to eq('active')
+      expect(customer.subscriptions.first.trial_start).to be_nil
+      expect(customer.subscriptions.first.trial_end).to be_nil
+    end
+
+    it "returns an error if trial_end is set to a past time" do
+      plan = Stripe::Plan.create(id: 'silver', amount: 999)
+      expect {
+        Stripe::Customer.create(id: 'test_cus_trial_end', card: 'tk', plan: 'silver', trial_end: Time.now.utc.to_i - 3600)
+      }.to raise_error {|e|
+        expect(e).to be_a(Stripe::InvalidRequestError)
+        expect(e.message).to eq('Invalid timestamp: must be an integer Unix timestamp in the future')
+      }
+    end
+
+    it "returns an error if trial_end is set without a plan" do
+      expect {
+        Stripe::Customer.create(id: 'test_cus_trial_end', card: 'tk', trial_end: "now")
+      }.to raise_error {|e|
+        expect(e).to be_a(Stripe::InvalidRequestError)
+        expect(e.message).to eq('Received unknown parameter: trial_end')
+      }
+    end
+
+  end
+
   it 'cannot create a customer with a plan that does not exist' do
     expect {
       customer = Stripe::Customer.create(id: 'test_cus_no_plan', card: 'tk', :plan => 'non-existant')

data/spec/shared_stripe_examples/subscription_examples.rb

@@ -26,6 +26,23 @@ shared_examples 'Customer Subscriptions' do
 
     end
 
+    it "correctly sets quantity and application_fee_percent" do
+      Stripe::Plan.create(
+        :amount => 2500,
+        :interval => 'month',
+        :name => 'Test plan',
+        :currency => 'usd',
+        :id => 'silver',
+        :statement_description => "testPlan"
+      )
+      customer = Stripe::Customer.create(id: 'test_customer_sub', card: 'tk')
+
+      subscription = customer.subscriptions.create({
+        :plan => "silver", quantity: 2, application_fee_percent: 10})
+      expect(subscription.quantity).to eq(2)
+      expect(subscription.application_fee_percent).to eq(10)
+    end
+
     it "adds additional subscription to customer with existing subscription" do
       silver =  Stripe::Plan.create(id: 'silver')
       gold =    Stripe::Plan.create(id: 'gold')
@@ -114,6 +131,67 @@ shared_examples 'Customer Subscriptions' do
       expect(customer.subscriptions.data.first.plan.to_hash).to eq(plan.to_hash)
       expect(customer.subscriptions.data.first.customer).to eq(customer.id)
     end
+
+    it "overrides trial length when trial end is set" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'short_trial')
+      trial_end = Time.now.utc.to_i + 3600
+
+      sub = customer.subscriptions.create({ plan: 'trial', trial_end: trial_end })
+
+      expect(sub.object).to eq('subscription')
+      expect(sub.plan).to eq('trial')
+      expect(sub.current_period_end).to eq(trial_end)
+      expect(sub.trial_end).to eq(trial_end)
+    end
+
+    it "returns without a trial when trial_end is set to 'now'" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'no_trial', card: 'tk')
+
+      sub = customer.subscriptions.create({ plan: 'trial', trial_end: "now" })
+
+      expect(sub.object).to eq('subscription')
+      expect(sub.plan).to eq('trial')
+      expect(sub.status).to eq('active')
+      expect(sub.trial_start).to be_nil
+      expect(sub.trial_end).to be_nil
+    end
+
+    it "raises error when trial_end is not an integer or 'now'" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'cus_trial')
+
+      expect { customer.subscriptions.create({ plan: 'trial', trial_end: "gazebo" }) }.to raise_error {|e|
+        expect(e).to be_a Stripe::InvalidRequestError
+        expect(e.http_status).to eq(400)
+        expect(e.message).to eq("Invalid timestamp: must be an integer")
+      }
+    end
+
+    it "raises error when trial_end is set to a time in the past" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'past_trial')
+      trial_end = Time.now.utc.to_i - 3600
+
+      expect { customer.subscriptions.create({ plan: 'trial', trial_end: trial_end }) }.to raise_error {|e|
+        expect(e).to be_a Stripe::InvalidRequestError
+        expect(e.http_status).to eq(400)
+        expect(e.message).to eq("Invalid timestamp: must be an integer Unix timestamp in the future")
+      }
+    end
+
+    it "raises error when trial_end is set to a time more than five years in the future" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'long_trial')
+      trial_end = Time.now.utc.to_i + 31557600*5 + 3600 # 5 years + 1 hour
+
+      expect { customer.subscriptions.create({ plan: 'trial', trial_end: trial_end }) }.to raise_error {|e|
+        expect(e).to be_a Stripe::InvalidRequestError
+        expect(e.http_status).to eq(400)
+        expect(e.message).to eq("Invalid timestamp: can be no more than five years in the future")
+      }
+    end
   end
 
   context "updating a subscription" do
@@ -256,6 +334,69 @@ shared_examples 'Customer Subscriptions' do
       expect(customer.default_card).to_not be_nil
       expect(customer.default_card).to eq customer.cards.data.first.id
     end
+
+    it "overrides trial length when trial end is set" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'test_trial_end', plan: 'trial')
+
+      sub = customer.subscriptions.retrieve(customer.subscriptions.data.first.id)
+
+      trial_end = Time.now.utc.to_i + 3600
+      sub.trial_end = trial_end
+      sub.save
+
+      expect(sub.object).to eq('subscription')
+      expect(sub.trial_end).to eq(trial_end)
+      expect(sub.current_period_end).to eq(trial_end)
+    end
+
+    it "returns without a trial when trial_end is set to 'now'" do
+      plan = Stripe::Plan.create(id: 'trial', amount: 999, trial_period_days: 14)
+      customer = Stripe::Customer.create(id: 'test_trial_end', plan: 'trial')
+
+      sub = customer.subscriptions.retrieve(customer.subscriptions.data.first.id)
+
+      sub.trial_end = "now"
+      sub.save
+
+      expect(sub.object).to eq('subscription')
+      expect(sub.plan).to eq('trial')
+      expect(sub.status).to eq('active')
+      expect(sub.trial_start).to be_nil
+      expect(sub.trial_end).to be_nil
+    end
+
+    it "changes an active subscription to a trial when trial_end is set" do
+      plan = Stripe::Plan.create(id: 'no_trial', amount: 999)
+      customer = Stripe::Customer.create(id: 'test_trial_end', plan: 'no_trial', card: 'tk')
+
+      sub = customer.subscriptions.retrieve(customer.subscriptions.data.first.id)
+
+      trial_end = Time.now.utc.to_i + 3600
+      sub.trial_end = trial_end
+      sub.save
+
+      expect(sub.object).to eq('subscription')
+      expect(sub.plan).to eq('no_trial')
+      expect(sub.status).to eq('trialing')
+      expect(sub.trial_end).to eq(trial_end)
+      expect(sub.current_period_end).to eq(trial_end)
+    end
+
+
+    it "raises error when trial_end is not an integer or 'now'" do
+      plan = Stripe::Plan.create(id: 'no_trial', amount: 999)
+      customer = Stripe::Customer.create(id: 'test_trial_end', plan: 'no_trial', card: 'tk')
+
+      sub = customer.subscriptions.retrieve(customer.subscriptions.data.first.id)
+      sub.trial_end = "gazebo"
+
+      expect { sub.save }.to raise_error {|e|
+        expect(e).to be_a Stripe::InvalidRequestError
+        expect(e.http_status).to eq(400)
+        expect(e.message).to eq("Invalid timestamp: must be an integer")
+      }
+    end
   end
 
   context "cancelling a subscription" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-ruby-mock
 version: !ruby/object:Gem::Version
-  version: 1.10.1.5
+  version: 1.10.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stripe