stripe 4.9.0 → 5.28.0

data/test/stripe/stripe_configuration_test.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class StripeConfigurationTest < Test::Unit::TestCase
+    context ".setup" do
+      should "initialize a new configuration with defaults" do
+        config = Stripe::StripeConfiguration.setup
+
+        assert_equal Stripe::DEFAULT_CA_BUNDLE_PATH, config.ca_bundle_path
+        assert_equal true, config.enable_telemetry
+        assert_equal true, config.verify_ssl_certs
+        assert_equal 2, config.max_network_retry_delay
+        assert_equal 0.5, config.initial_network_retry_delay
+        assert_equal 0, config.max_network_retries
+        assert_equal 30, config.open_timeout
+        assert_equal 80, config.read_timeout
+        assert_equal 30, config.write_timeout
+        assert_equal "https://api.stripe.com", config.api_base
+        assert_equal "https://connect.stripe.com", config.connect_base
+        assert_equal "https://files.stripe.com", config.uploads_base
+      end
+
+      should "allow for overrides when a block is passed" do
+        config = Stripe::StripeConfiguration.setup do |c|
+          c.open_timeout = 100
+          c.read_timeout = 100
+          c.write_timeout = 100 if WRITE_TIMEOUT_SUPPORTED
+        end
+
+        assert_equal 100, config.open_timeout
+        assert_equal 100, config.read_timeout
+        assert_equal 100, config.write_timeout if WRITE_TIMEOUT_SUPPORTED
+      end
+    end
+
+    context "#reverse_duplicate_merge" do
+      should "return a duplicate object with overrides" do
+        config = Stripe::StripeConfiguration.setup do |c|
+          c.open_timeout = 100
+        end
+
+        duped_config = config.reverse_duplicate_merge(read_timeout: 500)
+
+        assert_equal config.open_timeout, duped_config.open_timeout
+        assert_equal 500, duped_config.read_timeout
+      end
+    end
+
+    context "#max_network_retries=" do
+      should "coerce the option into an integer" do
+        config = Stripe::StripeConfiguration.setup
+
+        config.max_network_retries = "10"
+        assert_equal 10, config.max_network_retries
+      end
+    end
+
+    context "#log_level=" do
+      should "be backwards compatible with old values" do
+        config = Stripe::StripeConfiguration.setup
+
+        config.log_level = "debug"
+        assert_equal Stripe::LEVEL_DEBUG, config.log_level
+
+        config.log_level = "info"
+        assert_equal Stripe::LEVEL_INFO, config.log_level
+      end
+
+      should "raise an error if the value isn't valid" do
+        config = Stripe::StripeConfiguration.setup
+
+        assert_raises ArgumentError do
+          config.log_level = "Foo"
+        end
+      end
+    end
+
+    context "options that require all connection managers to be cleared" do
+      should "clear when setting allow ca_bundle_path" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.ca_bundle_path = "/path/to/ca/bundle"
+      end
+
+      should "clear when setting open timeout" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.open_timeout = 10
+      end
+
+      should "clear when setting read timeout" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.read_timeout = 10
+      end
+
+      should "clear when setting uploads_base" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.uploads_base = "https://other.stripe.com"
+      end
+
+      should "clearn when setting api_base to be configured" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.api_base = "https://other.stripe.com"
+      end
+
+      should "clear when setting connect_base" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.connect_base = "https://other.stripe.com"
+      end
+
+      should "clear when setting verify_ssl_certs" do
+        config = Stripe::StripeConfiguration.setup
+
+        StripeClient.expects(:clear_all_connection_managers)
+        config.verify_ssl_certs = false
+      end
+    end
+  end
+end

data/test/stripe/stripe_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 StripeObjectTest < Test::Unit::TestCase
@@ -52,9 +52,9 @@ module Stripe
             2,
           ],
           map: {
-            :"0" => StripeObject.construct_from({ id: "index0" }, opts),
-            :"1" => "index1",
-            :"2" => 2,
+            "0": StripeObject.construct_from({ id: "index0" }, opts),
+            "1": "index1",
+            "2": 2,
           },
         }
 
@@ -212,43 +212,32 @@ module Stripe
 
     should "mass assign values with #update_attributes" do
       obj = Stripe::StripeObject.construct_from(id: 1, name: "Stripe")
-      obj.update_attributes(name: "STRIPE")
+
+      obj.update_attributes({ name: "STRIPE" })
+
       assert_equal "STRIPE", obj.name
 
       # unfortunately, we even assign unknown properties to duplicate the
       # behavior that we currently have via magic accessors with
       # method_missing
