stripe 4.24.0 → 5.36.0

data/Rakefile

@@ -13,7 +13,8 @@ RuboCop::RakeTask.new
 
 desc "Update bundled certs"
 task :update_certs do
-  require "faraday"
+  require "net/http"
+  require "uri"
 
   fetch_file "https://curl.haxx.se/ca/cacert.pem",
              ::File.expand_path("../lib/data/ca-certificates.crt", __FILE__)
@@ -23,14 +24,14 @@ end
 # helpers
 #
 
-def fetch_file(url, dest)
+def fetch_file(uri, dest)
   ::File.open(dest, "w") do |file|
-    resp = Faraday.get(url)
-    unless resp.status == 200
-      abort("bad response when fetching: #{url}\n" \
-        "Status #{resp.status}: #{resp.body}")
+    resp = Net::HTTP.get_response(URI.parse(uri))
+    unless resp.code.to_i == 200
+      abort("bad response when fetching: #{uri}\n" \
+        "Status #{resp.code}: #{resp.body}")
     end
     file.write(resp.body)
-    puts "Successfully fetched: #{url}"
+    puts "Successfully fetched: #{uri}"
   end
 end

data/VERSION

@@ -1 +1 @@
-4.24.0
+5.36.0

data/lib/stripe.rb

@@ -3,15 +3,16 @@
 # 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"
 require "set"
 require "socket"
 require "uri"
+require "forwardable"
 
 # Version
 require "stripe/version"
@@ -28,13 +29,17 @@ 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"
+require "stripe/stripe_configuration"
 
 # Named API resources
 require "stripe/resources"
@@ -45,36 +50,43 @@ require "stripe/oauth"
 module Stripe
   DEFAULT_CA_BUNDLE_PATH = __dir__ + "/data/ca-certificates.crt"
 
-  @app_info = nil
-
-  @api_base = "https://api.stripe.com"
-  @connect_base = "https://connect.stripe.com"
-  @uploads_base = "https://files.stripe.com"
-
-  @log_level = nil
-  @logger = nil
-
-  @proxy = nil
-
-  @max_network_retries = 0
-  @max_network_retry_delay = 2
-  @initial_network_retry_delay = 0.5
-
-  @ca_bundle_path = DEFAULT_CA_BUNDLE_PATH
-  @ca_store = nil
-  @verify_ssl_certs = true
+  # map to the same values as the standard library's logger
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
 
-  @open_timeout = 30
-  @read_timeout = 80
+  @app_info = nil
 
-  @enable_telemetry = true
+  @config = Stripe::StripeConfiguration.setup
 
   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_reader :max_network_retry_delay, :initial_network_retry_delay
+    extend Forwardable
+
+    attr_reader :config
+
+    # User configurable options
+    def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :api_version, :api_version=
+    def_delegators :@config, :stripe_account, :stripe_account=
+    def_delegators :@config, :api_base, :api_base=
+    def_delegators :@config, :uploads_base, :uploads_base=
+    def_delegators :@config, :connect_base, :connect_base=
+    def_delegators :@config, :open_timeout, :open_timeout=
+    def_delegators :@config, :read_timeout, :read_timeout=
+    def_delegators :@config, :write_timeout, :write_timeout=
+    def_delegators :@config, :proxy, :proxy=
+    def_delegators :@config, :verify_ssl_certs, :verify_ssl_certs=
+    def_delegators :@config, :ca_bundle_path, :ca_bundle_path=
+    def_delegators :@config, :log_level, :log_level=
+    def_delegators :@config, :logger, :logger=
+    def_delegators :@config, :max_network_retries, :max_network_retries=
+    def_delegators :@config, :enable_telemetry=, :enable_telemetry?
+    def_delegators :@config, :client_id=, :client_id
+
+    # Internal configurations
+    def_delegators :@config, :max_network_retry_delay
+    def_delegators :@config, :initial_network_retry_delay
+    def_delegators :@config, :ca_store
   end
 
   # Gets the application for a plugin that's identified some. See
@@ -87,99 +99,6 @@ module Stripe
     @app_info = info
   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.
