stripe 1.58.0 → 2.0.0

data/lib/stripe/stripe_response.rb

@@ -0,0 +1,48 @@
+module Stripe
+  # StripeResponse encapsulates some vitals of a response that came back from
+  # the Stripe API.
+  class StripeResponse
+    # The data contained by the HTTP body of the response deserialized from
+    # JSON.
+    attr_accessor :data
+
+    # The raw HTTP body of the response.
+    attr_accessor :http_body
+
+    # A Hash of the HTTP headers of the response.
+    attr_accessor :http_headers
+
+    # The integer HTTP status code of the response.
+    attr_accessor :http_status
+
+    # The Stripe request ID of the response.
+    attr_accessor :request_id
+
+    # Initializes a StripeResponse object from a Hash like the kind returned as
+    # part of a Faraday exception.
+    #
+    # This may throw JSON::ParserError if the response body is not valid JSON.
+    def self.from_faraday_hash(http_resp)
+      resp = StripeResponse.new
+      resp.data = JSON.parse(http_resp[:body], symbolize_names: true)
+      resp.http_body = http_resp[:body]
+      resp.http_headers = http_resp[:headers]
+      resp.http_status = http_resp[:status]
+      resp.request_id = http_resp[:headers]["Request-Id"]
+      resp
+    end
+
+    # Initializes a StripeResponse object from a Faraday HTTP response object.
+    #
+    # This may throw JSON::ParserError if the response body is not valid JSON.
+    def self.from_faraday_response(http_resp)
+      resp = StripeResponse.new
+      resp.data = JSON.parse(http_resp.body, symbolize_names: true)
+      resp.http_body = http_resp.body
+      resp.http_headers = http_resp.headers
+      resp.http_status = http_resp.status
+      resp.request_id = http_resp.headers["Request-Id"]
+      resp
+    end
+  end
+end

data/lib/stripe/transfer.rb

@@ -5,8 +5,8 @@ module Stripe
     include Stripe::APIOperations::Save
 
     def cancel
-      response, api_key = self.request(:post, cancel_url)
-      initialize_from(response, api_key)
+      resp, api_key = self.request(:post, cancel_url)
+      initialize_from(resp.data, api_key)
     end
 
     def cancel_url

data/lib/stripe/util.rb

@@ -68,18 +68,18 @@ module Stripe
     #
     # ==== Attributes
     #
-    # * +resp+ - Hash of fields and values to be converted into a StripeObject.
+    # * +data+ - Hash of fields and values to be converted into a StripeObject.
     # * +opts+ - Options for +StripeObject+ like an API key that will be reused
     #   on subsequent API calls.
-    def self.convert_to_stripe_object(resp, opts)
-      case resp
+    def self.convert_to_stripe_object(data, opts)
+      case data
       when Array
-        resp.map { |i| convert_to_stripe_object(i, opts) }
+        data.map { |i| convert_to_stripe_object(i, opts) }
       when Hash
         # Try converting to a known object class.  If none available, fall back to generic StripeObject
-        object_classes.fetch(resp[:object], StripeObject).construct_from(resp, opts)
+        object_classes.fetch(data[:object], StripeObject).construct_from(data, opts)
       else
-        resp
+        data
       end
     end
 

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.58.0'
+  VERSION = '2.0.0'
 end

data/stripe.gemspec

@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.homepage = 'https://stripe.com/docs/api/ruby'
   s.license = 'MIT'
 
-  s.add_dependency('rest-client', '>= 1.4', '< 4.0')
+  s.add_dependency('faraday', '~> 0')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")

data/test/api_fixtures.rb

@@ -0,0 +1,29 @@
+# APIFixtures loads fixture data generated by the core Stripe API so that we
+# can have slightly more accurate and up-to-date resource information in our
+# tests.
+class APIFixtures
+  def initialize
+    @fixtures = ::JSON.parse(File.read("#{PROJECT_ROOT}/spec/fixtures.json"),
+      symbolize_names: true)
+    freeze_recursively(@fixtures)
+  end
+
+  def [](name)
+    @fixtures[name]
+  end
+
+  def fetch(*args)
+    @fixtures.fetch(*args)
+  end
+
+  private
+
+  def freeze_recursively(data)
+    data.each do |k, v|
+      if v.is_a?(Hash)
+        freeze_recursively(v)
+      end
+    end
+    data.freeze
+  end
+end

data/test/api_stub_helpers.rb

