Module: Nexpose::AJAX
- Defined in:
- lib/nexpose/ajax.rb
Overview
Accessor to the Nexpose AJAX API. These core methods should allow direct access to underlying controllers in order to test functionality that is not currently exposed through the XML API.
Defined Under Namespace
Modules: CONTENT_TYPE
Class Method Summary collapse
-
.delete(nsc, uri, content_type = CONTENT_TYPE::XML) ⇒ Object
DELETE call to a Nexpose controller.
-
.form_post(nsc, uri, parameters, content_type = CONTENT_TYPE::FORM) ⇒ Hash
POST call to a Nexpose controller that uses a form-post model.
-
.get(nsc, uri, content_type = CONTENT_TYPE::XML, options = {}) ⇒ String|REXML::Document|Hash
GET call to a Nexpose controller.
- .get_api_error(request, response) ⇒ Object
-
.get_error_message(request, response) ⇒ Object
Get an error message from the response body if the request url api version is 2.1 or greater otherwise use the request body.
-
.get_request_api_version(request) ⇒ Object
Get the version of the api target by request.
- .get_rows(nsc, pref) ⇒ Object
-
.headers(nsc, request) ⇒ Object
Attach necessary header fields.
-
.https(nsc, timeout = nil) ⇒ Object
Use the Nexpose::Connection to establish a correct HTTPS object.
-
.parameterize_uri(uri, parameters) ⇒ Hash
Append the query parameters to given URI.
-
.patch(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML) ⇒ String
PATCH call to a Nexpose controller.
-
.post(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML, timeout = nil) ⇒ String|REXML::Document|Hash
POST call to a Nexpose controller.
-
.preserving_preference(nsc, pref) ⇒ Object
Execute a block of code while presenving the preferences for any underlying table being accessed.
-
.put(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML) ⇒ String
PUT call to a Nexpose controller.
- .request(nsc, request, timeout = nil) ⇒ Object
-
.row_pref_of(val) ⇒ Fixnum
Get a valid row preference value.
- .set_rows(nsc, pref, value) ⇒ Object
-
.use_response_error_message?(request, response) ⇒ Boolean
Code cleanup to allow for cleaner get_error_message method.
Class Method Details
.delete(nsc, uri, content_type = CONTENT_TYPE::XML) ⇒ Object
DELETE call to a Nexpose controller.
105 106 107 108 109 |
# File 'lib/nexpose/ajax.rb', line 105 def delete(nsc, uri, content_type = CONTENT_TYPE::XML) delete = Net::HTTP::Delete.new(uri) delete.set_content_type(content_type) request(nsc, delete) end |
.form_post(nsc, uri, parameters, content_type = CONTENT_TYPE::FORM) ⇒ Hash
POST call to a Nexpose controller that uses a form-post model. This is here to support legacy use of POST in old controllers.
93 94 95 96 97 98 |
# File 'lib/nexpose/ajax.rb', line 93 def form_post(nsc, uri, parameters, content_type = CONTENT_TYPE::FORM) post = Net::HTTP::Post.new(uri) post.set_content_type(content_type) post.set_form_data(parameters) request(nsc, post) end |
.get(nsc, uri, content_type = CONTENT_TYPE::XML, options = {}) ⇒ String|REXML::Document|Hash
GET call to a Nexpose controller.
30 31 32 33 34 35 |
# File 'lib/nexpose/ajax.rb', line 30 def get(nsc, uri, content_type = CONTENT_TYPE::XML, = {}) parameterize_uri(uri, ) get = Net::HTTP::Get.new(uri) get.set_content_type(content_type) request(nsc, get) end |
.get_api_error(request, response) ⇒ Object
170 171 172 173 174 |
# File 'lib/nexpose/ajax.rb', line 170 def get_api_error(request, response) req_type = request.class.name.split('::').last.upcase = (request, response) Nexpose::APIError.new(response, "#{req_type} request to #{request.path} failed. #{}", response.code) end |
.get_error_message(request, response) ⇒ Object
Get an error message from the response body if the request url api version is 2.1 or greater otherwise use the request body
188 189 190 191 192 193 |
# File 'lib/nexpose/ajax.rb', line 188 def (request, response) version = get_request_api_version(request) data_request = (request, response) return_response = (version >= 2.1 || data_request ) (return_response && response.body) ? "response body: #{response.body}" : "request body: #{request.body}" end |
.get_request_api_version(request) ⇒ Object
Get the version of the api target by request
179 180 181 182 183 184 |
# File 'lib/nexpose/ajax.rb', line 179 def get_request_api_version(request) matches = request.path.match(API_PATTERN) matches[:version].to_f rescue 0.0 end |
.get_rows(nsc, pref) ⇒ Object
247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/nexpose/ajax.rb', line 247 def get_rows(nsc, pref) uri = '/data/user/preferences/all' pref_key = "#{pref}.rows" resp = get(nsc, uri) json = JSON.parse(resp) if json.has_key?(pref_key) rows = json[pref_key].to_i rows > 0 ? rows : 10 else 10 end end |
.headers(nsc, request) ⇒ Object
Attach necessary header fields.
143 144 145 146 |
# File 'lib/nexpose/ajax.rb', line 143 def headers(nsc, request) request.add_field('nexposeCCSessionID', nsc.session_id) request.add_field('Cookie', "nexposeCCSessionID=#{nsc.session_id}") end |
.https(nsc, timeout = nil) ⇒ Object
Use the Nexpose::Connection to establish a correct HTTPS object.
134 135 136 137 138 139 140 |
# File 'lib/nexpose/ajax.rb', line 134 def https(nsc, timeout = nil) http = Net::HTTP.new(nsc.host, nsc.port) http.read_timeout = timeout if timeout http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE http end |
.parameterize_uri(uri, parameters) ⇒ Hash
Append the query parameters to given URI.
125 126 127 128 129 130 131 |
# File 'lib/nexpose/ajax.rb', line 125 def parameterize_uri(uri, parameters) params = Hash.try_convert(parameters) unless params.nil? || params.empty? uri = uri.concat(('?').concat(parameters.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&'))) end uri end |
.patch(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML) ⇒ String
PATCH call to a Nexpose controller.
76 77 78 79 80 81 |
# File 'lib/nexpose/ajax.rb', line 76 def patch(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML) patch = Net::HTTP::Patch.new(uri) patch.set_content_type(content_type) patch.body = payload.to_s if payload request(nsc, patch) end |
.post(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML, timeout = nil) ⇒ String|REXML::Document|Hash
POST call to a Nexpose controller.
61 62 63 64 65 66 |
# File 'lib/nexpose/ajax.rb', line 61 def post(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML, timeout = nil) post = Net::HTTP::Post.new(uri) post.set_content_type(content_type) post.body = payload.to_s if payload request(nsc, post, timeout) end |
.preserving_preference(nsc, pref) ⇒ Object
Execute a block of code while presenving the preferences for any underlying table being accessed. Use this method when accessing data tables which are present in the UI to prevent existing row preferences from being set to 500.
This is an internal utility method, not subject to backward compatibility concerns.
216 217 218 219 220 221 222 223 |
# File 'lib/nexpose/ajax.rb', line 216 def preserving_preference(nsc, pref) begin orig = get_rows(nsc, pref) yield ensure set_rows(nsc, pref, orig) end end |
.put(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML) ⇒ String
PUT call to a Nexpose controller.
45 46 47 48 49 50 |
# File 'lib/nexpose/ajax.rb', line 45 def put(nsc, uri, payload = nil, content_type = CONTENT_TYPE::XML) put = Net::HTTP::Put.new(uri) put.set_content_type(content_type) put.body = payload.to_s if payload request(nsc, put) end |
.request(nsc, request, timeout = nil) ⇒ Object
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/nexpose/ajax.rb', line 148 def request(nsc, request, timeout = nil) http = https(nsc, timeout) headers(nsc, request) # Return response body if request is successful. Brittle. response = http.request(request) case response when Net::HTTPOK, Net::HTTPCreated, Net::HTTPNoContent response.body when Net::HTTPForbidden raise Nexpose::PermissionError.new(response) when Net::HTTPFound if response.header['location'] =~ /login/ raise Nexpose::AuthenticationFailed.new(response) else raise get_api_error(request, response) end else raise get_api_error(request, response) end end |
.row_pref_of(val) ⇒ Fixnum
Get a valid row preference value.
This is an internal utility method, not subject to backward compatibility concerns.
233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/nexpose/ajax.rb', line 233 def row_pref_of(val) if val.nil? || val > 100 500 elsif val > 50 100 elsif val > 25 50 elsif val > 10 25 else 10 end end |
.set_rows(nsc, pref, value) ⇒ Object
260 261 262 263 264 265 266 |
# File 'lib/nexpose/ajax.rb', line 260 def set_rows(nsc, pref, value) uri = '/data/user/preference' params = { 'name' => "#{pref}.rows", 'value' => value } form_post(nsc, uri, params) end |
.use_response_error_message?(request, response) ⇒ Boolean
Code cleanup to allow for cleaner get_error_message method
197 198 199 200 201 202 203 |
# File 'lib/nexpose/ajax.rb', line 197 def (request, response) if (request.path.include?('/data/') && !response.content_type.nil?) response.content_type.include? 'text/plain' else return false end end |