mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-11-28 00:02:45 -05:00
42ea34b969
Usage on a top-level collection:
```
Stripe::Customer.list.auto_paging_each do |customer|
puts customer
end
```
Usage on a subcollection:
``` ruby
customer.invoices.auto_paging_each do |invoice|
puts invoice
end
```
We've also renamed `#all` to `#list` to prevent confusion ("all" implies
that all resources are being returned, and in Stripe's paginated API
this was not the case). An alias has been provided for backward API
compatibility.
Fixes #167.
Replaces #211 and #248.
102 lines
3.2 KiB
Ruby
102 lines
3.2 KiB
Ruby
module Stripe
|
|
class ListObject < StripeObject
|
|
include Enumerable
|
|
include Stripe::APIOperations::List
|
|
include Stripe::APIOperations::Request
|
|
|
|
# This accessor allows a `ListObject` to inherit a limit that was given to
|
|
# a predecessor. This allows consistent limits as a user pages through
|
|
# resources.
|
|
attr_accessor :limit
|
|
|
|
# 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 [](k)
|
|
case k
|
|
when String, Symbol
|
|
super
|
|
else
|
|
raise ArgumentError.new("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)
|
|
self.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?
|
|
self.data.empty?
|
|
end
|
|
|
|
def retrieve(id, opts={})
|
|
id, retrieve_params = Util.normalize_id(id)
|
|
response, opts = request(:get,"#{url}/#{CGI.escape(id)}", retrieve_params, opts)
|
|
Util.convert_to_stripe_object(response, opts)
|
|
end
|
|
|
|
def create(params={}, opts={})
|
|
response, opts = request(:post, url, params, opts)
|
|
Util.convert_to_stripe_object(response, 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) if !has_more
|
|
last_id = data.last.id
|
|
|
|
params = {
|
|
:limit => limit, # may be nil
|
|
: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 = {
|
|
:ending_before => first_id,
|
|
:limit => limit, # may be nil
|
|
}.merge(params)
|
|
|
|
list(params, opts)
|
|
end
|
|
end
|
|
end
|