stripe 3.2.0 → 5.16.0

data/test/stripe/stripe_response_test.rb

@@ -1,46 +1,95 @@
-require File.expand_path('../../test_helper', __FILE__)
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class StripeResponseTest < Test::Unit::TestCase
-    context ".from_faraday_hash" do
-      should "converts to StripeResponse" do
-        body = '{"foo": "bar"}'
+    context "Headers" do
+      should "allow case-insensitive header access" do
         headers = { "Request-Id" => "request-id" }
+        http_resp = create_net_http_resp(200, "", headers)
 
-        http_resp = {
-          body: body,
-          headers: headers,
-          status: 200,
-        }
+        headers = StripeResponse::Headers.from_net_http(http_resp)
 
-        resp = StripeResponse.from_faraday_hash(http_resp)
+        assert_equal "request-id", headers["request-id"]
+        assert_equal "request-id", headers["Request-Id"]
+        assert_equal "request-id", headers["Request-ID"]
+      end
 
-        assert_equal JSON.parse(body, symbolize_names: true), resp.data
-        assert_equal body, resp.http_body
-        assert_equal headers, resp.http_headers
-        assert_equal 200, resp.http_status
-        assert_equal "request-id", resp.request_id
+      should "initialize without error" do
+        StripeResponse::Headers.new({})
+        StripeResponse::Headers.new("Request-Id" => [])
+        StripeResponse::Headers.new("Request-Id" => ["request-id"])
+      end
+
+      should "initialize with error on a malformed hash" do
+        assert_raises(ArgumentError) do
+          StripeResponse::Headers.new(nil)
+        end
+
+        assert_raises(ArgumentError) do
+          StripeResponse::Headers.new(1 => [])
+        end
+
+        assert_raises(ArgumentError) do
+          StripeResponse::Headers.new("Request-Id" => 1)
+        end
+
+        assert_raises(ArgumentError) do
+          StripeResponse::Headers.new("Request-Id" => [1])
+        end
+      end
+
+      should "warn on duplicate header values" do
+        old_stderr = $stderr
+        $stderr = StringIO.new
+        begin
+          headers = StripeResponse::Headers.new("Duplicated" => %w[a b])
+          assert_equal "a", headers["Duplicated"]
+          assert_equal "Duplicate header values for `Duplicated`; returning only first",
+                       $stderr.string.rstrip
+        ensure
+          $stderr = old_stderr
+        end
       end
     end
 
-    context ".from_faraday_response" do
+    context ".from_net_http" do
       should "converts to StripeResponse" do
+        code = 200
         body = '{"foo": "bar"}'
         headers = { "Request-Id" => "request-id" }
+        http_resp = create_net_http_resp(code, body, headers)
 
-        env = Faraday::Env.from(
-          :status => 200, :body => body,
-          :response_headers => headers)
-        http_resp = Faraday::Response.new(env)
-
-        resp = StripeResponse.from_faraday_response(http_resp)
+        resp = StripeResponse.from_net_http(http_resp)
 
         assert_equal JSON.parse(body, symbolize_names: true), resp.data
         assert_equal body, resp.http_body
-        assert_equal headers, resp.http_headers
-        assert_equal 200, resp.http_status
+        assert_equal "request-id", resp.http_headers["Request-ID"]
+        assert_equal code, resp.http_status
         assert_equal "request-id", resp.request_id
       end
     end
+
+    # Synthesizes a `Net::HTTPResponse` object for testing purposes.
+    private def create_net_http_resp(code, body, headers)
+      # The "1.1" is HTTP version.
+      http_resp = Net::HTTPResponse.new("1.1", code.to_s, nil)
+      http_resp.body = body
+
+      # This is obviously super sketchy, but the Ruby team has done everything
+      # in their power to make these objects as difficult to test with as
+      # possible. Even if you specify a body, accessing `#body` the first time
+      # will attempt to read from a non-existent socket which will subsequently
+      # blow up. Setting this internal variable skips that read and allows the
+      # object to use the body that we specified above.
+      http_resp.instance_variable_set(:@read, true)
+
+      headers.each do |name, value|
+        http_resp[name] = value
+      end
+
+      http_resp
+    end
   end
 end

data/test/stripe/subscription_item_test.rb

@@ -1,32 +1,33 @@
-require File.expand_path('../../test_helper', __FILE__)
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class SubscriptionItemTest < Test::Unit::TestCase
     should "be listable" do
       items = Stripe::SubscriptionItem.list(
-        subscription: "sub_123",
+        subscription: "sub_123"
       )
       assert_requested :get, "#{Stripe.api_base}/v1/subscription_items",
