stripe 1.27.2 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4d368b987f5a34446fcc2906d9b3431b0e500e5
-  data.tar.gz: 2253d61edbdf951fe94f3cba720436084a69f49b
+  metadata.gz: d356b022d7063f14b899676fdea7cdca23959578
+  data.tar.gz: 04e99c26ba15d5cfaeaeb626cae12ea675136be6
 SHA512:
-  metadata.gz: 13688baa2544303346cc97936a8df74969c081db6c1d4bd437818064a50d11e766a6dc43d54c46711e37654c9b7d70cd9b504da147b64a4b19928cd9dc3f4634
-  data.tar.gz: 06f77ce31a7c684ee01b0189b1ec1ee7faba272e1d3b6adfbfe21cc537560595c44a59385e6487d77b7c71ba1948f7f7e132bcfec8d855794da2a6207449a307
+  metadata.gz: d3e60ed73189c99a626246686b1dedd62402ad70c97fab4af71488c5c9ed40927981b4272d1ea2b0d10bae5c2577d68dc2406a588f86b4c9dd400619a98b967b
+  data.tar.gz: c049b00c65f2cbab92ef02cec7c5604bf637d4bbb1b2dae44d537edbdfdd4285de41bd955f71acf4bf35fd2c866690600698115fcd2600c2a9f9bd3b416fab53

data/.gitignore

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

data/.travis.yml

@@ -19,4 +19,8 @@ matrix:
     - rvm: jruby-19mode
       gemfile: gemfiles/yajl.gemfile
 
+notifications:
+  email:
+    on_success: never
+
 sudo: false

data/History.txt

@@ -1,3 +1,12 @@
+=== 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.

data/README.rdoc

@@ -40,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.27.2
+1.28.0

data/lib/stripe/account.rb

@@ -27,6 +27,18 @@ module Stripe
       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 cause serious issues. Instead, set the individual fields of legal_entity like blah.legal_entity.first_name = \'Blah\'')
+    end
+
     def deauthorize(client_id, opts={})
       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)

data/lib/stripe/api_operations/update.rb

@@ -1,12 +1,35 @@
 module Stripe
   module APIOperations
     module Update
+      # 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) || url
+        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_with_options(params, :raise_error => false)
+
+        # 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, opts = request(:post, req_url, values)
@@ -14,6 +37,22 @@ module Stripe
         end
         self
       end
+
+      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
+          url
+        end
+      end
     end
   end
 end

data/lib/stripe/list_object.rb

@@ -1,5 +1,6 @@
 module Stripe
   class ListObject < StripeObject
+    include Enumerable
     include Stripe::APIOperations::Request
 
     def [](k)
@@ -15,6 +16,11 @@ module Stripe
       self.data.each(&blk)
     end
 
+    # Returns true if the page object contains no elements.
+    def empty?
+      self.data.empty?
+    end
+
     def retrieve(id, opts={})
       id, retrieve_params = Util.normalize_id(id)
       response, opts = request(:get,"#{url}/#{CGI.escape(id)}", retrieve_params, opts)

data/lib/stripe/stripe_object.rb

@@ -11,7 +11,7 @@ module Stripe
 
     def initialize(id=nil, opts={})
       id, @retrieve_params = Util.normalize_id(id)
-      @opts = opts
+      @opts = Util.normalize_opts(opts)
       @values = {}
       # This really belongs in APIResource, but not putting it there allows us
       # to have a unified inspect method
@@ -21,6 +21,7 @@ module Stripe
     end
 
     def self.construct_from(values, opts={})
+      values = Stripe::Util.symbolize_names(values)
       self.new(values[:id]).refresh_from(values, opts)
     end
 
@@ -34,25 +35,29 @@ module Stripe
     end
 
     def refresh_from(values, opts, partial=false)
-      @opts = opts
+      @opts = Util.normalize_opts(opts)
       @original_values = Marshal.load(Marshal.dump(values)) # deep copy
+
       removed = partial ? Set.new : Set.new(@values.keys - values.keys)
       added = Set.new(values.keys - @values.keys)
+
       # Wipe old state before setting new.  This is useful for e.g. updating a
       # customer, where there is no persistent card parameter.  Mark those values
       # which don't persist as transient
 
       instance_eval do
         remove_accessors(removed)
-        add_accessors(added)
+        add_accessors(added, values)
       end
+
       removed.each do |k|
         @values.delete(k)
         @transient_values.add(k)
         @unsaved_values.delete(k)
       end
