stripe 4.9.0 → 5.28.0

data/stripe.gemspec

@@ -7,19 +7,28 @@ require "stripe/version"
 Gem::Specification.new do |s|
   s.name = "stripe"
   s.version = Stripe::VERSION
-  s.required_ruby_version = ">= 2.1.0"
+  s.required_ruby_version = ">= 2.3.0"
   s.summary = "Ruby bindings for the Stripe API"
-  s.description = "Stripe is the easiest way to accept payments online.  See https://stripe.com for details."
+  s.description = "Stripe is the easiest way to accept payments online.  " \
+                  "See https://stripe.com for details."
   s.author = "Stripe"
   s.email = "support@stripe.com"
   s.homepage = "https://stripe.com/docs/api/ruby"
   s.license = "MIT"
 
-  s.add_dependency("faraday", "~> 0.13")
-  s.add_dependency("net-http-persistent", "~> 3.0")
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/stripe/stripe-ruby/issues",
+    "changelog_uri" =>
+      "https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://stripe.com/docs/api/ruby",
+    "github_repo" => "ssh://github.com/stripe/stripe-ruby",
+    "homepage_uri" => "https://stripe.com/docs/api/ruby",
+    "source_code_uri" => "https://github.com/stripe/stripe-ruby",
+  }
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| ::File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
   s.require_paths = ["lib"]
 end

data/test/stripe/account_link_test.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class AccountLinkTest < Test::Unit::TestCase
     should "be creatable" do
       link = Stripe::AccountLink.create(
         account: "acct_123",
-        failure_url: "https://stripe.com/failure",
-        success_url: "https://stripe.com/success",
-        type: "custom_account_verification"
+        refresh_url: "https://stripe.com/refresh",
+        return_url: "https://stripe.com/return",
+        type: "account_onboarding"
       )
       assert_requested :post, "#{Stripe.api_base}/v1/account_links"
       assert link.is_a?(Stripe::AccountLink)

data/test/stripe/account_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class AccountTest < Test::Unit::TestCase
@@ -24,15 +24,18 @@ module Stripe
     end
 
     should "be rejectable" do
