stripe 4.10.0 → 5.0.0

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")
@@ -251,14 +271,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 +319,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
@@ -491,7 +503,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
@@ -503,19 +592,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

data/test/stripe/apple_pay_domain_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 ApplePayDomainTest < Test::Unit::TestCase
@@ -24,10 +24,23 @@ module Stripe
     end
 
     should "be deletable" do
-      domain = Stripe::ApplePayDomain.retrieve("apwc_123")
-      domain = domain.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/apple_pay/domains/#{domain.id}"
-      assert domain.is_a?(Stripe::ApplePayDomain)
+    end
+
+    context "#delete" do
+      should "be deletable" do
+        domain = Stripe::ApplePayDomain.retrieve("apwc_123")
+        domain = domain.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/apple_pay/domains/#{domain.id}"
+        assert domain.is_a?(Stripe::ApplePayDomain)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        domain = Stripe::ApplePayDomain.delete("apwc_123")
+        assert_requested :delete, "#{Stripe.api_base}/v1/apple_pay/domains/apwc_123"
+        assert domain.is_a?(Stripe::ApplePayDomain)
+      end
     end
   end
 end

data/test/stripe/application_fee_refund_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 ApplicationFeeRefundTest < Test::Unit::TestCase

data/test/stripe/application_fee_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 ApplicationFeeTest < Test::Unit::TestCase
@@ -10,5 +10,49 @@ module Stripe
       assert fees.data.is_a?(Array)
       assert fees.data[0].is_a?(Stripe::ApplicationFee)
     end
