stripe 1.58.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62e0a925e86bf0a18b48c88a9a359241075cd94a
-  data.tar.gz: 8de490482c9fd1a2e7e8d5bd28ac8eb34a0276c6
+  metadata.gz: fe6ecafb3e94d2c21da1cad428be4ac9fda47ed9
+  data.tar.gz: d69bf4b5289a9661d3d8a9383bb4acea4cb2c0b9
 SHA512:
-  metadata.gz: bf4525ce47f09b015d0a450667df948a15794538b13c076aefa0ba147d7d6829e344abd7c61285f38c2fcbad7a859f708942a661fe6521b4f76357383627ca6d
-  data.tar.gz: b86195048056fb06aade87235e6bf46c7d642101bf55b7bfd1f3375bf9f741ff522c22f1b74cee3fa4c7d8228a47f1fd53bf548e89b243e8af5826f5ebef3393
+  metadata.gz: 381878036316652650840edfa24814e60b21ce6813a9e8cc4a5e58ff000349434d7947e63e51390d962d817755e0b40b68a1370781262b982cef93aa90296879
+  data.tar.gz: 9afa8b57e838b7a44264f302afbb2c9b62c40176dc699a17ff83fb5fe50c4c481f0cf7de3f83dd7c7ec70211dc466d5a22e290b3157cbb2ed34bc10562871bac

data/.gitattributes

