stripe 1.18.0 → 1.30.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 061c68a3e8fbf7b2adfa0a93489b1b124b08cb37
+  data.tar.gz: 4fda58089700ad1f39ab8a084b09982679b4e9a1
+SHA512:
+  metadata.gz: b2f3f7dff2c30038b9608f825f542061eccb6461bb1c0a9bebfb754ac5d7031c00e4df16e0a753edf92c5934435dcd1bfe191dfd2bdd5744c67ffdc268f3e16c
+  data.tar.gz: b68dfc54c11b18e6081a5794c89d717812607f334c60744f7b0cf0ba2a65a337f8f0465c4e092471cb3709e30df8fc62267550b73d255857914b40c1d9f32c47

data/.gitignore

@@ -2,3 +2,4 @@
 /Gemfile.lock
 .rvmrc
 Gemfile.lock
+tags

data/.travis.yml

@@ -6,11 +6,21 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
-  - 2.2  
+  - 2.2
+  - jruby-19mode
 
 gemfile:
   - gemfiles/default-with-activesupport.gemfile
   - gemfiles/json.gemfile
   - gemfiles/yajl.gemfile
 
+matrix:
+  exclude:
+    - rvm: jruby-19mode
+      gemfile: gemfiles/yajl.gemfile
+
+notifications:
+  email:
+    on_success: never
+
 sudo: false

data/History.txt