-        query: { subscription: "sub_123" }
-      assert items.data.kind_of?(Array)
-      assert items.data[0].kind_of?(Stripe::SubscriptionItem)
+                       query: { subscription: "sub_123" }
+      assert items.data.is_a?(Array)
+      assert items.data[0].is_a?(Stripe::SubscriptionItem)
     end
 
     should "be retrievable" do
       item = Stripe::SubscriptionItem.retrieve("si_123")
       assert_requested :get, "#{Stripe.api_base}/v1/subscription_items/si_123"
-      assert item.kind_of?(Stripe::SubscriptionItem)
+      assert item.is_a?(Stripe::SubscriptionItem)
     end
 
     should "be creatable" do
       item = Stripe::SubscriptionItem.create(
-        item: 'silver',
         plan: "sapphire-elite",
         quantity: 3,
         subscription: "sub_123"
       )
       assert_requested :post, "#{Stripe.api_base}/v1/subscription_items"
-      assert item.kind_of?(Stripe::SubscriptionItem)
+      assert item.is_a?(Stripe::SubscriptionItem)
     end
 
     should "be saveable" do
@@ -37,16 +38,47 @@ module Stripe
     end
 
     should "be updateable" do
-      item = Stripe::SubscriptionItem.update("si_123", metadata: {foo: 'bar'})
+      item = Stripe::SubscriptionItem.update("si_123", metadata: { foo: "bar" })
       assert_requested :post, "#{Stripe.api_base}/v1/subscription_items/si_123"
-      assert item.kind_of?(Stripe::SubscriptionItem)
+      assert item.is_a?(Stripe::SubscriptionItem)
     end
 