-      values.each do |k, v|
-        @values[k] = Util.convert_to_stripe_object(v, @opts)
+
+      update_attributes_with_options(values, :opts => opts)
+      values.each do |k, _|
         @transient_values.delete(k)
         @unsaved_values.delete(k)
       end
@@ -60,6 +65,11 @@ module Stripe
       return self
     end
 
+    # Mass assigns attributes on the model.
+    def update_attributes(values)
+      update_attributes_with_options(values, {})
+    end
+
     def [](k)
       @values[k.to_sym]
     end
@@ -85,8 +95,17 @@ module Stripe
     end
 
     def to_hash
+      maybe_to_hash = lambda do |value|
+        value.respond_to?(:to_hash) ? value.to_hash : value
+      end
+
       @values.inject({}) do |acc, (key, value)|
-        acc[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+        acc[key] = case value
+                   when Array
+                     value.map(&maybe_to_hash)
+                   else
+                     maybe_to_hash.call(value)
+                   end
         acc
       end
     end
@@ -191,9 +210,15 @@ module Stripe
       class << self; self; end
     end
 
+    def protected_fields
+      []
+    end
+
     def remove_accessors(keys)
+      f = protected_fields
       metaclass.instance_eval do
         keys.each do |k|
+          next if f.include?(k)
           next if @@permanent_attributes.include?(k)
           k_eq = :"#{k}="
           remove_method(k) if method_defined?(k)
@@ -202,9 +227,11 @@ module Stripe
       end
     end
 
-    def add_accessors(keys)
+    def add_accessors(keys, values)
+      f = protected_fields
       metaclass.instance_eval do
         keys.each do |k|
+          next if f.include?(k)
           next if @@permanent_attributes.include?(k)
           k_eq = :"#{k}="
           define_method(k) { @values[k] }
@@ -218,6 +245,11 @@ module Stripe
             @values[k] = v
             @unsaved_values.add(k)
           end
+
+          if [FalseClass, TrueClass].include?(values[k].class)
+            k_bool = :"#{k}?"
+            define_method(k_bool) { @values[k] }
+          end
         end
       end
     end
@@ -226,7 +258,10 @@ module Stripe
       # TODO: only allow setting in updateable classes.
       if name.to_s.end_with?('=')
         attr = name.to_s[0...-1].to_sym
-        add_accessors([attr])
+
+        # the second argument is only required when adding boolean accessors
+        add_accessors([attr], {})
+
         begin
           mth = method(name)
         rescue NameError
@@ -251,5 +286,36 @@ module Stripe
     def respond_to_missing?(symbol, include_private = false)
       @values && @values.has_key?(symbol) || super
     end
+
+    # Mass assigns attributes on the model.
+    #
+    # This is a version of +update_attributes+ that takes some extra options
+    # for internal use.
+    #
+    # ==== Options
+    #
+    # * +:opts:+ Options for StripeObject like an API key.
+    # * +:raise_error:+ Set to false to suppress ArgumentErrors on keys that
+    #   don't exist.
+    def update_attributes_with_options(values, options={})
+      # `opts` are StripeObject options
+      opts        = options.fetch(:opts, {})
+      raise_error = options.fetch(:raise_error, true)
+
+      values.each do |k, v|
+        if !@@permanent_attributes.include?(k) && !self.respond_to?(:"#{k}=")
+          if raise_error
+            raise ArgumentError,
+              "#{k} is not an attribute that can be assigned on this object"
+          else
+            next
+          end
+        end
+
+        @values[k] = Util.convert_to_stripe_object(v, opts)
+        @unsaved_values.add(k)
+      end
+      self
+    end
   end
 end

data/lib/stripe/util.rb

@@ -1,3 +1,5 @@
+require "webrick"
+
 module Stripe
   module Util
     def self.objects_to_ids(h)
@@ -93,7 +95,10 @@ module Stripe
     end
 
     def self.url_encode(key)
-      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      # Unfortunately, URI.escape was deprecated. Here we use a method from
+      # WEBrick instead given that it's a fairly close approximation (credit to
+      # the AWS Ruby SDK for coming up with the technique).
+      WEBrick::HTTPUtils.escape(key.to_s).gsub('%5B', '[').gsub('%5D', ']')
     end
 
     def self.flatten_params(params, parent_key=nil)

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.27.2'
+  VERSION = '1.28.0'
 end

data/test/stripe/account_test.rb

@@ -3,26 +3,34 @@ require File.expand_path('../../test_helper', __FILE__)
 module Stripe
   class AccountTest < Test::Unit::TestCase
     should "be retrievable" do
-      resp = {:email => "test+bindings@stripe.com", :charge_enabled => false, :details_submitted => false}
+      resp = make_account({
+        :charges_enabled => false,
+        :details_submitted => false,
+        :email => "test+bindings@stripe.com",
+      })
       @mock.expects(:get).
         once.
         with('https://api.stripe.com/v1/account', nil, nil).
         returns(make_response(resp))
       a = Stripe::Account.retrieve
       assert_equal "test+bindings@stripe.com", a.email
-      assert !a.charge_enabled
+      assert !a.charges_enabled
       assert !a.details_submitted
     end
 
     should "be retrievable via plural endpoint" do
-      resp = {:email => "test+bindings@stripe.com", :charge_enabled => false, :details_submitted => false}
+      resp = make_account({
+        :charges_enabled => false,
+        :details_submitted => false,
+        :email => "test+bindings@stripe.com",
+      })
       @mock.expects(:get).
         once.
         with('https://api.stripe.com/v1/accounts/acct_foo', nil, nil).
         returns(make_response(resp))
       a = Stripe::Account.retrieve('acct_foo')
       assert_equal "test+bindings@stripe.com", a.email
-      assert !a.charge_enabled
+      assert !a.charges_enabled
       assert !a.details_submitted
     end
 
@@ -33,6 +41,17 @@ module Stripe
       Stripe::Account.retrieve('sk_foobar')
     end
 
+    should "allow access to keys by method" do
+      account = Stripe::Account.construct_from(make_account({
+        :keys => {
+          :publishable => 'publishable-key',
+          :secret => 'secret-key',
+        }
+      }))
+      assert_equal 'publishable-key', account.keys.publishable
+      assert_equal 'secret-key', account.keys.secret
+    end
+
     should "be updatable" do
       resp = {
         :id => 'acct_foo',
@@ -58,6 +77,24 @@ module Stripe
       a.save
     end
 
+    should 'disallow direct overrides of legal_entity' do
+      account = Stripe::Account.construct_from(make_account({
+        :keys => {
+          :publishable => 'publishable-key',
+          :secret => 'secret-key',
+        },
+        :legal_entity => {
+          :first_name => 'Bling'
+        }
+      }))
+
+      assert_raise NoMethodError do
+        account.legal_entity = {:first_name => 'Blah'}
+      end
+
+      account.legal_entity.first_name = 'Blah'
+    end
+
     should "be able to deauthorize an account" do
       resp = {:id => 'acct_1234', :email => "test+bindings@stripe.com", :charge_enabled => false, :details_submitted => false}
       @mock.expects(:get).once.returns(make_response(resp))

data/test/stripe/api_resource_test.rb

@@ -545,6 +545,10 @@ module Stripe
           :id => 'myid',
           :legal_entity => {
             :last_name => 'Smith',
+            :address => {
+              :line1 => "test",
+              :city => "San Francisco"
+            }
           }
         })
 
