stripe 5.45.0 → 5.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2971f0ad2ef29349e932246a9bc9065d5d1ce53f21c14f7bcdb205b443779a42
-  data.tar.gz: a9a980c5cbdc14d79d60f5873f267db10153bd556c81378ec3c3ca270d87252d
+  metadata.gz: dc0fdc03553a1cb2d1d67ebe31538b25abd248d7f48ba0c6377bb8a9ff097a89
+  data.tar.gz: 31e2871a1f52b97e1994c3a4a4eb62068361167cb8c1d5a731244380247d2905
 SHA512:
-  metadata.gz: 47c89bc9c732bafeae007d6663ca82cbf5e32938d392bb130209d389f7fa59fa54ecb26b0f7b93658b8cd18eab82127c2bfedd6b8c6e3887bb92c99bcc41f11b
-  data.tar.gz: a73469bc20fbf0fae44c6409efbe53ce8d90c54dca56fe2f99dfc8a8fd045e9ac295b9df86f13be555648ead094746cb385cb2731cdbb40edbae858f2083f292
+  metadata.gz: 568b6acfdd6d7824cba36b8cf7c5ca6c85a11f2c0f9081df12175045e917a321b937c81ce98ebe43f455fc49e3d95d315c8da77ff6f7427d87197c4fbf08d80e
+  data.tar.gz: af1ed8b0d8d5f0782a7e953a6f56834f1fe7fb91eef2eeb82178e3dff784d5781cbee9fa53ac0c6ba0301124a7672cee39659716ac5c4a881e4a51a45cfec754

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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`

data/VERSION

@@ -1 +1 @@
-5.45.0
+5.46.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/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,

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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.45.0"
+  VERSION = "5.46.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,6 +36,7 @@ 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/singleton_api_resource"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 5.45.0
+  version: 5.46.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.
@@ -36,6 +36,7 @@ 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/connection_manager.rb
 - lib/stripe/error_object.rb
@@ -136,6 +137,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