Class: GenesisRuby::Network::Adapter::BaseAdapter

Inherits:
Object
  • Object
show all
Defined in:
lib/genesis_ruby/network/adapter/base_adapter.rb

Overview

Base Network Adapter Class

Direct Known Subclasses

NetHttpAdapter

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#response_bodyObject

Response body is plain string received from the server Response header is hash with the received headers from the server



11
12
13
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 11

def response_body
  @response_body
end

#response_headersObject

Response body is plain string received from the server Response header is hash with the received headers from the server



11
12
13
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 11

def response_headers
  @response_headers
end

Instance Method Details

#error?Boolean

Whether the response is an error (HTTP Code != 200)

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)


31
32
33
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 31

def error?
  raise NotImplementedError, 'Error? method must be implemented'
end

#executeObject

Execute the request Return the adapter library response object

Raises:

  • (NotImplementedError)


26
27
28
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 26

def execute
  raise NotImplementedError, 'Execute method must be implemented'
end

#prepare_request(data) ⇒ Object

Prepare the Request Return the adapter library request object

Raises:

  • (NotImplementedError)


20
21
22
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 20

def prepare_request(data)
  raise NotImplementedError, 'Prepare Request Body method must be implemented'
end

#server_messageObject

Response server message

Raises:

  • (NotImplementedError)


36
37
38
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 36

def server_message
  raise NotImplementedError, 'Server Message method must be implemented'
end

#statusObject

Retrieve HTTP Response Status Code

Raises:

  • (NotImplementedError)


14
15
16
# File 'lib/genesis_ruby/network/adapter/base_adapter.rb', line 14

def status
  raise NotImplementedError, 'Status method must be implemented'
end