stripe 5.20.0 → 5.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d5362cf3395da735662c079302a68f77a067db5ed0b33d9049ab47a5d610e6
-  data.tar.gz: a33095d14ba39ec3d3a178c5b6a7aaf477f3290a060bc9955d840d30f284d9ad
+  metadata.gz: dad4d3bffd7ba2748a3331de5d3b97108732144b33818a5e79efd6eb597e4834
+  data.tar.gz: c46abe2511c5316276921da29766c22aed11bb92b136b53fb7ea82fb542640c5
 SHA512:
-  metadata.gz: 5708098cb83cae3806edc15aa7baa946f7e1107e380282e64012b59d849a8e5b1a6c394b23347b20dc94a81922760cdaea7cb6b634c8c2f35f8b8c74694e5bee
-  data.tar.gz: 3add4e8a981bf84adabf38d6c6ee98c7dbebb0254709e38e3ee9c4aeddd68c9ce1b78cf594cf1aad7c1bb587767952cba0be15a273bdb6bf31ed215040c5162b
+  metadata.gz: 824c459fec4234b09e6d04d20b79728db4ccd19e0dc5cbe9874d319a995b62cb7c252dff31fad3c0fae295682bd68cfbb9fb52f0e98044f3708f1999c0f55d16
+  data.tar.gz: 6f1557c58e7c0ab6e407444208c142953889ec1f2746464804cf38d6766550aca0577902982211a696522f47e5ffc06d304f17c4fc7b4fdfbe60c1603077a72d

data/.rubocop.yml

@@ -44,10 +44,10 @@ Metrics/ClassLength:
     - "test/**/*.rb"
 
 Metrics/MethodLength:
-  # There's ~2 long methods in `StripeClient`. If we want to truncate those a
-  # little, we could move this to be closer to ~30 (but the default of 10 is
-  # probably too short).
-  Max: 50
+  # There's ~2 long methods in `StripeClient` and one in `NestedResource`. If
+  # we want to truncate those a little, we could move this to be closer to ~30
+  # (but the default of 10 is probably too short).
+  Max: 55
 
 Metrics/ModuleLength:
   Enabled: false

data/.travis.yml

@@ -17,7 +17,7 @@ sudo: false
 env:
   global:
     # If changing this number, please also change it in `test/test_helper.rb`.