-    should "be deletable" do
-      item = Stripe::SubscriptionItem.retrieve("si_123")
-      item = item.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/subscription_items/#{item.id}"
-      assert item.kind_of?(Stripe::SubscriptionItem)
+    context "#delete" do
+      should "be deletable" do
+        item = Stripe::SubscriptionItem.retrieve("si_123")
+        item = item.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/subscription_items/#{item.id}"
+        assert item.is_a?(Stripe::SubscriptionItem)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        item = Stripe::SubscriptionItem.delete("si_123")
+        assert_requested :delete, "#{Stripe.api_base}/v1/subscription_items/si_123"
+        assert item.is_a?(Stripe::SubscriptionItem)
+      end
+    end
+
+    context "#create_usage_record" do
+      should "create a usage record" do
+        Stripe::SubscriptionItem.create_usage_record(
+          "si_123",
+          quantity: 5000,
+          timestamp: Time.now.to_i,
+          action: "increment"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/subscription_items/si_123/usage_records"
+      end
+    end
+
+    context "#list_usage_record_summaries" do
+      should "list usage record summaries" do
+        Stripe::SubscriptionItem.list_usage_record_summaries(
+          "si_123"
+        )
+        assert_requested :get, "#{Stripe.api_base}/v1/subscription_items/si_123/usage_record_summaries"
+      end
     end
   end
 end

data/test/stripe/subscription_schedule_test.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class SubscriptionScheduleTest < Test::Unit::TestCase
+    should "be listable" do
+      subscriptions = Stripe::SubscriptionSchedule.list
+      assert_requested :get, "#{Stripe.api_base}/v1/subscription_schedules"
+      assert subscriptions.data.is_a?(Array)
+      assert subscriptions.data[0].is_a?(Stripe::SubscriptionSchedule)
+    end
+
+    should "be retrievable" do
+      schedule = Stripe::SubscriptionSchedule.retrieve("sub_sched_123")
+      assert_requested :get,
+                       "#{Stripe.api_base}/v1/subscription_schedules/sub_sched_123"
+      assert schedule.is_a?(Stripe::SubscriptionSchedule)
+    end
+
+    should "be creatable" do
+      schedule = Stripe::SubscriptionSchedule.create(
+        customer: "cus_123"
+      )
+      assert_requested :post, "#{Stripe.api_base}/v1/subscription_schedules"
+      assert schedule.is_a?(Stripe::SubscriptionSchedule)
+    end
+
+    should "be saveable" do
+      schedule = Stripe::SubscriptionSchedule.retrieve("sub_sched_123")
+      schedule.metadata["key"] = "value"
+      schedule.save
+      assert_requested :post,
+                       "#{Stripe.api_base}/v1/subscription_schedules/#{schedule.id}"
+    end
+
+    should "be updateable" do
+      schedule = Stripe::SubscriptionSchedule.update("sub_sched_123", metadata: { foo: "bar" })
+      assert_requested :post,
+                       "#{Stripe.api_base}/v1/subscription_schedules/sub_sched_123"
+      assert schedule.is_a?(Stripe::SubscriptionSchedule)
+    end
+
+    context "#cancel" do
+      should "cancel a subscription schedule" do
+        schedule = Stripe::SubscriptionSchedule.retrieve("sub_sched_123")
+        schedule = schedule.cancel
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/subscription_schedules/#{schedule.id}/cancel"
+        assert schedule.is_a?(Stripe::SubscriptionSchedule)
+      end
+    end
+
+    context ".cancel" do
+      should "cancel a subscription schedule" do
+        schedule = Stripe::SubscriptionSchedule.cancel("sub_sched_123")
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/subscription_schedules/sub_sched_123/cancel"
+        assert schedule.is_a?(Stripe::SubscriptionSchedule)
+      end
+    end
+
+    context "#release" do
+      should "release a subscription schedule" do
+        schedule = Stripe::SubscriptionSchedule.retrieve("sub_sched_123")
+        schedule = schedule.release
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/subscription_schedules/#{schedule.id}/release"
+        assert schedule.is_a?(Stripe::SubscriptionSchedule)
+      end
+    end
+
+    context ".release" do
+      should "release a subscription schedule" do
+        schedule = Stripe::SubscriptionSchedule.release("sub_sched_123")
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/subscription_schedules/sub_sched_123/release"
+        assert schedule.is_a?(Stripe::SubscriptionSchedule)
+      end
+    end
+  end
+end

data/test/stripe/subscription_test.rb

@@ -1,19 +1,21 @@
-require File.expand_path('../../test_helper', __FILE__)
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class SubscriptionTest < Test::Unit::TestCase
     should "be listable" do
       subscriptions = Stripe::Subscription.list
       assert_requested :get, "#{Stripe.api_base}/v1/subscriptions"
-      assert subscriptions.data.kind_of?(Array)
-      assert subscriptions.data[0].kind_of?(Stripe::Subscription)
+      assert subscriptions.data.is_a?(Array)
+      assert subscriptions.data[0].is_a?(Stripe::Subscription)
     end
 
     should "be retrievable" do
       subscription = Stripe::Subscription.retrieve("sub_123")
       assert_requested :get,
-        "#{Stripe.api_base}/v1/subscriptions/sub_123"
-      assert subscription.kind_of?(Stripe::Subscription)
+                       "#{Stripe.api_base}/v1/subscriptions/sub_123"
+      assert subscription.is_a?(Stripe::Subscription)
     end
 
     should "be creatable" do
@@ -21,37 +23,57 @@ module Stripe
         customer: "cus_123"
       )
       assert_requested :post, "#{Stripe.api_base}/v1/subscriptions"
-      assert subscription.kind_of?(Stripe::Subscription)
+      assert subscription.is_a?(Stripe::Subscription)
     end
 
     should "be saveable" do
       subscription = Stripe::Subscription.retrieve("sub_123")
-      subscription.metadata['key'] = 'value'
+      subscription.metadata["key"] = "value"
       subscription.save
       assert_requested :post,
-        "#{Stripe.api_base}/v1/subscriptions/#{subscription.id}"
+                       "#{Stripe.api_base}/v1/subscriptions/#{subscription.id}"
     end
 
     should "be updateable" do
-      subscription = Stripe::Subscription.update("sub_123", metadata: {foo: 'bar'})
+      subscription = Stripe::Subscription.update("sub_123", metadata: { foo: "bar" })
       assert_requested :post,
-        "#{Stripe.api_base}/v1/subscriptions/sub_123"
-      assert subscription.kind_of?(Stripe::Subscription)
+                       "#{Stripe.api_base}/v1/subscriptions/sub_123"
+      assert subscription.is_a?(Stripe::Subscription)
     end
 
-    should "be deletable" do
-      subscription = Stripe::Subscription.retrieve("sub_123")
-      subscription = subscription.delete
-      assert_requested :delete,
-        "#{Stripe.api_base}/v1/subscriptions/#{subscription.id}"
-      assert subscription.kind_of?(Stripe::Subscription)
+    context "#delete" do
+      should "be deletable" do
+        subscription = Stripe::Subscription.retrieve("sub_123")
+        subscription = subscription.delete
+        assert_requested :delete,
+                         "#{Stripe.api_base}/v1/subscriptions/#{subscription.id}"
+        assert subscription.is_a?(Stripe::Subscription)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        subscription = Stripe::Subscription.delete("sub_123")
+        assert_requested :delete,
+                         "#{Stripe.api_base}/v1/subscriptions/sub_123"
+        assert subscription.is_a?(Stripe::Subscription)
+      end
     end
 
     context "#delete_discount" do
       should "be able to delete a subscriptions's discount" do
         subscription = Stripe::Subscription.retrieve("sub_123")