-  def self.ca_bundle_path
-    @ca_bundle_path
-  end
-
-  def self.ca_bundle_path=(path)
-    @ca_bundle_path = path
-
-    # empty this field so a new store is initialized
-    @ca_store = nil
-  end
-
-  # A certificate store initialized from the the bundle in #ca_bundle_path and
-  # which is used to validate TLS on every request.
-  #
-  # This was added to the give the gem "pseudo thread safety" in that it seems
-  # when initiating many parallel requests marshaling the certificate store is
-  # the most likely point of failure (see issue #382). Any program attempting
-  # to leverage this pseudo safety should make a call to this method (i.e.
-  # `Stripe.ca_store`) in their initialization code because it marshals lazily
-  # and is itself not thread safe.
-  def self.ca_store
-    @ca_store ||= begin
-      store = OpenSSL::X509::Store.new
-      store.add_file(ca_bundle_path)
-      store
-    end
-  end
-
-  # map to the same values as the standard library's logger
-  LEVEL_DEBUG = Logger::DEBUG
-  LEVEL_ERROR = Logger::ERROR
-  LEVEL_INFO = Logger::INFO
-
-  # When set prompts the library to log some extra information to $stdout and
-  # $stderr about what it's doing. For example, it'll produce information about
-  # requests, responses, and errors that are received. Valid log levels are
-  # `debug` and `info`, with `debug` being a little more verbose in places.
-  #
-  # Use of this configuration is only useful when `.logger` is _not_ set. When
-  # it is, the decision what levels to print is entirely deferred to the logger.
-  def self.log_level
-    @log_level
-  end
-
-  def self.log_level=(val)
-    # Backwards compatibility for values that we briefly allowed
-    if val == "debug"
-      val = LEVEL_DEBUG
-    elsif val == "info"
-      val = LEVEL_INFO
-    end
-
-    if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
-      raise ArgumentError,
-            "log_level should only be set to `nil`, `debug` or `info`"
-    end
-    @log_level = val
-  end
-
-  # Sets a logger to which logging output will be sent. The logger should
-  # support the same interface as the `Logger` class that's part of Ruby's
-  # standard library (hint, anything in `Rails.logger` will likely be
-  # suitable).
-  #
-  # If `.logger` is set, the value of `.log_level` is ignored. The decision on
-  # what levels to print is entirely deferred to the logger.
-  def self.logger
-    @logger
-  end
-
-  def self.logger=(val)
-    @logger = val
-  end
-
-  def self.max_network_retries
-    @max_network_retries
-  end
-
-  def self.max_network_retries=(val)
-    @max_network_retries = val.to_i
-  end
-
-  def self.enable_telemetry?
-    @enable_telemetry
-  end
-
-  def self.enable_telemetry=(val)
-    @enable_telemetry = val
-  end
-
   # Sets some basic information about the running application that's sent along
   # with API requests. Useful for plugin authors to identify their plugin when
   # communicating with Stripe.
@@ -193,16 +112,6 @@ module Stripe
       version: version,
     }
   end
-
-  # DEPRECATED. Use `Util#encode_parameters` instead.
-  def self.uri_encode(params)
-    Util.encode_parameters(params)
-  end
-  private_class_method :uri_encode
-  class << self
-    extend Gem::Deprecate
-    deprecate :uri_encode, "Stripe::Util#encode_parameters", 2016, 1
-  end
 end
 
 Stripe.log_level = ENV["STRIPE_LOG"] unless ENV["STRIPE_LOG"].nil?

data/lib/stripe/api_operations/create.rb

@@ -4,7 +4,7 @@ module Stripe
   module APIOperations
     module Create
       def create(params = {}, opts = {})
-        resp, opts = request(:post, resource_url, params, opts)
+        resp, opts = execute_resource_request(:post, resource_url, params, opts)
         Util.convert_to_stripe_object(resp.data, opts)
       end
     end

data/lib/stripe/api_operations/delete.rb

@@ -15,15 +15,19 @@ module Stripe
         # * +opts+ - A Hash of additional options (separate from the params /
         #   object values) to be added to the request. E.g. to allow for an
         #   idempotency_key to be passed in the request headers, or for the
-        #   api_key to be overwritten. See {APIOperations::Request.request}.
+        #   api_key to be overwritten. See
+        #   {APIOperations::Request.execute_resource_request}.
         def delete(id, params = {}, opts = {})
-          resp, opts = request(:delete, "#{resource_url}/#{id}", params, opts)
+          resp, opts = execute_resource_request(:delete,
+                                                "#{resource_url}/#{id}",
+                                                params, opts)
           Util.convert_to_stripe_object(resp.data, opts)
         end
       end
 
       def delete(params = {}, opts = {})