+
+    context "#create_refund" do
+      should "create a refund" do
+        refund = Stripe::ApplicationFee.create_refund(
+          "fee_123"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/application_fees/fee_123/refunds"
+        assert refund.is_a?(Stripe::ApplicationFeeRefund)
+      end
+    end
+
+    context "#retrieve_refund" do
+      should "retrieve a refund" do
+        refund = Stripe::ApplicationFee.retrieve_refund(
+          "fee_123",
+          "fr_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/application_fees/fee_123/refunds/fr_123"
+        assert refund.is_a?(Stripe::ApplicationFeeRefund)
+      end
+    end
+
+    context "#update_refund" do
+      should "update a refund" do
+        refund = Stripe::ApplicationFee.update_refund(
+          "fee_123",
+          "fr_123",
+          metadata: { foo: "bar" }
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/application_fees/fee_123/refunds/fr_123"
+        assert refund.is_a?(Stripe::ApplicationFeeRefund)
+      end
+    end
+
+    context "#list_refunds" do
+      should "list the application fee's refuns" do
+        refunds = Stripe::ApplicationFee.list_refunds(
+          "fee_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/application_fees/fee_123/refunds"
+        assert refunds.is_a?(Stripe::ListObject)
+        assert refunds.data.is_a?(Array)
+      end
+    end
   end
 end

data/test/stripe/balance_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 BalanceTest < Test::Unit::TestCase

data/test/stripe/balance_transaction_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class BalanceTransactionTest < Test::Unit::TestCase
+    should "be listable" do
+      balance_transactions = Stripe::BalanceTransaction.list
+      assert_requested :get, "#{Stripe.api_base}/v1/balance_transactions"
+      assert balance_transactions.data.is_a?(Array)
+      assert balance_transactions.first.is_a?(Stripe::BalanceTransaction)
+    end
+
+    should "be retrievable" do
+      balance_transaction = Stripe::BalanceTransaction.retrieve("txn_123")
+      assert_requested :get, "#{Stripe.api_base}/v1/balance_transactions/txn_123"
+      assert balance_transaction.is_a?(Stripe::BalanceTransaction)
+    end
+  end
+end

data/test/stripe/bank_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 BankAccountTest < Test::Unit::TestCase

data/test/stripe/capability_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class CapabilityTest < Test::Unit::TestCase
+    context "#resource_url" do
+      should "return a resource URL" do
+        capability = Stripe::Capability.construct_from(
+          id: "acap_123",
+          account: "acct_123"
+        )
+        assert_equal "/v1/accounts/acct_123/capabilities/acap_123",
+                     capability.resource_url
+      end
+
+      should "raise without an account" do
+        capability = Stripe::Capability.construct_from(id: "acap_123")
+        assert_raises NotImplementedError do
+          capability.resource_url
+        end
+      end
+    end
+
+    should "raise on #retrieve" do
+      assert_raises NotImplementedError do
+        Stripe::Capability.retrieve("acap_123")
+      end
+    end
+
+    should "raise on #update" do
+      assert_raises NotImplementedError do
+        Stripe::Capability.update("acap_123", {})
+      end
+    end
+
+    should "be saveable" do
+      capability = Stripe::Account.retrieve_capability("acct_123", "acap_123")
+      capability.requested = true
+      capability.save
+      assert_requested :post,
+                       "#{Stripe.api_base}/v1/accounts/#{capability.account}/capabilities/#{capability.id}"
+    end
+  end
+end

data/test/stripe/charge_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 ChargeTest < Test::Unit::TestCase
@@ -40,18 +40,23 @@ module Stripe
       assert charge.is_a?(Stripe::Charge)
     end
 
-    context "#mark_as_fraudulent" do
-      should "charges should be able to be marked as fraudulent" do
+    context "#capture" do
+      should "capture the charge" do
         charge = Stripe::Charge.retrieve("ch_123")
-        charge = charge.mark_as_fraudulent
+        charge = charge.capture(amount: 100)
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/charges/ch_123/capture",
+                         body: { amount: 100 }
         assert charge.is_a?(Stripe::Charge)
       end
     end
 
-    context "#mark_as_safe" do
-      should "charges should be able to be marked as safe" do
-        charge = Stripe::Charge.retrieve("ch_123")
-        charge = charge.mark_as_safe
+    context ".capture" do
+      should "capture the charge" do
+        charge = Stripe::Charge.capture("ch_123", amount: 100)
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/charges/ch_123/capture",
+                         body: { amount: 100 }
         assert charge.is_a?(Stripe::Charge)
       end
     end

data/test/stripe/checkout/session_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
   module Checkout

data/test/stripe/connection_manager_test.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class ConnectionManagerTest < Test::Unit::TestCase
+    setup do
+      @manager = Stripe::ConnectionManager.new
+    end
+
+    context "#clear" do
+      should "clear any active connections" do
+        stub_request(:post, "#{Stripe.api_base}/path")
+          .to_return(body: JSON.generate(object: "account"))
+
+        # Making a request lets us know that at least one connection is open.
+        @manager.execute_request(:post, "#{Stripe.api_base}/path")
+
+        # Now clear the manager.
+        @manager.clear
+
+        # This check isn't great, but it's otherwise difficult to tell that
+        # anything happened with just the public-facing API.
+        assert_equal({}, @manager.instance_variable_get(:@active_connections))
+      end
+    end
+
+    context "#connection_for" do
+      should "correctly initialize a connection" do
+        old_proxy = Stripe.proxy
+
+        old_open_timeout = Stripe.open_timeout
+        old_read_timeout = Stripe.read_timeout
+
+        begin
+          # Make sure any global initialization here is undone in the `ensure`
+          # block below.
+          Stripe.proxy = "http://user:pass@localhost:8080"
+
+          Stripe.open_timeout = 123
+          Stripe.read_timeout = 456
+
+          conn = @manager.connection_for("https://stripe.com")
+
+          # Host/port
+          assert_equal "stripe.com", conn.address
+          assert_equal 443, conn.port
+
+          # Proxy
+          assert_equal "localhost", conn.proxy_address
+          assert_equal 8080, conn.proxy_port
+          assert_equal "user", conn.proxy_user
+          assert_equal "pass", conn.proxy_pass
+
+          # Timeouts
+          assert_equal 123, conn.open_timeout
+          assert_equal 456, conn.read_timeout
+
+          assert_equal true, conn.use_ssl?
+          assert_equal OpenSSL::SSL::VERIFY_PEER, conn.verify_mode
+          assert_equal Stripe.ca_store, conn.cert_store
+        ensure
+          Stripe.proxy = old_proxy
+
+          Stripe.open_timeout = old_open_timeout
+          Stripe.read_timeout = old_read_timeout
+        end
+      end
+
+      should "produce the same connection multiple times" do
+        conn1 = @manager.connection_for("https://stripe.com")
+        conn2 = @manager.connection_for("https://stripe.com")
+
+        assert_equal conn1, conn2
+      end
+
+      should "produce different connections for different hosts" do
+        conn1 = @manager.connection_for("https://example.com")
+        conn2 = @manager.connection_for("https://stripe.com")
+
+        refute_equal conn1, conn2
+      end
+
+      should "produce different connections for different ports" do
+        conn1 = @manager.connection_for("https://stripe.com:80")
+        conn2 = @manager.connection_for("https://stripe.com:443")
+
+        refute_equal conn1, conn2
+      end
+    end
+
+    context "#execute_request" do
+      should "make a request" do
+        stub_request(:post, "#{Stripe.api_base}/path?query=bar")
+          .with(
+            body: "body=foo",
+            headers: { "Stripe-Account" => "bar" }
+          )
+          .to_return(body: JSON.generate(object: "account"))
+
+        @manager.execute_request(:post, "#{Stripe.api_base}/path",
+                                 body: "body=foo",
+                                 headers: { "Stripe-Account" => "bar" },
+                                 query: "query=bar")
+      end
+
+      should "perform basic argument validation" do
+        e = assert_raises ArgumentError do
+          @manager.execute_request("POST", "#{Stripe.api_base}/path")
+        end
+        assert_equal e.message, "method should be a symbol"
+
+        e = assert_raises ArgumentError do
+          @manager.execute_request(:post, :uri)
+        end
+        assert_equal e.message, "uri should be a string"
+
+        e = assert_raises ArgumentError do
+          @manager.execute_request(:post, "#{Stripe.api_base}/path",
+                                   body: {})
+        end
+        assert_equal e.message, "body should be a string"
+
+        e = assert_raises ArgumentError do
+          @manager.execute_request(:post, "#{Stripe.api_base}/path",
+                                   headers: "foo")
+        end
+        assert_equal e.message, "headers should be a hash"
+
+        e = assert_raises ArgumentError do
+          @manager.execute_request(:post, "#{Stripe.api_base}/path",
+                                   query: {})
+        end
+        assert_equal e.message, "query should be a string"
+      end
+    end
+  end
+end

data/test/stripe/country_spec_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 CountrySpecTest < Test::Unit::TestCase

data/test/stripe/coupon_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 CouponTest < Test::Unit::TestCase
@@ -41,11 +41,21 @@ module Stripe
       assert coupon.is_a?(Stripe::Coupon)
     end
 
-    should "be deletable" do
-      coupon = Stripe::Coupon.retrieve("25OFF")
-      coupon = coupon.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/coupons/#{coupon.id}"
-      assert coupon.is_a?(Stripe::Coupon)
+    context "#delete" do
+      should "be deletable" do
+        coupon = Stripe::Coupon.delete("25OFF")
+        assert_requested :delete, "#{Stripe.api_base}/v1/coupons/#{coupon.id}"
+        assert coupon.is_a?(Stripe::Coupon)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        coupon = Stripe::Coupon.retrieve("25OFF")
+        coupon = coupon.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/coupons/25OFF"
+        assert coupon.is_a?(Stripe::Coupon)
+      end
     end
   end
 end

data/test/stripe/credit_note_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class CreditNoteTest < Test::Unit::TestCase
+    should "be listable" do
+      credit_notes = Stripe::CreditNote.list
+      assert_requested :get, "#{Stripe.api_base}/v1/credit_notes"
+      assert credit_notes.data.is_a?(Array)
+      assert credit_notes.first.is_a?(Stripe::CreditNote)
+    end
+
+    should "be retrievable" do
+      credit_note = Stripe::CreditNote.retrieve("cn_123")
+      assert_requested :get, "#{Stripe.api_base}/v1/credit_notes/cn_123"
+      assert credit_note.is_a?(Stripe::CreditNote)
+    end
+
+    should "be creatable" do
+      credit_note = Stripe::CreditNote.create(
+        amount: 100,
+        invoice: "in_123",
+        reason: "duplicate"
+      )
+      assert_requested :post, "#{Stripe.api_base}/v1/credit_notes"
+      assert credit_note.is_a?(Stripe::CreditNote)
+    end
+
+    should "be saveable" do
+      credit_note = Stripe::CreditNote.retrieve("cn_123")
+      credit_note.metadata["key"] = "value"
+      credit_note.save
+      assert_requested :post, "#{Stripe.api_base}/v1/credit_notes/#{credit_note.id}"
+    end
+
+    should "be updateable" do
+      credit_note = Stripe::CreditNote.update("cn_123", metadata: { key: "value" })
+      assert_requested :post, "#{Stripe.api_base}/v1/credit_notes/cn_123"
+      assert credit_note.is_a?(Stripe::CreditNote)
+    end
+
+    context "#void_credit_note" do
+      should "void credit_note" do
+        credit_note = Stripe::CreditNote.retrieve("cn_123")
+        credit_note = credit_note.void_credit_note
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/credit_notes/#{credit_note.id}/void"
+        assert credit_note.is_a?(Stripe::CreditNote)
+      end
+    end
+
+    context ".void_credit_note" do
+      should "void credit_note" do
+        credit_note = Stripe::CreditNote.void_credit_note("cn_123")
+        assert_requested :post, "#{Stripe.api_base}/v1/credit_notes/cn_123/void"
+        assert credit_note.is_a?(Stripe::CreditNote)
+      end
+    end
+  end
+end