-    - STRIPE_MOCK_VERSION=0.88.0
+    - STRIPE_MOCK_VERSION=0.95.0
 
 cache:
   directories:

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 5.24.0 - 2020-08-26
+* [#939](https://github.com/stripe/stripe-ruby/pull/939) Extract configurations into separate object
+* [#940](https://github.com/stripe/stripe-ruby/pull/940) Fix typo in documentation of `stripe_object.rb`
+
+## 5.23.1 - 2020-08-05
+* [#936](https://github.com/stripe/stripe-ruby/pull/936) Rename API resource's `request` method
+
+## 5.23.0 - 2020-08-05
+* [#937](https://github.com/stripe/stripe-ruby/pull/937) Add support for the `PromotionCode` resource and APIs
+
+## 5.22.0 - 2020-05-11
+* [#918](https://github.com/stripe/stripe-ruby/pull/918) Add support for the `LineItem` resource and APIs
+
+## 5.21.0 - 2020-04-29
+* [#917](https://github.com/stripe/stripe-ruby/pull/917) Add support for the `Price` resource and APIs
+
 ## 5.20.0 - 2020-04-27
 * [#916](https://github.com/stripe/stripe-ruby/pull/916) Add new `.generate_header` method for webhooks
 

data/VERSION

@@ -1 +1 @@
-5.20.0
+5.24.0

data/lib/stripe.rb

@@ -12,6 +12,7 @@ require "securerandom"
 require "set"
 require "socket"
 require "uri"
+require "forwardable"
 
 # Version
 require "stripe/version"
@@ -38,6 +39,7 @@ 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"
@@ -48,47 +50,41 @@ 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
+  @configuration = Stripe::StripeConfiguration.setup
 
   class << self
-    attr_accessor :api_key
-    attr_accessor :api_version
+    extend Forwardable
+
+    # User configurable options
+    def_delegators :@configuration, :api_key, :api_key=
+    def_delegators :@configuration, :api_version, :api_version=
+    def_delegators :@configuration, :stripe_account, :stripe_account=
+    def_delegators :@configuration, :api_base, :api_base=
+    def_delegators :@configuration, :uploads_base, :uploads_base=
+    def_delegators :@configuration, :connect_base, :connect_base=
+    def_delegators :@configuration, :open_timeout, :open_timeout=
+    def_delegators :@configuration, :read_timeout, :read_timeout=
+    def_delegators :@configuration, :proxy, :proxy=
+    def_delegators :@configuration, :verify_ssl_certs, :verify_ssl_certs=
+    def_delegators :@configuration, :ca_bundle_path, :ca_bundle_path=
+    def_delegators :@configuration, :log_level, :log_level=
+    def_delegators :@configuration, :logger, :logger=
+    def_delegators :@configuration, :max_network_retries, :max_network_retries=
+    def_delegators :@configuration, :enable_telemetry=, :enable_telemetry?
+
+    # Internal configurations
+    def_delegators :@configuration, :max_network_retry_delay
+    def_delegators :@configuration, :initial_network_retry_delay
+    def_delegators :@configuration, :ca_store
+
     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
 
   # Gets the application for a plugin that's identified some. See
@@ -101,126 +97,6 @@ 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.
-  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
-
-    StripeClient.clear_all_connection_managers
-  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
-
-  def self.connect_base=(connect_base)
-    @connect_base = connect_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
-  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.open_timeout=(open_timeout)
-    @open_timeout = open_timeout
-    StripeClient.clear_all_connection_managers
-  end
-
-  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
   # with API requests. Useful for plugin authors to identify their plugin when
   # communicating with Stripe.
@@ -234,16 +110,6 @@ module Stripe
       version: version,
     }
   end
-
-  def self.uploads_base=(uploads_base)
-    @uploads_base = uploads_base
-    StripeClient.clear_all_connection_managers
-  end
-
-  def self.verify_ssl_certs=(verify_ssl_certs)
-    @verify_ssl_certs = verify_ssl_certs
-    StripeClient.clear_all_connection_managers
-  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,7 +6,7 @@ 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

data/lib/stripe/api_operations/nested_resource.rb

@@ -31,35 +31,36 @@ module Stripe
             define_singleton_method(:"create_#{resource}") \
               do |id, params = {}, opts = {}|
                 url = send(resource_url_method, id)
-                resp, opts = request(:post, url, params, opts)
+                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)
+                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)
+                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)
+                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)
+                resp, opts = execute_resource_request(:get, url, params, opts)
                 Util.convert_to_stripe_object(resp.data, opts)
               end
           else

data/lib/stripe/api_operations/request.rb

@@ -4,7 +4,8 @@ module Stripe
   module APIOperations
     module Request
       module ClassMethods
-        def request(method, url, params = {}, opts = {})
+        def execute_resource_request(method, url,
+                                     params = {}, opts = {})
           params ||= {}
 
           error_on_invalid_params(params)
@@ -36,6 +37,17 @@ 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)
@@ -71,10 +83,14 @@ 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
+
+      # See notes on `alias` above.
+      alias request execute_resource_request
     end
   end
 end

data/lib/stripe/api_operations/save.rb

@@ -15,7 +15,8 @@ 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 update(id, params = {}, opts = {})
           params.each_key do |k|
             if protected_fields.include?(k)
@@ -23,7 +24,8 @@ module Stripe
             end
           end
 
-          resp, opts = request(:post, "#{resource_url}/#{id}", params, opts)
+          resp, opts = execute_resource_request(:post, "#{resource_url}/#{id}",
+                                                params, opts)
           Util.convert_to_stripe_object(resp.data, opts)
         end
       end
@@ -43,7 +45,8 @@ 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 save(params = {}, opts = {})
         # We started unintentionally (sort of) allowing attributes sent to
         # +save+ to override values used during the update. So as not to break
@@ -59,7 +62,7 @@ module Stripe
         # generated a uri for this object with an identifier baked in
         values.delete(:id)
 
-        resp, opts = request(:post, save_url, values, opts)
+        resp, opts = execute_resource_request(:post, save_url, values, opts)
         initialize_from(resp.data, opts)
       end