Class: Dodopayments::Internal::DefaultPageNumberPagination

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

Overview

Examples:

if default_page_number_pagination.has_next?
  default_page_number_pagination = default_page_number_pagination.next_page
end

default_page_number_pagination.auto_paging_each do |payment|
  puts(payment)
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Type::BasePage

#to_enum

Constructor Details

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

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



71
72
73
74
75
76
77
78
79
 
# File 'lib/dodopayments/internal/default_page_number_pagination.rb', line 71

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

  case page_data
  in {items: Array => items}
    @items = items.map { Dodopayments::Internal::Type::Converter.coerce(@model, _1) }
  else
  end
end

Instance Attribute Details

#items ⇒ Array<generic<Elem>>? 



20
21
22
 
# File 'lib/dodopayments/internal/default_page_number_pagination.rb', line 20

def items
  @items
end

Instance Method Details

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

Yield Parameters:

  • (generic<Elem>) 


51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/dodopayments/internal/default_page_number_pagination.rb', line 51

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

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



84
85
86
87
88
 
# File 'lib/dodopayments/internal/default_page_number_pagination.rb', line 84

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

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

#next_page ⇒ self

Raises:

  • (Dodopayments::HTTP::Error) 


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/dodopayments/internal/default_page_number_pagination.rb', line 29

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

  req = Dodopayments::Internal::Util.deep_merge(
    @req,
    {
      query: {
        page_number: @req.fetch(:query).fetch(
          :page_number, 1
        ).to_i.succ
      }
    }
  )
  @client.request(req)
end

#next_page? ⇒ Boolean 



23
24
25
 
# File 'lib/dodopayments/internal/default_page_number_pagination.rb', line 23

def next_page?
  !items.to_a.empty?
end