stripe 5.44.0 → 5.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ec1a11bdbe04229b1d1649fb6734fb7708ac33cc67794f04b77a3fc5944952
-  data.tar.gz: ea006443a2f57c24b67b3effbcc693a3ae1ed6a688ebe0dc18cf9f014fda0847
+  metadata.gz: b214442a5d4e98a82fb5f1566e55969c0af85298f3bde7cfe77c8fdd3c34f59e
+  data.tar.gz: 8b402f5fa893793576f4d2ae830476ed626850cc3a44e201d3e5f23d5e4069ad
 SHA512:
-  metadata.gz: 8cddde45a7100e9e2c7803b752218af71d16208b90d808df79aac161c0a115bc952127c971d492f72496b9d13df8e25351748e78b65cfef1ce5ec4cb0b0d4296
-  data.tar.gz: 7c6a3a82748389de1a1b4088219d56d7564145718d1e4beaac53be90e56899669dc50a72613023c0409b0f70d49f6f75c7ad712d10e8a65de39b25e22ceba961
+  metadata.gz: c25f86d87cae70a56a406a50651a923e652e1db189fd987ba37b3d6081658c25d142285c7f969fc8d3ce80a86c54dc628a356fc3d17d8354bfa7884c4abea0f8
+  data.tar.gz: 5591798e38bd9b2e59fd8357b377842f281353832eb450580488393a311e7a62d882feeddcb58bbdda3363691a871d3c091801b2734367f17534a4629321a767

data/CHANGELOG.md

@@ -1,9 +1,24 @@
 # Changelog
 
+## 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`
-  
+  * 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

data/VERSION

@@ -1 +1 @@
-5.44.0
+5.47.0

data/lib/stripe/api_operations/search.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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
+      end
+    end
+  end
+end

data/lib/stripe/api_resource.rb

@@ -63,22 +63,7 @@ module Stripe
     # adds a `capture` class method to the resource class that, when called,
     # will send a POST request to `/v1/<object_name>/capture`.
     def self.custom_method(name, http_verb:, http_path: nil)
-      unless %i[get post delete].include?(http_verb)
-        raise ArgumentError,
-              "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
-              "of :get, :post or :delete."
-      end
-      http_path ||= name.to_s
-      define_singleton_method(name) do |id, params = {}, opts = {}|
-        unless id.is_a?(String)
-          raise ArgumentError,
-                "id should be a string representing the ID of an API resource"
-        end
-
-        url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(http_path)}"
-        resp, opts = execute_resource_request(http_verb, url, params, opts)
-        Util.convert_to_stripe_object(resp.data, opts)
-      end
+      Util.custom_method self, self, name, http_verb, http_path
     end
 
     def resource_url
@@ -105,7 +90,7 @@ module Stripe
       instance
     end
 
-    protected def request_stripe_object(method:, path:, params:, opts: {})
+    def request_stripe_object(method:, path:, params:, opts: {})
       resp, opts = execute_resource_request(method, path, params, opts)
 
       # If we're getting back this thing, update; otherwise, instantiate.

data/lib/stripe/api_resource_test_helpers.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Stripe
+  # The base class for nested TestHelpers classes in resource objects.
+  # The APIResourceTestHelpers handles URL generation and custom method
+  # support for test-helper methods.
+  #
+  #  class MyAPIResource < APIResource
+  #    class TestHelpers < APIResourceTestHelpers
+  class APIResourceTestHelpers
+    def initialize(resource)
+      @resource = resource
+    end
+
+    # Adds a custom method to a test helper. This is used to add support for
+    # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
+    # following parameters:
+    # - name: the name of the custom method to create (as a symbol)
+    # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
+    # - http_path: the path to append to the resource's URL. If not provided,
+    #              the name is used as the path
+    #
+    # For example, this call:
+    #     custom_method :capture, http_verb: post
+    # adds a `capture` class method to the resource class that, when called,
+    # will send a POST request to `/v1/<object_name>/capture`.
+    def self.custom_method(name, http_verb:, http_path: nil)
+      Util.custom_method self::RESOURCE_CLASS, self, name, http_verb, http_path
+    end
+
+    def self.resource_url
+      "/v1/test_helpers/"\
+      "#{self::RESOURCE_CLASS::OBJECT_NAME.downcase.tr('.', '/')}s"
+    end
+
+    def resource_url
+      unless (id = @resource["id"])
+        raise InvalidRequestError.new(
+          "Could not determine which URL to request: #{self.class} instance " \
+          "has invalid ID: #{id.inspect}",
+          "id"
+        )
+      end
+      "#{self.class.resource_url}/#{CGI.escape(id)}"
+    end
+  end
+end

