Class: Zabby::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/zabby/connection.rb

Constant Summary collapse

JSONRPC_SCRIPT =

Name of the Zabbix RPC script

"/api_jsonrpc.php"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Connection

Returns a new instance of Connection.



15
16
17
 
# File 'lib/zabby/connection.rb', line 15

def initialize
  reset
end

Instance Attribute Details

#auth ⇒ Object (readonly)

Returns the value of attribute auth.



12
13
14
 
# File 'lib/zabby/connection.rb', line 12

def auth
  @auth
end

#password ⇒ Object (readonly)

Returns the value of attribute password.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def password
  @password
end

#proxy_host ⇒ Object (readonly)

Returns the value of attribute proxy_host.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def proxy_host
  @proxy_host
end

#proxy_password ⇒ Object (readonly)

Returns the value of attribute proxy_password.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def proxy_password
  @proxy_password
end

#proxy_user ⇒ Object (readonly)

Returns the value of attribute proxy_user.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def proxy_user
  @proxy_user
end

#request_id ⇒ Object (readonly)

Returns the value of attribute request_id.



13
14
15
 
# File 'lib/zabby/connection.rb', line 13

def request_id
  @request_id
end

#request_path ⇒ Object (readonly)

Returns the value of attribute request_path.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def request_path
  @request_path
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def uri
  @uri
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



11
12
13
 
# File 'lib/zabby/connection.rb', line 11

def user
  @user
end

Instance Method Details

#authenticate ⇒ Authentication key

Returns:

  • (Authentication key) 


53
54
55
56
57
58
59
60
61
 
# File 'lib/zabby/connection.rb', line 53

def authenticate
  auth_message = format_message('user', 'login',
                                'user' => @user,
                                'password' => @password)
  @auth = query_zabbix_rpc(auth_message)
rescue Exception => e
  @auth = nil
  raise e
end

#format_message(element, action, params = {}) ⇒ Object 



63
64
65
66
67
68
69
70
71
 
# File 'lib/zabby/connection.rb', line 63

def format_message(element, action, params = {})
  {
      'jsonrpc' => '2.0',
      'id' => next_request_id,
      'method' => "#{element}.#{action}",
      'params' => params,
      'auth' => @auth
  }
end

#http ⇒ Object

Prepare http object



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/zabby/connection.rb', line 89

def http
  if @proxy_host
    http = Net::HTTP::Proxy(@proxy_host.host, @proxy_host.port, @proxy_user, @proxy_password).new(@uri.host, @uri.port)
  else
    http = Net::HTTP.new(@uri.host, @uri.port)
  end
  if @uri.scheme == "https"
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end
  http
end

#logged_in? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/zabby/connection.rb', line 44

def logged_in?
  !@auth.nil?
end

#login(config) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/zabby/connection.rb', line 25

def (config)
  return @auth if @auth
  
  @uri = URI.parse(config.server)
  @user = config.user
  @password = config.password
  if config.proxy_host
    @proxy_host = URI.parse(config.proxy_host)
    @proxy_user = config.proxy_user
    @proxy_password = config.proxy_password
  end
  @request_path = @uri.path[-4,4] == '.php' ? @uri.path : @uri.path + JSONRPC_SCRIPT
  authenticate
end

#logout ⇒ Object 



40
41
42
 
# File 'lib/zabby/connection.rb', line 40

def logout
  reset
end

#next_request_id ⇒ Object 



48
49
50
 
# File 'lib/zabby/connection.rb', line 48

def next_request_id
  @request_id += 1
end

#perform_request(element, action, params) ⇒ Object

Perform an authenticated request

Raises:



74
75
76
77
78
79
 
# File 'lib/zabby/connection.rb', line 74

def perform_request(element, action, params)
  raise AuthenticationError.new("Not logged in") if !logged_in?

  message = format_message(element, action, params)
  query_zabbix_rpc(message)
end

#query_zabbix_rpc(message) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/zabby/connection.rb', line 102

def query_zabbix_rpc(message)
  # Send the request!
  response = http.request(request(message))

  if response.code != "200" then
    raise ResponseCodeError.new("Response code from [#{@uri}] is #{response.code}): #{response.body}")
  end

  zabbix_response = JSON.parse(response.body)

  #if not ( responce_body_hash['id'] == id ) then
  # raise Zabbix::InvalidAnswerId.new("Wrong ID in zabbix answer")
  #end

  # Check errors in zabbix answer. If error exist - raise exception Zabbix::Error
  if (error = zabbix_response['error']) then
    error_message = error['message']
    error_data = error['data']
    error_code = error['code']

    e_message = "Code: [" + error_code.to_s + "]. Message: [" + error_message +
            "]. Data: [" + error_data + "]."

    if error_data == "Login name or password is incorrect"
      raise AuthenticationError.new(e_message)
    else
      raise StandardError.new(e_message)
    end
  end

  zabbix_response['result']
end

#request(message) ⇒ Object 



81
82
83
84
85
86
 
# File 'lib/zabby/connection.rb', line 81

def request(message)
  req = Net::HTTP::Post.new(@request_path)
  req.add_field('Content-Type', 'application/json-rpc')
  req.body = JSON.generate(message)
  req
end

#reset ⇒ Object 



19
20
21
22
23
 
# File 'lib/zabby/connection.rb', line 19

def reset
  @uri = @user = @password = @proxy_host = @proxy_user = @proxy_password = nil
  @request_id = 0
  @auth = nil
end