stripe 4.9.0 → 5.1.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.9.0
+5.1.0

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"
@@ -26,90 +26,27 @@ require "stripe/api_operations/save"
 
 # API resource support classes
 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"
 
 # Named API resources
-require "stripe/account"
-require "stripe/account_link"
-require "stripe/alipay_account"
-require "stripe/apple_pay_domain"
-require "stripe/application_fee"
-require "stripe/application_fee_refund"
-require "stripe/balance"
-require "stripe/balance_transaction"
-require "stripe/bank_account"
-require "stripe/bitcoin_receiver"
-require "stripe/bitcoin_transaction"
-require "stripe/card"
-require "stripe/charge"
-require "stripe/checkout/session"
-require "stripe/country_spec"
-require "stripe/coupon"
-require "stripe/customer"
-require "stripe/dispute"
-require "stripe/ephemeral_key"
-require "stripe/event"
-require "stripe/exchange_rate"
-require "stripe/file"
-require "stripe/file_link"
-require "stripe/invoice"
-require "stripe/invoice_item"
-require "stripe/invoice_line_item"
-require "stripe/issuer_fraud_record"
-require "stripe/issuing/authorization"
-require "stripe/issuing/card"
-require "stripe/issuing/card_details"
-require "stripe/issuing/cardholder"
-require "stripe/issuing/dispute"
-require "stripe/issuing/transaction"
-require "stripe/login_link"
-require "stripe/order"
-require "stripe/order_return"
-require "stripe/payment_intent"
-require "stripe/payout"
-require "stripe/person"
-require "stripe/plan"
-require "stripe/product"
-require "stripe/radar/value_list"
-require "stripe/radar/value_list_item"
-require "stripe/recipient"
-require "stripe/recipient_transfer"
-require "stripe/refund"
-require "stripe/reporting/report_run"
-require "stripe/reporting/report_type"
-require "stripe/reversal"
-require "stripe/review"
-require "stripe/sigma/scheduled_query_run"
-require "stripe/sku"
-require "stripe/source"
-require "stripe/source_transaction"
-require "stripe/subscription"
-require "stripe/subscription_item"
-require "stripe/subscription_schedule"
-require "stripe/subscription_schedule_revision"
-require "stripe/terminal/connection_token"
-require "stripe/terminal/location"
-require "stripe/terminal/reader"
-require "stripe/three_d_secure"
-require "stripe/token"
-require "stripe/topup"
-require "stripe/transfer"
-require "stripe/usage_record"
-require "stripe/usage_record_summary"
-require "stripe/webhook_endpoint"
+require "stripe/resources"
 
 # OAuth
 require "stripe/oauth"
 
 module Stripe
-  DEFAULT_CA_BUNDLE_PATH = ::File.dirname(__FILE__) + "/data/ca-certificates.crt"
+  DEFAULT_CA_BUNDLE_PATH = __dir__ + "/data/ca-certificates.crt"
 
   @app_info = nil
 
@@ -120,6 +57,8 @@ module Stripe
   @log_level = nil
   @logger = nil
 
+  @proxy = nil
+
   @max_network_retries = 0
   @max_network_retry_delay = 2
   @initial_network_retry_delay = 0.5
@@ -131,11 +70,23 @@ module Stripe
   @open_timeout = 30
   @read_timeout = 80
 
