stripe 5.41.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd45fe315151a7731bb10cc98d81b8db23a24d4defefc1faca38591d5f5484b
-  data.tar.gz: 5d4db093fa51a3e11cd63bc52deca194c50efa421ccb6845b74f76b3992e3c79
+  metadata.gz: e7dfdb00614bcd3674779d258240b4c5e9cf5cb6806a9bc456d2384b19f652be
+  data.tar.gz: d4ab60d674524c92fbdf7c7fde52329ee2280685422c95673461fbb99ba3e3cb
 SHA512:
-  metadata.gz: 0ba186c7d33ec0c10f9dcc2967e87a930f896760aa11b79b43d6712d3b4761b21b10ef48498d52315ec1da4cfca45e0439905b2871f7b0e1eae458476ac36b8c
-  data.tar.gz: d84e048270bf915017efb4f92cf456f37709e55ac97d3d6c68c470ede10fed86a9d5b6e775c0c150144d1b7ab618e634ac826f0e63b780029984022ef22ee165
+  metadata.gz: c405ffc3f03cdb9da19dc5fcbac2a56f22dca4b9f3dc93e2a524655d12d84464a2788ce90f2b593dd8ca8c5475a4fb734e882fc9c7eb3e88fc460fe743025c16
+  data.tar.gz: 34063f3c3d73a69c89584f0eb381739634a91f3b7e57d7c1cf1ed7b08a64fcc1c40938bb2b0fdd8e5305d72fbe9c4313a5de64c598dbd870cfb29a86d8ea37a0

data/CHANGELOG.md

@@ -1,5 +1,261 @@
 # Changelog
 
