stripe 4.9.0 → 5.28.0

data/test/stripe/issuing/card_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 Issuing
@@ -41,12 +41,33 @@ module Stripe
         assert card.is_a?(Stripe::Issuing::Card)
       end
 
-      should "be able to retrieve card details" do
-        card = Stripe::Issuing::Card.retrieve("ic_123")
+      context "#details" do
+        should "retrieve a card's details" do
+          # The /details endpoint is deprecated and not in the spec so we mock
+          stub_request(:get, "#{Stripe.api_base}/v1/issuing/cards/ic_123/details")
+            .to_return(body: JSON.generate(object: "issuing.card_details"))
+
+          card_details = Stripe::Issuing::Card.details("ic_123")
+          assert_requested :get, "#{Stripe.api_base}/v1/issuing/cards/ic_123/details"
+          assert card_details.is_a?(Stripe::Issuing::CardDetails)
+        end
+      end
+
+      context ".details" do
+        should "retrieve a card's details" do
+          # The /details endpoint is deprecated and not in the spec so we mock
+          stub_request(:get, "#{Stripe.api_base}/v1/issuing/cards/ic_123/details")
+            .to_return(body: JSON.generate(object: "issuing.card_details"))
+
+          card = Stripe::Issuing::Card.construct_from(
+            id: "ic_123",
+            object: "issuing.card_details"
+          )
+          card_details = card.details
 
-        card_details = card.details
-        assert_requested :get, "#{Stripe.api_base}/v1/issuing/cards/ic_123/details"
-        assert card_details.is_a?(Stripe::Issuing::CardDetails)
+          assert_requested :get, "#{Stripe.api_base}/v1/issuing/cards/ic_123/details"
+          assert card_details.is_a?(Stripe::Issuing::CardDetails)
+        end
       end
     end
   end

data/test/stripe/issuing/cardholder_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 Issuing

data/test/stripe/issuing/dispute_test.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-require ::File.expand_path("../../../test_helper", __FILE__)
+require ::File.expand_path("../../test_helper", __dir__)
 
 module Stripe
   module Issuing
     class DisputeTest < Test::Unit::TestCase
       should "be creatable" do
-        dispute = Stripe::Issuing::Dispute.create(
-          reason: "fraudulent",
-          disputed_transaction: "ipi_123"
-        )
+        dispute = Stripe::Issuing::Dispute.create(transaction: "ipi_123")
+
         assert_requested :post, "#{Stripe.api_base}/v1/issuing/disputes"
         assert dispute.is_a?(Stripe::Issuing::Dispute)
       end
@@ -27,19 +25,30 @@ module Stripe
         assert dispute.is_a?(Stripe::Issuing::Dispute)
       end
 
-      should "be saveable" do
-        dispute = Stripe::Issuing::Dispute.retrieve("ich_123")
-        dispute.metadata["key"] = "value"
-        dispute.save
-        assert_requested :post, "#{Stripe.api_base}/v1/issuing/disputes/#{dispute.id}"
-        assert dispute.is_a?(Stripe::Issuing::Dispute)
-      end
-
       should "be updateable" do
-        dispute = Stripe::Issuing::Dispute.update("ich_123", metadata: { foo: "bar" })
+        dispute = Stripe::Issuing::Dispute.update("ich_123", {})
         assert_requested :post, "#{Stripe.api_base}/v1/issuing/disputes/ich_123"
         assert dispute.is_a?(Stripe::Issuing::Dispute)
       end
+
+      context "#submit" do
+        should "submit the dispute" do
+          dispute = Stripe::Issuing::Dispute.retrieve("idp_123")
+          dispute = dispute.submit
+          assert_requested :post,
+                           "#{Stripe.api_base}/v1/issuing/disputes/idp_123/submit"
+          assert dispute.is_a?(Stripe::Issuing::Dispute)
+        end
+      end
+
+      context ".submit" do
+        should "submit the dispute" do
+          dispute = Stripe::Issuing::Dispute.submit("idp_123")
+          assert_requested :post,
+                           "#{Stripe.api_base}/v1/issuing/disputes/idp_123/submit"
+          assert dispute.is_a?(Stripe::Issuing::Dispute)
+        end
+      end
     end
   end
 end

data/test/stripe/issuing/transaction_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 Issuing

data/test/stripe/list_object_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 ListObjectTest < Test::Unit::TestCase
@@ -25,20 +25,80 @@ module Stripe
       assert_equal expected, list.each.to_a
     end
 
-    should "provide #auto_paging_each" do
+    should "provide #reverse_each" do
       arr = [
         { id: 1 },
         { id: 2 },
         { id: 3 },
       ]
+      expected = Util.convert_to_stripe_object(arr.reverse, {})
+      list = Stripe::ListObject.construct_from(data: arr)
+      assert_equal expected, list.reverse_each.to_a
+    end
+
+    should "provide #auto_paging_each that supports forward pagination" do
+      arr = [
+        { id: 1 },
+        { id: 2 },
+        { id: 3 },
+        { id: 4 },
+        { id: 5 },
+        { id: 6 },
+      ]
       expected = Util.convert_to_stripe_object(arr, {})
 
