module Nimbu::Pagination
A module that decorates response with pagination helpers
A module that decorates response with pagination helpers
Public Instance Methods
Iterate over results set pages by automatically calling `next_page` until all pages are exhausted. Caution needs to be exercised when using this feature - 100 pages iteration will perform 100 API
calls. By default this is off. You can set it on the client, individual API
instances or just per given request.
# File lib/nimbu-api/pagination.rb, line 29 def auto_paginate(auto=false) if links.any? && (current_api.auto_pagination? || auto) resources_bodies = [] each_page { |resource| resources_bodies += resource.body } self.body = resources_bodies end self end
Retrive number of total pages base on current :per_page parameter
# File lib/nimbu-api/pagination.rb, line 19 def count_pages page_iterator.count.to_i end
Iterator like each for response pages. If there are no pages to iterate over this method will return current page.
# File lib/nimbu-api/pagination.rb, line 40 def each_page yield self while page_iterator.has_next? yield next_page end end
Retrives the result of the first page. Returns nil
if there is no first page - either because you are already on the first page or there are no pages at all in the result.
# File lib/nimbu-api/pagination.rb, line 50 def first_page first_request = page_iterator.first self.instance_eval { @env = first_request.env } if first_request first_request end
Returns true
if there is another page in the result set, otherwise false
# File lib/nimbu-api/pagination.rb, line 94 def has_next_page? page_iterator.has_next? end
Retrives the result of the last page. Returns nil
if there is no last page - either because you are already on the last page, there is only one page or there are no pages at all in the result.
# File lib/nimbu-api/pagination.rb, line 76 def last_page last_request = page_iterator.last self.instance_eval { @env = last_request.env } if last_request last_request end
Return page links
# File lib/nimbu-api/pagination.rb, line 14 def links @links = Nimbu::Pagination::PageLinks.new(env[:response_headers]) end
Retrives the result of the next page. Returns nil
if there is no next page or no pages at all.
# File lib/nimbu-api/pagination.rb, line 58 def next_page next_request = page_iterator.next self.instance_eval { @env = next_request.env } if next_request next_request end
Retrives a specific result for a page given page number. The page_number
parameter is not validate, hitting a page that does not exist will return Nimbu
API
error. Consequently, if there is only one page, this method returns nil
# File lib/nimbu-api/pagination.rb, line 86 def page(page_number) request = page_iterator.get_page(page_number) self.instance_eval { @env = request.env } if request request end
Retrives the result of the previous page. Returns nil
if there is no previous page or no pages at all.
# File lib/nimbu-api/pagination.rb, line 66 def prev_page prev_request = page_iterator.prev self.instance_eval { @env = prev_request.env } if prev_request prev_request end