Class: Trav3::Response

Inherits:

Object

• Object
• Trav3::Response

Extended by:

Forwardable

Defined in:

lib/trav3/response/response.rb

Overview

The results from queries return either Success or RequestError which both repsond with Hash like query methods for the JSON data or the Net::HTTP resonse object methods.

The Response classes Success and RequestError forward method calls for all of the instance methods of a ResponseCollection to the collection. And many of the methods calls for the Net::HTTP response are also available on this class and those method calls are forwarded to the response.

Direct Known Subclasses

RequestError, Success

Instance Method Summary

• #[] ⇒ Object

  Forwards to :@collection.

• #body ⇒ Object

  Forwards to :@response.

• #code ⇒ Object

  Forwards to :@response.

• #code_type ⇒ Object

  Forwards to :@response.

• #count ⇒ Object

  Forwards to :@collection.

• #decode_content ⇒ Object

  Forwards to :@response.

• #dig ⇒ Object

  Forwards to :@collection.

• #each ⇒ Object

  Forwards to :@collection.

• #each_header ⇒ Object

  Forwards to :@response.

• #empty? ⇒ Object

  Forwards to :@collection.

• #entity ⇒ Object

  Forwards to :@response.

• #failure? ⇒ Boolean abstract
• #fetch ⇒ Object

  Forwards to :@collection.

• #first ⇒ Object

  Forwards to :@collection.

• #follow ⇒ Object

  Forwards to :@collection.

• #get_fields ⇒ Object

  Forwards to :@response.

• #has_key? ⇒ Object

  Forwards to :@collection.

• #hash? ⇒ Object

  Forwards to :@collection.

• #header ⇒ Object

  Forwards to :@response.

• #http_version ⇒ Object

  Forwards to :@response.

• #initialize(travis, response) ⇒ Response constructor

  A new instance of Response.

• #inspect ⇒ Object

  Class name and keys of response.

• #key? ⇒ Object

  Forwards to :@collection.

• #keys ⇒ Object

  Forwards to :@collection.

• #last ⇒ Object

  Forwards to :@collection.

• #message ⇒ Object

  Forwards to :@response.

• #msg ⇒ Object

  Forwards to :@response.

• #read_body ⇒ Object

  Forwards to :@response.

• #read_header ⇒ Object

  Forwards to :@response.

• #reading_body ⇒ Object

  Forwards to :@response.

• #response ⇒ Object

  Forwards to :@response.

• #success? ⇒ Boolean abstract
• #uri ⇒ Object

  Forwards to :@response.

• #value ⇒ Object

  Forwards to :@response.

• #values ⇒ Object

  Forwards to :@collection.

Constructor Details

#initialize(travis, response) ⇒ Response

Returns a new instance of Response

# File 'lib/trav3/response/response.rb', line 115

def initialize(travis, response)
  @travis = travis
  @response = response
  @collection = begin
                  result = JSON.parse(response&.body || '{}')
                  ResponseCollection.new(travis, result)
                rescue JSON::ParserError
                  response.error!
                end
end

Instance Method Details

#[] ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#[]

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#body ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#body

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#code ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#code

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#code_type ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#code_type

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#count ⇒ Object

Forwards to :@collection.

See Also:

• Trav3::ResponseCollection#count

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#decode_content ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#decode_content

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#dig ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#dig

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#each ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#each

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#each_header ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPHeader#each_header

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#empty? ⇒ Object

Forwards to :@collection.

See Also:

• Trav3::ResponseCollection#empty?

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#entity ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#entity

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#failure? ⇒ Boolean

This method is abstract.

Returns:

• (Boolean)

Raises:

• (Unimplemented)

# File 'lib/trav3/response/response.rb', line 137

def failure?
  raise Unimplemented
end

#fetch ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#fetch

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#first ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#first

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#follow ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#follow

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#get_fields ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPHeader#get_fields

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#has_key? ⇒ Object

Forwards to :@collection.

See Also:

• Trav3::ResponseCollection#has_key?

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#hash? ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#hash?

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#header ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#header

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#http_version ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#http_version

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#inspect ⇒ Object

Class name and keys of response

# File 'lib/trav3/response/response.rb', line 127

def inspect
  "<#{self.class} Response: keys = #{keys}>"
end

#key? ⇒ Object

Forwards to :@collection.

See Also:

• Trav3::ResponseCollection#key?

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#keys ⇒ Object

Forwards to :@collection.

See Also:

• Trav3::ResponseCollection#keys

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#last ⇒ Object

Forwards to :@collection

See Also:

• Trav3::ResponseCollection#last

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)

#message ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#message

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#msg ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#msg

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#read_body ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#read_body

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#read_header ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#read_header

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#reading_body ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#reading_body

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#response ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#response

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#success? ⇒ Boolean

This method is abstract.

Returns:

• (Boolean)

Raises:

• (Unimplemented)

# File 'lib/trav3/response/response.rb', line 132

def success?
  raise Unimplemented
end

#uri ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#uri

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#value ⇒ Object

Forwards to :@response

See Also:

• Net::HTTPResponse#value

# File 'lib/trav3/response/response.rb', line 111

def_delegators :@response, :body, :code, :code_type, :decode_content,
:each_header, :entity, :get_fields, :header, :http_version,
:message, :msg, :read_body, :read_header, :reading_body, :response,
:uri, :value

#values ⇒ Object

Forwards to :@collection.

See Also:

• Trav3::ResponseCollection#values

# File 'lib/trav3/response/response.rb', line 58

def_delegators :@collection, *ResponseCollection.instance_methods(false)