+      # Initial list object to page on. Notably, its last data element will be
+      # used as a cursor to fetch the next page.
       list = TestListObject.construct_from(data: [{ id: 1 }],
                                            has_more: true,
                                            url: "/things")
+      list.filters = { limit: 3 }
+
+      # The test will start with the synthetic list object above, and use it as
+      # a starting point to fetch two more pages. The second page indicates
+      # that there are no more elements by setting `has_more` to `false`, and
+      # iteration stops.
       stub_request(:get, "#{Stripe.api_base}/things")
-        .with(query: { starting_after: "1" })
-        .to_return(body: JSON.generate(data: [{ id: 2 }, { id: 3 }], has_more: false))
+        .with(query: { starting_after: "1", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 2 }, { id: 3 }, { id: 4 }], has_more: true, url: "/things"))
+      stub_request(:get, "#{Stripe.api_base}/things")
+        .with(query: { starting_after: "4", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 5 }, { id: 6 }], has_more: false, url: "/things"))
+
+      assert_equal expected, list.auto_paging_each.to_a
+    end
+
+    should "provide #auto_paging_each that supports backward pagination with `ending_before`" do
+      arr = [
+        { id: 6 },
+        { id: 5 },
+        { id: 4 },
+        { id: 3 },
+        { id: 2 },
+        { id: 1 },
+      ]
+      expected = Util.convert_to_stripe_object(arr, {})
+
+      # Initial list object to page on. Notably, its first data element will be
+      # used as a cursor to fetch the next page.
+      list = TestListObject.construct_from(data: [{ id: 6 }],
+                                           has_more: true,
+                                           url: "/things")
+
+      # We also add an `ending_before` filter on the list to simulate backwards
+      # pagination.
+      list.filters = { ending_before: 7, limit: 3 }
+
+      # The test will start with the synthetic list object above, and use it as
+      # a starting point to fetch two more pages. The second page indicates
+      # that there are no more elements by setting `has_more` to `false`, and
+      # iteration stops.
+      stub_request(:get, "#{Stripe.api_base}/things")
+        .with(query: { ending_before: "6", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 3 }, { id: 4 }, { id: 5 }], has_more: true, url: "/things"))
+      stub_request(:get, "#{Stripe.api_base}/things")
+        .with(query: { ending_before: "3", limit: "3" })
+        .to_return(body: JSON.generate(data: [{ id: 1 }, { id: 2 }], has_more: false, url: "/things"))
 
       assert_equal expected, list.auto_paging_each.to_a
     end
@@ -97,7 +157,7 @@ module Stripe
         .with(query: { "expand[]" => "data.source", "limit" => "3", "starting_after" => "1" })
         .to_return(body: JSON.generate(data: [{ id: 2 }], has_more: false))
       next_list = list.next_page
-      assert_equal({ expand: ["data.source"], limit: 3 }, next_list.filters)
+      assert_equal({ expand: ["data.source"], limit: 3, starting_after: 1 }, next_list.filters)
     end
 
     should "fetch an empty page through #next_page" do
@@ -114,39 +174,25 @@ module Stripe
 
     should "fetch a next page through #previous_page" do
       list = TestListObject.construct_from(data: [{ id: 2 }],
+                                           has_more: true,
                                            url: "/things")
       stub_request(:get, "#{Stripe.api_base}/things")
         .with(query: { ending_before: "2" })
-        .to_return(body: JSON.generate(data: [{ id: 1 }]))
+        .to_return(body: JSON.generate(data: [{ id: 1 }], has_more: false))
       next_list = list.previous_page
       refute next_list.empty?
     end
 
     should "fetch a next page through #previous_page and respect limit" do
       list = TestListObject.construct_from(data: [{ id: 2 }],
+                                           has_more: true,
                                            url: "/things")
       list.filters = { expand: ["data.source"], limit: 3 }
       stub_request(:get, "#{Stripe.api_base}/things")
         .with(query: { "expand[]" => "data.source", "limit" => "3", "ending_before" => "2" })
-        .to_return(body: JSON.generate(data: [{ id: 1 }]))
+        .to_return(body: JSON.generate(data: [{ id: 1 }], has_more: false))
       next_list = list.previous_page
-      assert_equal({ expand: ["data.source"], limit: 3 }, next_list.filters)
-    end
-
-    #
-    # backward compatibility
-    #
-
-    # note that the name #all is deprecated, as is using it fetch the next page
-    # in a list
-    should "be able to retrieve full lists given a listobject" do
-      c = Stripe::Charge.all
-      assert c.is_a?(Stripe::ListObject)
-      assert_equal("/v1/charges", c.resource_url)
-      all = c.all
-      assert all.is_a?(Stripe::ListObject)
-      assert_equal("/v1/charges", all.resource_url)
-      assert all.data.is_a?(Array)
+      assert_equal({ ending_before: 2, expand: ["data.source"], limit: 3 }, next_list.filters)
     end
   end
 end

data/test/stripe/login_link_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 LoginLinkTest < Test::Unit::TestCase
@@ -12,7 +12,7 @@ module Stripe
           "data" => [],
           "has_more" => false,
           "object" => "list",