-        subscription = subscription.delete_discount
-        assert subscription.kind_of?(Stripe::Subscription)
+        discount = subscription.delete_discount
+        assert_requested :delete, "#{Stripe.api_base}/v1/subscriptions/sub_123/discount"
+        assert discount.is_a?(Stripe::Discount)
+      end
+    end
+
+    context ".delete_discount" do
+      should "be able to delete a subscriptions's discount" do
+        discount = Stripe::Subscription.delete_discount("sub_123")
+        assert_requested :delete, "#{Stripe.api_base}/v1/subscriptions/sub_123/discount"
+        assert discount.is_a?(Stripe::Discount)
       end
     end
   end

data/test/stripe/tax_id_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class TaxIdTest < Test::Unit::TestCase
+    context "#resource_url" do
+      should "return a resource URL" do
+        tax_id = Stripe::TaxId.construct_from(
+          id: "txi_123",
+          customer: "cus_123"
+        )
+        assert_equal "/v1/customers/cus_123/tax_ids/txi_123",
+                     tax_id.resource_url
+      end
+
+      should "raise without a customer" do
+        tax_id = Stripe::TaxId.construct_from(id: "txi_123")
+        assert_raises NotImplementedError do
+          tax_id.resource_url
+        end
+      end
+    end
+
+    should "raise on #retrieve" do
+      assert_raises NotImplementedError do
+        Stripe::TaxId.retrieve("txi_123")
+      end
+    end
+  end
+end

data/test/stripe/tax_rate_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class TaxRateTest < Test::Unit::TestCase
+    should "be listable" do
+      tax_rates = Stripe::TaxRate.list
+      assert_requested :get, "#{Stripe.api_base}/v1/tax_rates"
+      assert tax_rates.data.is_a?(Array)
+      assert tax_rates.first.is_a?(Stripe::TaxRate)
+    end
+
+    should "be retrievable" do
+      tax_rate = Stripe::TaxRate.retrieve("txr_123")
+      assert_requested :get, "#{Stripe.api_base}/v1/tax_rates/txr_123"
+      assert tax_rate.is_a?(Stripe::TaxRate)
+    end
+
+    should "be creatable" do
+      tax_rate = Stripe::TaxRate.create(
+        display_name: "name",
+        inclusive: false,
+        percentage: 10.15
+      )
+      assert_requested :post, "#{Stripe.api_base}/v1/tax_rates"
+      assert tax_rate.is_a?(Stripe::TaxRate)
+    end
+
+    should "be saveable" do
+      tax_rate = Stripe::TaxRate.retrieve("txr_123")
+      tax_rate.metadata["key"] = "value"
+      tax_rate.save
+      assert_requested :post, "#{Stripe.api_base}/v1/tax_rates/#{tax_rate.id}"
+    end
+
+    should "be updateable" do
+      tax_rate = Stripe::TaxRate.update("txr_123", metadata: { key: "value" })
+      assert_requested :post, "#{Stripe.api_base}/v1/tax_rates/txr_123"
+      assert tax_rate.is_a?(Stripe::TaxRate)
+    end
+  end
+end

data/test/stripe/terminal/connection_token_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __dir__)
+
+module Stripe
+  module Terminal
+    class ConnectionTokenTest < Test::Unit::TestCase
+      should "be creatable" do
+        connection_token = Stripe::Terminal::ConnectionToken.create
+
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/connection_tokens"
+        assert connection_token.is_a?(Stripe::Terminal::ConnectionToken)
+      end
+    end
+  end
+end

