stripe 3.2.0 → 5.16.0

data/lib/stripe.rb

@@ -1,89 +1,63 @@
+# frozen_string_literal: true
+
 # Stripe Ruby bindings
 # API spec at https://stripe.com/docs/api
-require 'cgi'
-require 'openssl'
-require 'rbconfig'
-require 'set'
-require 'socket'
-
-require 'faraday'
-require 'json'
+require "cgi"
+require "json"
+require "logger"
+require "net/http"
+require "openssl"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "socket"
+require "uri"
 
 # Version
-require 'stripe/version'
+require "stripe/version"
 
 # API operations
-require 'stripe/api_operations/create'
-require 'stripe/api_operations/save'
-require 'stripe/api_operations/delete'
-require 'stripe/api_operations/list'
-require 'stripe/api_operations/request'
+require "stripe/api_operations/create"
+require "stripe/api_operations/delete"
+require "stripe/api_operations/list"
+require "stripe/api_operations/nested_resource"
+require "stripe/api_operations/request"
+require "stripe/api_operations/save"
 
 # API resource support classes
-require 'stripe/errors'
-require 'stripe/util'
-require 'stripe/stripe_client'
-require 'stripe/stripe_object'
-require 'stripe/stripe_response'
-require 'stripe/list_object'
-require 'stripe/api_resource'
-require 'stripe/singleton_api_resource'
-require 'stripe/webhook'
+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/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/country_spec'
-require 'stripe/coupon'
-require 'stripe/customer'
-require 'stripe/dispute'
-require 'stripe/ephemeral_key'
-require 'stripe/event'
-require 'stripe/file_upload'
-require 'stripe/invoice'
-require 'stripe/invoice_item'
-require 'stripe/invoice_line_item'
-require 'stripe/login_link'
-require 'stripe/order'
-require 'stripe/order_return'
-require 'stripe/payout'
-require 'stripe/plan'
-require 'stripe/product'
-require 'stripe/recipient'
-require 'stripe/recipient_transfer'
-require 'stripe/refund'
-require 'stripe/reversal'
-require 'stripe/sku'
-require 'stripe/source'
-require 'stripe/subscription'
-require 'stripe/subscription_item'
-require 'stripe/three_d_secure'
-require 'stripe/token'
-require 'stripe/transfer'
+require "stripe/resources"
 
 # OAuth
-require 'stripe/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
 
-  @api_base = 'https://api.stripe.com'
-  @connect_base = 'https://connect.stripe.com'
-  @uploads_base = 'https://uploads.stripe.com'
+  @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
@@ -96,9 +70,23 @@ module Stripe
   @open_timeout = 30
   @read_timeout = 80
 
+  @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
@@ -113,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.
@@ -125,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
@@ -144,24 +139,65 @@ module Stripe
     end
   end
 
-  LEVEL_DEBUG = "debug"
-  LEVEL_INFO = "info"
+  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 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.
+  # 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)
-    if val != nil && ![LEVEL_DEBUG, LEVEL_INFO].include?(val)
-      raise ArgumentError, "log_level should only be set to `nil`, `debug` or `info`"
+    # 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
@@ -170,31 +206,44 @@ module Stripe
     @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.
   #
-  # Takes a name and optional version and plugin URL.
-  def self.set_app_info(name, version: nil, url: nil)
+  # Takes a name and optional  partner program ID, plugin URL, and version.
+  def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
     @app_info = {
       name: name,
+      partner_id: partner_id,
       url: url,
       version: version,
     }
   end
 
-  private
-
-  # 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
-  class << self
-    extend Gem::Deprecate
-    deprecate :uri_encode, "Stripe::Util#encode_parameters", 2016, 01
+
+  def self.verify_ssl_certs=(verify_ssl_certs)
+    @verify_ssl_certs = verify_ssl_certs
+    StripeClient.clear_all_connection_managers
   end
 end
 
-unless ENV["STRIPE_LOG"].nil?
-  Stripe.log_level = ENV["STRIPE_LOG"]
-end
+Stripe.log_level = ENV["STRIPE_LOG"] unless ENV["STRIPE_LOG"].nil?

data/stripe.gemspec

@@ -1,22 +1,34 @@
-$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+# frozen_string_literal: true
 
-require 'stripe/version'
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
 
-spec = Gem::Specification.new do |s|
-  s.name = 'stripe'
+require "stripe/version"
+
+Gem::Specification.new do |s|
+  s.name = "stripe"
   s.version = Stripe::VERSION
-  s.required_ruby_version = '>= 1.9.3'
-  s.summary = 'Ruby bindings for the Stripe API'
-  s.description = 'Stripe is the easiest way to accept payments online.  See https://stripe.com for details.'
-  s.author = 'Stripe'
-  s.email = 'support@stripe.com'
-  s.homepage = 'https://stripe.com/docs/api/ruby'
-  s.license = 'MIT'
+  s.required_ruby_version = ">= 2.3.0"
+  s.summary = "Ruby bindings for the Stripe API"
+  s.description = "Stripe is the easiest way to accept payments online.  " \
+                  "See https://stripe.com for details."
+  s.author = "Stripe"
+  s.email = "support@stripe.com"
+  s.homepage = "https://stripe.com/docs/api/ruby"
+  s.license = "MIT"
 
-  s.add_dependency('faraday', '~> 0.9')
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/stripe/stripe-ruby/issues",
+    "changelog_uri" =>
+      "https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://stripe.com/docs/api/ruby",
+    "github_repo" => "ssh://github.com/stripe/stripe-ruby",
+    "homepage_uri" => "https://stripe.com/docs/api/ruby",
+    "source_code_uri" => "https://github.com/stripe/stripe-ruby",
+  }
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
 end

data/test/openapi/README.md

@@ -0,0 +1,9 @@
+## Using custom OpenAPI specification and fixtures files
+
+You can place custom OpenAPI specification and fixtures files in this
+directory. The files must be in JSON format, and must be named `spec3.json`
+and `fixtures3.json` respectively.
+
+If those files are present, the test suite will start its own stripe-mock
+process on a random available port. In order for this to work, `stripe-mock`
+must be on the `PATH` in the environment used to run the test suite.

data/test/stripe/account_link_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __dir__)
+
+module Stripe
+  class AccountLinkTest < Test::Unit::TestCase
+    should "be creatable" do
+      link = Stripe::AccountLink.create(
+        account: "acct_123",
+        failure_url: "https://stripe.com/failure",
+        success_url: "https://stripe.com/success",
+        type: "custom_account_verification"
+      )
+      assert_requested :post, "#{Stripe.api_base}/v1/account_links"
+      assert link.is_a?(Stripe::AccountLink)
+    end
+  end
+end