stripe 15.6.0.pre.beta.1 → 16.0.0

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/CONTRIBUTING.md

@@ -1,25 +0,0 @@
-
-# Contributing
-
-We welcome bug reports, feature requests, and code contributions in a pull request.
-
-For most pull requests, we request that you identify or create an associated issue that has the necessary context. We use these issues to reach agreement on an approach and save the PR author from having to redo work. Fixing typos or documentation issues likely do not need an issue; for any issue that introduces substantial code changes, changes the public interface, or if you aren't sure, please find or [create an issue](https://www.github.com/stripe/stripe-ruby/issues/new/choose).
-
-## Contributor License Agreement
-
-All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agreement, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant.
-
-## Generated code
-
-This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution.
-
-To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. 
-
-## Compatibility with supported language and runtime versions
-
-This project supports [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward.
-
-## Set up your dev environment
-
-Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment.
-

data/CONTRIBUTORS

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

data/Gemfile

@@ -1,41 +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.75.2" if RUBY_VERSION >= "2.7"
-
-  gem "sorbet"
-  gem "tapioca"
-
-  platforms :mri do
-    gem "byebug"
-    gem "pry"
-    gem "pry-byebug"
-  end
-
-  platforms :jruby do
-    gem "rbi", "0.2.4" # jruby does not support rbs, a new dependency in 0.3.0
-  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 @@
-v1932

data/README.md

@@ -1,424 +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).
-
-## 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'
-
-client = Stripe::StripeClient.new("sk_test_...")
-
-# list customers
-customers = client.v1.customers.list()
-
-# retrieve single customer 
-customer = client.v1.customers.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"
-
-client = Stripe::StripeClient.new("sk_test_...")
-
-client.v1.customers.list(
-  {},
-  {
-    api_key: 'sk_test_...',
-    stripe_account: 'acct_...',
-    stripe_version: '2018-02-28',
-  }
-)
-```
-
-### StripeClient vs legacy pattern
-
-We introduced the `StripeClient` class in v13 of the Ruby SDK. The legacy pattern used prior to that version is still available to use but will be marked as deprecated soon. Review the [migration guide to use StripeClient](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v13) to move from the legacy pattern.
-
-Once the legacy pattern is deprecated, new API endpoints will only be accessible in the StripeClient. While there are no current plans to remove the legacy pattern for existing API endpoints, this may change in the future.
-
-### Accessing resource properties
-
-Both indexer and accessors can be used to retrieve values of resource properties.
-
-```ruby
-customer = client.v1.customers.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 = client.v1.customers.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 = client.v1.customers.retrieve('cus_123456789')
-
-print(customer.last_response.http_status) # to retrieve status code
-print(customer.last_response.http_headers) # to retrieve headers
-```
-
-If you are accessing a response field with custom hashes provided by you, such as `Customer.metadata`,
-please access your fields with the `[]` accessor.
-
-### 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
-```
-
-### Types
-
-In [v14.0.0](https://github.com/stripe/stripe-python/releases/tag/v7.1.0) and newer, the library provides RBI
-static type annotations. See [the wiki](https://github.com/stripe/stripe-ruby/wiki/Static-Type-Annotations)
-for an detailed guide.
-
-Please note that these types are available only for static analysis and we only support RBIs at the moment.
-Please [report an issue](https://github.com/stripe/stripe-ruby/issues/new/choose)
-if you find discrepancies or have issues using types.
-
-The RBIs can be found in the `rbi/stripe/` directory, and to decrease `Tapioca` loading time we pack the gem with the
-combined RBI at `rbi/stripe.rbi`.
-
-#### Types and the Versioning Policy
-
-We release type changes in minor releases. While stripe-ruby follows semantic versioning, our semantic
-versions describe the runtime behavior of the library alone. Our type annotations are not reflected in the
-semantic version. That is, upgrading to a new minor version of `stripe-ruby` might result in your type checker
-producing a type error that it didn't before. You can use `~> x.x` or `x.x.x` constrain the version
-of `stripe-ruby` in your Gemfile to a certain version or range of `stripe-ruby`.
-
-#### Types and API Versions
-
-The types describe the [Stripe API version](https://stripe.com/docs/api/versioning)
-that was the latest at the time of release. This is the version that your library sends
-by default. If you are overriding `Stripe.api_version` / `stripe_version` on the StripeClient,
-or using a webhook endpoint tied to an older version, be aware that the data
-you see at runtime may not match the types.
-
-### Public Preview SDKs
-
-Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-beta.X` suffix like `11.2.0-beta.2`.
-We would love for you to try these as we incrementally release new features and improve them based on your feedback.
-
-To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-ruby/releases/) and use it in the `gem install` command:
-
-```sh
-gem install stripe -v <replace-with-the-version-of-your-choice>
-```
-
-You can find the latest version to use in this command from the [releases page](https://github.com/stripe/stripe-ruby/releases/)
-
-> **Note**
-> There can be breaking changes between two versions of the public preview SDKs without a bump in the major version. Therefore we recommend pinning the package version to a specific 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 version of the public preview SDK.
-
-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.
-
-Some preview features require a name and version to be set in the `Stripe-Version` header like `feature_beta=v3`. If your preview feature has this requirement, use the `Stripe.add_beta_version` function (available only in the public preview SDKs):
-
-```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 was removed in v13+
-
-you can now use the `raw_request` method on `StripeClient`.
-
-```ruby
-client = Stripe::StripeClient.new('sk_test_...')
-resp = client.raw_request(:post, "/v1/beta_endpoint", params: {param: 123}, opts: {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
-
-<!--
-# 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 @@
-15.6.0-beta.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. 👍