stripe 5.21.0 → 5.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cdafae953d1c503aebdf2976b20a5c04dc01b61ac0b6bac2bd92993900b78f7
-  data.tar.gz: 1c382fee9a657f61b3862b27f638a58b1ea4cd795d3fff0d0e057c15ec2c182a
+  metadata.gz: 2bff9fb79cc55a44a50f4f3bf5ae748d3a23a242e283cee0988a27ad0df2c1b3
+  data.tar.gz: 668da0eecea17d8fe1714f0cb51639ce8c928be8e21ba0a3ac1ba3c5b0014a62
 SHA512:
-  metadata.gz: 4bc22a8af3a1bae3156e536a7155533a4438814570e84aebbe318c1894b8775c9957e478df5d05c52d4627fabd0105b3c2a9036bda96282ffbac8cbb747b0ece
-  data.tar.gz: 61804b56ab0d6dd379eab1f0c9fcb6841a771d59705f1ffc9cd1616ccab24575eb81baf95d1dde8a32d99d45848cc723a7ddc87b465b68a68cb6be1900ec87d3
+  metadata.gz: 0c0cd52e780ad6f033ef5fa5c6966f1a8a51c667cf2ef99190dcaa7a501c1ea58bfe6cdeab55d90b4d308cbeb1596bc716d45ac212b2de0b0667c243d55b6195
+  data.tar.gz: 129ea3f6979acbd37fea34fe1dc739e0664ac327118b8768eee49cec4d4b9ac4e70987d8f739d2b121e8535776ed0e2abdcc474343352788c3dd400f0de4b178

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.89.0
+    - STRIPE_MOCK_VERSION=0.98.0
 
 cache:
   directories:

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 5.25.0 - 2020-09-02
+* [#944](https://github.com/stripe/stripe-ruby/pull/944) Add support for the Issuing Dispute Submit API
+
+## 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
 

data/README.md

@@ -60,14 +60,14 @@ available in your [Stripe Dashboard][api-keys]. Set `Stripe.api_key` to its
 value:
 
 ```ruby
-require "stripe"
-Stripe.api_key = "sk_test_..."
+require 'stripe'
+Stripe.api_key = 'sk_test_...'
 
 # list customers
 Stripe::Customer.list()
 
 # retrieve single customer
-Stripe::Customer.retrieve("cus_123456789")
+Stripe::Customer.retrieve('cus_123456789')
 ```
 
 ### Per-request Configuration
@@ -82,38 +82,38 @@ require "stripe"
 Stripe::Customer.list(
   {},
   {
-    api_key: "sk_test_...",
-    stripe_account: "acct_...",
-    stripe_version: "2018-02-28",
+    api_key: 'sk_test_...',
+    stripe_account: 'acct_...',
+    stripe_version: '2018-02-28',
   }
 )
 
 Stripe::Customer.retrieve(
-  "cus_123456789",
+  'cus_123456789',
   {
-    api_key: "sk_test_...",
-    stripe_account: "acct_...",
-    stripe_version: "2018-02-28",
+    api_key: 'sk_test_...',
+    stripe_account: 'acct_...',
+    stripe_version: '2018-02-28',
   }
 )
 
 Stripe::Customer.retrieve(
   {
-    id: "cus_123456789",
+    id: 'cus_123456789',
     expand: %w(balance_transaction)
   },
   {
-    stripe_version: "2018-02-28",
-    api_key: "sk_test_...",
+    stripe_version: '2018-02-28',
+    api_key: 'sk_test_...',
   }
 )
 
 Stripe::Customer.capture(
-  "cus_123456789",
+  'cus_123456789',
   {},
   {
-    stripe_version: "2018-02-28",
-    api_key: "sk_test_...",
+    stripe_version: '2018-02-28',
+    api_key: 'sk_test_...',
   }
 )
 ```
@@ -136,7 +136,7 @@ method:
 ```ruby
 client = Stripe::StripeClient.new
 customer, resp = client.request do
-  Stripe::Customer.retrieve("cus_123456789",)
+  Stripe::Customer.retrieve('cus_123456789',)
 end
 puts resp.request_id
 ```
@@ -146,7 +146,7 @@ puts resp.request_id
 A proxy can be configured with `Stripe.proxy`:
 
 ```ruby
-Stripe.proxy = "https://user:pass@example.com:1234"
+Stripe.proxy = 'https://user:pass@example.com:1234'
 ```
 
 ### Configuring an API Version
@@ -155,7 +155,7 @@ By default, the library will use the API version pinned to the account making
 a request. This can be overridden with this global option:
 
 ```ruby
-Stripe.api_version = "2018-02-28"
+Stripe.api_version = '2018-02-28'
 ```
 
 See [versioning in the API reference][versioning] for more information.
@@ -166,7 +166,7 @@ By default, the library will use its own internal bundle of known CA
 certificates, but it's possible to configure your own:
 
 ```ruby
-Stripe.ca_bundle_path = "path/to/ca/bundle"
+Stripe.ca_bundle_path = 'path/to/ca/bundle'
 ```
 
 ### Configuring Automatic Retries
@@ -258,7 +258,7 @@ For example:
 Stripe::Instrumentation.subscribe(:request_end) do |request_event|
   tags = {
     method: request_event.method,
-    resource: request_event.path.split("/")[2],
+    resource: request_event.path.split('/')[2],
     code: request_event.http_status,
     retries: request_event.num_retries
   }
@@ -272,7 +272,7 @@ If you're writing a plugin that uses the library, we'd appreciate it if you
 identified using `#set_app_info`:
 
 ```ruby
-Stripe.set_app_info("MyAwesomePlugin", version: "1.2.34", url: "https://myawesomeplugin.info");
+Stripe.set_app_info('MyAwesomePlugin', version: '1.2.34', url: 'https://myawesomeplugin.info')
 ```
 
 This information is passed along when the library makes calls to the Stripe

data/VERSION

@@ -1 +1 @@
-5.21.0
+5.25.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