stripe 2.0.3 → 5.55.0

data/lib/stripe/resources.rb

@@ -0,0 +1,100 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+require "stripe/resources/account"
+require "stripe/resources/account_link"
+require "stripe/resources/alipay_account"
+require "stripe/resources/apple_pay_domain"
+require "stripe/resources/application_fee"
+require "stripe/resources/application_fee_refund"
+require "stripe/resources/balance"
+require "stripe/resources/balance_transaction"
+require "stripe/resources/bank_account"
+require "stripe/resources/billing_portal/configuration"
+require "stripe/resources/billing_portal/session"
+require "stripe/resources/bitcoin_receiver"
+require "stripe/resources/bitcoin_transaction"
+require "stripe/resources/capability"
+require "stripe/resources/card"
+require "stripe/resources/cash_balance"
+require "stripe/resources/charge"
+require "stripe/resources/checkout/session"
+require "stripe/resources/country_spec"
+require "stripe/resources/coupon"
+require "stripe/resources/credit_note"
+require "stripe/resources/credit_note_line_item"
+require "stripe/resources/customer"
+require "stripe/resources/customer_balance_transaction"
+require "stripe/resources/discount"
+require "stripe/resources/dispute"
+require "stripe/resources/ephemeral_key"
+require "stripe/resources/event"
+require "stripe/resources/exchange_rate"
+require "stripe/resources/file"
+require "stripe/resources/file_link"
+require "stripe/resources/financial_connections/account"
+require "stripe/resources/financial_connections/account_owner"
+require "stripe/resources/financial_connections/account_ownership"
+require "stripe/resources/financial_connections/session"
+require "stripe/resources/funding_instructions"
+require "stripe/resources/identity/verification_report"
+require "stripe/resources/identity/verification_session"
+require "stripe/resources/invoice"
+require "stripe/resources/invoice_item"
+require "stripe/resources/invoice_line_item"
+require "stripe/resources/issuing/authorization"
+require "stripe/resources/issuing/card"
+require "stripe/resources/issuing/card_details"
+require "stripe/resources/issuing/cardholder"
+require "stripe/resources/issuing/dispute"
+require "stripe/resources/issuing/transaction"
+require "stripe/resources/line_item"
+require "stripe/resources/login_link"
+require "stripe/resources/mandate"
+require "stripe/resources/order"
+require "stripe/resources/order_return"
+require "stripe/resources/payment_intent"
+require "stripe/resources/payment_link"
+require "stripe/resources/payment_method"
+require "stripe/resources/payout"
+require "stripe/resources/person"
+require "stripe/resources/plan"
+require "stripe/resources/price"
+require "stripe/resources/product"
+require "stripe/resources/promotion_code"
+require "stripe/resources/quote"
+require "stripe/resources/radar/early_fraud_warning"
+require "stripe/resources/radar/value_list"
+require "stripe/resources/radar/value_list_item"
+require "stripe/resources/recipient"
+require "stripe/resources/recipient_transfer"
+require "stripe/resources/refund"
+require "stripe/resources/reporting/report_run"
+require "stripe/resources/reporting/report_type"
+require "stripe/resources/reversal"
+require "stripe/resources/review"
+require "stripe/resources/setup_attempt"
+require "stripe/resources/setup_intent"
+require "stripe/resources/shipping_rate"
+require "stripe/resources/sigma/scheduled_query_run"
+require "stripe/resources/sku"
+require "stripe/resources/source"
+require "stripe/resources/source_transaction"
+require "stripe/resources/subscription"
+require "stripe/resources/subscription_item"
+require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax_code"
+require "stripe/resources/tax_id"
+require "stripe/resources/tax_rate"
+require "stripe/resources/terminal/configuration"
+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"
+require "stripe/resources/transfer"
+require "stripe/resources/usage_record"
+require "stripe/resources/usage_record_summary"
+require "stripe/resources/webhook_endpoint"

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

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
+
 module Stripe
   class SingletonAPIResource < APIResource
     def self.resource_url
       if self == SingletonAPIResource
-        raise NotImplementedError.new('SingletonAPIResource is an abstract class.  You should perform actions on its subclasses (Account, etc.)')
+        raise NotImplementedError,
+              "SingletonAPIResource is an abstract class. You should " \
+              "perform actions on its subclasses (Balance, etc.)"
       end
-      "/v1/#{CGI.escape(class_name.downcase)}"
+      # Namespaces are separated in object names with periods (.) and in URLs
+      # with forward slashes (/), so replace the former with the latter.
+      "/v1/#{self::OBJECT_NAME.downcase.tr('.', '/')}"
     end
 
     def resource_url
       self.class.resource_url
     end
 
-    def self.retrieve(opts={})
-      instance = self.new(nil, Util.normalize_opts(opts))
+    def self.retrieve(opts = {})
+      instance = new(nil, Util.normalize_opts(opts))
       instance.refresh
       instance
     end