-        resp, opts = request(:delete, resource_url, params, opts)
+        resp, opts = execute_resource_request(:delete, resource_url,
+                                              params, opts)
         initialize_from(resp.data, opts)
       end
 

data/lib/stripe/api_operations/list.rb

@@ -6,25 +6,14 @@ module Stripe
       def list(filters = {}, opts = {})
         opts = Util.normalize_opts(opts)
 
-        resp, opts = request(:get, resource_url, filters, opts)
+        resp, opts = execute_resource_request(:get, resource_url, filters, opts)
         obj = ListObject.construct_from(resp.data, opts)
 
         # set filters so that we can fetch the same limit, expansions, and
         # predicates when accessing the next and previous pages
-        #
-        # just for general cleanliness, remove any paging options
         obj.filters = filters.dup
-        obj.filters.delete(:ending_before)
-        obj.filters.delete(:starting_after)
-
         obj
       end
-
-      # The original version of #list was given the somewhat unfortunate name of
-      # #all, and this alias allows us to maintain backward compatibility (the
-      # choice was somewhat misleading in the way that it only returned a single
-      # page rather than all objects).
-      alias all list
     end
   end
 end

data/lib/stripe/api_operations/nested_resource.rb

@@ -6,7 +6,7 @@ module Stripe
     # that it's possible to do so from a static context (i.e. without a
     # pre-existing collection of subresources on the parent).
     #
-    # For examle, a transfer gains the static methods for reversals so that the
+    # For example, a transfer gains the static methods for reversals so that the
     # methods `.create_reversal`, `.retrieve_reversal`, `.update_reversal`,
     # etc. all become available.
     module NestedResource
@@ -14,9 +14,11 @@ module Stripe
                                         resource_plural: nil)
         resource_plural ||= "#{resource}s"
         path ||= resource_plural
+
         raise ArgumentError, "operations array required" if operations.nil?
 
         resource_url_method = :"#{resource}s_url"
+
         define_singleton_method(resource_url_method) do |id, nested_id = nil|
           url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(path)}"
           url += "/#{CGI.escape(nested_id)}" unless nested_id.nil?
@@ -27,39 +29,40 @@ module Stripe
           case operation
           when :create
             define_singleton_method(:"create_#{resource}") \
-                do |id, params = {}, opts = {}|
-              url = send(resource_url_method, id)
-              resp, opts = request(:post, url, params, opts)
-              Util.convert_to_stripe_object(resp.data, opts)
-            end
+              do |id, params = {}, opts = {}|
+                url = send(resource_url_method, id)
+                resp, opts = execute_resource_request(:post, url, params, opts)
+                Util.convert_to_stripe_object(resp.data, opts)
+              end
           when :retrieve
             define_singleton_method(:"retrieve_#{resource}") \
-                do |id, nested_id, opts = {}|
-              url = send(resource_url_method, id, nested_id)
-              resp, opts = request(:get, url, {}, opts)
-              Util.convert_to_stripe_object(resp.data, opts)
-            end
+              do |id, nested_id, opts = {}|
+                url = send(resource_url_method, id, nested_id)
+                resp, opts = execute_resource_request(:get, url, {}, opts)
+                Util.convert_to_stripe_object(resp.data, opts)
+              end
           when :update
             define_singleton_method(:"update_#{resource}") \
-                do |id, nested_id, params = {}, opts = {}|
-              url = send(resource_url_method, id, nested_id)
-              resp, opts = request(:post, url, params, opts)
-              Util.convert_to_stripe_object(resp.data, opts)
-            end
+              do |id, nested_id, params = {}, opts = {}|
+                url = send(resource_url_method, id, nested_id)
+                resp, opts = execute_resource_request(:post, url, params, opts)
+                Util.convert_to_stripe_object(resp.data, opts)
+              end
           when :delete
             define_singleton_method(:"delete_#{resource}") \
-                do |id, nested_id, params = {}, opts = {}|
-              url = send(resource_url_method, id, nested_id)
-              resp, opts = request(:delete, url, params, opts)
-              Util.convert_to_stripe_object(resp.data, opts)
-            end
+              do |id, nested_id, params = {}, opts = {}|
+                url = send(resource_url_method, id, nested_id)
+                resp, opts = execute_resource_request(:delete, url, params,
+                                                      opts)
+                Util.convert_to_stripe_object(resp.data, opts)
+              end
           when :list
             define_singleton_method(:"list_#{resource_plural}") \
