stripe 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc52fa0e9fcfaf1ffdb6427a94285ccf90daacfb9c212400dc3f25dd2bd3ce4
-  data.tar.gz: c3d8a2d531140836ee11a4aa80f7244226fe1c4cf106ef439820fe5bddb426c5
+  metadata.gz: b8b2647147e752c48286db590da33c49eab3ada2597f747e285aeba1c859285d
+  data.tar.gz: 72ba2a35faae21c340fb7bad6bfb0325fe9d6dbd8862e2f37e10d8e80f8ded51
 SHA512:
-  metadata.gz: 575263394c5d6275016782f492ce1f7e334d003ad9479ef6016521800527006ef6c1a67fbe0e6e58afae64e32b35bc722290763b5d8b588d7263377f86925ef1
-  data.tar.gz: 044c6379ba0974f110e1a348a7eeeb0f0ada68fbbeb7ae6a4e8939c2f6597c7fb0a080aab7c58de77b33beecc2ffe551b90ed471c63544b74f9e0725389dfb71
+  metadata.gz: ebafa5766c73b0b3fd13f5a5fcb1e5488b5eb56d5000d184b5f042cdf5dc2906572fd340d0c61f262d027f4a3f3ec7a0df47e1101da47c9b6ad89b7382097a63
+  data.tar.gz: 37fa65a65eaf7af72012db023b1a70a9c753c86e77ac9911eade36f780ab9f0b08ad6dec1846b8fad103051567f75f95771c600a4fc59c5fbbe102626ce7369e

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 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.
 

data/Makefile

@@ -1,7 +1,7 @@
 .PHONY: update-version codegen-format
 update-version:
 	@echo "$(VERSION)" > VERSION
-	@perl -pi -e 's|VERSION = "[.\d]+"|VERSION = "$(VERSION)"|' lib/stripe/version.rb
+	@perl -pi -e 's|VERSION = "[.\-\w\d]+"|VERSION = "$(VERSION)"|' lib/stripe/version.rb
 
 codegen-format:
 	bundle exec rubocop -o /dev/null --auto-correct

data/OPENAPI_VERSION

@@ -1 +1 @@
-v152
+v157

data/VERSION

@@ -1 +1 @@
-6.3.0
+6.4.0

data/lib/stripe/api_operations/create.rb

@@ -4,8 +4,12 @@ module Stripe
   module APIOperations
     module Create
       def create(params = {}, opts = {})