@@ -0,0 +1,125 @@
+require "json"
+
+# Provides a set of helpers for a test suite that help to mock out the Stripe
+# API.
+module APIStubHelpers
+  protected
+
+  # Uses Webmock to stub out the Stripe API for testing purposes. The stub will
+  # by default respond on any routes that are defined in the bundled OpenAPI
+  # spec with generated response data.
+  #
+  # An `override_app` can be specified to get finer grain control over how a
+  # stubbed endpoint responds. It can be used to modify generated responses,
+  # mock expectations, or even to override the default stub completely.
+  def stub_api
+    stub_request(:any, /^#{Stripe.api_base}/).to_rack(new_api_stub)
+  end
+
+  def stub_connect
+    stub_request(:any, /^#{Stripe.connect_base}/).to_return(:body => "{}")
+  end
+
+  private
+
+  # APIStubMiddleware intercepts a response generated by Committee's stubbing
+  # middleware, and tries to replace it with a better version from a set of
+  # sample fixtures data generated from Stripe's core API service.
+  class APIStubMiddleware
+    API_FIXTURES = APIFixtures.new
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      # We use a vendor specific prefix (`x-resourceId`) embedded in the schema
+      # of any resource in our spec to identify it (e.g. "charge"). This allows
+      # us to cross-reference that response with some data that we might find
+      # in our fixtures file so that we can respond with a higher fidelity
+      # response.
+      schema = env["committee.response_schema"]
+      resource_id = schema.data["x-resourceId"] || ""
+
+      if data = API_FIXTURES[resource_id.to_sym]
+        # standard top-level API resource
+        data = fixturize_lists_recursively(schema, data)
+        env["committee.response"] = data
+      elsif schema.properties["object"].enum == ["list"]
+        # top level list (like from a list endpoint)
+        data = fixturize_list(schema, env["committee.response"])
+        env["committee.response"] = data
+      else
+        raise "no fixture for: #{resource_id}"
+      end
+      @app.call(env)
+    end
+
+    private
+
+    # If schema looks like a Stripe list object, then we look up the resource
+    # that the list is supposed to include and inject it into `data` as a
+    # fixture. Also calls into that other schema recursively so that sublists
+    # within it will also be assigned a fixture.
+    def fixturize_list(schema, data)
+      object_schema = schema.properties["object"]
+      if object_schema && object_schema.enum == ["list"]
+        subschema = schema.properties["data"].items
+        resource_id = subschema.data["x-resourceId"] || ""
+        if subdata = API_FIXTURES[resource_id.to_sym]
+          subdata = fixturize_lists_recursively(subschema, subdata)
+
+          data = data ? data.dup : {}
+          data[:data] = [subdata]
+        end
+      end
+      data
+    end
+
+    # Examines each of the given schema's properties and calls #fixturize_list
+    # on them so that any sublists will be populated with sample fixture data.
+    def fixturize_lists_recursively(schema, data)
+      data = data.dup
+      schema.properties.each do |key, subschema|
+        data[key.to_sym] = fixturize_list(subschema, data[key.to_sym])
+      end
+      data
+    end
+  end
+
+  # A descendant of the standard `Sinatra::Base` that we can use to enrich
+  # certain types of responses.
+  class APIStubApp < Sinatra::Base
+    not_found do
+      "endpoint not found in API stub: #{request.request_method} #{request.path_info}"
+    end
+  end
+
+  # Finds the latest OpenAPI specification in ROOT/spec/ and parses it for
+  # use with Committee.
+  def self.initialize_spec
+    schema_data = ::JSON.parse(File.read("#{PROJECT_ROOT}/spec/spec.json"))
+
+    driver = Committee::Drivers::OpenAPI2.new
+    driver.parse(schema_data)
+  end
+
+  # Creates a new Rack app with Committee middleware it.
+  def new_api_stub
+    Rack::Builder.new {
+      use Committee::Middleware::RequestValidation, schema: @@spec,
+        params_response: true, strict: true
+      use Committee::Middleware::Stub, schema: @@spec,
+        call: true
+      use APIStubMiddleware
+      run APIStubApp.new
+    }
+  end
+
+  # Parse and initialize the OpenAPI spec only once for the entire test suite.
+  @@spec = initialize_spec
+
+  # The default override app. Doesn't respond on any route so generated
+  # responses will always take precedence.
+  @@default_override_app = Sinatra.new
+end

data/test/stripe/account_test.rb

@@ -2,296 +2,202 @@ require File.expand_path('../../test_helper', __FILE__)
 
 module Stripe
   class AccountTest < Test::Unit::TestCase
-    should "be retrievable" do
-      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.charges_enabled
-      assert !a.details_submitted
-    end
+    FIXTURE = API_FIXTURES.fetch(:account)
 
-    should "be retrievable via plural endpoint" do
-      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.charges_enabled
-      assert !a.details_submitted
+    should "be listable" do
+      accounts = Stripe::Account.list
+      assert_requested :get, "#{Stripe.api_base}/v1/accounts"
+      assert accounts.data.kind_of?(Array)
+      assert accounts.data[0].kind_of?(Stripe::Account)
     end
 
-    should "be retrievable using an API key as the only argument" do
-      account = mock
-      Stripe::Account.expects(:new).once.with(nil, {:api_key => 'sk_foobar'}).returns(account)
-      account.expects(:refresh).once
-      Stripe::Account.retrieve('sk_foobar')
+    should "be retrievable using singular endpoint" do
+      account = Stripe::Account.retrieve
+      assert_requested :get, "#{Stripe.api_base}/v1/account"
+      assert account.kind_of?(Stripe::Account)
     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
+    should "be retrievable using plural endpoint" do
+      account = Stripe::Account.retrieve(FIXTURE[:id])
+      assert_requested :get, "#{Stripe.api_base}/v1/accounts/#{FIXTURE[:id]}"
+      assert account.kind_of?(Stripe::Account)
     end
 
     should "be rejectable" do
       account_data = {:id => 'acct_foo'}
-      @mock.expects(:get).
-        once.
-        with('https://api.stripe.com/v1/accounts/acct_foo', nil, nil).
-        returns(make_response(account_data))
+      stub_request(:get, "#{Stripe.api_base}/v1/accounts/acct_foo").
+        to_return(body: JSON.generate(account_data))
 
-      @mock.expects(:post).
-        once.
-        with("https://api.stripe.com/v1/accounts/acct_foo/reject", nil, 'reason=fraud').
-        returns(make_response(account_data))
+      stub_request(:post, "#{Stripe.api_base}/v1/accounts/acct_foo/reject").
+        to_return(body: JSON.generate(account_data))
 
       account = Stripe::Account.retrieve('acct_foo')
       account.reject(:reason => 'fraud')
     end
 
-    should "be saveable" do
-      resp = {
-        :id => 'acct_foo',
-        :legal_entity => {
-          :address => {
-            :line1 => '1 Two Three'
-          }
-        }
-      }
-      @mock.expects(:get).
-        once.
-        with('https://api.stripe.com/v1/accounts/acct_foo', nil, nil).
-        returns(make_response(resp))
-
-      @mock.expects(:post).
-        once.
-        with('https://api.stripe.com/v1/accounts/acct_foo', nil, 'legal_entity[address][line1]=2+Three+Four&legal_entity[first_name]=Bob').
-        returns(make_response(resp))
-
-      a = Stripe::Account.retrieve('acct_foo')
-      a.legal_entity.first_name = 'Bob'
-      a.legal_entity.address.line1 = '2 Three Four'
-      a.save
+    should "be creatable" do
+      account = Stripe::Account.create(:metadata => {})
+      assert_requested :post, "#{Stripe.api_base}/v1/accounts"
+      assert account.kind_of?(Stripe::Account)
     end
 
-    should "be updatable" do
-      resp = {
-        :id => 'acct_foo',
-        :business_name => 'ACME Corp',
-      }
-      @mock.expects(:post).
-        once.
-        with('https://api.stripe.com/v1/accounts/acct_foo', nil, 'business_name=ACME+Corp').
-        returns(make_response(resp))
-
-      a = Stripe::Account.update('acct_foo', :business_name => "ACME Corp")
-      assert_equal('ACME Corp', a.business_name)
+    should "be saveable" do
+      account = Stripe::Account.retrieve(FIXTURE[:id])
+      account.metadata['key'] = 'value'
+      account.save
+      assert_requested :post, "#{Stripe.api_base}/v1/accounts/#{FIXTURE[:id]}"
     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'
+    should "be updateable" do
+      account = Stripe::Account.update(FIXTURE[:id], metadata: {foo: 'bar'})
+      assert_requested :post, "#{Stripe.api_base}/v1/accounts/#{FIXTURE[:id]}"
+      assert account.kind_of?(Stripe::Account)
     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))