@@ -552,12 +556,12 @@ module Stripe
           "#{Stripe.api_base}/v1/accounts/myid",
           nil,
           any_of(
-            'legal_entity[first_name]=Bob&legal_entity[last_name]=',
-            'legal_entity[last_name]=&legal_entity[first_name]=Bob'
+            'legal_entity[address][line1]=Test2&legal_entity[address][city]=',
+            'legal_entity[address][city]=&legal_entity[address][line1]=Test2'
           )
         ).returns(make_response({"id" => "myid"}))
 
-        acct.legal_entity = {:first_name => 'Bob'}
+        acct.legal_entity.address = {:line1 => 'Test2'}
         acct.save
       end
 
@@ -627,6 +631,31 @@ module Stripe
 
         acct.save
       end
+
+      should 'should create a new resource when an object without an id is saved' do
+        account = Stripe::Account.construct_from({
+          :id => nil,
+          :display_name => nil,
+        })
+
+        @mock.expects(:post).once.with("#{Stripe.api_base}/v1/accounts", nil, 'display_name=stripe').
+          returns(make_response({"id" => "charge_id"}))
+
+        account.display_name = 'stripe'
+        account.save
+      end
+
+      should 'set attributes as part of save' do
+        account = Stripe::Account.construct_from({
+          :id => nil,
+          :display_name => nil,
+        })
+
+        @mock.expects(:post).once.with("#{Stripe.api_base}/v1/accounts", nil, 'display_name=stripe').
+          returns(make_response({"id" => "charge_id"}))
+
+        account.save(:display_name => 'stripe')
+      end
     end
   end
 end

