Class: ModernTreasury::Internal::Page

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

Overview

Examples:

if page.has_next?
  page = page.next_page
end

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

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
 
# File 'lib/modern_treasury/internal/page.rb', line 65

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

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

  @per_page = ModernTreasury::Internal::Util.coerce_integer(headers["x-per-page"])
  @after_cursor = headers["x-after-cursor"]&.to_s
end

Instance Attribute Details

#after_cursor ⇒ String

Returns:

  • (String) 


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

def after_cursor
  @after_cursor
end

#per_page ⇒ Integer

Returns:

  • (Integer) 


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

def per_page
  @per_page
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/modern_treasury/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.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) 


81
82
83
84
85
86
87
 
# File 'lib/modern_treasury/internal/page.rb', line 81

def inspect
  # rubocop:disable Layout/LineLength
  model = ModernTreasury::Internal::Type::Converter.inspect(@model, depth: 1)

  "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} per_page=#{per_page.inspect} after_cursor=#{after_cursor.inspect}>"
  # rubocop:enable Layout/LineLength
end

#next_page ⇒ self

Returns:

  • (self)

Raises:

  • (ModernTreasury::HTTP::Error) 


32
33
34
35
36
37
38
39
40
 
# File 'lib/modern_treasury/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 = ModernTreasury::Internal::Util.deep_merge(@req, {query: {after_cursor: after_cursor}})
  @client.request(req)
end

#next_page? ⇒ Boolean

Returns:

  • (Boolean) 


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

def next_page?
  !after_cursor.to_s.empty?
end