@@ -1,3 +1,101 @@
+=== 1.30.0 2015-10-09
+
+* Add `StripeObject#deleted?` for a reliable way to check whether an object is alive
+* Deprecate `StripeObject#refresh_from`
+* New parameter encoding scheme that doesn't use `URI.escape`
+
+=== 1.29.1 2015-10-06
+
+* Fix bug where ampersands were not being properly encoded
+
+=== 1.29.0 2015-10-05
+
+* Add pagination helpers `#auto_paging_each`, `#previous_page`, and `#next_page`
+
+=== 1.28.1 2015-10-05
+
+* Fix URI being referenced by file upload resources
+
+=== 1.28.0 2015-10-05
+
+* Make StripeObject's #save "upsert"-like; creates an object if new
+* Add #update_attributes to StripeObject for safe mass assignment
+* Properly mass assign attributes on calls to #save
+* Add question mark helpers for boolean fields (e.g. #paid? as well as old #paid)
+* Fix a bug that broke the API for StripeObject initialization
+* Remove use of deprecated URI.escape
+
+=== 1.27.2 2015-09-25
+
+* Correct the URLs used to fetch Bitcoin transactions.
+
+=== 1.27.1 2015-09-20
+
+* Use hash rockets for backwards compatibility.
+
+=== 1.27.0 2015-09-14
+
+* Add Orders, Products, and SKUs for Relay.
+
+=== 1.26.0 2015-09-11
+
+* Add support for 429 Rate Limited response
+
+=== 1.25.0 2015-08-17
+
+* Added support for refund listing and retrieval without an associated charge
+
+=== 1.24.0 2015-08-03
+
+* Added support for deleting managed accounts
+* Added support for dispute listing and retrieval
+* Bugfix: token objects now are the correct class
+
+=== 1.23.0 2015-07-06
+
+* Added request IDs and HTTP headers to errors.
+
+=== 1.22.0 2015-06-10
+
+* Added support for bank accounts and debit cards in managed accounts (via the `external_accounts` param)
+
+=== 1.21.0 2015-04-14
+
+* Remove TLS cert revocation check. (All pre-heartbleed certs have expired.)
+* Bugfix: don't unset keys when they don't exist on StripeObject.
+
+=== 1.20.4 2015-03-26
+
+* Raise an error when explicitly passing nil as the API key on resource methods
+* Fix error when passing an API key to Balance.retrieve (github issue #232)
+
+=== 1.20.3 2015-03-13
+
+* Fixed error when updating certain resources (github issue #224)
+
+=== 1.20.2 2015-03-10
+
+* Added support for updating nested hashes besides `metadata` (which was already supported)
+* Fixed bug in balance retrieval
+
+=== 1.20.1 2015-02-26
+
+* Updated Card to point to customer sources endpoint when customer property is set
+
+=== 1.20.0 2015-02-19
+
+* Added Update & Delete operations to Bitcoin Receivers
+
+=== 1.19.1 2015-02-18
+
+* Fixed fetching upcoming invoice/paying invoice methods
+
+=== 1.19.0 2015-02-15
+
+* Support for new Transfers /reversals endpoint
+* Account retrieval now optionally accepts an account ID
+* Better support for passing custom headers, like Stripe-Account, through requests
+
 === 1.18.0 2015-01-21
 
 * 1 major enhancement:

data/README.rdoc

@@ -1,11 +1,15 @@
-= Stripe Ruby bindings {<img src="https://travis-ci.org/stripe/stripe-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/stripe/stripe-ruby] {<img src="https://gemnasium.com/stripe/stripe-ruby.png" alt="Dependency Status" />}[https://gemnasium.com/stripe/stripe-ruby]
+= Stripe Ruby bindings {<img src="https://travis-ci.org/stripe/stripe-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/stripe/stripe-ruby]
+
+== Documentation
+
+{Ruby API Docs}[https://stripe.com/docs/api/ruby#intro]
 
 == Installation
 
 You don't need this source code unless you want to modify the gem. If
 you just want to use the Stripe Ruby bindings, you should run:
 
-  gem install --source https://code.stripe.com stripe
+  gem install stripe
 
 If you want to build the gem from source:
 
@@ -23,17 +27,12 @@ If you want to build the gem from source:
 
 * rest-client, json
 
-== Mirrors
+== Bundler
 
-The stripe gem is mirrored on Rubygems, so you should be able to
-install it via <tt>gem install stripe</tt> if desired. We recommend using
-the https://code.stripe.com mirror so all code is fetched over SSL.
-
-Note that if you are installing via bundler, you should be sure to use the https
+If you are installing via bundler, you should be sure to use the https
 rubygems source in your Gemfile, as any gems fetched over http could potentially be
 compromised in transit and alter the code of gems fetched securely over https:
 
-  source 'https://code.stripe.com'
   source 'https://rubygems.org'
 
   gem 'rails'
@@ -41,4 +40,14 @@ compromised in transit and alter the code of gems fetched securely over https:
 
 == Development
 
-Test cases can be run with: `bundle exec rake test`
+Run all tests:
+
+    bundle exec rake
+
+Run a single test suite:
+
+    bundle exec ruby -Ilib/ test/stripe/util_test.rb
+
+Run a single test:
+
+    bundle exec ruby -Ilib/ test/stripe/util_test.rb -n /should.convert.names.to.symbols/

data/VERSION

@@ -1 +1 @@
-1.18.0
+1.30.0

data/lib/stripe/account.rb

@@ -1,9 +1,51 @@
 module Stripe
-  class Account < SingletonAPIResource
+  class Account < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Update
+
+    def url
+      if self['id']
+        super
+      else
+        "/v1/account"
+      end
+    end
+
+    # @override To make id optional
+    def self.retrieve(id=ARGUMENT_NOT_PROVIDED, opts={})
+      id = id.equal?(ARGUMENT_NOT_PROVIDED) ? nil : Util.check_string_argument!(id)
+      # Account used to be a singleton, where this method's signature was `(opts={})`.
+      # For the sake of not breaking folks who pass in an OAuth key in opts, let's lurkily
+      # string match for it.
+      if opts == {} && id.is_a?(String) && id.start_with?('sk_')
+        # `super` properly assumes a String opts is the apiKey and normalizes as expected.
+        opts = id
+        id = nil
+      end
+      super(id, opts)
+    end
+
+    def protected_fields
+      [:legal_entity]
+    end
+
+    def legal_entity
+      self['legal_entity']
+    end
+
+    def legal_entity=(_)
+      raise NoMethodError.new('Overridding legal_entity can cause serious issues. Instead, set the individual fields of legal_entity like blah.legal_entity.first_name = \'Blah\'')
+    end
+
     def deauthorize(client_id, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(:post, '/oauth/deauthorize', api_key, { 'client_id' => client_id, 'stripe_user_id' => self.id }, headers, Stripe.connect_base)
-      Util.convert_to_stripe_object(response, api_key)
+      opts = {:api_base => Stripe.connect_base}.merge(Util.normalize_opts(opts))
+      response, opts = request(:post, '/oauth/deauthorize', { 'client_id' => client_id, 'stripe_user_id' => self.id }, opts)
+      opts.delete(:api_base) # the api_base here is a one-off, don't persist it
+      Util.convert_to_stripe_object(response, opts)
     end
+
+    ARGUMENT_NOT_PROVIDED = Object.new
   end
 end

data/lib/stripe/api_operations/create.rb

@@ -1,16 +1,9 @@
 module Stripe
   module APIOperations
     module Create
-      module ClassMethods
-        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
-
-      def self.included(base)
-        base.extend(ClassMethods)
+      def create(params={}, opts={})
+        response, opts = request(:post, url, params, opts)
+        Util.convert_to_stripe_object(response, opts)
       end
     end
   end

data/lib/stripe/api_operations/delete.rb

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

data/lib/stripe/api_operations/list.rb

@@ -1,17 +1,25 @@
 module Stripe
   module APIOperations
     module List
-      module ClassMethods
-        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
+      def list(filters={}, opts={})
+        opts = Util.normalize_opts(opts)
+        opts = @opts.merge(opts) if @opts
+
+        response, opts = request(:get, url, filters, opts)
+        obj = ListObject.construct_from(response, opts)
 
-      def self.included(base)
-        base.extend(ClassMethods)
+        # set a limit so that we can fetch the same number when accessing the
+        # next and previous pages
+        obj.limit = filters[:limit]
+
+        obj
       end
+
+      # The original version of #list was given the somewhat unfortunate name of
+      # #all, and this alias allows us to maintain backward compatibility (the
+      # choice was somewhat misleading in the way that it only returned a single
+      # page rather than all objects).
+      alias :all :list
     end
   end
 end

data/lib/stripe/api_operations/request.rb

@@ -0,0 +1,41 @@
+module Stripe
+  module APIOperations
+    module Request
+      module ClassMethods
+        OPTS_KEYS_TO_PERSIST = Set[:api_key, :api_base, :stripe_account, :stripe_version]
+
+        def request(method, url, params={}, opts={})
+          opts = Util.normalize_opts(opts)
+
+          headers = opts.clone
+          api_key = headers.delete(:api_key)
+          api_base = headers.delete(:api_base)
+          # Assume all remaining opts must be headers
+
+          response, opts[:api_key] = Stripe.request(method, url, api_key, params, headers, api_base)
+
+          # Hash#select returns an array before 1.9
+          opts_to_persist = {}
+          opts.each do |k, v|
+            if OPTS_KEYS_TO_PERSIST.include?(k)
+              opts_to_persist[k] = v
+            end
+          end
+
+          [response, opts_to_persist]
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params={}, opts={})
+        opts = @opts.merge(Util.normalize_opts(opts))
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/stripe/api_operations/update.rb

@@ -1,55 +1,56 @@
 module Stripe
   module APIOperations
     module Update
-      def save(opts={})
-        values = serialize_params(self).merge(opts)
-
-        if @values[:metadata]
-          values[:metadata] = serialize_metadata
-        end
+      # Creates or updates an API resource.
+      #
+      # If the resource doesn't yet have an assigned ID and the resource is one
+      # that can be created, then the method attempts to create the resource.
+      # The resource is updated otherwise.
+      #
+      # ==== Attributes
+      #
+      # * +params+ - Overrides any parameters in the resource's serialized data
+      #   and includes them in the create or update. If +:req_url:+ is included
+      #   in the list, it overrides the update URL used for the create or
+      #   update.
+      def save(params={})
+        # Let the caller override the URL but avoid serializing it.
+        req_url = params.delete(:req_url) || save_url
+
+        # We started unintentionally (sort of) allowing attributes send to
+        # +save+ to override values used during the update. So as not to break
+        # the API, this makes that official here.
+        update_attributes(params)
+
+        # Now remove any parameters that look like object attributes.
+        params = params.reject { |k, _| respond_to?(k) }
+
+        values = self.class.serialize_params(self).merge(params)
 
         if values.length > 0
+          # note that id gets removed here our call to #url above has already
+          # generated a uri for this object with an identifier baked in
           values.delete(:id)
 
-          response, api_key = Stripe.request(:post, url, @api_key, values)
-          refresh_from(response, api_key)
+          response, opts = request(:post, req_url, values)
+          initialize_from(response, opts)
         end
         self
       end
 
-      def serialize_metadata
-        if @unsaved_values.include?(:metadata)
-          # the metadata object has been reassigned
-          # i.e. as object.metadata = {key => val}
-          metadata_update = @values[:metadata]  # new hash
-          new_keys = metadata_update.keys.map(&:to_sym)
-          # remove keys at the server, but not known locally
-          keys_to_unset = @previous_metadata.keys - new_keys
-          keys_to_unset.each {|key| metadata_update[key] = ''}
-
-          metadata_update
-        else
-          # metadata is a StripeObject, and can be serialized normally
-          serialize_params(@values[:metadata])
-        end
-      end
-
-      def serialize_params(obj)
-        case obj
-        when nil
-          ''
-        when StripeObject
-          unsaved_keys = obj.instance_variable_get(:@unsaved_values)
-          obj_values = obj.instance_variable_get(:@values)
-          update_hash = {}
-
-          unsaved_keys.each do |k|
-            update_hash[k] = serialize_params(obj_values[k])
-          end
-
-          update_hash
+      private
+
+      def save_url
+        # This switch essentially allows us "upsert"-like functionality. If the
+        # API resource doesn't have an ID set (suggesting that it's new) and
+        # its class responds to .create (which comes from
+        # Stripe::APIOperations::Create), then use the URL to create a new
+        # resource. Otherwise, generate a URL based on the object's identifier
+        # for a normal update.
+        if self[:id] == nil && self.class.respond_to?(:create)
+          self.class.url
         else
-          obj
+          url
         end
       end
     end

data/lib/stripe/api_resource.rb

@@ -1,5 +1,7 @@
 module Stripe
   class APIResource < StripeObject
+    include Stripe::APIOperations::Request
+
     def self.class_name
       self.name.split('::')[-1]
     end
@@ -19,12 +21,13 @@ module Stripe
     end
 
     def refresh
-      response, api_key = Stripe.request(:get, url, @api_key, @retrieve_options)
-      refresh_from(response, api_key)
+      response, opts = request(:get, url, @retrieve_params)
+      initialize_from(response, opts)
     end
 
-    def self.retrieve(id, api_key=nil)
-      instance = self.new(id, api_key)
+    def self.retrieve(id, opts={})
+      opts = Util.normalize_opts(opts)
+      instance = self.new(id, opts)
       instance.refresh
       instance
     end

data/lib/stripe/application_fee.rb

@@ -1,15 +1,14 @@
 module Stripe
   class ApplicationFee < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def self.url
       '/v1/application_fees'
     end
 
     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)
+      response, opts = request(:post, refund_url, params, opts)
+      initialize_from(response, opts)
     end
 
     private

data/lib/stripe/application_fee_refund.rb

@@ -1,7 +1,7 @@
 module Stripe
   class ApplicationFeeRefund < APIResource
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def url
       "#{ApplicationFee.url}/#{CGI.escape(fee)}/refunds/#{CGI.escape(id)}"

data/lib/stripe/balance_transaction.rb

@@ -1,6 +1,6 @@
 module Stripe
   class BalanceTransaction < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def self.url
       '/v1/balance/history'

data/lib/stripe/bank_account.rb

@@ -0,0 +1,19 @@
+module Stripe
+  class BankAccount < APIResource
+    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+
+    def url
+      if respond_to?(:customer)
+        "#{Customer.url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
+      elsif respond_to?(:account)
+        "#{Account.url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"
+      end
+    end
+
+    def self.retrieve(id, opts=nil)
+      raise NotImplementedError.new("Bank accounts cannot be retrieved without an account ID. Retrieve a bank account using account.external_accounts.retrieve('card_id')")
+    end
+  end
+end

data/lib/stripe/bitcoin_receiver.rb

@@ -1,10 +1,20 @@
 module Stripe
   class BitcoinReceiver < APIResource
-    include Stripe::APIOperations::Create
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
 
     def self.url
       "/v1/bitcoin/receivers"
     end
+
+    def url
+      if respond_to?(:customer)
+        "#{Customer.url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
+      else
+        "#{self.class.url}/#{CGI.escape(id)}"
+      end
+    end
   end
 end

data/lib/stripe/bitcoin_transaction.rb

@@ -1,4 +1,9 @@
 module Stripe
   class BitcoinTransaction < APIResource
+    extend Stripe::APIOperations::List
+
+    def self.url
+      "/v1/bitcoin/transactions"
+    end
   end
 end

data/lib/stripe/card.rb

@@ -2,18 +2,20 @@ module Stripe
   class Card < APIResource
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def url
       if respond_to?(:recipient)
         "#{Recipient.url}/#{CGI.escape(recipient)}/cards/#{CGI.escape(id)}"
       elsif respond_to?(:customer)
-        "#{Customer.url}/#{CGI.escape(customer)}/cards/#{CGI.escape(id)}"
+        "#{Customer.url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
+      elsif respond_to?(:account)
+        "#{Account.url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"
       end
     end
 
-    def self.retrieve(id, api_key=nil)
-      raise NotImplementedError.new("Cards cannot be retrieved without a customer ID. Retrieve a card using customer.cards.retrieve('card_id')")
+    def self.retrieve(id, opts=nil)
+      raise NotImplementedError.new("Cards cannot be retrieved without a customer ID. Retrieve a card using customer.sources.retrieve('card_id')")
     end
   end
 end