data/lib/stripe/object_types.rb

@@ -9,6 +9,7 @@ module Stripe
       {
         # data structures
         ListObject::OBJECT_NAME => ListObject,
+        SearchResultObject::OBJECT_NAME => SearchResultObject,
 
         # business objects
         Account::OBJECT_NAME => Account,
@@ -94,6 +95,7 @@ module Stripe
         Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,
         Terminal::Location::OBJECT_NAME => Terminal::Location,
         Terminal::Reader::OBJECT_NAME => Terminal::Reader,
+        TestHelpers::TestClock::OBJECT_NAME => TestHelpers::TestClock,
         ThreeDSecure::OBJECT_NAME => ThreeDSecure,
         Token::OBJECT_NAME => Token,
         Topup::OBJECT_NAME => Topup,

data/lib/stripe/resources/charge.rb

@@ -5,6 +5,7 @@ module Stripe
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "charge"
@@ -19,5 +20,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/charges/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/customer.rb

@@ -6,6 +6,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
 
@@ -48,5 +49,13 @@ module Stripe
       resp, opts = execute_resource_request(:delete, resource_url + "/discount")
       Util.convert_to_stripe_object(resp.data, opts)
     end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/customers/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/invoice.rb

@@ -6,6 +6,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "invoice"
@@ -70,5 +71,13 @@ module Stripe
       resp, opts = execute_resource_request(:get, resource_url + "/upcoming/lines", params, opts)
       Util.convert_to_stripe_object(resp.data, opts)
     end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/invoices/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/payment_intent.rb

@@ -5,6 +5,7 @@ module Stripe
   class PaymentIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "payment_intent"
@@ -49,5 +50,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/payment_intents/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/price.rb

@@ -5,8 +5,17 @@ module Stripe
   class Price < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "price"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/prices/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/product.rb

@@ -6,8 +6,17 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "product"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/products/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/refund.rb

@@ -8,5 +8,16 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "refund"
+
+    custom_method :cancel, http_verb: :post
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/subscription.rb

@@ -6,6 +6,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "subscription"
@@ -22,5 +23,13 @@ module Stripe
     end
 
     save_nested_resource :source
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/subscriptions/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/test_helpers/test_clock.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TestClock < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "test_helpers.test_clock"
+
+      custom_method :advance, http_verb: :post
+
+      def advance(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/advance",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources.rb

@@ -83,6 +83,7 @@ require "stripe/resources/tax_rate"
 require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
+require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/three_d_secure"
 require "stripe/resources/token"
 require "stripe/resources/topup"

data/lib/stripe/search_result_object.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Stripe
+  class SearchResultObject < StripeObject
+    include Enumerable
+    include Stripe::APIOperations::Search
+    include Stripe::APIOperations::Request
+
+    OBJECT_NAME = "search_result"
+
+    # This accessor allows a `SearchResultObject` to inherit various filters
+    # that were given to a predecessor. This allows for things like consistent
+    # limits, expansions, and predicates as a user pages through resources.
+    attr_accessor :filters
+
+    # An empty search result object. This is returned from +next+ when we know
+    # that there isn't a next page in order to replicate the behavior of the API
+    # when it attempts to return a page beyond the last.
+    def self.empty_search_result(opts = {})
+      SearchResultObject.construct_from({ data: [] }, opts)
+    end
+
+    def initialize(*args)
+      super
+      self.filters = {}
+    end
+
+    def [](key)
+      case key
+      when String, Symbol
+        super
+      else
+        raise ArgumentError,
+              "You tried to access the #{key.inspect} index, but " \
+              "SearchResultObject types only support String keys. " \
+              "(HINT: Search calls return an object with a 'data' (which is " \
+              "the data array). You likely want to call #data[#{key.inspect}])"
+      end
+    end
+
+    # Iterates through each resource in the page represented by the current
+    # `SearchListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    # Returns true if the page object contains no elements.
+    def empty?
+      data.empty?
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_search_result_page+.
+    def auto_paging_each(&blk)
+      return enum_for(:auto_paging_each) unless block_given?
+
+      page = self
+
+      loop do
+        page.each(&blk)
+        page = page.next_search_result_page
+
+        break if page.empty?
+      end
+    end
+
+    # Fetches the next page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def next_search_result_page(params = {}, opts = {})
+      return self.class.empty_search_result(opts) unless has_more
+
+      params = filters.merge(page: next_page).merge(params)
+
+      _search(url, params, opts)
+    end
+  end
+end

data/lib/stripe/util.rb

@@ -47,6 +47,53 @@ module Stripe
       Util.object_classes[object_name] == klass
     end
 
+    # Adds a custom method to a resource class. This is used to add support for
+    # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
+    # following parameters:
+    # - name: the name of the custom method to create (as a symbol)
+    # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
+    # - http_path: the path to append to the resource's URL. If not provided,
+    #              the name is used as the path
+    # - resource: the resource implementation class
+    # - target: the class that custom static method will be added to
+    #
+    # For example, this call:
+    #     custom_method :capture, http_verb: post
+    # adds a `capture` class method to the resource class that, when called,
+    # will send a POST request to `/v1/<object_name>/capture`.
+    def self.custom_method(resource, target, name, http_verb, http_path)
+      unless %i[get post delete].include?(http_verb)
+        raise ArgumentError,
+              "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
+              "of :get, :post or :delete."
+      end
+      unless target.respond_to?(:resource_url)
+        raise ArgumentError,
+              "Invalid target value: #{target}. Target class should have a " \
+              "`resource_url` method."
+      end
+      http_path ||= name.to_s
+      target.define_singleton_method(name) do |id, params = {}, opts = {}|
+        unless id.is_a?(String)
+          raise ArgumentError,
+                "id should be a string representing the ID of an API resource"
+        end
+
+        url = "#{target.resource_url}/"\
+              "#{CGI.escape(id)}/"\
+              "#{CGI.escape(http_path)}"
+
+        resp, opts = resource.execute_resource_request(
+          http_verb,
+          url,
+          params,
+          opts
+        )
+
+        Util.convert_to_stripe_object(resp.data, opts)
+      end
+    end
+
     # Converts a hash of fields or an array of hashes into a +StripeObject+ or
     # array of +StripeObject+s. These new objects will be created as a concrete
     # type as dictated by their `object` field (e.g. an `object` value of

data/lib/stripe/version.rb

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

data/lib/stripe.rb

@@ -24,6 +24,7 @@ require "stripe/api_operations/list"
 require "stripe/api_operations/nested_resource"
 require "stripe/api_operations/request"
 require "stripe/api_operations/save"
+require "stripe/api_operations/search"
 
 # API resource support classes
 require "stripe/errors"
@@ -35,8 +36,10 @@ require "stripe/stripe_client"
 require "stripe/stripe_object"
 require "stripe/stripe_response"
 require "stripe/list_object"
+require "stripe/search_result_object"
 require "stripe/error_object"
 require "stripe/api_resource"
+require "stripe/api_resource_test_helpers"
 require "stripe/singleton_api_resource"
 require "stripe/webhook"
 require "stripe/stripe_configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 5.44.0
+  version: 5.47.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -36,7 +36,9 @@ files:
 - lib/stripe/api_operations/nested_resource.rb
 - lib/stripe/api_operations/request.rb
 - lib/stripe/api_operations/save.rb
+- lib/stripe/api_operations/search.rb
 - lib/stripe/api_resource.rb
+- lib/stripe/api_resource_test_helpers.rb
 - lib/stripe/connection_manager.rb
 - lib/stripe/error_object.rb
 - lib/stripe/errors.rb
@@ -128,6 +130,7 @@ files:
 - lib/stripe/resources/terminal/connection_token.rb
 - lib/stripe/resources/terminal/location.rb
 - lib/stripe/resources/terminal/reader.rb
+- lib/stripe/resources/test_helpers/test_clock.rb
 - lib/stripe/resources/three_d_secure.rb
 - lib/stripe/resources/token.rb
 - lib/stripe/resources/topup.rb
@@ -135,6 +138,7 @@ files:
 - lib/stripe/resources/usage_record.rb
 - lib/stripe/resources/usage_record_summary.rb
 - lib/stripe/resources/webhook_endpoint.rb
+- lib/stripe/search_result_object.rb
 - lib/stripe/singleton_api_resource.rb
 - lib/stripe/stripe_client.rb
 - lib/stripe/stripe_configuration.rb