-  @enable_telemetry = false
+  @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
+    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
@@ -150,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.
@@ -162,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
@@ -181,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
@@ -206,7 +177,8 @@ module Stripe
     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`"
+      raise ArgumentError,
+            "log_level should only be set to `nil`, `debug` or `info`"
     end
     @log_level = val
   end
@@ -234,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
@@ -256,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/lib/stripe/api_operations/delete.rb

@@ -3,11 +3,33 @@
 module Stripe
   module APIOperations
     module Delete
+      module ClassMethods
+        # Deletes an API resource
+        #
+        # Deletes the identified resource with the passed in parameters.
+        #
+        # ==== Attributes
+        #
+        # * +id+ - ID of the resource to delete.
+        # * +params+ - A hash of parameters to pass to the API
+        # * +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}.
+        def delete(id, params = {}, opts = {})
+          resp, opts = request(:delete, "#{resource_url}/#{id}", params, opts)
+          Util.convert_to_stripe_object(resp.data, opts)
+        end
+      end
+
       def delete(params = {}, opts = {})
-        opts = Util.normalize_opts(opts)
         resp, opts = request(:delete, resource_url, params, opts)
         initialize_from(resp.data, opts)
       end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
     end
   end
 end

data/lib/stripe/api_operations/list.rb

@@ -19,12 +19,6 @@ module Stripe
 
         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

@@ -10,8 +10,10 @@ module Stripe
     # methods `.create_reversal`, `.retrieve_reversal`, `.update_reversal`,
     # etc. all become available.
     module NestedResource
-      def nested_resource_class_methods(resource, path: nil, operations: nil)
-        path ||= "#{resource}s"
+      def nested_resource_class_methods(resource, path: nil, operations: nil,
+                                        resource_plural: nil)
+        resource_plural ||= "#{resource}s"
+        path ||= resource_plural
         raise ArgumentError, "operations array required" if operations.nil?
 
         resource_url_method = :"#{resource}s_url"
@@ -24,31 +26,36 @@ module Stripe
         operations.each do |operation|
           case operation
           when :create
-            define_singleton_method(:"create_#{resource}") do |id, params = {}, opts = {}|
+            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
           when :retrieve
-            define_singleton_method(:"retrieve_#{resource}") do |id, nested_id, opts = {}|
+            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
           when :update
-            define_singleton_method(:"update_#{resource}") do |id, nested_id, params = {}, opts = {}|
+            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
           when :delete
-            define_singleton_method(:"delete_#{resource}") do |id, nested_id, params = {}, opts = {}|
+            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
           when :list
-            define_singleton_method(:"list_#{resource}s") do |id, params = {}, opts = {}|
+            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)

data/lib/stripe/api_operations/request.rb

@@ -31,12 +31,10 @@ module Stripe
           [resp, opts_to_persist]
         end
 
-        private
-
-        def warn_on_opts_in_params(params)
+        private def warn_on_opts_in_params(params)
           Util::OPTS_USER_SPECIFIED.each do |opt|
             if params.key?(opt)
-              $stderr.puts("WARNING: #{opt} should be in opts instead of params.")
+              warn("WARNING: #{opt} should be in opts instead of params.")
             end
           end
         end
@@ -46,9 +44,7 @@ module Stripe
         base.extend(ClassMethods)
       end
 
-      protected
-
-      def request(method, url, params = {}, opts = {})
+      protected def request(method, url, params = {}, opts = {})
         opts = @opts.merge(Util.normalize_opts(opts))
         self.class.request(method, url, params, opts)
       end

data/lib/stripe/api_operations/save.rb

@@ -76,9 +76,7 @@ module Stripe
         base.extend(ClassMethods)
       end
 
-      private
-
-      def save_url
+      private def save_url
         # This switch essentially allows us "upsert"-like functionality. If the
         # API resource doesn't have an ID set (suggesting that it's new) and
         # its class responds to .create (which comes from

data/lib/stripe/api_resource.rb

@@ -17,7 +17,9 @@ module Stripe
 
     def self.resource_url
       if self == APIResource
-        raise NotImplementedError, "APIResource is an abstract class.  You should perform actions on its subclasses (Charge, Customer, etc.)"
+        raise NotImplementedError,
+              "APIResource is an abstract class. You should perform actions " \
+              "on its subclasses (Charge, Customer, etc.)"
       end
       # Namespaces are separated in object names with periods (.) and in URLs
       # with forward slashes (/), so replace the former with the latter.
@@ -48,9 +50,44 @@ module Stripe
       end
     end
 
+    # Adds a custom method to a resource class. This is used to add support for
+    # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
+    # following parameters:
+    # - name: the name of the custom method to create (as a symbol)
+    # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
+    # - http_path: the path to append to the resource's URL. If not provided,
+    #              the name is used as the path
+    #
+    # For example, this call:
+    #     custom_method :capture, http_verb: post
+    # adds a `capture` class method to the resource class that, when called,
+    # will send a POST request to `/v1/<object_name>/capture`.
+    def self.custom_method(name, http_verb:, http_path: nil)
+      unless %i[get post delete].include?(http_verb)
+        raise ArgumentError,
+              "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
+              "of :get, :post or :delete."
+      end
+      http_path ||= name.to_s
+      define_singleton_method(name) do |id, params = {}, opts = {}|
+        unless id.is_a?(String)
+          raise ArgumentError,
+                "id should be a string representing the ID of an API resource"
+        end
+
+        url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(http_path)}"
+        resp, opts = request(http_verb, url, params, opts)
+        Util.convert_to_stripe_object(resp.data, opts)
+      end
+    end
+
     def resource_url
       unless (id = self["id"])
-        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", "id")
+        raise InvalidRequestError.new(
+          "Could not determine which URL to request: #{self.class} instance " \
+          "has invalid ID: #{id.inspect}",
+          "id"
+        )
       end
       "#{self.class.resource_url}/#{CGI.escape(id)}"
     end
@@ -66,5 +103,16 @@ module Stripe
       instance.refresh
       instance
     end
+
+    protected def request_stripe_object(method:, path:, params:, opts: {})
+      resp, opts = request(method, path, params, opts)
+
+      # If we're getting back this thing, update; otherwise, instantiate.
+      if Util.object_name_matches_class?(resp.data[:object], self.class)
+        initialize_from(resp.data, opts)
+      else
+        Util.convert_to_stripe_object(resp.data, opts)
+      end
+    end
   end
 end