-          "url" =>  "/v1/accounts/acct_123/login_links",
+          "url" => "/v1/accounts/acct_123/login_links",
         },
       }
       @account = Stripe::Account.construct_from(account_fixture)

data/test/stripe/mandate_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class MandateTest < Test::Unit::TestCase
+    should "be retrievable" do
+      schedule = Stripe::Mandate.retrieve("mandate_123")
+      assert_requested :get,
+                       "#{Stripe.api_base}/v1/mandates/mandate_123"
+      assert schedule.is_a?(Stripe::Mandate)
+    end
+  end
+end

data/test/stripe/multipart_encoder_test.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class MultipartEncoderTest < Test::Unit::TestCase
+    should "multipart encode parameters" do
+      Tempfile.create("image.jpg") do |f|
+        f.write "file-content"
+        f.flush
+        f.rewind
+
+        encoder = MultipartEncoder.new
+        encoder.encode(
+          file: f,
+          other_param: "other-param-content"
+        )
+        encoder.close
+        body = encoder.body
+
+        assert_equal <<~BODY.rstrip, body
+          --#{encoder.boundary}\r
+          Content-Disposition: form-data; name="file"; filename="#{::File.basename(f.path)}"\r
+          Content-Type: application/octet-stream\r
+          \r
+          file-content\r
+          --#{encoder.boundary}\r
+          Content-Disposition: form-data; name="other_param"\r
+          \r
+          other-param-content\r
+          --#{encoder.boundary}--
+        BODY
+      end
+    end
+
+    should "encode file-like objects" do
+      klass = Class.new do
+        def read
+          "klass-read-content"
+        end
+      end
+
+      encoder = MultipartEncoder.new
+      encoder.encode(
+        file_like: klass.new
+      )
+      encoder.close
+      body = encoder.body
+
+      assert_equal <<~BODY.rstrip, body
+        --#{encoder.boundary}\r
+        Content-Disposition: form-data; name="file_like"; filename="blob"\r
+        Content-Type: application/octet-stream\r
+        \r
+        klass-read-content\r
+        --#{encoder.boundary}--
+      BODY
+    end
+
+    should "escape quotes and line break characters in parameter names" do
+      encoder = MultipartEncoder.new
+      encoder.encode(
+        %("quoted\n\r") => "content"
+      )
+      encoder.close
+      body = encoder.body
+
+      assert_equal <<~BODY.rstrip, body
+        --#{encoder.boundary}\r
+        Content-Disposition: form-data; name="%22quoted  %22"\r
+        \r
+        content\r
+        --#{encoder.boundary}--
+      BODY
+    end
+
+    context ".encode" do
+      should "provide an easy encoding shortcut" do
+        body, content_type = MultipartEncoder.encode(
+          param: "content"
+        )
+        assert_include body, %(Content-Disposition: form-data; name="param")
+        assert_include content_type, "#{MultipartEncoder::MULTIPART_FORM_DATA}; boundary="
+      end
+    end
+
+    context "#body" do
+      should "error if not yet closed" do
+        encoder = MultipartEncoder.new
+
+        e = assert_raises RuntimeError do
+          encoder.body
+        end
+        assert_equal "object must be closed before getting body", e.message
+      end
+    end
+
+    context "#close" do
+      should "error if closed twice" do
+        encoder = MultipartEncoder.new
+        encoder.close
+
+        e = assert_raises RuntimeError do
+          encoder.close
+        end
+        assert_equal "object already closed", e.message
+      end
+    end
+
+    context "#content_type" do
+      should "produce a content type containing boundary" do
+        encoder = MultipartEncoder.new
+        assert_equal "#{MultipartEncoder::MULTIPART_FORM_DATA}; boundary=#{encoder.boundary}",
+                     encoder.content_type
+      end
+    end
+
+    context "#encode" do
+      should "error if already closed" do
+        encoder = MultipartEncoder.new
+        encoder.close
+
+        e = assert_raises RuntimeError do
+          encoder.encode(param: "content")
+        end
+        assert_equal "no more parameters can be written to closed object", e.message
+      end
+    end
+  end
+end

data/test/stripe/oauth_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 OAuthTest < Test::Unit::TestCase
@@ -67,6 +67,22 @@ module Stripe
                            code: "this_is_an_authorization_code")
         assert_equal("sk_access_token", resp.access_token)
       end
+
+      should "override the API key when client_secret is passed" do
+        stub_request(:post, "#{Stripe.connect_base}/oauth/token")
+          .with(body: {
+            "client_secret" => "client_secret_override",
+            "grant_type" => "authorization_code",
+            "code" => "this_is_an_authorization_code",
+          })
+          .with(headers: { "Authorization": "Bearer client_secret_override" })
+          .to_return(body: JSON.generate(access_token: "another_access_token"))
+
+        resp = OAuth.token(client_secret: "client_secret_override",
+                           grant_type: "authorization_code",
+                           code: "this_is_an_authorization_code")
+        assert_equal("another_access_token", resp.access_token)
+      end
     end
 
     context ".deauthorize" do