@@ -0,0 +1,4 @@
+# may be useful in hiding large schema changes in pull request diffs (but not
+# using it for now)
+spec/*.json binary
+spec/*.yaml binary

data/.travis.yml

@@ -1,12 +1,11 @@
 language: ruby
 
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
   - 2.3.0
-  - jruby-19mode
+  - 2.4.0
   - jruby-9.0.5.0
 
 notifications:

data/Gemfile

@@ -3,23 +3,21 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
+  gem 'committee', '2.0.0.pre6'
   gem 'mocha', '~> 0.13.2'
-  gem 'pry'
   gem 'rake'
   gem 'shoulda-context'
+  gem 'sinatra'
   gem 'test-unit'
+  gem 'webmock'
 
-  # mime-types has become only compatible with Ruby versions > 2 and we're
-  # still supporting 1.9 for the time being. Lock to old versions of
-  # mime-types and rest-client which are known to work in our Gemfile (it's
-  # fine to use newer versions in live environments so we don't have these in
-  # the gemspec).
-  #
-  #     https://github.com/travis-ci/travis-ci/issues/5145
-  #
-  if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0')
-    gem 'mime-types', '2.6.2'
-    gem 'rest-client', '1.8.0'
+  # Rack 2.0+ requires Ruby >= 2.2.2 which is problematic for the test suite on
+  # older Ruby versions. Check Ruby the version here and put a maximum
+  # constraint on Rack if necessary.
+  if RUBY_VERSION >= '2.2.2'
+    gem "rack", ">= 1.5"
+  else
+    gem "rack", ">= 1.5", "< 2.0"
   end
 
   platforms :mri do
@@ -27,6 +25,7 @@ group :development do
     # it's known to work well
     if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.0.0')
       gem 'byebug'
+      gem 'pry'
       gem 'pry-byebug'
     end
   end

data/History.txt

@@ -1,3 +1,11 @@
+=== 2.0.0 2017-02-14
+
+* Drop support for Ruby 1.9
+* Allow HTTP client that makes Stripe calls to be configured via Faraday
+* Drop RestClient
+* Switch to OpenAPI 2.0 spec and generated fixtures in test suite
+* Switch to Webmock in test suite
+
 === 1.58.0 2017-01-19
 
 * Remove erroneously added list methods for `Source` model

data/README.md

@@ -32,8 +32,7 @@ If you want to build the gem from source:
 
 ### Requirements
 
-* Ruby 1.9.3 or above.
-* rest-client
+* Ruby 2.0+.
 
 ### Bundler
 
@@ -51,8 +50,8 @@ gem 'stripe'
 ## Usage
 
 The library needs to be configured with your account's secret key which is
-available in the [Dashboard][dashboard]. Assign its value to `Stripe.api_key`
-and the library will send it along automatically with every request:
+available in your [Stripe Dashboard][dashboard]. Set `Stripe.api_key` to its
+value:
 
 ``` ruby
 require "stripe"
@@ -67,14 +66,11 @@ Stripe::Charge.retrieve(
 )
 ```
 
-You can also set a per-request key and/or account like in the examples below.
-This is often useful for Connect applications that use multiple API keys during
-the lifetime of a process.
+### Per-request Configuration
 
-Authentication is transparently handled for you in subsequent method calls on
-the returned object.
-
-For example:
+For apps that need to use multiple keys during the lifetime of a process, like
+one that uses [Stripe Connect][connect], it's also possible to set a
+per-request key and/or account:
 
 ``` ruby
 require "stripe"
@@ -92,6 +88,40 @@ Stripe::Charge.retrieve(
 )
 ```
 
+### Configuring a Client
+
+While a default HTTP client is used by default, it's also possible to have the
+library use any client supported by [Faraday][faraday] by initializing a
+`Stripe::StripeClient` object and giving it a connection:
+
+``` ruby
+conn = Faraday.new
+client = Stripe::StripeClient.new(conn)
+client.request do
+  charge, resp = Stripe::Charge.retrieve(
+    "ch_18atAXCdGbJFKhCuBAa4532Z",
+  )
+end
+puts resp.request_id
+```
+
+### Configuring CA Bundles
+
+By default, the library will use its own internal bundle of known CA
+certificates, but it's possible to configure your own:
+
+    Stripe.ca_bundle_path = "path/to/ca/bundle"
+
+### Configuring Automatic Retries
+
+The library can be configured to automatically retry requests that fail due to
+an intermittent network problem:
+
+    Stripe.max_network_retries = 2
+
+[Idempotency keys][idempotency-keys] are added to requests to guarantee that
+retries are safe.
+
 ## Development
 
 Run all tests:
@@ -110,25 +140,8 @@ Update bundled CA certificates from the [Mozilla cURL release][curl]:
 
     bundle exec rake update_certs
 
-## Configuration
-
-### ca_bundle_path
-
-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.
-
-### max_network_retries
-
-When `max_network_retries` is set to a positive integer, stripe will retry
-requests that fail on a network error. Idempotency keys will be added to `POST`
-and `DELETE` requests to ensure the safety of retrying. There will be a short delay
-between each retry, with an exponential backoff algorithm used to determine the
-length of the delay. Default value is 0.
-
-Example:
-
-    Stripe.max_network_retries = 2
-
+[connect]: https://stripe.com/connect
 [curl]: http://curl.haxx.se/docs/caextract.html
+[faraday]: https://github.com/lostisland/faraday
+[idempotency-keys]: https://stripe.com/docs/api/ruby#idempotent_requests
 [dashboard]: https://dashboard.stripe.com/account

data/Rakefile

@@ -10,7 +10,7 @@ desc "update bundled certs"
 task :update_certs do
   require "restclient"
   File.open(File.join(File.dirname(__FILE__), 'lib', 'data', 'ca-certificates.crt'), 'w') do |file|
-    resp = RestClient.get "https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt"
+    resp = Faraday.get "https://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt"
     abort("bad response when fetching bundle") unless resp.code == 200
     file.write(resp.to_str)
   end

data/VERSION

@@ -1 +1 @@
-1.58.0
+2.0.0

data/lib/stripe.rb

@@ -6,7 +6,7 @@ require 'rbconfig'
 require 'set'
 require 'socket'
 
-require 'rest-client'
+require 'faraday'
 require 'json'
 
 # Version
@@ -22,7 +22,9 @@ require 'stripe/api_operations/request'
 # 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'
@@ -66,35 +68,6 @@ require 'stripe/transfer'
 module Stripe
   DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
 
-  # Exceptions which we'd like to retry. This includes both socket errors that
-  # may represent an intermittent problem and some special HTTP statuses.
-  RETRY_EXCEPTIONS = [
-    # Destination refused the connection. This could occur from a single
-    # saturated server, so retry in case it's intermittent.
-    Errno::ECONNREFUSED,
-
-    # Connection reset. This occasionally occurs on a server problem, and
-    # deserves a retry because the server should terminate all requests
-    # properly even if they were invalid.
-    Errno::ECONNRESET,
-
-    # Timed out making the connection. It's worth retrying under this
-    # circumstance.
-    Errno::ETIMEDOUT,
-
-    # A server may respond with a 409 to indicate that there is a concurrent
-    # request executing with the same idempotency key. In the case that a
-    # request failed due to a connection problem and the client has retried too
-    # early, but the server is still executing the old request, we would like
-    # the client to continue retrying until getting a "real" response status
-    # back.
-    RestClient::Conflict,
-
-    # Retry on timeout-related problems. This shouldn't be lumped in with HTTP
-    # exceptions, but with RestClient it is.
-    RestClient::RequestTimeout,
-  ].freeze
-
   @api_base = 'https://api.stripe.com'
   @connect_base = 'https://connect.stripe.com'
   @uploads_base = 'https://uploads.stripe.com'
@@ -103,7 +76,7 @@ module Stripe
   @max_network_retry_delay = 2
   @initial_network_retry_delay = 0.5
 
-  @ca_bundle_path  = DEFAULT_CA_BUNDLE_PATH
+  @ca_bundle_path = DEFAULT_CA_BUNDLE_PATH
   @ca_store = nil
   @verify_ssl_certs = true
 
@@ -117,10 +90,6 @@ module Stripe
     attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 
-  def self.api_url(url='', api_base_url=nil)
-    (api_base_url || @api_base) + url
-  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.
@@ -152,62 +121,6 @@ module Stripe
     end
   end
 
-  def self.request(method, url, api_key, params={}, headers={}, api_base_url=nil)
-    api_base_url = api_base_url || @api_base
-
-    unless api_key ||= @api_key
-      raise AuthenticationError.new('No API key provided. ' \
-        'Set your API key using "Stripe.api_key = <API-KEY>". ' \
-        'You can generate API keys from the Stripe web interface. ' \
-        'See https://stripe.com/api for details, or email support@stripe.com ' \
-        'if you have any questions.')
-    end
-
-    if api_key =~ /\s/
-      raise AuthenticationError.new('Your API key is invalid, as it contains ' \
-        'whitespace. (HINT: You can double-check your API key from the ' \
-        'Stripe web interface. See https://stripe.com/api for details, or ' \
-        'email support@stripe.com if you have any questions.)')
-    end
-
-    if verify_ssl_certs
-      request_opts = {:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
-                      :ssl_cert_store => ca_store}
-    else
-      request_opts = {:verify_ssl => false}
-      unless @verify_ssl_warned
-        @verify_ssl_warned = true
-        $stderr.puts("WARNING: Running without SSL cert verification. " \
-          "You should never do this in production. " \
-          "Execute 'Stripe.verify_ssl_certs = true' to enable verification.")
-      end
-    end
-
-    params = Util.objects_to_ids(params)
-    url = api_url(url, api_base_url)
-
-    case method.to_s.downcase.to_sym
-    when :get, :head, :delete
-      # Make params into GET parameters
-      url += "#{URI.parse(url).query ? '&' : '?'}#{Util.encode_parameters(params)}" if params && params.any?
-      payload = nil
-    else
-      if headers[:content_type] && headers[:content_type] == "multipart/form-data"
-        payload = params
-      else
-        payload = Util.encode_parameters(params)
-      end
-    end
-
-    request_opts.update(:headers => request_headers(api_key, method).update(headers),
-                        :method => method, :open_timeout => open_timeout,
-                        :payload => payload, :url => url, :timeout => read_timeout)
-
-    response = execute_request_with_rescues(request_opts, api_base_url)
-
-    [parse(response), api_key]
-  end
-
   def self.max_network_retries
     @max_network_retries
   end
@@ -218,242 +131,6 @@ module Stripe
 
   private
 
-  def self.api_error(error, resp, error_obj)
-    APIError.new(error[:message], resp.code, resp.body, error_obj, resp.headers)
-  end
-
-  def self.authentication_error(error, resp, error_obj)
-    AuthenticationError.new(error[:message], resp.code, resp.body, error_obj,
-                            resp.headers)
-  end
-
-  def self.card_error(error, resp, error_obj)
-    CardError.new(error[:message], error[:param], error[:code],
-                  resp.code, resp.body, error_obj, resp.headers)
-  end
-
-  def self.execute_request(opts)
-    RestClient::Request.execute(opts)
-  end
-
-  def self.execute_request_with_rescues(request_opts, api_base_url, retry_count = 0)
-    begin
-      response = execute_request(request_opts)
-
-    # We rescue all exceptions from a request so that we have an easy spot to
-    # implement our retry logic across the board. We'll re-raise if it's a type
-    # of exception that we didn't expect to handle.
-    rescue => e
-      if should_retry?(e, retry_count)
-        retry_count = retry_count + 1
-        sleep sleep_time(retry_count)
-        retry
-      end
-
-      case e
-      when SocketError
-        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
-
-      when RestClient::ExceptionWithResponse
-        if e.response
-          handle_api_error(e.response)
-        else
-          response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
-        end
-
-      when RestClient::Exception, Errno::ECONNREFUSED, OpenSSL::SSL::SSLError
-        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
-
-      # Only handle errors when we know we can do so, and re-raise otherwise.
-      # This should be pretty infrequent.
-      else
-        raise
-      end
-    end
-
-    response
-  end
-
-  def self.general_api_error(rcode, rbody)
-    APIError.new("Invalid response object from API: #{rbody.inspect} " +
-                 "(HTTP response code was #{rcode})", rcode, rbody)
-  end
-
-  def self.get_uname
-    if File.exist?('/proc/version')
-      File.read('/proc/version').strip
-    else
-      case RbConfig::CONFIG['host_os']
-      when /linux|darwin|bsd|sunos|solaris|cygwin/i
-        get_uname_from_system
-      when /mswin|mingw/i
-        get_uname_from_system_ver
-      else
-        "unknown platform"
-      end
-    end
-  end
-
-  def self.get_uname_from_system
-    (`uname -a 2>/dev/null` || '').strip
-  rescue Errno::ENOENT
-    "uname executable not found"
-  rescue Errno::ENOMEM # couldn't create subprocess
-    "uname lookup failed"
-  end
-
-  def self.get_uname_from_system_ver
-    (`ver` || '').strip
-  rescue Errno::ENOENT
-    "ver executable not found"
-  rescue Errno::ENOMEM # couldn't create subprocess
-    "uname lookup failed"
-  end
-
-  def self.handle_api_error(resp)
-    begin
-      error_obj = JSON.parse(resp.body)
-      error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error]
-      raise StripeError.new unless error && error.is_a?(Hash)
-
-    rescue JSON::ParserError, StripeError
-      raise general_api_error(resp.code, resp.body)
-    end
-
-    case resp.code
-    when 400, 404
-      raise invalid_request_error(error, resp, error_obj)
-    when 401
-      raise authentication_error(error, resp, error_obj)
-    when 402
-      raise card_error(error, resp, error_obj)
-    when 403
-      raise permission_error(error, resp, error_obj)
-    when 429
-      raise rate_limit_error(error, resp, error_obj)
-    else
-      raise api_error(error, resp, error_obj)
-    end
-
-  end
-
-  def self.handle_restclient_error(e, request_opts, retry_count, api_base_url=nil)
-
-    api_base_url = @api_base unless api_base_url
-    connection_message = "Please check your internet connection and try again. " \
-        "If this problem persists, you should check Stripe's service status at " \
-        "https://twitter.com/stripestatus, or let us know at support@stripe.com."
-
-    case e
-    when RestClient::RequestTimeout
-      message = "Could not connect to Stripe (#{api_base_url}). #{connection_message}"
-
-    when RestClient::ServerBrokeConnection
-      message = "The connection to the server (#{api_base_url}) broke before the " \
-        "request completed. #{connection_message}"
-
-    when OpenSSL::SSL::SSLError
-      message = "Could not establish a secure connection to Stripe, you may " \
-                "need to upgrade your OpenSSL version. To check, try running " \
-                "'openssl s_client -connect api.stripe.com:443' from the " \
-                "command line."
-
-    when RestClient::SSLCertificateNotVerified
-      message = "Could not verify Stripe's SSL certificate. " \
-        "Please make sure that your network is not intercepting certificates. " \
-        "(Try going to https://api.stripe.com/v1 in your browser.) " \
-        "If this problem persists, let us know at support@stripe.com."
-
-    when SocketError
-      message = "Unexpected error communicating when trying to connect to Stripe. " \
-        "You may be seeing this message because your DNS is not working. " \
-        "To check, try running 'host stripe.com' from the command line."
-
-    else
-      message = "Unexpected error communicating with Stripe. " \
-        "If this problem persists, let us know at support@stripe.com."
-
-    end
-
-    if retry_count > 0
-      message += " Request was retried #{retry_count} times."
-    end
-
-    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
-  end
-
-  def self.invalid_request_error(error, resp, error_obj)
-    InvalidRequestError.new(error[:message], error[:param], resp.code,
-                            resp.body, error_obj, resp.headers)
-  end
-
-  def self.parse(response)
-    begin
-      # Would use :symbolize_names => true, but apparently there is
-      # some library out there that makes symbolize_names not work.
-      response = JSON.parse(response.body)
-    rescue JSON::ParserError
-      raise general_api_error(response.code, response.body)
-    end
-
-    Util.symbolize_names(response)
-  end
-
-  def self.permission_error(error, resp, error_obj)
-    PermissionError.new(error[:message], resp.code, resp.body, error_obj, resp.headers)
-  end
-
-  def self.rate_limit_error(error, resp, error_obj)
-    RateLimitError.new(error[:message], resp.code, resp.body, error_obj,
-                       resp.headers)
-  end
-
-  def self.request_headers(api_key, method)
-    headers = {
-      'User-Agent' => "Stripe/v1 RubyBindings/#{Stripe::VERSION}",
-      'Authorization' => "Bearer #{api_key}",
-      'Content-Type' => 'application/x-www-form-urlencoded'
-    }
-
-    # It is only safe to retry network failures on post and delete
-    # requests if we add an Idempotency-Key header
-    if [:post, :delete].include?(method) && self.max_network_retries > 0
-      headers['Idempotency-Key'] ||= SecureRandom.uuid
-    end
-
-    headers['Stripe-Version'] = api_version if api_version
-    headers['Stripe-Account'] = stripe_account if stripe_account
-
-    begin
-      headers.update('X-Stripe-Client-User-Agent' => JSON.generate(user_agent))
-    rescue => e
-      headers.update('X-Stripe-Client-Raw-User-Agent' => user_agent.inspect,
-                     :error => "#{e} (#{e.class})")
-    end
-  end
-
-  def self.should_retry?(e, retry_count)
-    retry_count < self.max_network_retries &&
-      RETRY_EXCEPTIONS.any? { |klass| e.is_a?(klass) }
-  end
-
-  def self.sleep_time(retry_count)
-    # Apply exponential backoff with initial_network_retry_delay on the number
-    # of attempts so far as inputs. Do not allow the number to exceed
-    # max_network_retry_delay.
-    sleep_seconds = [initial_network_retry_delay * (2 ** (retry_count - 1)), max_network_retry_delay].min
-
-    # Apply some jitter by randomizing the value in the range of (sleep_seconds
-    # / 2) to (sleep_seconds).
-    sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
-
-    # But never sleep less than the base sleep seconds.
-    sleep_seconds = [initial_network_retry_delay, sleep_seconds].max
-
-    sleep_seconds
-  end
-
   # DEPRECATED. Use `Util#encode_parameters` instead.
   def self.uri_encode(params)
     Util.encode_parameters(params)
@@ -462,21 +139,4 @@ module Stripe
     extend Gem::Deprecate
     deprecate :uri_encode, "Stripe::Util#encode_parameters", 2016, 01
   end
-
-  def self.user_agent
-    @uname ||= get_uname
-    lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
-
-    {
-      :bindings_version => Stripe::VERSION,
-      :lang => 'ruby',
-      :lang_version => lang_version,
-      :platform => RUBY_PLATFORM,
-      :engine => defined?(RUBY_ENGINE) ? RUBY_ENGINE : '',
-      :publisher => 'stripe',
-      :uname => @uname,
-      :hostname => Socket.gethostname,
-    }
-
-  end
 end