data/test/stripe/list_object_test.rb

@@ -12,5 +12,19 @@ module Stripe
       assert_equal('/v1/charges', all.url)
       assert all.data.kind_of?(Array)
     end
+
+    should "provide #empty?" do
+      object = Stripe::ListObject.construct_from({ :data => [] })
+      assert object.empty?
+      object = Stripe::ListObject.construct_from({ :data => [{}] })
+      refute object.empty?
+    end
+
+    should "provide enumerable functionality" do
+      @mock.expects(:get).once.returns(make_response(make_charge_array))
+      c = Stripe::Charge.all
+      assert c.kind_of?(Stripe::ListObject)
+      assert_equal 3, c.count
+    end
   end
 end

data/test/stripe/stripe_object_test.rb

@@ -9,6 +9,12 @@ module Stripe
       assert !obj.respond_to?(:baz)
     end
 
+    should "marshal be insensitive to strings vs. symbols when constructin" do
+      obj = Stripe::StripeObject.construct_from({ :id => 1, 'name' => 'Stripe' })
+      assert_equal 1, obj[:id]
+      assert_equal 'Stripe', obj[:name]
+    end
+
     should "marshal a stripe object correctly" do
       obj = Stripe::StripeObject.construct_from({ :id => 1, :name => 'Stripe' }, {:api_key => 'apikey'})
       m = Marshal.load(Marshal.dump(obj))
@@ -19,10 +25,29 @@ module Stripe
     end
 
     should "recursively call to_hash on its values" do
-      nested = Stripe::StripeObject.construct_from({ :id => 7, :foo => 'bar' })
-      obj = Stripe::StripeObject.construct_from({ :id => 1, :nested => nested })
-      expected_hash = { :id => 1, :nested => { :id => 7, :foo => 'bar' } }
+      nested_hash = { :id => 7, :foo => 'bar' }
+      nested = Stripe::StripeObject.construct_from(nested_hash)
+      obj = Stripe::StripeObject.construct_from({ :id => 1, :nested => nested, :list => [nested] })
+      expected_hash = { :id => 1, :nested => nested_hash, :list => [nested_hash] }
       assert_equal expected_hash, obj.to_hash
     end
+
+    should "assign question mark accessors for booleans" do
+      obj = Stripe::StripeObject.construct_from({ :id => 1, :bool => true, :not_bool => 'bar' })
+      assert obj.respond_to?(:bool?)
+      assert obj.bool?
+      refute obj.respond_to?(:not_bool?)
+    end
+
+    should "mass assign values with #update_attributes" do
+      obj = Stripe::StripeObject.construct_from({ :id => 1, :name => 'Stripe' })
+      obj.update_attributes(:name => 'STRIPE')
+      assert_equal "STRIPE", obj.name
+
+      e = assert_raises(ArgumentError) do
+        obj.update_attributes(:foo => 'bar')
+      end
+      assert_equal "foo is not an attribute that can be assigned on this object", e.message
+    end
   end
 end

data/test/test_data.rb

@@ -16,6 +16,14 @@ module Stripe
       m
     end
 
+    def make_account(params={})
+      {
+        :charges_enabled => false,
+        :details_submitted => false,
+        :email => "test+bindings@stripe.com",
+      }.merge(params)
+    end
+
     def make_balance(params={})
       {
         :pending => [
@@ -315,10 +323,11 @@ module Stripe
         :customer => 'c_test_customer',
         :date => 1349738950,
         :lines => {
-          "invoiceitems" => [
+          :object => 'list',
+          :data => [
             {
               :id => 'ii_test_invoice_item',
-              :object => '',
+              :object => 'invoiceitem',
               :livemode => false,
               :amount => 1000,
               :currency => 'usd',
@@ -338,7 +347,7 @@ module Stripe
         :charge => nil,
         :discount => nil,
         :ending_balance => nil,
-        :next_payemnt_attempt => 1349825350,
+        :next_payment_attempt => 1349825350,
       }
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.27.2
+  version: 1.28.0
 platform: ruby
 authors:
 - Ross Boucher
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client