stripe 5.28.0 → 5.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc768f1967f8b5d8d925a101dffc820bd4dfa96155cecc9bd86926cb30f07cbe
-  data.tar.gz: 7dcd29fb83035f6f6af335bf3a4acde40ea4ce7e0e097413b9f76c696bb3e529
+  metadata.gz: 1c7a2e67a4d91e1a22dff9303644b5f2efb74675bce05e364fff8d287f3fa8bd
+  data.tar.gz: a560d866c948d0bbc8f3389571c313da67a26650a771159fa785d7a1e3beccc9
 SHA512:
-  metadata.gz: e911a5c3138805c0aeb5abe270186e4d4219b8414e3336579cda3caa02ad32797d0d088cce8468156f4dff27a6ff55ac107419e7a0b01040eec36be8684073d7
-  data.tar.gz: 6fd38cd5ffde35f1065ce18104382f106eec79fb3494099e49723745ada158f7f63df1164653a6ada3fe0c62ae0ed764cbf9e40e878f4e3bb4dbd6c799cffbfa
+  metadata.gz: a257d84bec5ef9fe3005b362da5c5194a71e257e77baa71c5872b990fefc3e3ee7cc26201d773cf4f5ca29af0fd8b2d3f3b047e11a833c51aba7bca2f6b3947a
+  data.tar.gz: eae3ef2579f9ce37a5e447cd46ca67bdfebc2324e5767cc0925d7f2bee5d8f289a69512ff9221cb28bdd9c4ec39a8cea1f7b5af14b67d18b2fa8a3c9ce7dbb47

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## 5.38.0 - 2021-08-10
+* [#993](https://github.com/stripe/stripe-ruby/pull/993) Add `request_id` to RequestEndEvent
+* [#991](https://github.com/stripe/stripe-ruby/pull/991) Codegen more files
+* [#989](https://github.com/stripe/stripe-ruby/pull/989) Remove unused API error types from docs.
+
+## 5.37.0 - 2021-07-14
+* [#988](https://github.com/stripe/stripe-ruby/pull/988) API Updates
+  * Add support for `list_computed_upfront_line_items` method on resource `Quote`
+
+## 5.36.0 - 2021-07-09
+* [#987](https://github.com/stripe/stripe-ruby/pull/987) Add support for `Quote` API
+
+## 5.35.0 - 2021-06-30
+* [#985](https://github.com/stripe/stripe-ruby/pull/985) Update normalize_opts to use dup instead of clone.
+* [#982](https://github.com/stripe/stripe-ruby/pull/982) Deprecate travis
+* [#983](https://github.com/stripe/stripe-ruby/pull/983) Add support for making a request and receiving the response as a stream.
+
+## 5.34.0 - 2021-06-04
+* [#981](https://github.com/stripe/stripe-ruby/pull/981) API Updates
+  * Add support for `TaxCode` API.
+
+## 5.33.0 - 2021-05-19
+* [#979](https://github.com/stripe/stripe-ruby/pull/979) Add support for the Identify VerificationSession and VerificationReport APIs
+
+## 5.32.1 - 2021-04-05
+* Correct use of regexp `match` in gemspec for old versions of Ruby
+
+## 5.32.0 - 2021-04-05
+* [#973](https://github.com/stripe/stripe-ruby/pull/973) Reduce packed gem size
+
+## 5.31.0 - 2021-04-02
+* [#968](https://github.com/stripe/stripe-ruby/pull/968) Allow StripeClient to be configured per instance
+* [#971](https://github.com/stripe/stripe-ruby/pull/971) On config change, only clear connection managers for changed config
+* [#972](https://github.com/stripe/stripe-ruby/pull/972) Rename `Stripe.configuration` to `Stripe.config`
+* [#970](https://github.com/stripe/stripe-ruby/pull/970) Reserve some critical field names when adding `StripeObject` accessors
+* [#967](https://github.com/stripe/stripe-ruby/pull/967) CI: github actions
+
+## 5.30.0 - 2021-02-22
+* [#965](https://github.com/stripe/stripe-ruby/pull/965) Add support for the Billing Portal Configuration API
+
+## 5.29.1 - 2021-02-09
+* [#964](https://github.com/stripe/stripe-ruby/pull/964) Fix return value of `Customer#delete_discount`
+
+## 5.29.0 - 2021-01-05
+* [#952](https://github.com/stripe/stripe-ruby/pull/952) Allow client_id configuration on instance config
+
 ## 5.28.0 - 2020-10-14
 * [#950](https://github.com/stripe/stripe-ruby/pull/950) Add configuration option for `write_timeout` for connections on Ruby 2.6+
 

data/Gemfile

@@ -5,7 +5,6 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "coveralls", require: false
   gem "mocha", "~> 0.13.2"
   gem "rack", ">= 2.0.6"
   gem "rake"

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/stripe.svg)](https://badge.fury.io/rb/stripe)
 [![Build Status](https://travis-ci.org/stripe/stripe-ruby.svg?branch=master)](https://travis-ci.org/stripe/stripe-ruby)
-[![Coverage Status](https://coveralls.io/repos/github/stripe/stripe-ruby/badge.svg?branch=master)](https://coveralls.io/github/stripe/stripe-ruby?branch=master)
 
 The Stripe Ruby library provides convenient access to the Stripe API from
 applications written in the Ruby language. It includes a pre-defined set of
@@ -21,6 +20,9 @@ The library also provides other features. For example:
 
 See the [Ruby API docs](https://stripe.com/docs/api/ruby#intro).
 
+See [video demonstrations][youtube-playlist] covering how to use the library.
+
+
 ## Installation
 
 You don't need this source code unless you want to modify the gem. If you just
@@ -250,6 +252,7 @@ a success or error. Receives `RequestEndEvent` with the following properties:
 - `path`: Request path. (`String`)
 - `user_data`: A hash on which users may have set arbitrary data in
   `request_begin`. See above for more information. (`Hash`)
+- `request_id`. HTTP request identifier.
 
 #### Example
 
@@ -340,6 +343,7 @@ Update the bundled [stripe-mock] by editing the version number found in
 [idempotency-keys]: https://stripe.com/docs/api/ruby#idempotent_requests
 [stripe-mock]: https://github.com/stripe/stripe-mock
 [versioning]: https://stripe.com/docs/api/ruby#versioning
+[youtube-playlist]: https://www.youtube.com/playlist?list=PLy1nL-pvL2M50RmP6ie-gdcSnfOuQCRYk
 
 <!--
 # vim: set tw=79:

data/VERSION

@@ -1 +1 @@
-5.28.0
+5.38.0

data/lib/stripe/api_operations/request.rb

@@ -6,6 +6,28 @@ module Stripe
       module ClassMethods
         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)
@@ -22,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
@@ -89,6 +113,15 @@ module Stripe
         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

data/lib/stripe/api_resource.rb

@@ -115,5 +115,13 @@ module Stripe
         Util.convert_to_stripe_object(resp.data, opts)
       end
     end
+
+    protected def request_stream(method:, path:, params:, opts: {},
+                                 &read_body_chunk_block)
+      resp, = execute_resource_request_stream(
+        method, path, params, opts, &read_body_chunk_block
+      )
+      resp
+    end
   end
 end

data/lib/stripe/connection_manager.rb

@@ -15,8 +15,10 @@ module Stripe
     # by `StripeClient` to determine whether a connection manager should be
     # garbage collected or not.
     attr_reader :last_used
+    attr_reader :config
 
-    def initialize
+    def initialize(config = Stripe.config)
+      @config = config
       @active_connections = {}
       @last_used = Util.monotonic_time
 
@@ -64,7 +66,8 @@ module Stripe
 
     # Executes an HTTP request to the given URI with the given method. Also
     # allows a request body, headers, and query string to be specified.
-    def execute_request(method, uri, body: nil, headers: nil, query: nil)
+    def execute_request(method, uri, body: nil, headers: nil, query: nil,
+                        &block)
       # Perform some basic argument validation because it's easy to get
       # confused between strings and hashes for things like body and query
       # parameters.
@@ -90,8 +93,22 @@ module Stripe
                u.path
              end
 
+      method_name = method.to_s.upcase
+      has_response_body = method_name != "HEAD"
+      request = Net::HTTPGenericRequest.new(
+        method_name,
+        (body ? true : false),
+        has_response_body,
+        path,
+        headers
+      )
+
       @mutex.synchronize do
-        connection.send_request(method.to_s.upcase, path, body, headers)
+        # The block parameter is special here. If a block is provided, the block
+        # is invoked with the Net::HTTPResponse. However, the body will not have
+        # been read yet in the block, and can be streamed by calling
+        # HTTPResponse#read_body.
+        connection.request(request, body, &block)
       end
     end
 
@@ -117,17 +134,17 @@ module Stripe
       # reused Go's default for `DefaultTransport`.
       connection.keep_alive_timeout = 30
 
-      connection.open_timeout = Stripe.open_timeout
-      connection.read_timeout = Stripe.read_timeout
+      connection.open_timeout = config.open_timeout
+      connection.read_timeout = config.read_timeout
       if connection.respond_to?(:write_timeout=)
-        connection.write_timeout = Stripe.write_timeout
+        connection.write_timeout = config.write_timeout
       end
 
       connection.use_ssl = uri.scheme == "https"
 
-      if Stripe.verify_ssl_certs
+      if config.verify_ssl_certs
         connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        connection.cert_store = Stripe.ca_store
+        connection.cert_store = config.ca_store
       else
         connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
         warn_ssl_verify_none
@@ -141,10 +158,10 @@ module Stripe
     # out those pieces to make passing them into a new connection a little less
     # ugly.
     private def proxy_parts
-      if Stripe.proxy.nil?
+      if config.proxy.nil?
         [nil, nil, nil, nil]
       else
-        u = URI.parse(Stripe.proxy)
+        u = URI.parse(config.proxy)
         [u.host, u.port, u.user, u.password]
       end
     end

data/lib/stripe/error_object.rb

@@ -69,9 +69,8 @@ module Stripe
       @values[:source]
     end
 
-    # The type of error returned. One of `api_connection_error`, `api_error`,
-    # `authentication_error`, `card_error`, `idempotency_error`,
-    # `invalid_request_error`, or `rate_limit_error`.
+    # The type of error returned. One of `api_error`, `card_error`,
+    # `idempotency_error`, or `invalid_request_error`.
     def type
       @values[:type]
     end

data/lib/stripe/instrumentation.rb

@@ -32,6 +32,7 @@ module Stripe
       attr_reader :method
       attr_reader :num_retries
       attr_reader :path
+      attr_reader :request_id
 
       # Arbitrary user-provided data in the form of a Ruby hash that's passed
       # from subscribers on `request_begin` to subscribers on `request_end`.
@@ -40,12 +41,13 @@ module Stripe
       attr_reader :user_data
 
       def initialize(duration:, http_status:, method:, num_retries:, path:,
-                     user_data: nil)
+                     request_id:, user_data: nil)
         @duration = duration
         @http_status = http_status
         @method = method
         @num_retries = num_retries
         @path = path
+        @request_id = request_id
         @user_data = user_data
         freeze
       end

data/lib/stripe/oauth.rb

@@ -7,8 +7,8 @@ module Stripe
 
       def self.execute_resource_request(method, url, params, opts)
         opts = Util.normalize_opts(opts)
-        opts[:client] ||= StripeClient.active_client
-        opts[:api_base] ||= Stripe.connect_base
+        opts[:client] ||= opts[:client] || StripeClient.active_client
+        opts[:api_base] ||= opts[:client].config.connect_base
 
         super(method, url, params, opts)
       end
@@ -29,7 +29,8 @@ module Stripe
     end
 
     def self.authorize_url(params = {}, opts = {})
-      base = opts[:connect_base] || Stripe.connect_base
+      client = opts[:client] || StripeClient.active_client
+      base = opts[:connect_base] || client.config.connect_base
 
       path = "/oauth/authorize"
       path = "/express" + path if opts[:express]

data/lib/stripe/object_types.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/MethodLength
@@ -19,6 +20,7 @@ module Stripe
         Balance::OBJECT_NAME => Balance,
         BalanceTransaction::OBJECT_NAME => BalanceTransaction,
         BankAccount::OBJECT_NAME => BankAccount,
+        BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
         BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
         BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
         BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
@@ -40,6 +42,8 @@ module Stripe
         File::OBJECT_NAME => File,
         File::OBJECT_NAME_ALT => File,
         FileLink::OBJECT_NAME => FileLink,
+        Identity::VerificationReport::OBJECT_NAME => Identity::VerificationReport,
+        Identity::VerificationSession::OBJECT_NAME => Identity::VerificationSession,
         Invoice::OBJECT_NAME => Invoice,
         InvoiceItem::OBJECT_NAME => InvoiceItem,
         InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
@@ -62,6 +66,7 @@ module Stripe
         Price::OBJECT_NAME => Price,
         Product::OBJECT_NAME => Product,
         PromotionCode::OBJECT_NAME => PromotionCode,
+        Quote::OBJECT_NAME => Quote,
         Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
         Radar::ValueList::OBJECT_NAME => Radar::ValueList,
         Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
@@ -72,15 +77,16 @@ module Stripe
         Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
         Reversal::OBJECT_NAME => Reversal,
         Review::OBJECT_NAME => Review,
-        SKU::OBJECT_NAME => SKU,
         SetupAttempt::OBJECT_NAME => SetupAttempt,
         SetupIntent::OBJECT_NAME => SetupIntent,
         Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
+        SKU::OBJECT_NAME => SKU,
         Source::OBJECT_NAME => Source,
         SourceTransaction::OBJECT_NAME => SourceTransaction,
         Subscription::OBJECT_NAME => Subscription,
         SubscriptionItem::OBJECT_NAME => SubscriptionItem,
         SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
+        TaxCode::OBJECT_NAME => TaxCode,
         TaxId::OBJECT_NAME => TaxId,
         TaxRate::OBJECT_NAME => TaxRate,
         Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,

data/lib/stripe/resources/account.rb

@@ -45,12 +45,8 @@ module Stripe
     end
 
     # @override To make id optional
-    def self.retrieve(id = ARGUMENT_NOT_PROVIDED, opts = {})
-      id = if id.equal?(ARGUMENT_NOT_PROVIDED)
-             nil
-           else
-             Util.check_string_argument!(id)
-           end
+    def self.retrieve(id = nil, opts = {})
+      Util.check_string_argument!(id) if id
 
       # Account used to be a singleton, where this method's signature was
       # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
@@ -136,11 +132,10 @@ module Stripe
         client_id: client_id,
         stripe_user_id: id,
       }
+      opts = @opts.merge(Util.normalize_opts(opts))
       OAuth.deauthorize(params, opts)
     end
 
-    ARGUMENT_NOT_PROVIDED = Object.new
-
     private def serialize_additional_owners(legal_entity, additional_owners)
       original_value =
         legal_entity

data/lib/stripe/resources/application_fee_refund.rb

@@ -1,9 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class ApplicationFeeRefund < APIResource
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
     OBJECT_NAME = "fee_refund"
 

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing_portal.configuration"
+    end
+  end
+end

data/lib/stripe/resources/bitcoin_transaction.rb

@@ -1,9 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # Directly retrieving BitcoinTransactions is deprecated. Please use
+  # the Sources API instead: https://stripe.com/docs/sources/bitcoin
   class BitcoinTransaction < APIResource
-    # Directly retrieving BitcoinTransactions is deprecated. Please use the
-    # Sources API instead: https://stripe.com/docs/sources/bitcoin
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "bitcoin_transaction"

data/lib/stripe/resources/capability.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -26,7 +27,7 @@ module Stripe
     def self.update(_id, _params = nil, _opts = nil)
       raise NotImplementedError,
             "Capabilities cannot be updated without an account ID. Update a " \
-            "capability using Account.update_capability('account_id', " \
+            "capability using `Account.update_capability('account_id', " \
             "'capability_id', update_params)`"
     end
   end

data/lib/stripe/resources/credit_note_line_item.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/customer.rb

@@ -28,9 +28,14 @@ module Stripe
       alias detach_source delete_source
     end
 
+    # Deletes a discount associated with the customer.
+    #
+    # Returns the deleted discount. The customer object is not updated,
+    # so you must call `refresh` on it to get a new version with the
+    # discount removed.
     def delete_discount
       resp, opts = execute_resource_request(:delete, resource_url + "/discount")
-      initialize_from(resp.data, opts, true)
+      Util.convert_to_stripe_object(resp.data, opts)
     end
   end
 end

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -18,13 +19,13 @@ module Stripe
     def self.retrieve(_id, _opts = {})
       raise NotImplementedError,
             "Customer Balance Transactions cannot be retrieved without a customer ID. " \
-            "Retrieve a Customer Balance Transaction using Customer.retrieve_balance_transaction('cus_123', 'cbtxn_123')"
+            "Retrieve a Customer Balance Transaction using `Customer.retrieve_balance_transaction('cus_123', 'cbtxn_123')`"
     end
 
     def self.update(_id, _params = nil, _opts = nil)
       raise NotImplementedError,
             "Customer Balance Transactions cannot be retrieved without a customer ID. " \
-            "Update a Customer Balance Transaction using Customer.update_balance_transaction('cus_123', 'cbtxn_123', params)"
+            "Update a Customer Balance Transaction using `Customer.update_balance_transaction('cus_123', 'cbtxn_123', params)`"
     end
   end
 end

data/lib/stripe/resources/file.rb

@@ -25,8 +25,9 @@ module Stripe
         end
       end
 
+      config = opts[:client]&.config || Stripe.config
       opts = {
-        api_base: Stripe.uploads_base,
+        api_base: config.uploads_base,
         content_type: MultipartEncoder::MULTIPART_FORM_DATA,
       }.merge(Util.normalize_opts(opts))
       super

data/lib/stripe/resources/identity/verification_report.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReport < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "identity.verification_report"
+    end
+  end
+end

data/lib/stripe/resources/identity/verification_session.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSession < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "identity.verification_session"
+
+      custom_method :cancel, http_verb: :post
+      custom_method :redact, http_verb: :post
+
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/cancel",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def redact(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/redact",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/invoice_line_item.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/line_item.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/login_link.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/person.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe