stripe 4.20.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

@@ -43,6 +43,10 @@ module Stripe
       @object_classes ||= Stripe::ObjectTypes.object_names_to_classes
     end
 
+    def self.object_name_matches_class?(object_name, klass)
+      Util.object_classes[object_name] == klass
+    end
+
     # Converts a hash of fields or an array of hashes into a +StripeObject+ or
     # array of +StripeObject+s. These new objects will be created as a concrete
     # type as dictated by their `object` field (e.g. an `object` value of
@@ -194,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
 
@@ -241,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
@@ -277,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.20.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/lib/stripe.rb

@@ -3,9 +3,9 @@
 # Stripe Ruby bindings
 # API spec at https://stripe.com/docs/api
 require "cgi"
-require "faraday"
 require "json"
 require "logger"
+require "net/http"
 require "openssl"
 require "rbconfig"
 require "securerandom"
@@ -28,10 +28,13 @@ require "stripe/api_operations/save"
 require "stripe/errors"
 require "stripe/object_types"
 require "stripe/util"
+require "stripe/connection_manager"
+require "stripe/multipart_encoder"
 require "stripe/stripe_client"
 require "stripe/stripe_object"
 require "stripe/stripe_response"
 require "stripe/list_object"
+require "stripe/error_object"
 require "stripe/api_resource"
 require "stripe/singleton_api_resource"
 require "stripe/webhook"
@@ -70,9 +73,20 @@ module Stripe
   @enable_telemetry = true
 
   class << self
-    attr_accessor :stripe_account, :api_key, :api_base, :verify_ssl_certs,
-                  :api_version, :client_id, :connect_base, :uploads_base,
-                  :open_timeout, :read_timeout, :proxy
+    attr_accessor :api_key
+    attr_accessor :api_version
+    attr_accessor :client_id
+    attr_accessor :stripe_account
+
+    # These all get manual attribute writers so that we can reset connections
+    # if they change.
+    attr_reader :api_base
+    attr_reader :connect_base
+    attr_reader :open_timeout
+    attr_reader :proxy
+    attr_reader :read_timeout
+    attr_reader :uploads_base
+    attr_reader :verify_ssl_certs
 
     attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
@@ -87,6 +101,11 @@ module Stripe
     @app_info = info
   end
 
+  def self.api_base=(api_base)
+    @api_base = api_base
+    StripeClient.clear_all_connection_managers
+  end
+
   # The location of a file containing a bundle of CA certificates. By default
   # the library will use an included bundle that can successfully validate
   # Stripe certificates.
@@ -99,6 +118,8 @@ module Stripe
 
     # empty this field so a new store is initialized
     @ca_store = nil
+
+    StripeClient.clear_all_connection_managers
   end
 
   # A certificate store initialized from the the bundle in #ca_bundle_path and
@@ -118,6 +139,19 @@ module Stripe
     end
   end
 
+  def self.connection_base=(connection_base)
+    @connection_base = connection_base
+    StripeClient.clear_all_connection_managers
+  end
+
+  def self.enable_telemetry?
+    @enable_telemetry
+  end
+
+  def self.enable_telemetry=(val)
+    @enable_telemetry = val
+  end
+
   # map to the same values as the standard library's logger
   LEVEL_DEBUG = Logger::DEBUG
   LEVEL_ERROR = Logger::ERROR
@@ -172,12 +206,19 @@ module Stripe
     @max_network_retries = val.to_i
   end
 
-  def self.enable_telemetry?
-    @enable_telemetry
+  def self.open_timeout=(open_timeout)
+    @open_timeout = open_timeout
+    StripeClient.clear_all_connection_managers
   end
 
-  def self.enable_telemetry=(val)
-    @enable_telemetry = val
+  def self.proxy=(proxy)
+    @proxy = proxy
+    StripeClient.clear_all_connection_managers
+  end
+
+  def self.read_timeout=(read_timeout)
+    @read_timeout = read_timeout
+    StripeClient.clear_all_connection_managers
   end
 
   # Sets some basic information about the running application that's sent along
@@ -194,14 +235,14 @@ module Stripe
     }
   end
 
-  # DEPRECATED. Use `Util#encode_parameters` instead.
-  def self.uri_encode(params)
-    Util.encode_parameters(params)
+  def self.uploads_base=(uploads_base)
+    @uploads_base = uploads_base
+    StripeClient.clear_all_connection_managers
   end
-  private_class_method :uri_encode
-  class << self
-    extend Gem::Deprecate
-    deprecate :uri_encode, "Stripe::Util#encode_parameters", 2016, 1
+
+  def self.verify_ssl_certs=(verify_ssl_certs)
+    @verify_ssl_certs = verify_ssl_certs
+    StripeClient.clear_all_connection_managers
   end
 end
 

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."
@@ -16,8 +16,15 @@ Gem::Specification.new do |s|
   s.homepage = "https://stripe.com/docs/api/ruby"
   s.license = "MIT"
 
-  s.add_dependency("faraday", "~> 0.13")
-  s.add_dependency("net-http-persistent", "~> 3.0")
+  s.metadata = {
+    "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",
+  }
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.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

@@ -4,10 +4,31 @@ require ::File.expand_path("../test_helper", __dir__)
 
 module Stripe
   class ApiResourceTest < Test::Unit::TestCase
+    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")
@@ -250,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" })
@@ -490,6 +503,83 @@ module Stripe
       end
     end
 
+    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?

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/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