stripe 4.24.0 → 5.0.0

data/lib/stripe/stripe_object.rb

@@ -127,18 +127,6 @@ module Stripe
         JSON.pretty_generate(@values)
     end
 
-    # Re-initializes the object based on a hash of values (usually one that's
-    # come back from an API call). Adds or removes value accessors as necessary
-    # and updates the state of internal data.
-    #
-    # Please don't use this method. If you're trying to do mass assignment, try
-    # #initialize_from instead.
-    def refresh_from(values, opts, partial = false)
-      initialize_from(values, opts, partial)
-    end
-    extend Gem::Deprecate
-    deprecate :refresh_from, "#update_attributes", 2016, 1
-
     # Mass assigns attributes on the model.
     #
     # This is a version of +update_attributes+ that takes some extra options
@@ -192,7 +180,9 @@ module Stripe
 
     def to_hash
       maybe_to_hash = lambda do |value|
-        value && value.respond_to?(:to_hash) ? value.to_hash : value
+        return nil if value.nil?
+
+        value.respond_to?(:to_hash) ? value.to_hash : value
       end
 
       @values.each_with_object({}) do |(key, value), acc|
@@ -256,6 +246,7 @@ module Stripe
         #
         unsaved = @unsaved_values.include?(k)
         next unless options[:force] || unsaved || v.is_a?(StripeObject)
+
         update_hash[k.to_sym] = serialize_params_value(
           @values[k], @original_values[k], unsaved, options[:force], key: k
         )
@@ -268,16 +259,6 @@ module Stripe
       update_hash
     end
 
-    class << self
-      # This class method has been deprecated in favor of the instance method
-      # of the same name.
-      def serialize_params(obj, options = {})
-        obj.serialize_params(options)
-      end
-      extend Gem::Deprecate
-      deprecate :serialize_params, "#serialize_params", 2016, 9
-    end
-
     # A protected field is one that doesn't get an accessor assigned to it
     # (i.e. `obj.public = ...`) and one which is not allowed to be updated via
     # the class level `Model.update(id, { ... })`.

data/lib/stripe/stripe_response.rb

@@ -4,6 +4,53 @@ module Stripe
   # StripeResponse encapsulates some vitals of a response that came back from
   # the Stripe API.
   class StripeResponse
+    # Headers provides an access wrapper to an API response's header data. It
+    # mainly exists so that we don't need to expose the entire
+    # `Net::HTTPResponse` object while still getting some of its benefits like
+    # case-insensitive access to header names and flattening of header values.
+    class Headers
+      # Initializes a Headers object from a Net::HTTP::HTTPResponse object.
+      def self.from_net_http(resp)
+        new(resp.to_hash)
+      end
+
+      # `hash` is expected to be a hash mapping header names to arrays of
+      # header values. This is the default format generated by calling
+      # `#to_hash` on a `Net::HTTPResponse` object because headers can be
+      # repeated multiple times. Using `#[]` will collapse values down to just
+      # the first.
+      def initialize(hash)
+        if !hash.is_a?(Hash) ||
+           !hash.keys.all? { |n| n.is_a?(String) } ||
+           !hash.values.all? { |a| a.is_a?(Array) } ||
+           !hash.values.all? { |a| a.all? { |v| v.is_a?(String) } }
+          raise ArgumentError,
+                "expect hash to be a map of string header names to arrays of " \
+                "header values"
+        end
+
+        @hash = {}
+
+        # This shouldn't be strictly necessary because `Net::HTTPResponse` will
+        # produce a hash with all headers downcased, but do it anyway just in
+        # case an object of this class was constructed manually.
+        #
+        # Also has the effect of duplicating the hash, which is desirable for a
+        # little extra object safety.
+        hash.each do |k, v|
+          @hash[k.downcase] = v
+        end
+      end
+
+      def [](name)
+        values = @hash[name.downcase]
+        if values && values.count > 1
+          warn("Duplicate header values for `#{name}`; returning only first")
+        end
+        values ? values.first : nil
+      end
+    end
+
     # The data contained by the HTTP body of the response deserialized from
     # JSON.
     attr_accessor :data
@@ -20,30 +67,15 @@ module Stripe
     # The Stripe request ID of the response.
     attr_accessor :request_id
 
-    # Initializes a StripeResponse object from a Hash like the kind returned as
-    # part of a Faraday exception.
-    #
-    # This may throw JSON::ParserError if the response body is not valid JSON.
-    def self.from_faraday_hash(http_resp)
-      resp = StripeResponse.new
-      resp.data = JSON.parse(http_resp[:body], symbolize_names: true)
-      resp.http_body = http_resp[:body]
-      resp.http_headers = http_resp[:headers]
-      resp.http_status = http_resp[:status]
-      resp.request_id = http_resp[:headers]["Request-Id"]
-      resp
-    end
-
-    # Initializes a StripeResponse object from a Faraday HTTP response object.
-    #
-    # This may throw JSON::ParserError if the response body is not valid JSON.
-    def self.from_faraday_response(http_resp)
+    # Initializes a StripeResponse object from a Net::HTTP::HTTPResponse
+    # object.
+    def self.from_net_http(http_resp)
       resp = StripeResponse.new
       resp.data = JSON.parse(http_resp.body, symbolize_names: true)
       resp.http_body = http_resp.body