-      a = Stripe::Account.retrieve
-
-
-      @mock.expects(:post).once.with do |url, api_key, params|
-        url == "#{Stripe.connect_base}/oauth/deauthorize" && api_key.nil? && CGI.parse(params) == { 'client_id' => [ 'ca_1234' ], 'stripe_user_id' => [ a.id ]}
-      end.returns(make_response({ 'stripe_user_id' => a.id }))
-      a.deauthorize('ca_1234', 'sk_test_1234')
+    should "be deletable" do
+      account = Stripe::Account.retrieve(FIXTURE[:id])
+      account = account.delete
+      assert_requested :delete, "#{Stripe.api_base}/v1/accounts/#{FIXTURE[:id]}"
+      assert account.kind_of?(Stripe::Account)
     end
 
-    should "reject nil api keys" do
-      assert_raise TypeError do
-        Stripe::Account.retrieve(nil)
-      end
-      assert_raise TypeError do
-        Stripe::Account.retrieve(:api_key => nil)
+    context "#bank_account=" do
+      should "warn that #bank_account= is deprecated" do
+        old_stderr = $stderr
+        $stderr = StringIO.new
+        begin
+          account = Stripe::Account.retrieve(FIXTURE[:id])
+          account.bank_account = "tok_123"
+          message = "NOTE: Stripe::Account#bank_account= is " +
+            "deprecated; use #external_account= instead"
+          assert_match Regexp.new(message), $stderr.string
+        ensure
+          $stderr = old_stderr
+        end
       end
     end
 