-      obj.update_attributes(unknown: "foo")
+      obj.update_attributes({ unknown: "foo" })
+
       assert_equal "foo", obj.unknown
     end
 
     should "#update_attributes with a hash" do
       obj = Stripe::StripeObject.construct_from({})
-      obj.update_attributes(metadata: { foo: "bar" })
+      obj.update_attributes({ metadata: { foo: "bar" } })
       assert_equal Stripe::StripeObject, obj.metadata.class
     end
 
     should "create accessors when #update_attributes is called" do
       obj = Stripe::StripeObject.construct_from({})
       assert_equal false, obj.send(:metaclass).method_defined?(:foo)
-      obj.update_attributes(foo: "bar")
+      obj.update_attributes({ foo: "bar" })
       assert_equal true, obj.send(:metaclass).method_defined?(:foo)
     end
 
-    should "warn that #refresh_from is deprecated" do
-      old_stderr = $stderr
-      $stderr = StringIO.new
-      begin
-        obj = Stripe::StripeObject.construct_from({})
-        obj.refresh_from({}, {})
-        message = "NOTE: Stripe::StripeObject#refresh_from is " \
-                  "deprecated; use #update_attributes instead"
-        assert_match Regexp.new(message), $stderr.string
-      ensure
-        $stderr = old_stderr
-      end
-    end
-
     should "pass opts down to children when initializing" do
       opts = { custom: "opts" }
 
@@ -282,7 +271,7 @@ module Stripe
 
     should "#serialize_params on a basic object" do
       obj = Stripe::StripeObject.construct_from(foo: nil)
-      obj.update_attributes(foo: "bar")
+      obj.update_attributes({ foo: "bar" })
       assert_equal({ foo: "bar" }, obj.serialize_params)
     end
 
@@ -302,14 +291,14 @@ module Stripe
     end
 
     should "#serialize_params on an array that shortens" do
-      obj = Stripe::StripeObject.construct_from(foo: ["0-index", "1-index", "2-index"])
+      obj = Stripe::StripeObject.construct_from(foo: %w[0-index 1-index 2-index])
       obj.foo = ["new-value"]
       assert_equal({ foo: ["new-value"] },
                    obj.serialize_params)
     end
 
     should "#serialize_params on an array that lengthens" do
-      obj = Stripe::StripeObject.construct_from(foo: ["0-index", "1-index", "2-index"])
+      obj = Stripe::StripeObject.construct_from(foo: %w[0-index 1-index 2-index])
       obj.foo = ["new-value"] * 4
       assert_equal({ foo: ["new-value"] * 4 },
                    obj.serialize_params)
@@ -331,8 +320,8 @@ module Stripe
     end
 
     should "#serialize_params on an array that is unchanged" do
-      obj = Stripe::StripeObject.construct_from(foo: ["0-index", "1-index", "2-index"])
-      obj.foo = ["0-index", "1-index", "2-index"]
+      obj = Stripe::StripeObject.construct_from(foo: %w[0-index 1-index 2-index])
+      obj.foo = %w[0-index 1-index 2-index]
       assert_equal({}, obj.serialize_params)
     end
 
@@ -475,20 +464,6 @@ module Stripe
       assert_equal(expected, obj.to_s)
     end
 
-    should "warn that .serialize_params is deprecated" do
-      old_stderr = $stderr
-      $stderr = StringIO.new
-      begin
-        obj = Stripe::StripeObject.construct_from({})
-        Stripe::StripeObject.serialize_params(obj)
-        message = "NOTE: Stripe::StripeObject.serialize_params is " \
-                  "deprecated; use #serialize_params instead"
-        assert_match Regexp.new(message), $stderr.string
-      ensure
-        $stderr = old_stderr
-      end
-    end
-
     should "error on setting a property to an empty string" do
       obj = Stripe::StripeObject.construct_from(foo: "bar")
       e = assert_raises ArgumentError do

data/test/stripe/stripe_response_test.rb

@@ -1,49 +1,95 @@
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+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,6 +1,6 @@
 # frozen_string_literal: true
 
-require ::File.expand_path("../../test_helper", __FILE__)
+require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class SubscriptionItemTest < Test::Unit::TestCase
@@ -22,7 +22,7 @@ module Stripe
 
     should "be creatable" do
       item = Stripe::SubscriptionItem.create(
-        plan: "sapphire-elite",
+        price: "sapphire-elite",
         quantity: 3,
         subscription: "sub_123"
       )
@@ -43,11 +43,42 @@ module Stripe
       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.is_a?(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

@@ -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 SubscriptionScheduleTest < Test::Unit::TestCase
@@ -51,6 +51,15 @@ module Stripe
       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")
@@ -60,5 +69,14 @@ module Stripe
         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