-        resp, opts = execute_resource_request(:post, resource_url, params, opts)
-        Util.convert_to_stripe_object(resp.data, opts)
+        request_stripe_object(
+          method: :post,
+          path: resource_url,
+          params: params,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_operations/delete.rb

@@ -18,17 +18,22 @@ module Stripe
         #   api_key to be overwritten. See
         #   {APIOperations::Request.execute_resource_request}.
         def delete(id, params = {}, opts = {})
-          resp, opts = execute_resource_request(:delete,
-                                                "#{resource_url}/#{id}",
-                                                params, opts)
-          Util.convert_to_stripe_object(resp.data, opts)
+          request_stripe_object(
+            method: :delete,
+            path: "#{resource_url}/#{id}",
+            params: params,
+            opts: opts
+          )
         end
       end
 
       def delete(params = {}, opts = {})
-        resp, opts = execute_resource_request(:delete, resource_url,
-                                              params, opts)
-        initialize_from(resp.data, opts)
+        request_stripe_object(
+          method: :delete,
+          path: resource_url,
+          params: params,
+          opts: opts
+        )
       end
 
       def self.included(base)

data/lib/stripe/api_operations/list.rb

@@ -4,15 +4,12 @@ module Stripe
   module APIOperations
     module List
       def list(filters = {}, opts = {})
-        opts = Util.normalize_opts(opts)
-
-        resp, opts = execute_resource_request(:get, resource_url, filters, opts)
-        obj = ListObject.construct_from(resp.data, opts)
-
-        # set filters so that we can fetch the same limit, expansions, and
-        # predicates when accessing the next and previous pages
-        obj.filters = filters.dup
-        obj
+        request_stripe_object(
+          method: :get,
+          path: resource_url,
+          params: filters,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_operations/nested_resource.rb

@@ -26,46 +26,74 @@ module Stripe
         end
 
         operations.each do |operation|
-          case operation
-          when :create
-            define_singleton_method(:"create_#{resource}") \
+          define_operation(
+            resource,
+            operation,
+            resource_url_method,
+            resource_plural
+          )
+        end
+      end
+
+      private def define_operation(
+        resource,
+        operation,
+        resource_url_method,
+        resource_plural
+      )
+        case operation
+        when :create
+          define_singleton_method(:"create_#{resource}") \
               do |id, params = {}, opts = {}|
-                url = send(resource_url_method, id)
-                resp, opts = execute_resource_request(:post, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :retrieve
-            define_singleton_method(:"retrieve_#{resource}") \
+            request_stripe_object(
+              method: :post,
+              path: send(resource_url_method, id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :retrieve
+          define_singleton_method(:"retrieve_#{resource}") \
               do |id, nested_id, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:get, url, {}, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :update
-            define_singleton_method(:"update_#{resource}") \
+            request_stripe_object(
+              method: :get,
+              path: send(resource_url_method, id, nested_id),
+              params: {},
+              opts: opts
+            )
+          end
+        when :update
+          define_singleton_method(:"update_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:post, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :delete
-            define_singleton_method(:"delete_#{resource}") \
+            request_stripe_object(
+              method: :post,
+              path: send(resource_url_method, id, nested_id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :delete
+          define_singleton_method(:"delete_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:delete, url, params,
-                                                      opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :list
-            define_singleton_method(:"list_#{resource_plural}") \
+            request_stripe_object(
+              method: :delete,
+              path: send(resource_url_method, id, nested_id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :list
+          define_singleton_method(:"list_#{resource_plural}") \
               do |id, params = {}, opts = {}|
-                url = send(resource_url_method, id)
-                resp, opts = execute_resource_request(:get, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          else
-            raise ArgumentError, "Unknown operation: #{operation.inspect}"
+            request_stripe_object(
+              method: :get,
+              path: send(resource_url_method, id),
+              params: params,
+              opts: opts
+            )
           end
+        else
+          raise ArgumentError, "Unknown operation: #{operation.inspect}"
         end
       end
     end

data/lib/stripe/api_operations/request.rb

@@ -24,6 +24,11 @@ module Stripe
           )
         end
 
+        private def request_stripe_object(method:, path:, params:, opts: {})
+          resp, opts = execute_resource_request(method, path, params, opts)
+          Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+        end
+
         private def execute_resource_request_internal(client_request_method_sym,
                                                       method, url,
                                                       params, opts,
@@ -122,6 +127,11 @@ module Stripe
         )
       end
 
+      private def request_stripe_object(method:, path:, params:, opts: {})
+        resp, opts = execute_resource_request(method, path, params, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+      end
+
       # See notes on `alias` above.
       alias request execute_resource_request
     end

data/lib/stripe/api_operations/save.rb

@@ -24,9 +24,12 @@ module Stripe
             end
           end
 
-          resp, opts = execute_resource_request(:post, "#{resource_url}/#{id}",
-                                                params, opts)
-          Util.convert_to_stripe_object(resp.data, opts)
+          request_stripe_object(
+            method: :post,
+            path: "#{resource_url}/#{id}",
+            params: params,
+            opts: opts
+          )
         end
       end
 

data/lib/stripe/api_operations/search.rb

@@ -4,15 +4,12 @@ module Stripe
   module APIOperations
     module Search
       def _search(search_url, filters = {}, opts = {})
-        opts = Util.normalize_opts(opts)
-
-        resp, opts = execute_resource_request(:get, search_url, filters, opts)
-        obj = SearchResultObject.construct_from(resp.data, opts)
-
-        # set filters so that we can fetch the same limit and query
-        # when accessing the next page
-        obj.filters = filters.dup
-        obj
+        request_stripe_object(
+          method: :get,
+          path: search_url,
+          params: filters,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_resource.rb

@@ -97,7 +97,7 @@ module Stripe
       if Util.object_name_matches_class?(resp.data[:object], self.class)
         initialize_from(resp.data, opts)
       else
-        Util.convert_to_stripe_object(resp.data, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
       end
     end
 

data/lib/stripe/resources/account.rb

@@ -12,18 +12,43 @@ module Stripe
 
     OBJECT_NAME = "account"
 
-    custom_method :reject, http_verb: :post
-
     nested_resource_class_methods :capability,
                                   operations: %i[retrieve update list],
                                   resource_plural: "capabilities"
     nested_resource_class_methods :person,
                                   operations: %i[create retrieve update delete list]
 
+    def persons(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def reject(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/reject",
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.persons(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reject(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(account) }),
         params: params,
         opts: opts
       )
@@ -60,11 +85,6 @@ module Stripe
       super(id, opts)
     end
 
-    def persons(params = {}, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/persons", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
-    end
-
     # We are not adding a helper for capabilities here as the Account object
     # already has a capabilities property which is a hash and not the sub-list
     # of capabilities.

data/lib/stripe/resources/apps/secret.rb

@@ -10,23 +10,21 @@ module Stripe
       OBJECT_NAME = "apps.secret"
 
       def self.delete_where(params = {}, opts = {})
-        resp, opts = execute_resource_request(
-          :post,
-          resource_url + "/delete",
-          params,
-          opts
+        request_stripe_object(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts
         )
-        Util.convert_to_stripe_object(resp.data, opts)
       end
 
       def self.find(params = {}, opts = {})
-        resp, opts = execute_resource_request(
-          :get,
-          resource_url + "/find",
-          params,
-          opts
+        request_stripe_object(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts
         )
-        Util.convert_to_stripe_object(resp.data, opts)
       end
     end
   end

data/lib/stripe/resources/charge.rb

@@ -10,12 +10,19 @@ module Stripe
 
     OBJECT_NAME = "charge"
 
-    custom_method :capture, http_verb: :post
-
     def capture(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/capture",
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.capture(charge, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/checkout/session.rb

@@ -10,14 +10,21 @@ module Stripe
 
       OBJECT_NAME = "checkout.session"
 
-      custom_method :expire, http_verb: :post
-
       nested_resource_class_methods :line_item, operations: %i[list]
 
       def expire(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/expire",
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.expire(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(session) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/credit_note.rb

@@ -9,25 +9,40 @@ module Stripe
 
     OBJECT_NAME = "credit_note"
 
-    custom_method :void_credit_note, http_verb: :post, http_path: "void"
-
     def void_credit_note(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/void",
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.void_credit_note(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
         params: params,
         opts: opts
       )
     end
 
     def self.preview(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/preview", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/preview",
+        params: params,
+        opts: opts
+      )
     end
 
     def self.list_preview_line_items(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/preview/lines", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/preview/lines",
+        params: params,
+        opts: opts
+      )
     end
   end
 end

data/lib/stripe/resources/customer.rb

@@ -12,9 +12,6 @@ module Stripe
 
     OBJECT_NAME = "customer"
 
-    custom_method :create_funding_instructions, http_verb: :post, http_path: "funding_instructions"
-    custom_method :list_payment_methods, http_verb: :get, http_path: "payment_methods"
-
     nested_resource_class_methods :balance_transaction,
                                   operations: %i[create retrieve update list]
     nested_resource_class_methods :tax_id,
@@ -23,7 +20,7 @@ module Stripe
     def create_funding_instructions(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/funding_instructions",
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -32,7 +29,7 @@ module Stripe
     def list_payment_methods(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/payment_methods",
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -47,19 +44,36 @@ module Stripe
       )
     end
 
+    def self.create_funding_instructions(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_payment_methods(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.retrieve_payment_method(
       customer,
       payment_method,
       params = {},
       opts = {}
     )
-      resp, opts = execute_resource_request(
-        :get,
-        format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
-        params,
-        opts
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
       )
-      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     custom_method :delete_discount, http_verb: :delete, http_path: "discount"
@@ -80,8 +94,11 @@ module Stripe
     # so you must call `refresh` on it to get a new version with the
     # discount removed.
     def delete_discount
-      resp, opts = execute_resource_request(:delete, resource_url + "/discount")
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :delete,
+        path: resource_url + "/discount",
+        params: {}
+      )
     end
 
     def self.search(params = {}, opts = {})
@@ -103,13 +120,12 @@ module Stripe
       if !opts_or_unused_nested_id.nil? && opts_or_unused_nested_id.class == Hash && opts.empty?
         opts = opts_or_unused_nested_id
       end
-      resp, opts = execute_resource_request(
-        :get,
-        format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
-        {},
-        opts
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: {},
+        opts: opts
       )
-      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     def self.update_cash_balance(
@@ -123,13 +139,38 @@ module Stripe
         raise ArgumentError, "update_cash_balance requires the second argument always be nil for legacy reasons."
       end
 
-      resp, opts = execute_resource_request(
-        :post,
-        format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
-        params,
-        opts
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
       )
-      Util.convert_to_stripe_object(resp.data, opts)
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Customer
+
+      def self.fund_cash_balance(customer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(customer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def fund_cash_balance(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(@resource["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/dispute.rb

@@ -8,12 +8,19 @@ module Stripe
 
     OBJECT_NAME = "dispute"
 
-    custom_method :close, http_verb: :post
-
     def close(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/close",
+        path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.close(dispute, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(dispute) }),
         params: params,
         opts: opts
       )