+## 9.0.0 - 2023-08-16
+**⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️**
+
+* [#1253](https://github.com/stripe/stripe-ruby/pull/1253) [#1260](https://github.com/stripe/stripe-ruby/pull/1260) Pin latest API version as the default
+  In this release, Stripe API Version `2023-08-16` (the latest at time of release) will be sent by default on all requests. This is a significant change with wide ramifications. The API version affects the properties you see on responses, the parameters you are allowed to send on requests, and so on. The previous default was to use your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version).
+  
+  To successfully upgrade to stripe-ruby v9, you must either
+  
+  1. **(Recommended) Upgrade your integration to be compatible with API Version `2023-08-16`.**
+  
+     Please read the API Changelog carefully for each API Version from `2023-08-16` back to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe [Test Mode](https://stripe.com/docs/keys#test-live-modes) before deploying them to production.
+  
+     You can read the [v9 migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v9) for more detailed instructions.
+  2. **(Alternative option) Specify a version other than `2023-08-16` when initializing `stripe-ruby`.**
+  
+     If you were previously initializing stripe-ruby without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). For example:
+  
+     ```diff
+       require 'stripe'
+       Stripe.api_key = "sk_test_..."
+     + Stripe.api_version = '2020-08-27'
+     ```
+  
+     If you were already initializing stripe-ruby with an explicit API Version, upgrading to v9 will not affect your integration.
+  
+     Read the [v9 migration guide](https://github.com/stripe-ruby/wiki/Migration-guide-for-v9) for more details.
+  
+  Going forward, each major release of this library will be *pinned* by default to the latest Stripe API Version at the time of release.
+  
+  That is, instead of upgrading stripe-ruby and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-ruby, you should also upgrade your integration to be compatible with the latest Stripe API version.
+
+## 8.7.0 - 2023-08-10
+* [#1256](https://github.com/stripe/stripe-ruby/pull/1256) Update generated code
+  Add resources `Tax::CalculationLineItem`, `Tax::TransactionLineItem`, and `Treasury::FinancialAccountFeatures`. These resources have no methods on them, but do represent the return type of methods elsewhere.
+
+## 8.6.0 - 2023-07-13
+* [#1244](https://github.com/stripe/stripe-ruby/pull/1244) Update generated code
+  * Add support for new resource `Tax.Settings`
+  * Add support for `retrieve` and `update` methods on resource `Settings`
+* [#1241](https://github.com/stripe/stripe-ruby/pull/1241) Update generated code
+
+* [#1209](https://github.com/stripe/stripe-ruby/pull/1209) Update shoulda-context version
+* [#1235](https://github.com/stripe/stripe-ruby/pull/1235) Allow "error" string as log level
+* [#1238](https://github.com/stripe/stripe-ruby/pull/1238) Update log level error message to include `error`
+* [#1231](https://github.com/stripe/stripe-ruby/pull/1231) fix: variable typo in README for instrumentation
+* [#1234](https://github.com/stripe/stripe-ruby/pull/1234) Update generated code
+
+* [#1230](https://github.com/stripe/stripe-ruby/pull/1230) Update generated code
+  * Release specs are identical.
+* [#1226](https://github.com/stripe/stripe-ruby/pull/1226) Update generated code
+
+* [#1223](https://github.com/stripe/stripe-ruby/pull/1223) Update generated code
+
+* [#1225](https://github.com/stripe/stripe-ruby/pull/1225) Downgrade jaro_winkler
+* [#1219](https://github.com/stripe/stripe-ruby/pull/1219) Update generated code
+  
+  Documentation updates.
+* [#1215](https://github.com/stripe/stripe-ruby/pull/1215) Update generated code
+
+* [#1208](https://github.com/stripe/stripe-ruby/pull/1208) Update generated code
+
+* [#1204](https://github.com/stripe/stripe-ruby/pull/1204) Update generated code
+
+
+## 8.5.0 - 2023-03-30
+* [#1203](https://github.com/stripe/stripe-ruby/pull/1203) Update generated code
+  * Remove support for `create` method on resource `Tax.Transaction`
+    * This is not a breaking change, as this method was deprecated before the Tax Transactions API was released in favor of the `create_from_calculation` method.
+* [#1201](https://github.com/stripe/stripe-ruby/pull/1201) Update save deprecation message
+
+## 8.4.0 - 2023-03-23
+* [#1197](https://github.com/stripe/stripe-ruby/pull/1197) Update generated code (new)
+  * Add support for new resources `Tax.CalculationLineItem`, `Tax.Calculation`, `Tax.TransactionLineItem`, and `Tax.Transaction`
+  * Add support for `create` and `list_line_items` methods on resource `Calculation`
+  * Add support for `create_from_calculation`, `create_reversal`, `create`, `list_line_items`, and `retrieve` methods on resource `Transaction`
+* [#1152](https://github.com/stripe/stripe-ruby/pull/1152) Symbolize hash keys inside `convert_to_stripe_object_with_params`
+
+## 8.3.0 - 2023-02-16
+* [#1175](https://github.com/stripe/stripe-ruby/pull/1175) API Updates
+  * Add support for `refund_payment` method on resource `Terminal.Reader`
+
+## 8.2.0 - 2023-02-02
+* [#1173](https://github.com/stripe/stripe-ruby/pull/1173) API Updates
+  * Add support for `resume` method on resource `Subscription`
+* [#1171](https://github.com/stripe/stripe-ruby/pull/1171) Remove unused `partial` param from `initialize_from`
+
+## 8.1.0 - 2023-01-12
+* [#1162](https://github.com/stripe/stripe-ruby/pull/1162) Improve request events instrumentation
+
+## 8.0.0 - 2022-11-16
+* [#1144](https://github.com/stripe/stripe-ruby/pull/1144) Next major release changes
+
+Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-11-15.
+
+"⚠️" symbol highlights breaking changes.
+
+### Deprecated
+- The `save` method is deprecated. Prefer the static `update` method that doesn't require retrieval of the resource to update it.
+  ``` ruby
+  # before
+  refund = Stripe::Refund.retrieve("re_123")
+  refund.description = "Refund description"
+  refund.save
+  
+  # after
+  Stripe::Refund.update("re_123", description: "Refund description")
+  ```
+
+### ⚠️ Removed
+- Removed deprecated `Sku` resource.
+- Removed deprecated `Orders` resource.
+- Removed deprecated `delete` method on `Subscription` resource. Please use `cancel` method instead.
+  ```ruby
+  # before
+  Stripe::Subscription::delete("sub_12345")
+
+  # after
+  Stripe::Subscription::cancel("sub_12345")
+  ```
+
+
+## 7.1.0 - 2022-08-19
+* [#1116](https://github.com/stripe/stripe-ruby/pull/1116) API Updates
+  * Add support for new resource `CustomerCashBalanceTransaction`
+* [#1118](https://github.com/stripe/stripe-ruby/pull/1118) Update AllowedChars in rubocop config
+* [#1117](https://github.com/stripe/stripe-ruby/pull/1117) Refresh rubocop config.
+* [#1115](https://github.com/stripe/stripe-ruby/pull/1115) Add a support section to the readme
+
+## 7.0.0 - 2022-08-02
+
+Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the SDK, read more detailed description at https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v7. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-08-01.
+
+"⚠️" symbol highlights breaking changes.
+
+* [#1106](https://github.com/stripe/stripe-ruby/pull/1106) API Updates
+* [#1092](https://github.com/stripe/stripe-ruby/pull/1092) API Updates
+* [#1090](https://github.com/stripe/stripe-ruby/pull/1090) Use auto-generation for `Invoice` methods
+* [#1103](https://github.com/stripe/stripe-ruby/pull/1103) Next major release changes
+
+### ⚠️ Changed
+* `retrieve_cash_balance` and `update_cash_balance` methods on `Customer` resource no longer requires the second argument to always be `nil`. The methods now now take in `customer_id`, `params`, and `opts` parameters.
+* Update default bundle of CA certificates to April 26, 2022.
+
+### Deprecated
+* Deprecate `delete` method on `Subscription` resource. Please use `cancel` method instead.
+
+### ⚠️ Removed
+* Remove `details` method from `Issuing.Card` resource. The method was not supported.
+* Remove `Issuing.CardDetails` resource. Read more at https://stripe.com/docs/issuing/cards/virtual.
+* Remove `create` method from `ReportType` resource. The method was not supported.
+* Remove `usage_record_summaries` method from `SubscriptionItem` resource. Please use `list_usage_record_summaries` method instead.
+* Remove `AlipayAccount`, `BitcoinReceiver`, `BitcoinTransaction`, `Issuing::CardDetails`, `Recipient`, ` RecipientTransfer`, and `ThreeDSecure` resources. The resources were deprecated or no longer in use.
+* Remove ability to list `Card` resource for a `Recipient`.
+* Remove `cancel` method from `Transfer` resource. The method was deprecated.
+
+## 6.5.0 - 2022-06-29
+* [#1084](https://github.com/stripe/stripe-ruby/pull/1084) API Updates
+  * Add support for `deliver_card`, `fail_card`, `return_card`, and `ship_card` test helper methods on resource `Issuing.Card`
+* [#1076](https://github.com/stripe/stripe-ruby/pull/1076) fix: Update logging to coerce ASCII-8BIT into UTF-8.
+
+## 6.4.0 - 2022-06-17
+* [#1073](https://github.com/stripe/stripe-ruby/pull/1073) API Updates
+  * Add support for `fund_cash_balance` test helper method on resource `Customer`
+* [#1074](https://github.com/stripe/stripe-ruby/pull/1074) Support updating pre-release versions
+* [#1072](https://github.com/stripe/stripe-ruby/pull/1072) Trigger workflows on beta branches
+* [#1071](https://github.com/stripe/stripe-ruby/pull/1071) Use request_stripe_object for all requests
+* [#1070](https://github.com/stripe/stripe-ruby/pull/1070) API Updates
+  
+  Switch from using meta-programing to generating explicit methods for custom methods.
+* [#1069](https://github.com/stripe/stripe-ruby/pull/1069) chore: Stop special implementation of Account.persons method.
+
+## 6.3.0 - 2022-06-08
+* [#1063](https://github.com/stripe/stripe-ruby/pull/1063) fix: Update cash balance methods to no longer require nested ID.
+
+## 6.2.0 - 2022-05-23
+* [#1060](https://github.com/stripe/stripe-ruby/pull/1060) API Updates
+  * Add support for new resource `Apps.Secret`
+
+## 6.1.0 - 2022-05-19
+* [#1057](https://github.com/stripe/stripe-ruby/pull/1057) API Updates
+  * Add support for new resources `Treasury.CreditReversal`, `Treasury.DebitReversal`, `Treasury.FinancialAccountFeatures`, `Treasury.FinancialAccount`, `Treasury.FlowDetails`, `Treasury.InboundTransfer`, `Treasury.OutboundPayment`, `Treasury.OutboundTransfer`, `Treasury.ReceivedCredit`, `Treasury.ReceivedDebit`, `Treasury.TransactionEntry`, and `Treasury.Transaction`
+  * Add support for `retrieve_payment_method` method on resource `Customer`
+  * Add support for `list_owners` and `list` methods on resource `FinancialConnections.Account`
+  
+  
+
+## 6.0.0 - 2022-05-09
+* [#1056](https://github.com/stripe/stripe-ruby/pull/1056) API Updates
+  Major version release. The [migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-Guide-for-v6) contains more information.
+  
+  (⚠️ = breaking changes):
+  * ⚠️ Replace the legacy `Order` API with the new `Order` API. 
+    * New methods: `cancel`, `list_line_items`, `reopen`, and `submit`
+    * Removed methods: `pay` and `return_order`
+    * Removed resources: `OrderItem` and `OrderReturn`
+  * ⚠️ Rename `FinancialConnections::Account.refresh` to `FinancialConnections::Account.refresh_account
+
+## 5.55.0 - 2022-05-05
+* [#1055](https://github.com/stripe/stripe-ruby/pull/1055) API Updates
+  * Add support for new resources `FinancialConnections.AccountOwner`, `FinancialConnections.AccountOwnership`, `FinancialConnections.Account`, and `FinancialConnections.Session`
+  
+
+## 5.54.0 - 2022-05-03
+* [#1053](https://github.com/stripe/stripe-ruby/pull/1053) API Updates
+  * Add support for new resource `CashBalance`
+
+## 5.53.0 - 2022-04-21
+* [#1050](https://github.com/stripe/stripe-ruby/pull/1050) API Updates
+  * Add support for `expire` test helper method on resource `Refund`
+
+## 5.52.0 - 2022-04-18
+* [#1046](https://github.com/stripe/stripe-ruby/pull/1046) [#1047](https://github.com/stripe/stripe-ruby/pull/1047) API Updates 
+  * Add support for new resources `FundingInstructions` and `Terminal.Configuration`
+
+## 5.51.0 - 2022-04-15
+* [#1046](https://github.com/stripe/stripe-ruby/pull/1046) This release was incomplete and was yanked from RubyGems immediately after it was published.
+
+## 5.50.0 - 2022-04-13
+* [#1045](https://github.com/stripe/stripe-ruby/pull/1045) API Updates
+  * Add support for `increment_authorization` method on resource `PaymentIntent`
+
+## 5.49.0 - 2022-04-08
+* [#1043](https://github.com/stripe/stripe-ruby/pull/1043) API Updates
+  * Add support for `apply_customer_balance` method on resource `PaymentIntent`
+
+## 5.48.0 - 2022-03-30
+* [#1041](https://github.com/stripe/stripe-ruby/pull/1041) API Updates
+  * Add support for `cancel_action`, `process_payment_intent`, `process_setup_intent`, and `set_reader_display` methods on resource `Terminal.Reader`
+
+## 5.47.0 - 2022-03-29
+* [#1040](https://github.com/stripe/stripe-ruby/pull/1040) API Updates
+  * Add support for Search API
+    * Add support for `search` method on resources `Charge`, `Customer`, `Invoice`, `PaymentIntent`, `Price`, `Product`, and `Subscription`
+  
+* [#1034](https://github.com/stripe/stripe-ruby/pull/1034) Add supporting classes for test helper generation
+
+## 5.46.0 - 2022-03-23
+* [#1039](https://github.com/stripe/stripe-ruby/pull/1039) API Updates
+  * Add support for `cancel` method on resource `Refund`
+* [#992](https://github.com/stripe/stripe-ruby/pull/992) Add support for Search API
+
+## 5.45.0 - 2022-03-01
+* [#1035](https://github.com/stripe/stripe-ruby/pull/1035) API Updates
+  * Add support for new resource `TestHelpers.TestClock`
+
+## 5.44.0 - 2022-02-16
+* [#1032](https://github.com/stripe/stripe-ruby/pull/1032) API Updates
+  * Add support for `verify_microdeposits` method on resources `PaymentIntent` and `SetupIntent`
+
+## 5.43.0 - 2022-01-20
+* [#1031](https://github.com/stripe/stripe-ruby/pull/1031) API Updates
+  * Add support for new resource `PaymentLink`
+
+## 5.42.0 - 2021-12-13
+* [#1022](https://github.com/stripe/stripe-ruby/pull/1022) Add connection manager logging and include object IDs in logging.
+
 ## 5.41.0 - 2021-11-16
 * [#1017](https://github.com/stripe/stripe-ruby/pull/1017) API Updates
   * Add support for new resource `ShippingRate`

data/Gemfile

@@ -5,12 +5,12 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
+  gem "coveralls_reborn", "~> 0.25.0" if RUBY_VERSION >= "3.1"
   gem "mocha", "~> 0.13.2"
   gem "rack", ">= 2.0.6"
   gem "rake"
 
-  # Update to 2.0.0 once it ships.
-  gem "shoulda-context", "2.0.0.rc4"
+  gem "shoulda-context", "2.0.0"
 
   gem "test-unit"
 
@@ -25,6 +25,9 @@ group :development do
   # up-to-date, but it's not the end of the world if it's not.
   gem "rubocop", "0.80"
 
+  # jaro_winkler 1.5.5 installation fails for jruby
+  gem "jaro_winkler", "1.5.4"
+
   platforms :mri do
     gem "byebug"
     gem "pry"

data/Makefile

@@ -0,0 +1,13 @@
+.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 --auto-correct
+
+ci-test:
+	bundle install && bundle exec rake test
+
+test: ci-test

data/OPENAPI_VERSION

@@ -0,0 +1 @@
+v461

data/README.md

@@ -1,7 +1,8 @@
 # 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)
+[![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)
+[![Coverage Status](https://coveralls.io/repos/github/stripe/stripe-ruby/badge.svg?branch=master)](https://coveralls.io/github/stripe/stripe-ruby?branch=master)
 
 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
@@ -18,7 +19,7 @@ The library also provides other features. For example:
 
 ## Documentation
 
-See the [Ruby API docs](https://stripe.com/docs/api/ruby#intro).
+See the [Ruby API docs](https://stripe.com/docs/api?lang=ruby).
 
 See [video demonstrations][youtube-playlist] covering how to use the library.
 
@@ -252,7 +253,11 @@ a success or error. Receives `RequestEndEvent` with the following properties:
 - `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.
+- `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
 
@@ -260,9 +265,13 @@ 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: request_event.path.split('/')[2],
+    resource: resource,
     code: request_event.http_status,
     retries: request_event.num_retries
   }
@@ -293,6 +302,31 @@ You can disable this behavior if you prefer:
 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, use the `Stripe.api_version` field to set it:
+
+```python
+Stripe.api_version += "; feature_beta=v3"
+```
+
+## 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
 
 The test suite depends on [stripe-mock], so make sure to fetch and run it from a
@@ -340,9 +374,9 @@ 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
-[idempotency-keys]: https://stripe.com/docs/api/ruby#idempotent_requests
+[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/ruby#versioning
+[versioning]: https://stripe.com/docs/api/versioning?lang=ruby
 [youtube-playlist]: https://www.youtube.com/playlist?list=PLy1nL-pvL2M50RmP6ie-gdcSnfOuQCRYk
 
 <!--

data/VERSION

@@ -1 +1 @@
-5.41.0
+9.0.0