stripe 14.0.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5525691fb4bdeceebc4d8a3ff05952e3b0f2f90f77ffedf9f3b982a6e15cc49
-  data.tar.gz: 8d2250d5b1941abbf886cbd160ee80bf16fbe1d66412665a9e6121e9b88d4928
+  metadata.gz: 9ac9a4371f393b1650cd2b5198d4e2ceed046c9676183b0d339fd985c4b8b815
+  data.tar.gz: 3fc59d72c6450657a7797088c39f5c85d9b8bba505992cfc3fdbdc7a8d27fb7d
 SHA512:
-  metadata.gz: 3e347248e1f10850cc635b84053a05098ba18366b9614a2d8390905552da62fcdb0eaa17d917b2dc3718f54448c1e34f418258b8d1bc71adc8e0d22c39e91601
-  data.tar.gz: 3f83f0d0ab7b51b0fb908611293879549c324aeac451661df9182c9771dcd3e2322a083e733fcb0741a2e80576220fa50a7cde87855fd9f7405d9063c24ddef7
+  metadata.gz: 4f156649ca332eff3a2837ec1f038ebcc8ab9f5c35194d031e2610b45ef6b74cb0b651b3402d0afa98375a7ac293f0e54761e191dd6237e58e372b42b2cba681
+  data.tar.gz: 1cb72620268bf94d44b0ddd6090b41404efc0b25606759907c2a3d6821577b45b488738bdfdac34b6ba3a6e9fb769d9646ad1b184580d84fac3df6451a0fd172

data/CHANGELOG.md

@@ -1,4 +1,24 @@
 # Changelog
