Class: Orb::Internal::Page

Inherits:
Object
  • Object
show all
Includes:
Type::BasePage
Defined in:
lib/orb/internal/page.rb

Overview

Examples:

if page.has_next?
  page = page.next_page
end

page.auto_paging_each do |coupon|
  puts(coupon)
end

Defined Under Namespace

Classes: PaginationMetadata

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

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

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 Page.

Parameters:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/orb/internal/page.rb', line 65

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

  case page_data
  in {data: Array => data}
    @data = data.map { Orb::Internal::Type::Converter.coerce(@model, _1) }
  else
  end
  case page_data
  in {pagination_metadata: Hash | nil => pagination_metadata}
    @pagination_metadata =
      Orb::Internal::Type::Converter.coerce(
        Orb::Internal::Page::PaginationMetadata,
        pagination_metadata
      )
  else
  end
end

Instance Attribute Details

#data ⇒ Array<generic<Elem>>?

Returns:

  • (Array<generic<Elem>>, nil) 


20
21
22
 
# File 'lib/orb/internal/page.rb', line 20

def data
  @data
end

#pagination_metadata ⇒ PaginationMetadata

Returns:



23
24
25
 
# File 'lib/orb/internal/page.rb', line 23

def pagination_metadata
  @pagination_metadata
end

Instance Method Details

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

Parameters:

  • blk (Proc)

Yield Parameters:

  • (generic<Elem>) 


45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/orb/internal/page.rb', line 45

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

  page = self
  loop do
    page.data&.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) 


87
88
89
90
91
 
# File 'lib/orb/internal/page.rb', line 87

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

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

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (Orb::HTTP::Error) 


32
33
34
35
36
37
38
39
40
 
# File 'lib/orb/internal/page.rb', line 32

def next_page
  unless next_page?
    message = "No more pages available. Please check #next_page? before calling ##{__method__}"
    raise RuntimeError.new(message)
  end

  req = Orb::Internal::Util.deep_merge(@req, {query: {cursor: pagination_metadata&.next_cursor}})
  @client.request(req)
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/orb/internal/page.rb', line 26

def next_page?
  !data.to_a.empty? && !pagination_metadata&.next_cursor.to_s.empty?
end