stripe 4.9.0 → 5.28.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@stripe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/Gemfile

@@ -7,27 +7,24 @@ gemspec
 group :development do
   gem "coveralls", require: false
   gem "mocha", "~> 0.13.2"
+  gem "rack", ">= 2.0.6"
   gem "rake"
-  gem "shoulda-context"
+
+  # Update to 2.0.0 once it ships.
+  gem "shoulda-context", "2.0.0.rc4"
+
   gem "test-unit"
-  gem "timecop"
-  gem "webmock"
+
+  # Version doesn't matter that much, but this one contains some fixes for Ruby
+  # 2.7 warnings that add noise to the test suite.
+  gem "webmock", ">= 3.8.0"
 
   # Rubocop changes pretty quickly: new cops get added and old cops change
   # names or go into new namespaces. This is a library and we don't have
   # `Gemfile.lock` checked in, so to prevent good builds from suddenly going
   # bad, pin to a specific version number here. Try to keep this relatively
   # up-to-date, but it's not the end of the world if it's not.
-  gem "rubocop", "0.50.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", ">= 2.0.6"
-  else
-    gem "rack", ">= 1.6.11", "< 2.0" # rubocop:disable Bundler/DuplicatedGem
-  end
+  gem "rubocop", "0.80"
 
   platforms :mri do
     gem "byebug"

data/README.md

@@ -1,5 +1,6 @@
 # Stripe Ruby Library
 