-      account_data = { id: "acct_foo" }
-      stub_request(:get, "#{Stripe.api_base}/v1/accounts/acct_foo")
-        .to_return(body: JSON.generate(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")
+      account = account.reject(reason: "fraud")
+      assert_requested :post, "#{Stripe.api_base}/v1/accounts/#{account.id}/reject"
+      assert account.is_a?(Stripe::Account)
+    end
+
+    context ".reject" do
+      should "reject the account" do
+        account = Stripe::Account.reject("acct_foo", reason: "fraud")
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/#{account.id}/reject"
+        assert account.is_a?(Stripe::Account)
+      end
     end
 
     should "be creatable" do
@@ -54,11 +57,21 @@ module Stripe
       assert account.is_a?(Stripe::Account)
     end
 
-    should "be deletable" do
-      account = Stripe::Account.retrieve("acct_123")
-      account = account.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/accounts/#{account.id}"
-      assert account.is_a?(Stripe::Account)
+    context "#delete" do
+      should "be deletable" do
+        account = Stripe::Account.retrieve("acct_123")
+        account = account.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/accounts/#{account.id}"
+        assert account.is_a?(Stripe::Account)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        account = Stripe::Account.delete("acct_123")
+        assert_requested :delete, "#{Stripe.api_base}/v1/accounts/acct_123"
+        assert account.is_a?(Stripe::Account)
+      end
     end
 
     should "be able to list Persons" do
@@ -69,22 +82,6 @@ module Stripe
       assert persons.data[0].is_a?(Stripe::Person)
     end
 
-    context "#bank_account=" do
-      should "warn that #bank_account= is deprecated" do
-        old_stderr = $stderr
-        $stderr = StringIO.new
-        begin
-          account = Stripe::Account.retrieve("acct_123")
-          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
-
     context "#deauthorize" do
       should "deauthorize an account" do
         account = Stripe::Account.retrieve("acct_123")
@@ -100,7 +97,12 @@ module Stripe
 
     context "#legal_entity=" do
       should "disallow direct overrides" do
-        account = Stripe::Account.retrieve("acct_123")
+        account = Stripe::Account.construct_from(
+          id: "acct_123",
+          legal_entity: {
+            first_name: "name",
+          }
+        )
 
         assert_raise NoMethodError do
           account.legal_entity = { first_name: "Blah" }
@@ -111,7 +113,7 @@ module Stripe
     end
 
     context "#serialize_params" do
-      should "serialize an a new additional_owners" do
+      should "serialize a new additional_owners" do
         obj = Stripe::Util.convert_to_stripe_object({
           object: "account",
           legal_entity: Stripe::StripeObject.construct_from({
@@ -247,5 +249,164 @@ module Stripe
         assert_equal(expected, obj.serialize_params)
       end
     end
+
+    context "#retrieve_capability" do
+      should "retrieve a capability" do
+        capability = Stripe::Account.retrieve_capability(
+          "acct_123",
+          "acap_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/accounts/acct_123/capabilities/acap_123"
+        assert capability.is_a?(Stripe::Capability)
+      end
+    end
+
+    context "#update_capability" do
+      should "update a capability" do
+        capability = Stripe::Account.update_capability(
+          "acct_123",
+          "acap_123",
+          requested: true
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/acct_123/capabilities/acap_123"
+        assert capability.is_a?(Stripe::Capability)
+      end
+    end
+
+    context "#list_capabilities" do
+      should "list the account's external accounts" do
+        capabilities = Stripe::Account.list_capabilities(
+          "acct_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/accounts/acct_123/capabilities"
+        assert capabilities.is_a?(Stripe::ListObject)
+        assert capabilities.data.is_a?(Array)
+      end
+    end
+
+    context "#create_external_account" do
+      should "create an external account" do
+        external_account = Stripe::Account.create_external_account(
+          "acct_123",
+          external_account: "btok_123"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/acct_123/external_accounts"
+        assert external_account.is_a?(Stripe::BankAccount)
+      end
+    end
+
+    context "#retrieve_external_account" do
+      should "retrieve an external account" do
+        external_account = Stripe::Account.retrieve_external_account(
+          "acct_123",
+          "ba_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/accounts/acct_123/external_accounts/ba_123"
+        assert external_account.is_a?(Stripe::BankAccount)
+      end
+    end
+
+    context "#update_external_account" do
+      should "update an external account" do
+        external_account = Stripe::Account.update_external_account(
+          "acct_123",
+          "ba_123",
+          metadata: { foo: "bar" }
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/acct_123/external_accounts/ba_123"
+        assert external_account.is_a?(Stripe::BankAccount)
+      end
+    end
+
+    context "#delete_external_account" do
+      should "delete an external_account" do
+        external_account = Stripe::Account.delete_external_account(
+          "acct_123",
+          "ba_123"
+        )
+        assert_requested :delete, "#{Stripe.api_base}/v1/accounts/acct_123/external_accounts/ba_123"
+        assert external_account.deleted
+        assert_equal "ba_123", external_account.id
+      end
+    end
+
+    context "#list_external_accounts" do
+      should "list the account's external accounts" do
+        external_accounts = Stripe::Account.list_external_accounts(
+          "acct_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/accounts/acct_123/external_accounts"
+        assert external_accounts.is_a?(Stripe::ListObject)
+        assert external_accounts.data.is_a?(Array)
+      end
+    end
+
+    context "#create_login_link" do
+      should "create a login link" do
+        login_link = Stripe::Account.create_login_link(
+          "acct_123"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/acct_123/login_links"
+        assert login_link.is_a?(Stripe::LoginLink)
+      end
+    end
+
+    context "#create_person" do
+      should "create a person" do
+        person = Stripe::Account.create_person(
+          "acct_123",
+          first_name: "John",
+          last_name: "Doe"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/acct_123/persons"
+        assert person.is_a?(Stripe::Person)
+      end
+    end
+
+    context "#retrieve_person" do
+      should "retrieve a person" do
+        person = Stripe::Account.retrieve_person(
+          "acct_123",
+          "person_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/accounts/acct_123/persons/person_123"
+        assert person.is_a?(Stripe::Person)
+      end
+    end
+
+    context "#update_person" do
+      should "update a person" do
+        person = Stripe::Account.update_person(
+          "acct_123",
+          "person_123",
+          first_name: "John"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/acct_123/persons/person_123"
+        assert person.is_a?(Stripe::Person)
+      end
+    end
+
+    context "#delete_person" do
+      should "delete an person" do
+        person = Stripe::Account.delete_person(
+          "acct_123",
+          "person_123"
+        )
+        assert_requested :delete, "#{Stripe.api_base}/v1/accounts/acct_123/persons/person_123"
+        assert person.deleted
+        assert_equal "person_123", person.id
+      end
+    end
+
+    context "#list_persons" do
+      should "list the account's external accounts" do
+        persons = Stripe::Account.list_persons(
+          "acct_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/accounts/acct_123/persons"
+        assert persons.is_a?(Stripe::ListObject)
+        assert persons.data.is_a?(Array)
+      end
+    end
   end
 end

data/test/stripe/alipay_account_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class AlipayAccountTest < Test::Unit::TestCase

data/test/stripe/api_operations_test.rb

@@ -1,14 +1,13 @@
-# -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class ApiOperationsTest < Test::Unit::TestCase
     class UpdateableResource < APIResource
       include Stripe::APIOperations::Save
 
-      OBJECT_NAME = "updateableresource".freeze
+      OBJECT_NAME = "updateableresource"
 
       def self.protected_fields
         [:protected]
@@ -35,7 +34,7 @@ module Stripe
     context ".nested_resource_class_methods" do
       class MainResource < APIResource
         extend Stripe::APIOperations::NestedResource
-        OBJECT_NAME = "mainresource".freeze
+        OBJECT_NAME = "mainresource"
         nested_resource_class_methods :nested,
                                       operations: %i[create retrieve update delete list]
       end

data/test/stripe/api_resource_test.rb

@@ -1,14 +1,34 @@
-# -*- coding: utf-8 -*-
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class ApiResourceTest < Test::Unit::TestCase
-    class NestedTestAPIResource < Stripe::APIResource
+    class CustomMethodAPIResource < APIResource
+      OBJECT_NAME = "custom_method"
+      custom_method :my_method, http_verb: :post
+    end
+
+    class NestedTestAPIResource < APIResource
       save_nested_resource :external_account
     end
 
+    context ".custom_method" do
+      should "call to an RPC-style method" do
+        stub_request(:post, "#{Stripe.api_base}/v1/custom_methods/ch_123/my_method")
+          .to_return(body: JSON.generate({}))
+        CustomMethodAPIResource.my_method("ch_123")
+      end
+
+      should "raise an error if a non-ID is passed" do
+        e = assert_raises ArgumentError do
+          CustomMethodAPIResource.my_method(id: "ch_123")
+        end
+        assert_equal "id should be a string representing the ID of an API resource",
+                     e.message
+      end
+    end
+
     context ".save_nested_resource" do
       should "can have a scalar set" do
         r = NestedTestAPIResource.new("test_resource")
@@ -91,15 +111,15 @@ module Stripe
     end
 
     should "send expand when fetching through ListObject" do
-      stub_request(:get, "#{Stripe.api_base}/v1/customers/cus_123")
-        .to_return(body: JSON.generate(customer_fixture))
+      stub_request(:get, "#{Stripe.api_base}/v1/charges/ch_123")
+        .to_return(body: JSON.generate(charge_fixture))
 
-      stub_request(:get, "#{Stripe.api_base}/v1/customers/cus_123/sources/cc_test_card")
-        .with(query: { "expand" => ["customer"] })
-        .to_return(body: JSON.generate(customer_fixture))
+      stub_request(:get, "#{Stripe.api_base}/v1/charges/ch_123/refunds/re_123")
+        .with(query: { "expand" => ["balance_transaction"] })
+        .to_return(body: JSON.generate(charge_fixture))
 
-      customer = Stripe::Customer.retrieve("cus_123")
-      customer.sources.retrieve(id: "cc_test_card", expand: [:customer])
+      charge = Stripe::Charge.retrieve("ch_123")
+      charge.refunds.retrieve(id: "re_123", expand: [:balance_transaction])
     end
 
     context "when specifying per-object credentials" do
@@ -207,6 +227,39 @@ module Stripe
         end
       end
 
+      should "error if the params is not a Hash" do
+        stub_request(:post, "#{Stripe.api_base}/v1/charges/ch_123/capture")
+          .to_return(body: JSON.generate(charge_fixture))
+
+        e = assert_raises(ArgumentError) { Stripe::Charge.capture("ch_123", "sk_test_secret") }
+
+        assert_equal "request params should be either a Hash or nil (was a String)", e.message
+      end
+
+      should "allow making a request with params set to nil" do
+        stub_request(:post, "#{Stripe.api_base}/v1/charges/ch_123/capture")
+          .to_return(body: JSON.generate(charge_fixture))
+
+        Stripe::Charge.capture("ch_123", nil, "sk_test_secret")
+      end
+
+      should "error if a user-specified opt is given a non-nil non-string value" do
+        stub_request(:post, "#{Stripe.api_base}/v1/charges")
+          .to_return(body: JSON.generate(charge_fixture))
+
+        # Works fine if not included or a string.
+        Stripe::Charge.create({ amount: 100, currency: "usd" }, {})
+        Stripe::Charge.create({ amount: 100, currency: "usd" }, idempotency_key: "12345")
+
+        # Errors on a non-string.
+        e = assert_raises(ArgumentError) do
+          Stripe::Charge.create({ amount: 100, currency: "usd" }, idempotency_key: :foo)
+        end
+        assert_equal "request option 'idempotency_key' should be a string value " \
+                       "(was a Symbol)",
+                     e.message
+      end
+
       should "requesting with a unicode ID should result in a request" do
         stub_request(:get, "#{Stripe.api_base}/v1/customers/%E2%98%83")
           .to_return(body: JSON.generate(make_missing_id_error), status: 404)
@@ -251,14 +304,6 @@ module Stripe
         assert_equal c.created, 12_345
       end
 
-      should "accessing a property other than id or parent on an unfetched object should fetch it" do
-        stub_request(:get, "#{Stripe.api_base}/v1/charges")
-          .with(query: { customer: "cus_123" })
-          .to_return(body: JSON.generate(customer_fixture))
-        c = Stripe::Customer.new("cus_123")
-        c.charges
-      end
-
       should "updating an object should issue a POST request with only the changed properties" do
         stub_request(:post, "#{Stripe.api_base}/v1/customers/cus_123")
           .with(body: { "description" => "another_mn" })
@@ -307,7 +352,7 @@ module Stripe
         charges = Stripe::Charge.list.data
         assert charges.is_a? Array
         assert charges[0].is_a? Stripe::Charge
-        assert charges[0].source.is_a?(Stripe::StripeObject)
+        assert charges[0].payment_method_details.is_a?(Stripe::StripeObject)
       end
 
       should "passing in a stripe_account header should pass it through on call" do
@@ -375,20 +420,22 @@ module Stripe
       end
 
       should "correctly handle replaced nested objects" do
-        acct = Stripe::Account.construct_from(id: "myid",
-                                              legal_entity: {
-                                                last_name: "Smith",
-                                                address: {
-                                                  line1: "test",
-                                                  city: "San Francisco",
-                                                },
-                                              })
-
-        stub_request(:post, "#{Stripe.api_base}/v1/accounts/myid")
-          .with(body: { legal_entity: { address: { line1: "Test2", city: "" } } })
+        acct = Stripe::Account.construct_from(
+          id: "acct_123",
+          company: {
+            name: "company_name",
+            address: {
+              line1: "test",
+              city: "San Francisco",
+            },
+          }
+        )
+
+        stub_request(:post, "#{Stripe.api_base}/v1/accounts/acct_123")
+          .with(body: { company: { address: { line1: "Test2", city: "" } } })
           .to_return(body: JSON.generate("id" => "my_id"))
 
-        acct.legal_entity.address = { line1: "Test2" }
+        acct.company.address = { line1: "Test2" }
         acct.save
       end
 
@@ -489,7 +536,84 @@ module Stripe
       end
     end
 
-    @@fixtures = {}
+    context "#request_stripe_object" do
+      class HelloTestAPIResource < APIResource
+        OBJECT_NAME = "hello"
+        def say_hello(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: resource_url + "/say",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
+      setup do
+        Util.instance_variable_set(
+          :@object_classes,
+          Stripe::ObjectTypes.object_names_to_classes.merge(
+            "hello" => HelloTestAPIResource
+          )
+        )
+      end
+      teardown do
+        Util.class.instance_variable_set(:@object_classes, Stripe::ObjectTypes.object_names_to_classes)
+      end
+
+      should "make requests appropriately" do
+        stub_request(:post, "#{Stripe.api_base}/v1/hellos/hi_123/say")
+          .with(body: { foo: "bar" }, headers: { "Stripe-Account" => "acct_hi" })
+          .to_return(body: JSON.generate("object" => "hello"))
+
+        hello = HelloTestAPIResource.new(id: "hi_123")
+        hello.say_hello({ foo: "bar" }, stripe_account: "acct_hi")
+      end
+
+      should "update attributes in-place when it returns the same thing" do
+        stub_request(:post, "#{Stripe.api_base}/v1/hellos/hi_123/say")
+          .to_return(body: JSON.generate("object" => "hello", "additional" => "attribute"))
+
+        hello = HelloTestAPIResource.new(id: "hi_123")
+        hello.unsaved = "a value"
+        new_hello = hello.say_hello
+
+        # Doesn't matter if you use the return variable or the instance.
+        assert_equal(hello, new_hello)
+
+        # It updates new attributes in-place.
+        assert_equal("attribute", hello.additional)
+
+        # It removes unsaved attributes, but at least lets you know about them.
+        e = assert_raises(NoMethodError) { hello.unsaved }
+        assert_match("The 'unsaved' attribute was set in the past", e.message)
+      end
+
+      should "instantiate a new object of the appropriate class when it is different than the host class" do
+        stub_request(:post, "#{Stripe.api_base}/v1/hellos/hi_123/say")
+          .to_return(body: JSON.generate("object" => "goodbye", "additional" => "attribute"))
+
+        hello = HelloTestAPIResource.new(id: "hi_123")
+        hello.unsaved = "a value"
+        new_goodbye = hello.say_hello
+
+        # The returned value and the instance are different objects.
+        refute_equal(new_goodbye, hello)
+
+        # The returned value has stuff from the server.
+        assert_equal("attribute", new_goodbye.additional)
+        assert_equal("goodbye", new_goodbye.object)
+
+        # You instance doesn't have stuff from the server.
+        e = assert_raises(NoMethodError) { hello.additional }
+        refute_match(/was set in the past/, e.message)
+
+        # The instance preserves unset attributes on the original instance (not sure this is good behavior?)
+        assert_equal("a value", hello.unsaved)
+      end
+    end
+
+    @@fixtures = {} # rubocop:disable Style/ClassVars
     setup do
       if @@fixtures.empty?
         cache_fixture(:charge) do
@@ -501,19 +625,17 @@ module Stripe
       end
     end
 
-    private
-
-    def charge_fixture
+    private def charge_fixture
       @@fixtures[:charge]
     end
 
-    def customer_fixture
+    private def customer_fixture
       @@fixtures[:customer]
     end
 
     # Expects to retrieve a fixture from stripe-mock (an API call should be
     # included in the block to yield to) and does very simple memoization.
-    def cache_fixture(key)
+    private def cache_fixture(key)
       return @@fixtures[key] if @@fixtures.key?(key)
 
       obj = yield