-    should "be able to create a bank account" do
-      resp = {
-        :id => 'acct_1234',
-        :external_accounts => {
-          :object => "list",
-          :resource_url => "/v1/accounts/acct_1234/external_accounts",
-          :data => [],
-        }
-      }
-      @mock.expects(:get).once.returns(make_response(resp))
-      a = Stripe::Account.retrieve
+    context "#deauthorize" do
+      should "deauthorize an account" do
+        account = Stripe::Account.retrieve(FIXTURE[:id])
 
-      @mock.expects(:post).
-        once.
-        with('https://api.stripe.com/v1/accounts/acct_1234/external_accounts', nil, 'external_account=btok_1234').
-        returns(make_response(resp))
-      a.external_accounts.create({:external_account => 'btok_1234'})
+        # Unfortunately, the OpenAPI spec doesn't yet cover anything under the
+        # Connect endpoints, so for just stub this out with Webmock.
+        stub_request(:post, "#{Stripe.connect_base}/oauth/deauthorize").
+          with(body: { 'client_id' => 'ca_1234', 'stripe_user_id' => account.id}).
+          to_return(body: JSON.generate({ 'stripe_user_id' => account.id }))
+        account.deauthorize('ca_1234', 'sk_test_1234')
+      end
     end
 
-    should "be able to retrieve a bank account" do
-      resp = {
-        :id => 'acct_1234',
-        :external_accounts => {
-          :object => "list",
-          :resource_url => "/v1/accounts/acct_1234/external_accounts",
-          :data => [{
-            :id => "ba_1234",
-            :object => "bank_account",
-          }],
-        }
-      }
-      @mock.expects(:get).once.returns(make_response(resp))
-      a = Stripe::Account.retrieve
-      assert_equal(BankAccount, a.external_accounts.data[0].class)
-    end
+    context "#legal_entity=" do
+      should 'disallow direct overrides' do
+        account = Stripe::Account.retrieve(FIXTURE[:id])
 
-    should "#serialize_params an a new additional_owners" do
-      obj = Stripe::Util.convert_to_stripe_object({
-        :object => "account",
-        :legal_entity => Stripe::StripeObject.construct_from({
-        }),
-      }, {})
-      obj.legal_entity.additional_owners = [
-        { :first_name => "Joe" },
-        { :first_name => "Jane" },
-      ]
+        assert_raise NoMethodError do
+          account.legal_entity = {:first_name => 'Blah'}
+        end
 
-      expected = {
-        :legal_entity => {
-          :additional_owners => {
-            "0" => { :first_name => "Joe" },
-            "1" => { :first_name => "Jane" },
-          }
-        }
-      }
-      assert_equal(expected, obj.serialize_params)
+        account.legal_entity.first_name = 'Blah'
+      end
     end
 