+[![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)
 
@@ -11,11 +12,9 @@ API.
 
 The library also provides other features. For example:
 
-* Easy configuration path for fast setup and use.
-* Helpers for pagination.
-* Tracking of "fresh" values in API resources so that partial updates can be
-  executed.
-* Built-in mechanisms for the serialization of parameters according to the
+- Easy configuration path for fast setup and use.
+- Helpers for pagination.
+- Built-in mechanisms for the serialization of parameters according to the
   expectations of Stripe's API.
 
 ## Documentation
@@ -27,15 +26,19 @@ See the [Ruby API docs](https://stripe.com/docs/api/ruby#intro).
 You don't need this source code unless you want to modify the gem. If you just
 want to use the package, just run:
 
-    gem install stripe
+```sh
+gem install stripe
+```
 
 If you want to build the gem from source:
 
-    gem build stripe.gemspec
+```sh
+gem build stripe.gemspec
+```
 
 ### Requirements
 
-* Ruby 2.0+.
+- Ruby 2.3+.
 
 ### Bundler
 
@@ -43,7 +46,7 @@ If you are installing via bundler, you should be sure to use the https rubygems
 source in your Gemfile, as any gems fetched over http could potentially be
 compromised in transit and alter the code of gems fetched securely over https:
 
-``` ruby
+```ruby
 source 'https://rubygems.org'
 
 gem 'rails'
@@ -56,17 +59,15 @@ The library needs to be configured with your account's secret key which is
 available in your [Stripe Dashboard][api-keys]. Set `Stripe.api_key` to its
 value:
 
-``` ruby
-require "stripe"
-Stripe.api_key = "sk_test_..."
+```ruby
+require 'stripe'
+Stripe.api_key = 'sk_test_...'
 
-# list charges
-Stripe::Charge.list()
+# list customers
+Stripe::Customer.list()
 
-# retrieve single charge
-Stripe::Charge.retrieve(
-  "ch_18atAXCdGbJFKhCuBAa4532Z",
-)
+# retrieve single customer
+Stripe::Customer.retrieve('cus_123456789')
 ```
 
 ### Per-request Configuration
@@ -75,51 +76,87 @@ 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
+```ruby
 require "stripe"
 
-Stripe::Charge.list(
+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',
+  {
+    api_key: 'sk_test_...',
+    stripe_account: 'acct_...',
+    stripe_version: '2018-02-28',
   }
 )
 
-Stripe::Charge.retrieve(
-  "ch_18atAXCdGbJFKhCuBAa4532Z",
+Stripe::Customer.retrieve(
+  {
+    id: 'cus_123456789',
+    expand: %w(balance_transaction)
+  },
+  {
+    stripe_version: '2018-02-28',
+    api_key: 'sk_test_...',
+  }
+)
+
+Stripe::Customer.capture(
+  'cus_123456789',
+  {},
   {
-    :api_key => "sk_test_...",
-    :stripe_account => "acct_...",
-    :stripe_version => "2018-02-28"
+    stripe_version: '2018-02-28',
+    api_key: 'sk_test_...',
   }
 )
 ```
 
-### Configuring a Client
+Keep in mind that there are different method signatures depending on the action:
 
-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:
+- When operating on a collection (e.g. `.list`, `.create`) the method signature is
+  `method(params, opts)`.
+- When operating on resource (e.g. `.capture`, `.update`) the method signature is
+  `method(id, params, opts)`.
+- One exception is that `retrieve`, despite being an operation on a resource, has the signature
+  `retrieve(id, opts)`. In addition, it will accept a Hash for the `id` param but will extract the
+  `id` key out and use the others as options.
 
-``` ruby
-conn = Faraday.new
-client = Stripe::StripeClient.new(conn)
-charge, resp = client.request do
-  Stripe::Charge.retrieve(
-    "ch_18atAXCdGbJFKhCuBAa4532Z",
-  )
+### Accessing a response object
+
+Get access to response objects by initializing a client and using its `request`
+method:
+
+```ruby
+client = Stripe::StripeClient.new
+customer, resp = client.request do
+  Stripe::Customer.retrieve('cus_123456789',)
 end
 puts resp.request_id
 ```
 
+### Configuring a proxy
+
+A proxy can be configured with `Stripe.proxy`:
+
+```ruby
+Stripe.proxy = 'https://user:pass@example.com:1234'
+```
+
 ### Configuring an API Version
 
 By default, the library will use the API version pinned to the account making
 a request. This can be overridden with this global option:
 
-    Stripe.api_version = "2018-02-28"
+```ruby
+Stripe.api_version = '2018-02-28'
+```
 
 See [versioning in the API reference][versioning] for more information.
 
@@ -128,25 +165,33 @@ See [versioning in the API reference][versioning] for more information.
 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"
+```ruby
+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:
+You can enable automatic retries on requests that fail due to a transient
+problem by configuring the maximum number of retries:
+
+```ruby
+Stripe.max_network_retries = 2
+```
 
-    Stripe.max_network_retries = 2
+Various errors can trigger a retry, like a connection error or a timeout, and
+also certain API responses like HTTP status `409 Conflict`.
 
 [Idempotency keys][idempotency-keys] are added to requests to guarantee that
 retries are safe.
 
 ### Configuring Timeouts
 
-Open and read timeouts are configurable:
+Open, read and write timeouts are configurable:
 
-```java
-Stripe.open_timeout = 30 // in seconds
+```ruby
+Stripe.open_timeout = 30 # in seconds
 Stripe.read_timeout = 80
+Stripe.write_timeout = 30 # only supported on Ruby 2.6+
 ```
 
 Please take care to set conservative read timeouts. Some API requests can take
@@ -162,53 +207,129 @@ production use, but `debug` is also available for more verbosity.
 There are a few options for enabling it:
 
 1. Set the environment variable `STRIPE_LOG` to the value `debug` or `info`:
-   ```
+
+   ```sh
    $ export STRIPE_LOG=info
    ```
 
 2. Set `Stripe.log_level`:
-   ``` ruby
+
+   ```ruby
    Stripe.log_level = Stripe::LEVEL_INFO
    ```
 
+### Instrumentation
+
+The library has various hooks that user code can tie into by passing a block to
+`Stripe::Instrumentation.subscribe` to be notified about specific events.
+
+#### `request_begin`
+
+Invoked when an HTTP request starts. Receives `RequestBeginEvent` with the
+following properties:
+
+- `method`: HTTP method. (`Symbol`)
+- `path`: Request path. (`String`)
+- `user_data`: A hash on which users can set arbitrary data, and which will be
+  passed through to `request_end` invocations. This could be used, for example,
+  to assign unique IDs to each request, and it'd work even if many requests are
+  running in parallel. All subscribers share the same object for any particular
+  request, so they must be careful to use unique keys that will not conflict
+  with other subscribers. (`Hash`)
+
+#### `request_end`
+
+Invoked when an HTTP request finishes, regardless of whether it terminated with
+a success or error. Receives `RequestEndEvent` with the following properties:
+
+- `duration`: Request duration in seconds. (`Float`)
+- `http_status`: HTTP response code (`Integer`) if available, or `nil` in case
+  of a lower level network error.
+- `method`: HTTP method. (`Symbol`)
+- `num_retries`: The number of retries. (`Integer`)
+- `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`)
+
+#### Example
+
+For example:
+
+```ruby
+Stripe::Instrumentation.subscribe(:request_end) do |request_event|
+  tags = {
+    method: request_event.method,
+    resource: request_event.path.split('/')[2],
+    code: request_event.http_status,
+    retries: request_event.num_retries
+  }
+  StatsD.distribution('stripe_request', request_event.duration, tags: tags)
+end
+```
+
 ### Writing a Plugin
 
 If you're writing a plugin that uses the library, we'd appreciate it if you
 identified using `#set_app_info`:
 
-    Stripe.set_app_info("MyAwesomePlugin", version: "1.2.34", url: "https://myawesomeplugin.info");
+```ruby
+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
 API.
 
+### Request latency telemetry
+
+By default, the library sends request latency telemetry to Stripe. These
+numbers help Stripe improve the overall latency of its API for all users.
+
+You can disable this behavior if you prefer:
+
+```ruby
+Stripe.enable_telemetry = false
+```
+
 ## Development
 
 The test suite depends on [stripe-mock], so make sure to fetch and run it from a
 background terminal ([stripe-mock's README][stripe-mock] also contains
 instructions for installing via Homebrew and other methods):
 
-    go get -u github.com/stripe/stripe-mock
-    stripe-mock
+```sh
+go get -u github.com/stripe/stripe-mock
+stripe-mock
+```
 
 Run all tests:
 
-    bundle exec rake test
+```sh
+bundle exec rake test
+```
 
 Run a single test suite:
 
-    bundle exec ruby -Ilib/ test/stripe/util_test.rb
+```sh
+bundle exec ruby -Ilib/ test/stripe/util_test.rb
+```
 
 Run a single test:
 
-    bundle exec ruby -Ilib/ test/stripe/util_test.rb -n /should.convert.names.to.symbols/
+```sh
+bundle exec ruby -Ilib/ test/stripe/util_test.rb -n /should.convert.names.to.symbols/
+```
 
 Run the linter:
 
-    bundle exec rake rubocop
+```sh
+bundle exec rake rubocop
+```
 
 Update bundled CA certificates from the [Mozilla cURL release][curl]:
 
-    bundle exec rake update_certs
+```sh
+bundle exec rake update_certs
+```
 
 Update the bundled [stripe-mock] by editing the version number found in
 `.travis.yml`.
@@ -216,7 +337,6 @@ Update the bundled [stripe-mock] by editing the version number found in
 [api-keys]: https://dashboard.stripe.com/account/apikeys
 [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
 [stripe-mock]: https://github.com/stripe/stripe-mock
 [versioning]: https://stripe.com/docs/api/ruby#versioning