class Moonclerk::ListObject
Attributes
This accessor allows a ‘ListObject` to inherit a count that was given to a predecessor. This allows consistent counts as a user pages through resources. Offset is used to shift the starting point of the list.
This accessor allows a ‘ListObject` to inherit a count that was given to a predecessor. This allows consistent counts as a user pages through resources. Offset is used to shift the starting point of the list.
Public Class Methods
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.
# File lib/moonclerk/list_object.rb, line 14 def self.empty_list ListObject.construct_from({ data: [], object: "" }) end
Public Instance Methods
# File lib/moonclerk/list_object.rb, line 18 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.") end 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
.
# File lib/moonclerk/list_object.rb, line 42 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
# File lib/moonclerk/list_object.rb, line 64 def create(params = {}) response = request(:post, url, params) Util.convert_to_moonclerk_object(response) 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
.
# File lib/moonclerk/list_object.rb, line 32 def each(&blk) self.data.each(&blk) end
Returns true if the page object contains no elements.
# File lib/moonclerk/list_object.rb, line 54 def empty? self.data.blank? end
Fetches the next page in the resource list (if there is one).
This method will try to respect the count of the current page. If none was given, the default count will be fetched again.
# File lib/moonclerk/list_object.rb, line 73 def next_page(params = {}) params = { :count => count, # may be nil :offset => (offset || 0) + (count || 20), }.merge(params) list(params) end
Fetches the previous page in the resource list (if there is one).
This method will try to respect the count of the current page. If none was given, the default count will be fetched again.
# File lib/moonclerk/list_object.rb, line 86 def previous_page(params = {}) new_offset = (offset || 0) - (count || 20) new_offset = 0 if new_offset < 0 params = { :count => count, # may be nil :offset => new_offset, }.merge(params) list(params) end
# File lib/moonclerk/list_object.rb, line 58 def retrieve(id) id, retrieve_params = Util.normalize_id(id) response = request(:get,"#{url}/#{CGI.escape(id)}", retrieve_params) Util.convert_to_moonclerk_object(response) end