Class: Saorin::Response

Inherits:
Object
  • Object
show all
Includes:
Dumpable
Defined in:
lib/saorin/response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dumpable

#to_json

Constructor Details

#initialize(options = {}) ⇒ Response

Returns a new instance of Response.



11
12
13
14
15
16
 
# File 'lib/saorin/response.rb', line 11

def initialize(options = {})
  @version = options[:version] || Saorin::JSON_RPC_VERSION
  @result = options[:result]
  @error = options[:error]
  @id = options[:id]
end

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.



9
10
11
 
# File 'lib/saorin/response.rb', line 9

def error
  @error
end

#id ⇒ Object

Returns the value of attribute id.



9
10
11
 
# File 'lib/saorin/response.rb', line 9

def id
  @id
end

#result ⇒ Object

Returns the value of attribute result.



9
10
11
 
# File 'lib/saorin/response.rb', line 9

def result
  @result
end

#version ⇒ Object

Returns the value of attribute version.



9
10
11
 
# File 'lib/saorin/response.rb', line 9

def version
  @version
end

Class Method Details

.from_hash(hash) ⇒ Object

Raises:



45
46
47
48
 
# File 'lib/saorin/response.rb', line 45

def self.from_hash(hash)
  raise Saorin::InvalidResponse unless hash.is_a?(::Hash)
  new Saorin::Utility.symbolized_keys(hash)
end

Instance Method Details

#error? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/saorin/response.rb', line 18

def error?
  !!@error
end

#to_h ⇒ Object 



36
37
38
39
40
41
42
43
 
# File 'lib/saorin/response.rb', line 36

def to_h
  h = {}
  h['jsonrpc'] = @version
  h['result'] = @result unless error?
  h['error'] = @error if error?
  h['id'] = id
  h
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
25
26
27
28
29
30
 
# File 'lib/saorin/response.rb', line 22

def valid?
  return false unless !(@result && @error)
  return false unless [String].any? { |type| @version.is_a? type }
  return false unless [Object].any? { |type| @result.is_a? type }
  return false unless [Saorin::Error, Hash, NilClass].any? { |type| @error.is_a? type }
  return false unless [String, Numeric, NilClass].any? { |type| @id.is_a? type }
  return false unless @version == JSON_RPC_VERSION
  true
end

#validate ⇒ Object

Raises:



32
33
34
 
# File 'lib/saorin/response.rb', line 32

def validate
  raise Saorin::InvalidResponse unless valid?
end