stripe 13.4.1 → 17.0.1

data/CODE_OF_CONDUCT.md

@@ -1,77 +0,0 @@
-# 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/CONTRIBUTORS

@@ -1,3 +0,0 @@
-Greg Brockman <gdb@gregbrockman.com>
-Ross Boucher <rboucher@gmail.com>
-Bradley Grzesiak <brad@bendyworks.com>

data/Gemfile

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-group :development do
-  gem "mocha", "~> 1.16.0"
-  gem "rack", ">= 2.0.6"
-  gem "rake"
-
-  gem "shoulda-context", "2.0.0"
-
-  gem "test-unit"
-
-  # 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.
-  #
-  # The latest version of rubocop is only compatible with Ruby 2.7+
-  gem "rubocop", "1.57.2" if RUBY_VERSION >= "2.7"
-
-  gem "sorbet"
-  gem "tapioca"
-
-  platforms :mri do
-    gem "byebug"
-    gem "pry"
-    gem "pry-byebug"
-  end
-end

data/History.txt

@@ -1 +0,0 @@
-History.txt has been converted to a formal changelog. Please see CHANGELOG.md.

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) 2011- Stripe, Inc. (https://stripe.com)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Makefile

@@ -1,22 +0,0 @@
-# NOTE: this file is deprecated and slated for deletion; prefer using the equivalent `just` commands.
-
-.PHONY: update-version codegen-format test ci-test
-update-version:
-	@echo "$(VERSION)" > VERSION
-	@perl -pi -e 's|VERSION = "[.\-\w\d]+"|VERSION = "$(VERSION)"|' lib/stripe/version.rb
-
-codegen-format:
-	bundle install --quiet
-	bundle exec rubocop -o /dev/null --autocorrect
-
-ci-test:
-	bundle install && bundle exec rake test
-	@version=$$(ruby -e "puts RUBY_VERSION.split('.')[0..1].join.to_i"); \
-	if [ $$version -ge 27 ]; then \
-		echo "Ruby version >= 2.7, continue with srb tc"; \
-		bundle exec srb tc; \
-	else \
-		echo "Ruby version < 2.7, skipping srb tc"; \
-	fi
-
-test: ci-test

data/OPENAPI_VERSION

@@ -1 +0,0 @@
-v1463

data/README.md

@@ -1,422 +0,0 @@
-# Stripe Ruby Library
-
-[![Gem Version](https://badge.fury.io/rb/stripe.svg)](https://badge.fury.io/rb/stripe)
-[![Build Status](https://github.com/stripe/stripe-ruby/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/stripe/stripe-ruby/actions?query=branch%3Amaster)
-
-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
-classes for API resources that initialize themselves dynamically from API
-responses which makes it compatible with a wide range of versions of the Stripe
-API.
-
-The library also provides other features. For example:
-
-- 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
-
-See the [Ruby API docs](https://stripe.com/docs/api?lang=ruby).
-
-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
-want to use the package, just run:
-
-```sh
-gem install stripe
-```
-
-If you want to build the gem from source:
-
-```sh
-gem build stripe.gemspec
-```
-
-### Requirements
-
-- Ruby 2.3+.
-
-### Bundler
-
-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
-source 'https://rubygems.org'
-
-gem 'rails'
-gem 'stripe'
-```
-
-## Usage
-
-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_...'
-
-# list customers
-Stripe::Customer.list()
-
-# retrieve single customer
-Stripe::Customer.retrieve('cus_123456789')
-```
-
-### Per-request Configuration
-
-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"
-
-Stripe::Customer.list(
-  {},
-  {
-    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::Customer.retrieve(
-  {
-    id: 'cus_123456789',
-    expand: %w(balance_transaction)
-  },
-  {
-    stripe_version: '2018-02-28',
-    api_key: 'sk_test_...',
-  }
-)
-
-Stripe::Customer.capture(
-  'cus_123456789',
-  {},
-  {
-    stripe_version: '2018-02-28',
-    api_key: 'sk_test_...',
-  }
-)
-```
-
-Keep in mind that there are different method signatures depending on the action:
-
-- 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.
-
-### Accessing resource properties
-
-Both indexer and accessors can be used to retrieve values of resource properties.
-
-```ruby
-customer = Stripe::Customer.retrieve('cus_123456789')
-puts customer['id']
-puts customer.id
-```
-
-NOTE: If the resource property is not defined, the accessors will raise an exception, while the indexer will return `nil`.
-
-```ruby
-customer = Stripe::Customer.retrieve('cus_123456789')
-puts customer['unknown'] # nil
-puts customer.unknown # raises NoMethodError
-```
-
-### Accessing a response object
-
-Get access to response objects by using the `last_response` property of the returned resource:
-
-```ruby
-customer = Stripe::Customer.retrieve('cus_123456789')
-
-print(customer.last_response.http_status) # to retrieve status code
-print(customer.last_response.http_headers) # to retrieve headers
-```
-
-### 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:
-
-```ruby
-Stripe.api_version = '2018-02-28'
-```
-
-See [versioning in the API reference][versioning] for more information.
-
-### 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:
-
-```ruby
-Stripe.ca_bundle_path = 'path/to/ca/bundle'
-```
-
-### Configuring Automatic Retries
-
-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
-```
-
-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, read and write timeouts are configurable:
-
-```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
-some time, and a short timeout increases the likelihood of a problem within our
-servers.
-
-### Logging
-
-The library can be configured to emit logging that will give you better insight
-into what it's doing. The `info` logging level is usually most appropriate for
-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
-   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`)
-- `request_id`: HTTP request identifier. (`String`)
-- `response_header`: The response headers. (`Hash`)
-- `response_body` = The response body. (`String`)
-- `request_header` = The request headers. (`Hash`)
-- `request_body` = The request body. (`String`)
-
-#### Example
-
-For example:
-
-```ruby
-Stripe::Instrumentation.subscribe(:request_end) do |request_event|
-  # Filter out high-cardinality ids from `path`
-  path_parts = request_event.path.split("/").drop(2)
-  resource = path_parts.map { |part| part.match?(/\A[a-z_]+\z/) ? part : ":id" }.join("/")
-
-  tags = {
-    method: request_event.method,
-    resource: resource,
-    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`:
-
-```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.
-
-### Telemetry
-
-By default, the library sends telemetry to Stripe regarding request latency and feature usage. These
-numbers help Stripe improve the overall latency of its API for all users, and
-improve popular features.
-
-You can disable this behavior if you prefer:
-
-```ruby
-Stripe.enable_telemetry = false
-```
-
-### Beta SDKs
-
-Stripe has features in the beta phase that can be accessed via the beta version of this package.
-We would love for you to try these and share feedback with us before these features reach the stable phase.
-To install a beta version use `gem install` with the exact version you'd like to use:
-
-```sh
-gem install stripe -v 7.1.0.pre.beta.2
-```
-
-> **Note**
-> There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your Gemfile. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
-
-We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.
-
-If your beta feature requires a `Stripe-Version` header to be sent, set the `Stripe.api_version` field using `Stripe.add_beta_version`:
-
-```python
-Stripe.add_beta_version("feature_beta", "v3")
-```
-
-### Custom requests
-
-If you:
-
-- would like to send a request to an undocumented API (for example you are in a private beta)
-- prefer to bypass the method definitions in the library and specify your request details directly,
-- used the method `Stripe::APIResource.request(...)` to specify your own requests, which will soon be broken
-
-you can now use the `raw_request` method on `StripeClient`.
-
-```ruby
-client = Stripe::StripeClient.new(...)
-resp = client.raw_request(:post, "/v1/beta_endpoint", {param: 123}, {stripe_version: "2022-11-15; feature_beta=v3"})
-
-# (Optional) resp is a StripeResponse. You can use `Stripe.deserialize` to get a StripeObject.
-deserialized_resp = client.deserialize(resp.http_body)
-```
-
-## Support
-
-New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
-
-## Development
-
-[Contribution guidelines for this project](CONTRIBUTING.md)
-
-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):
-
-```sh
-go install github.com/stripe/stripe-mock@latest
-stripe-mock
-```
-
-We use [just](https://github.com/casey/just) for common development tasks. You can install it or run the underlying commands directly (by copying them from the `justfile`). Common tasks include:
-
-Run all tests:
-
-```sh
-just test
-# or: bundle exec rake test
-```
-
-Run a single test suite:
-
-```sh
-bundle exec ruby -Ilib/ test/stripe/util_test.rb
-```
-
-Run a single test:
-
-```sh
-bundle exec ruby -Ilib/ test/stripe/util_test.rb -n /should.convert.names.to.symbols/
-```
-
-Run the linter:
-
-```sh
-just lint
-# or: bundle exec rubocop
-```
-
-Update bundled CA certificates from the [Mozilla cURL release][curl]:
-
-```sh
-just update-certs
-# or: bundle exec rake update_certs
-```
-
-Update the bundled [stripe-mock] by editing the version number found in
-`.travis.yml`.
-
-[api-keys]: https://dashboard.stripe.com/account/apikeys
-[connect]: https://stripe.com/connect
-[curl]: http://curl.haxx.se/docs/caextract.html
-[idempotency-keys]: https://stripe.com/docs/api/idempotent_requests?lang=ruby
-[stripe-mock]: https://github.com/stripe/stripe-mock
-[versioning]: https://stripe.com/docs/api/versioning?lang=ruby
-[youtube-playlist]: https://www.youtube.com/playlist?list=PLy1nL-pvL2M50RmP6ie-gdcSnfOuQCRYk
-
-<!--
-# vim: set tw=79:
--->

data/Rakefile

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require "rake/testtask"
-
-task default: %i[test rubocop]
-
-Rake::TestTask.new do |t|
-  t.pattern = "./test/**/*_test.rb"
-end
-
-desc "Update bundled certs"
-task :update_certs do
-  require "net/http"
-  require "uri"
-
-  fetch_file "https://curl.haxx.se/ca/cacert.pem",
-             File.expand_path("lib/data/ca-certificates.crt", __dir__)
-end
-
-#
-# helpers
-#
-
-def fetch_file(uri, dest)
-  File.open(dest, "w") do |file|
-    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: #{uri}"
-  end
-end

data/VERSION

@@ -1 +0,0 @@
-13.4.1

data/examples/README.md

@@ -1,16 +0,0 @@
-## Running an example
-
-From the examples folder, run:
-`RUBYLIB=../lib ruby your_example.rb`
-
-e.g.
-
-`RUBYLIB=../lib ruby thinevent_webhook_handler.rb`
-
-## Adding a new example
-
-1. Clone new_example.rb
-2. Implement your example
-3. Fill out the file comment. Include a description and key steps that are being demonstrated.
-4. Run it (as per above)
-5. 👍

data/examples/example_template.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# example_template.py - This is a template for defining new examples.  It is not intended to be used directly.
-#
-# <describe what this example does>
-#
-# In this example, we:
-#   - <key step 1>
-#   - <key step 2
-#   - ...
-#
-# <describe assumptions about the user's stripe account, environment, or configuration;
-# or things to watch out for when running>
-
-require "stripe"
-require "date"
-
-class ExampleTemplate
-  attr_accessor :api_key
-
-  def initialize(api_key)
-    @api_key = api_key
-  end
-
-  def do_something_great
-    puts "Hello World"
-    # client = Stripe::StripeClient.new(api_key)
-    # client.v1
-  end
-end
-
-# Send meter events
-api_key = "{{API_KEY}}"
-
-example = ExampleTemplate.new(api_key)
-example.do_something_great