class Helio::ListObject

Constants

OBJECT_NAME

Attributes

filters[RW]

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.

Public Class Methods

empty_list(opts = {}) click to toggle source

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/helio/list_object.rb, line 20
def self.empty_list(opts = {})
  ListObject.construct_from({ data: [] }, opts)
end
new(*args) click to toggle source
Calls superclass method Helio::HelioObject::new
# File lib/helio/list_object.rb, line 24
def initialize(*args)
  super
  self.filters = {}
end

Public Instance Methods

[](k) click to toggle source
Calls superclass method Helio::HelioObject#[]
# File lib/helio/list_object.rb, line 29
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
auto_paging_each(&blk) click to toggle source

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/helio/list_object.rb, line 53
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
each(&blk) click to toggle source

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/helio/list_object.rb, line 43
def each(&blk)
  data.each(&blk)
end
empty?() click to toggle source

Returns true if the page object contains no elements.

# File lib/helio/list_object.rb, line 65
def empty?
  data.empty?
end
next_page(params = {}, opts = {}) click to toggle source

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.

# File lib/helio/list_object.rb, line 79
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
previous_page(params = {}, opts = {}) click to toggle source

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.

# File lib/helio/list_object.rb, line 92
def previous_page(params = {}, opts = {})
  first_id = data.first.id

  params = filters.merge(ending_before: first_id).merge(params)

  list(params, opts)
end
resource_url() click to toggle source
# File lib/helio/list_object.rb, line 100
def resource_url
  url ||
    raise(ArgumentError, "List object does not contain a 'url' field.")
end
retrieve(id, opts = {}) click to toggle source
# File lib/helio/list_object.rb, line 69
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_helio_object(resp.data, opts)
end