-                do |id, params = {}, opts = {}|
-              url = send(resource_url_method, id)
-              resp, opts = request(:get, url, params, opts)
-              Util.convert_to_stripe_object(resp.data, opts)
-            end
+              do |id, params = {}, opts = {}|
+                url = send(resource_url_method, id)
+                resp, opts = execute_resource_request(:get, url, params, opts)
+                Util.convert_to_stripe_object(resp.data, opts)
+              end
           else
             raise ArgumentError, "Unknown operation: #{operation.inspect}"
           end

data/lib/stripe/api_operations/request.rb

@@ -4,10 +4,38 @@ module Stripe
   module APIOperations
     module Request
       module ClassMethods
-        def request(method, url, params = {}, opts = {})
+        def execute_resource_request(method, url,
+                                     params = {}, opts = {})
+          execute_resource_request_internal(
+            :execute_request, method, url, params, opts
+          )
+        end
+
+        def execute_resource_request_stream(method, url,
+                                            params = {}, opts = {},
+                                            &read_body_chunk_block)
+          execute_resource_request_internal(
+            :execute_request_stream,
+            method,
+            url,
+            params,
+            opts,
+            &read_body_chunk_block
+          )
+        end
+
+        private def execute_resource_request_internal(client_request_method_sym,
+                                                      method, url,
+                                                      params, opts,
+                                                      &read_body_chunk_block)
+          params ||= {}
+
+          error_on_invalid_params(params)
           warn_on_opts_in_params(params)
 
           opts = Util.normalize_opts(opts)
+          error_on_non_string_user_opts(opts)
+
           opts[:client] ||= StripeClient.active_client
 
           headers = opts.clone
@@ -16,10 +44,12 @@ module Stripe
           client = headers.delete(:client)
           # Assume all remaining opts must be headers
 
-          resp, opts[:api_key] = client.execute_request(
+          resp, opts[:api_key] = client.send(
+            client_request_method_sym,
             method, url,
             api_base: api_base, api_key: api_key,
-            headers: headers, params: params
+            headers: headers, params: params,
+            &read_body_chunk_block
           )
 
           # Hash#select returns an array before 1.9
@@ -31,10 +61,43 @@ module Stripe
           [resp, opts_to_persist]
         end
 
+        # This method used to be called `request`, but it's such a short name
+        # that it eventually conflicted with the name of a field on an API
+        # resource (specifically, `Event#request`), so it was renamed to
+        # something more unique.
+        #
+        # The former name had been around for just about forever though, and
+        # although all internal uses have been renamed, I've left this alias in
+        # place for backwards compatibility. Consider removing it on the next
+        # major.
+        alias request execute_resource_request
+
+        private def error_on_non_string_user_opts(opts)
+          Util::OPTS_USER_SPECIFIED.each do |opt|
+            next unless opts.key?(opt)
+
+            val = opts[opt]
+            next if val.nil?
+            next if val.is_a?(String)
+
+            raise ArgumentError,
+                  "request option '#{opt}' should be a string value " \
+                    "(was a #{val.class})"
+          end
+        end
+
+        private def error_on_invalid_params(params)
+          return if params.nil? || params.is_a?(Hash)
+
+          raise ArgumentError,
+                "request params should be either a Hash or nil " \
+                  "(was a #{params.class})"
+        end
+
         private def warn_on_opts_in_params(params)
           Util::OPTS_USER_SPECIFIED.each do |opt|
             if params.key?(opt)
-              warn("WARNING: #{opt} should be in opts instead of params.")
+              warn("WARNING: '#{opt}' should be in opts instead of params.")
             end
           end
         end
@@ -44,10 +107,23 @@ module Stripe
         base.extend(ClassMethods)
       end
 
-      protected def request(method, url, params = {}, opts = {})
+      protected def execute_resource_request(method, url,
+                                             params = {}, opts = {})
         opts = @opts.merge(Util.normalize_opts(opts))
-        self.class.request(method, url, params, opts)
+        self.class.execute_resource_request(method, url, params, opts)
       end
+
+      protected def execute_resource_request_stream(method, url,
+                                                    params = {}, opts = {},
+                                                    &read_body_chunk_block)
+        opts = @opts.merge(Util.normalize_opts(opts))
+        self.class.execute_resource_request_stream(
+          method, url, params, opts, &read_body_chunk_block
+        )
+      end
+
+      # See notes on `alias` above.
+      alias request execute_resource_request
     end
   end
 end