-      resp.http_headers = http_resp.headers
-      resp.http_status = http_resp.status
-      resp.request_id = http_resp.headers["Request-Id"]
+      resp.http_headers = Headers.from_net_http(http_resp)
+      resp.http_status = http_resp.code.to_i
+      resp.request_id = http_resp["request-id"]
       resp
     end
   end

data/lib/stripe/util.rb

@@ -198,11 +198,13 @@ module Stripe
 
     def self.check_string_argument!(key)
       raise TypeError, "argument must be a string" unless key.is_a?(String)
+
       key
     end
 
     def self.check_api_key!(key)
       raise TypeError, "api_key must be a string" unless key.is_a?(String)
+
       key
     end
 
@@ -245,14 +247,14 @@ module Stripe
     #
 
     COLOR_CODES = {
-      black:   0, light_black:   60,
-      red:     1, light_red:     61,
-      green:   2, light_green:   62,
-      yellow:  3, light_yellow:  63,
-      blue:    4, light_blue:    64,
+      black: 0, light_black: 60,
+      red: 1, light_red: 61,
+      green: 2, light_green: 62,
+      yellow: 3, light_yellow: 63,
+      blue: 4, light_blue: 64,
       magenta: 5, light_magenta: 65,
-      cyan:    6, light_cyan:    66,
-      white:   7, light_white:   67,
+      cyan: 6, light_cyan: 66,
+      white: 7, light_white: 67,
       default: 9,
     }.freeze
     private_constant :COLOR_CODES
@@ -281,10 +283,7 @@ module Stripe
     end
     private_class_method :level_name
 
-    # TODO: Make these named required arguments when we drop support for Ruby
-    # 2.0.
-    def self.log_internal(message, data = {}, color: nil, level: nil,
-                          logger: nil, out: nil)
+    def self.log_internal(message, data = {}, color:, level:, logger:, out:)
       data_str = data.reject { |_k, v| v.nil? }
                      .map do |(k, v)|
         format("%<key>s=%<value>s",

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "4.24.0".freeze
+  VERSION = "5.0.0"
 end

data/lib/stripe/webhook.rb

@@ -22,7 +22,7 @@ module Stripe
     end
 
     module Signature
-      EXPECTED_SCHEME = "v1".freeze
+      EXPECTED_SCHEME = "v1"
 
       def self.compute_signature(payload, secret)
         OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("sha256"), secret, payload)

data/stripe.gemspec

@@ -7,7 +7,7 @@ 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."
@@ -17,18 +17,15 @@ Gem::Specification.new do |s|
   s.license = "MIT"
 
   s.metadata = {
-    "bug_tracker_uri"   => "https://github.com/stripe/stripe-ruby/issues",
-    "changelog_uri"     =>
+    "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",
+    "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.add_dependency("faraday", "~> 0.13")
-  s.add_dependency("net-http-persistent", "~> 3.0")
-
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n")

data/test/stripe/account_test.rb

@@ -82,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")

data/test/stripe/api_operations_test.rb

@@ -7,7 +7,7 @@ module Stripe
     class UpdateableResource < APIResource
       include Stripe::APIOperations::Save
 
-      OBJECT_NAME = "updateableresource".freeze
+      OBJECT_NAME = "updateableresource"
 
       def self.protected_fields
         [:protected]
@@ -34,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

@@ -5,7 +5,7 @@ require ::File.expand_path("../test_helper", __dir__)
 module Stripe
   class ApiResourceTest < Test::Unit::TestCase
     class CustomMethodAPIResource < APIResource
-      OBJECT_NAME = "custom_method".freeze
+      OBJECT_NAME = "custom_method"
       custom_method :my_method, http_verb: :post
     end
 
@@ -271,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" })
@@ -513,7 +505,7 @@ module Stripe
 
     context "#request_stripe_object" do
       class HelloTestAPIResource < APIResource
-        OBJECT_NAME = "hello".freeze
+        OBJECT_NAME = "hello"
         def say_hello(params = {}, opts = {})
           request_stripe_object(
             method: :post,

data/test/stripe/charge_test.rb

@@ -60,21 +60,5 @@ module Stripe
         assert charge.is_a?(Stripe::Charge)
       end
     end
-
-    context "#mark_as_fraudulent" do
-      should "charges should be able to be marked as fraudulent" do
-        charge = Stripe::Charge.retrieve("ch_123")
-        charge = charge.mark_as_fraudulent
-        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
-        assert charge.is_a?(Stripe::Charge)
-      end
-    end
   end
 end

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