stripe 1.16.0 → 1.16.1

data/.travis.yml

@@ -1,11 +1,15 @@
 language: ruby
+
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
+
 gemfile:
   - gemfiles/default-with-activesupport.gemfile
   - gemfiles/json.gemfile
   - gemfiles/yajl.gemfile
+
+sudo: false

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.16.1 2014-12-19
+
+* 2 minor enhancements:
+  * Ability to send idempotent requests
+  * Ability to specify stripe account as a header.
+
 === 1.16.0 2014-10-08
 
 * 1 minor enhacement:

data/README.rdoc

@@ -14,7 +14,13 @@ If you want to build the gem from source:
 == Requirements
 
 * Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load
-  ActiveSupport.)
+  ActiveSupport.) For Ruby versions before 1.9.2, you'll need to add this to your Gemfile:
+
+    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.2')
+      gem 'rest-client', '~> 1.6.8'
+    end
+
+
 * rest-client, json
 
 == Mirrors

data/VERSION

@@ -1 +1 @@
-1.16.0
+1.16.1

data/lib/stripe/api_operations/create.rb

@@ -2,8 +2,9 @@ module Stripe
   module APIOperations
     module Create
       module ClassMethods
-        def create(params={}, api_key=nil)
-          response, api_key = Stripe.request(:post, self.url, api_key, params)
+        def create(params={}, opts={})
+          api_key, headers = Util.parse_opts(opts)
+          response, api_key = Stripe.request(:post, self.url, api_key, params, headers)
           Util.convert_to_stripe_object(response, api_key)
         end
       end

data/lib/stripe/api_operations/delete.rb

@@ -1,10 +1,10 @@
 module Stripe
   module APIOperations
     module Delete
-      def delete(params = {})
-        response, api_key = Stripe.request(:delete, url, @api_key, params)
+      def delete(params = {}, opts={})
+        api_key, headers = Util.parse_opts(opts)
+        response, api_key = Stripe.request(:delete, url, api_key, params, headers)
         refresh_from(response, api_key)
-        self
       end
     end
   end

data/lib/stripe/api_operations/list.rb

@@ -2,8 +2,9 @@ module Stripe
   module APIOperations
     module List
       module ClassMethods
-        def all(filters={}, api_key=nil)
-          response, api_key = Stripe.request(:get, url, api_key, filters)
+        def all(filters={}, opts={})
+          api_key, headers = Util.parse_opts(opts)
+          response, api_key = Stripe.request(:get, url, api_key, filters, headers)
           Util.convert_to_stripe_object(response, api_key)
         end
       end

data/lib/stripe/api_resource.rb

@@ -4,7 +4,7 @@ module Stripe
       self.name.split('::')[-1]
     end
 
-    def self.url()
+    def self.url
       if self == APIResource
         raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (Charge, Customer, etc.)')
       end
@@ -21,7 +21,6 @@ module Stripe
     def refresh
       response, api_key = Stripe.request(:get, url, @api_key, @retrieve_options)
       refresh_from(response, api_key)
-      self
     end
 
     def self.retrieve(id, api_key=nil)

data/lib/stripe/application_fee.rb

@@ -6,10 +6,10 @@ module Stripe
       '/v1/application_fees'
     end
 