data/test/stripe/terminal/location_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __dir__)
+
+module Stripe
+  module Terminal
+    class LocationTest < Test::Unit::TestCase
+      should "be creatable" do
+        location = Stripe::Terminal::Location.create(
+          address: {
+            line1: "line1",
+            country: "US",
+            postal_code: "12345",
+            city: "San Francisco",
+            state: "CA",
+          },
+          display_name: "name"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/locations"
+        assert location.is_a?(Stripe::Terminal::Location)
+      end
+
+      should "be listable" do
+        locations = Stripe::Terminal::Location.list
+        assert_requested :get, "#{Stripe.api_base}/v1/terminal/locations"
+        assert locations.data.is_a?(Array)
+        assert locations.data[0].is_a?(Stripe::Terminal::Location)
+      end
+
+      should "be retrievable" do
+        location = Stripe::Terminal::Location.retrieve("loc_123")
+        assert_requested :get, "#{Stripe.api_base}/v1/terminal/locations/loc_123"
+        assert location.is_a?(Stripe::Terminal::Location)
+      end
+
+      should "be saveable" do
+        location = Stripe::Terminal::Location.retrieve("loc_123")
+        location["display_name"] = "new name"
+        location.save
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/locations/loc_123"
+        assert location.is_a?(Stripe::Terminal::Location)
+      end
+
+      should "be updateable" do
+        location = Stripe::Terminal::Location.update("loc_123", display_name: "new name")
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/locations/loc_123"
+        assert location.is_a?(Stripe::Terminal::Location)
+      end
+
+      context "#delete" do
+        should "be deletable" do
+          location = Stripe::Terminal::Location.retrieve("loc_123")
+          location = location.delete
+          assert_requested :delete, "#{Stripe.api_base}/v1/terminal/locations/#{location.id}"
+          assert location.is_a?(Stripe::Terminal::Location)
+        end
+      end
+
+      context ".delete" do
+        should "be deletable" do
+          location = Stripe::Terminal::Location.delete("loc_123")
+          assert_requested :delete, "#{Stripe.api_base}/v1/terminal/locations/loc_123"
+          assert location.is_a?(Stripe::Terminal::Location)
+        end
+      end
+    end
+  end
+end

data/test/stripe/terminal/reader_test.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __dir__)
+
+module Stripe
+  module Terminal
+    class ReaderTest < Test::Unit::TestCase
+      should "be creatable" do
+        reader = Stripe::Terminal::Reader.create(
+          registration_code: "elegant-orange-aqua",
+          label: "label"
+        )
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/readers"
+        assert reader.is_a?(Stripe::Terminal::Reader)
+      end
+
+      should "be listable" do
+        readers = Stripe::Terminal::Reader.list
+        assert_requested :get, "#{Stripe.api_base}/v1/terminal/readers"
+        assert readers.data.is_a?(Array)
+        assert readers.data[0].is_a?(Stripe::Terminal::Reader)
+      end
+
+      should "be retrievable" do
+        reader = Stripe::Terminal::Reader.retrieve("rdr_123")
+        assert_requested :get, "#{Stripe.api_base}/v1/terminal/readers/rdr_123"
+        assert reader.is_a?(Stripe::Terminal::Reader)
+      end
+
+      should "be saveable" do
+        reader = Stripe::Terminal::Reader.retrieve("rdr_123")
+        reader["label"] = "new label"
+        reader.save
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/readers/rdr_123"
+        assert reader.is_a?(Stripe::Terminal::Reader)
+      end
+
+      should "be updateable" do
+        reader = Stripe::Terminal::Reader.update("rdr_123", label: "new label")
+        assert_requested :post, "#{Stripe.api_base}/v1/terminal/readers/rdr_123"
+        assert reader.is_a?(Stripe::Terminal::Reader)
+      end
+
+      context "#delete" do
+        should "be deletable" do
+          reader = Stripe::Terminal::Reader.retrieve("rdr_123")
+          reader = reader.delete
+          assert_requested :delete, "#{Stripe.api_base}/v1/terminal/readers/#{reader.id}"
+          assert reader.is_a?(Stripe::Terminal::Reader)
+        end
+      end
+
+      context ".delete" do
+        should "be deletable" do
+          reader = Stripe::Terminal::Reader.delete("rdr_123")
+          assert_requested :delete, "#{Stripe.api_base}/v1/terminal/readers/rdr_123"
+          assert reader.is_a?(Stripe::Terminal::Reader)
+        end
+      end
+    end
+  end
+end

data/test/stripe/three_d_secure_test.rb

@@ -1,11 +1,13 @@
-require File.expand_path('../../test_helper', __FILE__)
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class ThreeDSecureTest < Test::Unit::TestCase
     should "be retrievable" do
       secure = Stripe::ThreeDSecure.retrieve("tdsrc_123")
       assert_requested :get, "#{Stripe.api_base}/v1/3d_secure/tdsrc_123"
-      assert secure.kind_of?(Stripe::ThreeDSecure)
+      assert secure.is_a?(Stripe::ThreeDSecure)
     end
 
     should "be creatable" do