+## 15.0.0 - 2025-04-09
+
+### Breaking change
+* [#1574](https://github.com/stripe/stripe-ruby/pull/1574) Rename `object_id` in V2::Core::EventService::ListParams to `object_id_`
+  * ⚠️ Change name of parameter from `object_id` to `object_id_` on `Stripe::V2::Core::EventService::ListParams` to avoid conflict with Ruby native attribute, as found in https://github.com/stripe/stripe-ruby/issues/1567
+  * This is a no-op unless you are using this specific parameter that was introduced in `v14.0.0`
+
+* [#1576](https://github.com/stripe/stripe-ruby/pull/1576) Explicitly pass through custom headers in retrieve
+  * Fix custom options passing for resource-based retrieve
+* [#1571](https://github.com/stripe/stripe-ruby/pull/1571) Validate all instance variable keys returned from the API
+  * Validate all keys returned from the API, including custom response fields, to make sure they can be set in an instance variable, as brought up in https://github.com/stripe/stripe-ruby/issues/1564
+    * We do not set instance variables for invalid field names (as defined by the [Ruby spec](https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#ident)). We recommend for custom hash map response fields, use the `[]` accessor.
+       ```ruby
+       c = client.v1.customers.retrieve("cus_123")
+       c.metadata["invalid-variable-name!"]
+       c.metadata["valid_key_name_works_too"]
+      ```
+* [#1575](https://github.com/stripe/stripe-ruby/pull/1575) Remove unused youtube playlist link
+* [#1573](https://github.com/stripe/stripe-ruby/pull/1573) Remove link for stale youtube video playlist
+
 ## 14.0.0 - 2025-04-01
 * [#1559](https://github.com/stripe/stripe-ruby/pull/1559) Add RBI annotations for fields and params
   * Adds explicit field types for resources and parameters for methods, and add RBI static annotations for all resources and services

data/README.md

@@ -20,8 +20,6 @@ The library also provides other features. For example:
 
 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
@@ -158,6 +156,9 @@ 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`:
@@ -444,7 +445,6 @@ Update the bundled [stripe-mock] by editing the version number found in
 [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/VERSION

@@ -1 +1 @@
-14.0.0
+15.0.0

data/lib/stripe/api_operations/save.rb

@@ -67,7 +67,8 @@ module Stripe
         values.delete(:id)
         opts = Util.normalize_opts(opts)
         APIRequestor.active_requestor.execute_request_initialize_from(:post, save_url, :api, self,
-                                                                      params: values, opts: opts,
+                                                                      params: values,
+                                                                      opts: RequestOptions.extract_opts_from_hash(opts),
                                                                       usage: ["save"])
       end
       extend Gem::Deprecate

data/lib/stripe/api_operations/singleton_save.rb

@@ -64,7 +64,8 @@ module Stripe
         opts = Util.normalize_opts(opts)
 
         APIRequestor.active_requestor.execute_request_initialize_from(:post, resource_url, :api, self,
-                                                                      params: values, opts: opts,
+                                                                      params: values,
+                                                                      opts: RequestOptions.extract_opts_from_hash(opts),
                                                                       usage: ["save"])
       end
       extend Gem::Deprecate

data/lib/stripe/api_requestor.rb

@@ -220,9 +220,11 @@ module Stripe
     # with future non-major changes.
     def execute_request_initialize_from(method, path, base_address, object,
                                         params: {}, opts: {}, usage: [])
-      opts = RequestOptions.combine_opts(object.instance_variable_get(:@opts), opts)
+      opts = RequestOptions.combine_opts(object.instance_variable_get(:@opts) || {}, opts)
       opts = Util.normalize_opts(opts)
+
       params = params.to_h if params.is_a?(RequestParams)
+
       http_resp, req_opts = execute_request_internal(
         method, path, base_address, params, opts, usage
       )

data/lib/stripe/api_resource.rb

@@ -98,7 +98,10 @@ module Stripe
               "It is not possible to refresh v2 objects. Please retrieve the object using the StripeClient instead."
       end
 
-      @obj = @requestor.execute_request_initialize_from(:get, resource_url, :api, self, params: @retrieve_params)
+      opts = RequestOptions.extract_opts_from_hash(@retrieve_opts || {})
+      @retrieve_opts = {} # Make sure to clear the retrieve options
+      @obj = @requestor.execute_request_initialize_from(:get, resource_url, :api, self, params: @retrieve_params,
+                                                                                        opts: opts)
       initialize_from(
         @obj.last_response.data,
         @obj.instance_variable_get(:@opts),
@@ -114,8 +117,12 @@ module Stripe
               "It is not possible to retrieve v2 objects on the resource. Please use the StripeClient instead."
       end
 
-      opts = Util.normalize_opts(opts)
-      instance = new(id, opts)
+      instance = new(id)
+      # Explicitly send options for the retrieve call, to preserve custom headers
+      # This is so we can pass custom headers from this static function
+      # to the instance variable method call
+      # The custom headers will be cleaned up with the rest of the RequestOptions
+      instance.instance_variable_set(:@retrieve_opts, Util.normalize_opts(opts))
       instance.refresh
     end
 

data/lib/stripe/request_options.rb

@@ -56,7 +56,7 @@ module Stripe
     # Merges requestor options hash on a StripeObject
     # with a per-request options hash, giving precedence
     # to the per-request options. Returns the merged request options.
-    # Expects two hashes.
+    # Expects two hashes, expects extract_opts_from_hash to be called first!!!
     def self.combine_opts(object_opts, req_opts)
       merged_opts = {
         api_key: req_opts[:api_key] || object_opts[:api_key],
@@ -64,6 +64,7 @@ module Stripe
         stripe_account: req_opts[:stripe_account] || object_opts[:stripe_account],
         stripe_context: req_opts[:stripe_context] || object_opts[:stripe_context],
         stripe_version: req_opts[:stripe_version] || object_opts[:stripe_version],
+        headers: req_opts[:headers] || {},
       }
 
       # Remove nil values from headers

data/lib/stripe/resources/source.rb

@@ -1270,7 +1270,7 @@ module Stripe
             "/#{CGI.escape(id)}"
       opts = Util.normalize_opts(opts)
       APIRequestor.active_requestor.execute_request_initialize_from(:delete, url, :api, self,
-                                                                    params: params, opts: opts)
+                                                                    params: params, opts: RequestOptions.extract_opts_from_hash(opts))
     end
 
     def source_transactions(params = {}, opts = {})

data/lib/stripe/services/v2/core/event_service.rb

@@ -9,11 +9,13 @@ module Stripe
           # The page size.
           attr_accessor :limit
           # Primary object ID used to retrieve related events.
-          attr_accessor :object_id
+          #
+          # To avoid conflict with Ruby's ':object_id', this attribute has been renamed. If using a hash parameter map instead, please use the original name ':object_id' with NO trailing underscore as the provided param key.
+          attr_accessor :object_id_
 
-          def initialize(limit: nil, object_id: nil)
+          def initialize(limit: nil, object_id_: nil)
             @limit = limit
-            @object_id = object_id
+            @object_id_ = object_id_
           end
         end
 

data/lib/stripe/stripe_object.rb

@@ -336,7 +336,7 @@ module Stripe
       end
     end
 
-    protected def add_accessors(keys, values)
+    protected def add_accessors(keys, values) # rubocop:todo Metrics/PerceivedComplexity
       # not available in the #instance_eval below
       protected_fields = self.class.protected_fields
 
@@ -372,7 +372,16 @@ module Stripe
       end
 
       keys.each do |k|
-        instance_variable_set(:"@#{k}", values[k])
+        if Util.valid_variable_name?(k)
+          instance_variable_set(:"@#{k}", values[k])
+        else
+          Util.log_info(<<~LOG
+            The variable name '#{k}' is not a valid Ruby variable name.
+            Use ["#{k}"] to access this field, skipping instance variable instantiation...
+          LOG
+                       )
+
+        end
       end
     end
 
@@ -473,13 +482,14 @@ module Stripe
 
     # Should only be for v2 events and lists, for now.
     protected def _request(method:, path:, base_address:, params: {}, opts: {})
-      req_opts = RequestOptions.combine_opts(@opts, opts)
+      req_opts = RequestOptions.extract_opts_from_hash(opts)
+      req_opts = RequestOptions.combine_opts(@opts, req_opts)
       @requestor.execute_request(
         method,
         path,
         base_address,
         params: params,
-        opts: RequestOptions.extract_opts_from_hash(req_opts)
+        opts: req_opts
       )
     end
 

data/lib/stripe/util.rb

@@ -4,6 +4,9 @@ require "cgi"
 
 module Stripe
   module Util
+    LEGAL_FIRST_CHARACTER = /[a-zA-Z_]/.freeze
+    LEGAL_VARIABLE_CHARACTER = /[a-zA-Z0-9_]/.freeze
+
     def self.objects_to_ids(obj)
       case obj
       when APIResource
@@ -309,6 +312,14 @@ module Stripe
       end
     end
 
+    # Return false for strings that are invalid variable names
+    # Does NOT expect there to be a preceding '@' for instance variables
+    def self.valid_variable_name?(key)
+      return false if key.empty? || key[0] !~ LEGAL_FIRST_CHARACTER
+
+      key[1..-1].chars.all? { |char| char =~ LEGAL_VARIABLE_CHARACTER }
+    end
+
     def self.check_string_argument!(key)
       raise TypeError, "argument must be a string" unless key.is_a?(String)
 

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "14.0.0"
+  VERSION = "15.0.0"
 end

data/rbi/stripe/services/v2/core/event_service.rbi

@@ -11,10 +11,12 @@ module Stripe
           sig { returns(T.nilable(Integer)) }
           attr_accessor :limit
           # Primary object ID used to retrieve related events.
+          #
+          # To avoid conflict with Ruby's ':object_id', this attribute has been renamed. If using a hash parameter map instead, please use the original name ':object_id' with NO trailing underscore as the provided param key.
           sig { returns(String) }
-          attr_accessor :object_id
-          sig { params(limit: T.nilable(Integer), object_id: String).void }
-          def initialize(limit: nil, object_id: nil); end
+          attr_accessor :object_id_
+          sig { params(limit: T.nilable(Integer), object_id_: String).void }
+          def initialize(limit: nil, object_id_: nil); end
         end
         class RetrieveParams < Stripe::RequestParams
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 14.0.0
+  version: 15.0.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.