-    should "#serialize_params on an partially changed additional_owners" do
-      obj = Stripe::Util.convert_to_stripe_object({
-        :object => "account",
-        :legal_entity => {
-          :additional_owners => [
-            Stripe::StripeObject.construct_from({
-              :first_name => "Joe"
-            }),
-            Stripe::StripeObject.construct_from({
-              :first_name => "Jane"
-            }),
-          ]
+    context "#serialize_params" do
+      should "serialize an a new additional_owners" do
+        obj = Stripe::Util.convert_to_stripe_object({
+          :object => "account",
+          :legal_entity => Stripe::StripeObject.construct_from({
+          }),
+        }, {})
+        obj.legal_entity.additional_owners = [
+          { :first_name => "Joe" },
+          { :first_name => "Jane" },
+        ]
+
+        expected = {
+          :legal_entity => {
+            :additional_owners => {
+              "0" => { :first_name => "Joe" },
+              "1" => { :first_name => "Jane" },
+            }
+          }
         }
-      }, {})
-      obj.legal_entity.additional_owners[1].first_name = "Stripe"
+        assert_equal(expected, obj.serialize_params)
+      end
 
-      expected = {
-        :legal_entity => {
-          :additional_owners => {
-            "1" => { :first_name => "Stripe" }
+      should "serialize on an partially changed additional_owners" do
+        obj = Stripe::Util.convert_to_stripe_object({
+          :object => "account",
+          :legal_entity => {
+            :additional_owners => [
+              Stripe::StripeObject.construct_from({
+                :first_name => "Joe"
+              }),
+              Stripe::StripeObject.construct_from({
+                :first_name => "Jane"
+              }),
+            ]
+          }
+        }, {})
+        obj.legal_entity.additional_owners[1].first_name = "Stripe"
+
+        expected = {
+          :legal_entity => {
+            :additional_owners => {
+              "1" => { :first_name => "Stripe" }
+            }
           }
         }
-      }
-      assert_equal(expected, obj.serialize_params)
-    end
+        assert_equal(expected, obj.serialize_params)
+      end
 
-    should "#serialize_params on an unchanged additional_owners" do
-      obj = Stripe::Util.convert_to_stripe_object({
-        :object => "account",
-        :legal_entity => {
-          :additional_owners => [
-            Stripe::StripeObject.construct_from({
-              :first_name => "Joe"
-            }),
-            Stripe::StripeObject.construct_from({
-              :first_name => "Jane"
-            }),
-          ]
-        }
-      }, {})
+      should "serialize on an unchanged additional_owners" do
+        obj = Stripe::Util.convert_to_stripe_object({
+          :object => "account",
+          :legal_entity => {
+            :additional_owners => [
+              Stripe::StripeObject.construct_from({
+                :first_name => "Joe"
+              }),
+              Stripe::StripeObject.construct_from({
+                :first_name => "Jane"
+              }),
+            ]
+          }
+        }, {})
 
-      expected = {
-        :legal_entity => {
-          :additional_owners => {}
+        expected = {
+          :legal_entity => {
+            :additional_owners => {}
+          }
         }
-      }
-      assert_equal(expected, obj.serialize_params)
-    end
+        assert_equal(expected, obj.serialize_params)
+      end
 
-    # Note that the empty string that we send for this one has a special
-    # meaning for the server, which interprets it as an array unset.
-    should "#serialize_params on an unset additional_owners" do
-      obj = Stripe::Util.convert_to_stripe_object({
-        :object => "account",
-        :legal_entity => {
-          :additional_owners => [
-            Stripe::StripeObject.construct_from({
-              :first_name => "Joe"
-            }),
-            Stripe::StripeObject.construct_from({
-              :first_name => "Jane"
-            }),
-          ]
-        }
-      }, {})
-      obj.legal_entity.additional_owners = nil
+      # Note that the empty string that we send for this one has a special
+      # meaning for the server, which interprets it as an array unset.
+      should "serialize on an unset additional_owners" do
+        obj = Stripe::Util.convert_to_stripe_object({
+          :object => "account",
+          :legal_entity => {
+            :additional_owners => [
+              Stripe::StripeObject.construct_from({
+                :first_name => "Joe"
+              }),
+              Stripe::StripeObject.construct_from({
+                :first_name => "Jane"
+              }),
+            ]
+          }
+        }, {})
+        obj.legal_entity.additional_owners = nil
 
-      expected = {
-        :legal_entity => {
-          :additional_owners => ""
+        expected = {
+          :legal_entity => {
+            :additional_owners => ""
+          }
         }
-      }
-      assert_equal(expected, obj.serialize_params)
-    end
-
-    context "#bank_account=" do
-      should "warn that #bank_account= is deprecated" do
-        old_stderr = $stderr
-        $stderr = StringIO.new
-        begin
-          a = Stripe::Account.new("test_account")
-          a.bank_account = "tok_123"
-          message = "NOTE: Stripe::Account#bank_account= is " +
-            "deprecated; use #external_account= instead"
-          assert_match Regexp.new(message), $stderr.string
-        ensure
-          $stderr = old_stderr
-        end
+        assert_equal(expected, obj.serialize_params)
       end
     end
   end