Class: FinchAPI::Internal::SinglePage

Inherits:
Array
  • Object
show all
Includes:
Type::BasePage
Defined in:
lib/finch_api/internal/single_page.rb

Overview

Examples:

if single_page.has_next?
  single_page = single_page.next_page
end
single_page.auto_paging_each do |payment|
  puts(payment)
end

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

#initialize(client:, req:, headers:, page_data:) ⇒ SinglePage

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of SinglePage.

Parameters:



53
54
55
56
57
58
59
60
61
 
# File 'lib/finch_api/internal/single_page.rb', line 53

def initialize(client:, req:, headers:, page_data:)
  super

  case page_data
  in Array
    replace(page_data.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) })
  else
  end
end

Instance Method Details

#auto_paging_each(&blk) {|| ... } ⇒ Object

Parameters:

  • blk (Proc)

Yield Parameters:

  • (generic<Elem>) 


33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/finch_api/internal/single_page.rb', line 33

def auto_paging_each(&blk)
  unless block_given?
    raise ArgumentError.new("A block must be given to ##{__method__}")
  end

  page = self
  loop do
    page.each(&blk)

    break unless page.next_page?
    page = page.next_page
  end
end

#inspect ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String) 


66
67
68
69
70
 
# File 'lib/finch_api/internal/single_page.rb', line 66

def inspect
  model = FinchAPI::Internal::Type::Converter.inspect(@model, depth: 1)

  "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
end

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (FinchAPI::HTTP::Error) 


26
27
28
 
# File 'lib/finch_api/internal/single_page.rb', line 26

def next_page
  RuntimeError.new("No more pages available.")
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/finch_api/internal/single_page.rb', line 20

def next_page?
  false
end