Class: Twilio::REST::Page

Inherits:

Object

Object
Twilio::REST::Page

show all

Includes:: Enumerable

Defined in:: lib/twilio-ruby/framework/rest/page.rb

Overview

Page Base Class

Direct Known Subclasses

Constant Summary collapse

META_KEYS =

[
  'end',
  'first_page_uri',
  'next_page_uri',
  'last_page_uri',
  'page',
  'page_size',
  'previous_page_uri',
  'total',
  'num_pages',
  'start',
  'uri'
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(version, response) ⇒ `Page`

Returns a new instance of Page.

# File 'lib/twilio-ruby/framework/rest/page.rb', line 23

def initialize(version, response)
  payload = process_response(response)

  @version = version
  @payload = payload
  @solution = {}
  @records = load_page(payload)
end

Instance Method Details

#each ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page.rb', line 92

def each
  @records.each do |record|
    yield get_instance(record)
  end
end

#get_instance(payload) ⇒ `Object`

Raises:

(Twilio::REST::TwilioError)



72
73
74

# File 'lib/twilio-ruby/framework/rest/page.rb', line 72

def get_instance(payload)
  raise Twilio::REST::TwilioError, 'Page.get_instance() must be implemented in the derived class'
end

#load_page(payload) ⇒ `Object`

Raises:

(Twilio::REST::TwilioError)

# File 'lib/twilio-ruby/framework/rest/page.rb', line 40

def load_page(payload)
  if payload['meta'] && payload['meta']['key']
    return payload[payload['meta']['key']]
  else
    keys = payload.keys
    key = keys - META_KEYS
    return payload[key.first] if key.size == 1
  end

  raise Twilio::REST::TwilioError, 'Page Records can not be deserialized'
end

#next_page ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page.rb', line 84

def next_page
  return nil unless next_page_url

  response = @version.domain.request('GET', next_page_url)

  self.class.new(@version, response, @solution)
end

#next_page_url ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page.rb', line 62

def next_page_url
  if @payload['meta'] && @payload['meta']['next_page_url']
    return @version.domain.absolute_url(URI.parse(@payload['meta']['next_page_url']).request_uri)
  elsif @payload['next_page_uri']
    return @version.domain.absolute_url(@payload['next_page_uri'])
  end

  nil
end

#previous_page ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page.rb', line 76

def previous_page
  return nil unless previous_page_url

  response = @version.domain.request('GET', previous_page_url)

  self.class.new(@version, response, @solution)
end

#previous_page_url ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page.rb', line 52

def previous_page_url
  if @payload['meta'] && @payload['meta']['previous_page_url']
    return @version.domain.absolute_url(URI.parse(@payload['meta']['previous_page_url']).request_uri)
  elsif @payload['previous_page_uri']
    return @version.domain.absolute_url(@payload['previous_page_uri'])
  end

  nil
end

#process_response(response) ⇒ `Object`

# File 'lib/twilio-ruby/framework/rest/page.rb', line 32

def process_response(response)
  if response.status_code != 200
    raise Twilio::REST::RestError.new('Unable to fetch page', response)
  end

  response.body
end

#to_s ⇒ `Object`



98
99
100

# File 'lib/twilio-ruby/framework/rest/page.rb', line 98

def to_s
  '#<Page>'
end

Class: Twilio::REST::Page

Overview

Direct Known Subclasses

Constant Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version, response) ⇒ Page

Instance Method Details

#each ⇒ Object

#get_instance(payload) ⇒ Object

#load_page(payload) ⇒ Object

#next_page ⇒ Object

#next_page_url ⇒ Object

#previous_page ⇒ Object

#previous_page_url ⇒ Object

#process_response(response) ⇒ Object

#to_s ⇒ Object

#initialize(version, response) ⇒ `Page`

#each ⇒ `Object`

#get_instance(payload) ⇒ `Object`

#load_page(payload) ⇒ `Object`

#next_page ⇒ `Object`

#next_page_url ⇒ `Object`

#previous_page ⇒ `Object`

#previous_page_url ⇒ `Object`

#process_response(response) ⇒ `Object`

#to_s ⇒ `Object`