-    def refund(params={})
-      response, api_key = Stripe.request(:post, refund_url, @api_key, params)
+    def refund(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(:post, refund_url, api_key, params, headers)
       refresh_from(response, api_key)
-      self
     end
 
     private

data/lib/stripe/charge.rb

@@ -4,28 +4,49 @@ module Stripe
     include Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
-    def refund(params={})
-      response, api_key = Stripe.request(:post, refund_url, @api_key, params)
+    def refund(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :post, refund_url, api_key || @api_key, params, headers)
       refresh_from(response, api_key)
-      self
     end
 
-    def capture(params={})
-      response, api_key = Stripe.request(:post, capture_url, @api_key, params)
+    def capture(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :post, capture_url, api_key || @api_key, params, headers)
       refresh_from(response, api_key)
-      self
     end
 
-    def update_dispute(params)
-      response, api_key = Stripe.request(:post, dispute_url, @api_key, params)
+    def update_dispute(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :post, dispute_url, api_key || @api_key, params, headers)
       refresh_from({ :dispute => response }, api_key, true)
       dispute
     end
 
-    def close_dispute
-      response, api_key = Stripe.request(:post, close_dispute_url, @api_key)
+    def close_dispute(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :post, close_dispute_url, api_key || @api_key, params, headers)
+      refresh_from(response, api_key)
+    end
+
+    def mark_as_fraudulent
+      params = {
+        :fraud_details => { :user_report => 'fraudulent' }
+      }
+      response, api_key = Stripe.request(:post, url, @api_key, params)
+      refresh_from(response, api_key)
+    end
+
+    def mark_as_safe
+      params = {
+        :fraud_details => { :user_report => 'safe' }
+      }
+      response, api_key = Stripe.request(:post, url, @api_key, params)
       refresh_from(response, api_key)
-      self
     end
 
     private

data/lib/stripe/customer.rb

@@ -5,8 +5,9 @@ module Stripe
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::List
 
-    def add_invoice_item(params)
-      InvoiceItem.create(params.merge(:customer => id), @api_key)
+    def add_invoice_item(params, opts={})
+      opts[:api_key] = @api_key
+      InvoiceItem.create(params.merge(:customer => id), opts)
     end
 
     def invoices
@@ -25,24 +26,31 @@ module Stripe
       Charge.all({ :customer => id }, @api_key)
     end
 
-    def create_upcoming_invoice(params={})
-      Invoice.create(params.merge(:customer => id), @api_key)
+    def create_upcoming_invoice(params={}, opts={})
+      opts[:api_key] = @api_key
+      Invoice.create(params.merge(:customer => id), opts)
     end
 
-    def cancel_subscription(params={})
-      response, api_key = Stripe.request(:delete, subscription_url, @api_key, params)
+    def cancel_subscription(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :delete, subscription_url, api_key || @api_key, params, headers)
       refresh_from({ :subscription => response }, api_key, true)
       subscription
     end
 
-    def update_subscription(params)
-      response, api_key = Stripe.request(:post, subscription_url, @api_key, params)
+    def update_subscription(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :post, subscription_url, api_key  || @api_key, params, headers)
       refresh_from({ :subscription => response }, api_key, true)
       subscription
     end
 
-    def create_subscription(params)
-      response, api_key = Stripe.request(:post, subscriptions_url, @api_key, params)
+    def create_subscription(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      response, api_key = Stripe.request(
+        :post, subscriptions_url, api_key || @api_key, params, headers)
       refresh_from({ :subscription => response }, api_key, true)
       subscription
     end

data/lib/stripe/invoice.rb

@@ -12,7 +12,6 @@ module Stripe
     def pay
       response, api_key = Stripe.request(:post, pay_url, @api_key)
       refresh_from(response, api_key)
-      self
     end
 
     private

data/lib/stripe/list_object.rb

@@ -20,15 +20,17 @@ module Stripe
       Util.convert_to_stripe_object(response, api_key)
     end
 
-    def create(params={}, api_key=nil)
+    def create(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
       api_key ||= @api_key
-      response, api_key = Stripe.request(:post, url, api_key, params)
+      response, api_key = Stripe.request(:post, url, api_key, params, headers)
       Util.convert_to_stripe_object(response, api_key)
     end
 
-    def all(params={}, api_key=nil)
+    def all(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
       api_key ||= @api_key
-      response, api_key = Stripe.request(:get, url, api_key, params)
+      response, api_key = Stripe.request(:get, url, api_key, params, headers)
       Util.convert_to_stripe_object(response, api_key)
     end
   end

data/lib/stripe/singleton_api_resource.rb

@@ -1,6 +1,6 @@
 module Stripe
   class SingletonAPIResource < APIResource
-    def self.url()
+    def self.url
       if self == SingletonAPIResource
         raise NotImplementedError.new('SingletonAPIResource is an abstract class.  You should perform actions on its subclasses (Account, etc.)')
       end

data/lib/stripe/stripe_object.rb

@@ -30,16 +30,14 @@ module Stripe
     end
 
     def self.construct_from(values, api_key=nil)
-      obj = self.new(values[:id], api_key)
-      obj.refresh_from(values, api_key)
-      obj
+      self.new(values[:id], api_key).refresh_from(values, api_key)
     end
 
     def to_s(*args)
       JSON.pretty_generate(@values)
     end
 
-    def inspect()
+    def inspect
       id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
       "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
     end
@@ -68,6 +66,8 @@ module Stripe
         @transient_values.delete(k)
         @unsaved_values.delete(k)
       end
+
+      return self
     end
 
     def [](k)

data/lib/stripe/transfer.rb

@@ -7,7 +7,6 @@ module Stripe
     def cancel
       response, api_key = Stripe.request(:post, cancel_url, @api_key)
       refresh_from(response, api_key)
-      self
     end
 
     def cancel_url

data/lib/stripe/util.rb

@@ -17,23 +17,26 @@ module Stripe
 
     def self.object_classes
       @object_classes ||= {
+        # data structures
+        'list' => ListObject,
+        
+        # business objects
+        'application_fee' => ApplicationFee,
         'balance' => Balance,
         'balance_transaction' => BalanceTransaction,
+        'card' => Card,
         'charge' => Charge,
+        'coupon' => Coupon,
         'customer' => Customer,
+        'event' => Event,
+        'fee_refund' => ApplicationFeeRefund,
         'invoiceitem' => InvoiceItem,
         'invoice' => Invoice,
         'plan' => Plan,
-        'coupon' => Coupon,
-        'event' => Event,
-        'transfer' => Transfer,
         'recipient' => Recipient,
-        'card' => Card,
-        'subscription' => Subscription,
-        'list' => ListObject,
         'refund' => Refund,
-        'application_fee' => ApplicationFee,
-        'fee_refund' => ApplicationFeeRefund
+        'subscription' => Subscription,        
+        'transfer' => Transfer
       }
     end
 
@@ -65,12 +68,12 @@ module Stripe
     def self.symbolize_names(object)
       case object
       when Hash
-        new = {}
+        new_hash = {}
         object.each do |key, value|
           key = (key.to_sym rescue key) || key
-          new[key] = symbolize_names(value)
+          new_hash[key] = symbolize_names(value)
         end
-        new
+        new_hash
       when Array
         object.map { |value| symbolize_names(value) }
       else
@@ -110,5 +113,27 @@ module Stripe
       end
       result
     end
+
+    # The secondary opts argument can either be a string or hash
+    # Turn this value into an api_key and a set of headers
+    def self.parse_opts(opts)
+      case opts
+      when NilClass
+        return nil, {}
+      when String
+        return opts, {}
+      when Hash
+        headers = {}
+        if opts[:idempotency_key]
+          headers[:idempotency_key] = opts[:idempotency_key] 
+        end
+        if opts[:stripe_account]
+          headers[:stripe_account] = opts[:stripe_account]
+        end
+        return opts[:api_key], headers
+      else
+        raise TypeError.new("parse_opts expects a string or a hash")
+      end
+    end
   end
 end

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.16.0'
+  VERSION = '1.16.1'
 end

data/test/stripe/api_resource_test.rb

@@ -63,10 +63,29 @@ module Stripe
         assert_equal(401, e.http_status)
         assert_equal(true, !!e.http_body)
         assert_equal(true, !!e.json_body[:error][:message])
-        assert_equal(test_invalid_api_key_error['error']['message'], e.json_body[:error][:message])
+        assert_equal(test_invalid_api_key_error[:error][:message], e.json_body[:error][:message])
       end
     end
 
+    should "send stripe account as header when set" do
+      stripe_account = "acct_0000"
+      Stripe.expects(:execute_request).with do |opts|
+        opts[:headers][:stripe_account] == stripe_account
+      end.returns(test_response(test_charge))
+
+      Stripe::Charge.create({:card => {:number => '4242424242424242'}},
+                            {:stripe_account => stripe_account, :api_key => 'sk_test_local'})
+    end
+
+    should "not send stripe account as header when not set" do
+      Stripe.expects(:execute_request).with do |opts|
+        opts[:headers][:stripe_account].nil?
+      end.returns(test_response(test_charge))
+
+      Stripe::Charge.create({:card => {:number => '4242424242424242'}},
+        'sk_test_local')
+    end
+
     context "when specifying per-object credentials" do
       context "with no global API key set" do
         should "use the per-object credential when creating" do
@@ -114,6 +133,17 @@ module Stripe
     end
 
     context "with valid credentials" do
+      should "send along the idempotency-key header" do
+        Stripe.expects(:execute_request).with do |opts|
+          opts[:headers][:idempotency_key] == 'bar'
+        end.returns(test_response(test_charge))
+
+        Stripe::Charge.create({:card => {:number => '4242424242424242'}}, {
+          :idempotency_key => 'bar',
+          :api_key => 'local',
+        })
+      end
+
       should "urlencode values in GET params" do
         response = test_response(test_charge_array)
         @mock.expects(:get).with("#{Stripe.api_base}/v1/charges?customer=test%20customer", nil, nil).returns(response)