mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-04 00:00:47 -04:00
863da48398
Adds the magic `frozen_string_literal: true` comment to every file and enables a Rubocop rule to make sure that it's always going to be there going forward as well. See here for more background [1], but the basic idea is that unlike many other languages, static strings in code are mutable by default. This has since been acknowledged as not a particularly good idea, and the intention is to rectify the mistake when Ruby 3 comes out, where all string literals will be frozen. The `frozen_string_literal` magic comment was introduced in Ruby 2.3 as a way of easing the transition, and allows libraries and projects to freeze their literals in advance. I don't think this is breaking in any way: it's possible that users might've been pulling out one of are literals somehow and mutating it, but that would probably not have been useful for anything and would certainly not be recommended, so I'm quite comfortable pushing this change through as a minor version. As discussed in #641. [1] https://stackoverflow.com/a/37799399
106 lines
3.3 KiB
Ruby
106 lines
3.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
class ListObject < StripeObject
|
|
include Enumerable
|
|
include Stripe::APIOperations::List
|
|
include Stripe::APIOperations::Request
|
|
include Stripe::APIOperations::Create
|
|
|
|
OBJECT_NAME = "list".freeze
|
|
|
|
# This accessor allows a `ListObject` 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 list 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_list(opts = {})
|
|
ListObject.construct_from({ data: [] }, opts)
|
|
end
|
|
|
|
def initialize(*args)
|
|
super
|
|
self.filters = {}
|
|
end
|
|
|
|
def [](k)
|
|
case k
|
|
when String, Symbol
|
|
super
|
|
else
|
|
raise ArgumentError, "You tried to access the #{k.inspect} index, but ListObject types only support String keys. (HINT: List calls return an object with a 'data' (which is the data array). You likely want to call #data[#{k.inspect}])"
|
|
end
|
|
end
|
|
|
|
# Iterates through each resource in the page represented by the current
|
|
# `ListObject`.
|
|
#
|
|
# 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
|
|
|
|
# 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_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_page
|
|
break if page.empty?
|
|
end
|
|
end
|
|
|
|
# Returns true if the page object contains no elements.
|
|
def empty?
|
|
data.empty?
|
|
end
|
|
|
|
def retrieve(id, opts = {})
|
|
id, retrieve_params = Util.normalize_id(id)
|
|
resp, opts = request(:get, "#{resource_url}/#{CGI.escape(id)}", retrieve_params, opts)
|
|
Util.convert_to_stripe_object(resp.data, opts)
|
|
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_page(params = {}, opts = {})
|
|
return self.class.empty_list(opts) unless has_more
|
|
last_id = data.last.id
|
|
|
|
params = filters.merge(starting_after: last_id).merge(params)
|
|
|
|
list(params, opts)
|
|
end
|
|
|
|
# Fetches the previous 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 previous_page(params = {}, opts = {})
|
|
first_id = data.first.id
|
|
|
|
params = filters.merge(ending_before: first_id).merge(params)
|
|
|
|
list(params, opts)
|
|
end
|
|
|
|
def resource_url
|
|
url ||
|
|
raise(ArgumentError, "List object does not contain a 'url' field.")
|
|
end
|
|
end
|
|
end
|