Skip to content

Commit

Permalink
Merge pull request #18 from aarranz/feature/initial-getServerDetails-…
Browse files Browse the repository at this point in the history 
…method

Feature/initial get server details method
  • Loading branch information
@aarranz
aarranz committed Apr 2, 2018
2 parents 1a111a6 + fc2ad72 commit e1ea985
Show file tree
Hide file tree
Showing 3 changed files with 202 additions and 28 deletions.
3 changes: 2 additions & 1 deletion .eslintrc-jasmine
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"extends": ".eslintrc",
"env": {
"jasmine": true
"jasmine": true,
"es6": true
}
}
120 changes: 94 additions & 26 deletions NGSI.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
* Copyright (c) 2013-2017 CoNWeT Lab., Universidad Politécnica de Madrid
* Copyright (c) 2018 Future Internet Consulting and Development Solutions S.L.
*
* This file is part of ngsijs.
*
Expand Down Expand Up @@ -243,17 +244,21 @@
}

NGSI.endpoints = {
REGISTER_CONTEXT: 'v1/registry/registerContext',
DISCOVER_CONTEXT_AVAILABILITY: 'v1/registry/discoverContextAvailability',
SUBSCRIBE_CONTEXT_AVAILABILITY: 'v1/registry/subscribeContextAvailability',
UPDATE_CONTEXT_AVAILABILITY_SUBSCRIPTION: 'v1/registry/updateContextAvailabilitySubscription',
UNSUBSCRIBE_CONTEXT_AVAILABILITY: 'v1/registry/unsubscribeContextAvailability',
QUERY_CONTEXT: 'v1/queryContext',
UPDATE_CONTEXT: 'v1/updateContext',
SUBSCRIBE_CONTEXT: 'v1/subscribeContext',
UPDATE_CONTEXT_SUBSCRIPTION: 'v1/updateContextSubscription',
UNSUBSCRIBE_CONTEXT: 'v1/unsubscribeContext',
CONTEXT_TYPES: 'v1/contextTypes',
SERVER_DETAILS: 'version',

v1: {
REGISTER_CONTEXT: 'v1/registry/registerContext',
DISCOVER_CONTEXT_AVAILABILITY: 'v1/registry/discoverContextAvailability',
SUBSCRIBE_CONTEXT_AVAILABILITY: 'v1/registry/subscribeContextAvailability',
UPDATE_CONTEXT_AVAILABILITY_SUBSCRIPTION: 'v1/registry/updateContextAvailabilitySubscription',
UNSUBSCRIBE_CONTEXT_AVAILABILITY: 'v1/registry/unsubscribeContextAvailability',
QUERY_CONTEXT: 'v1/queryContext',
UPDATE_CONTEXT: 'v1/updateContext',
SUBSCRIBE_CONTEXT: 'v1/subscribeContext',
UPDATE_CONTEXT_SUBSCRIPTION: 'v1/updateContextSubscription',
UNSUBSCRIBE_CONTEXT: 'v1/unsubscribeContext',
CONTEXT_TYPES: 'v1/contextTypes'
},

v2: {
BATCH_QUERY_OP: 'v2/op/query',
Expand Down Expand Up @@ -1693,6 +1698,69 @@
});
};

/**
* Retrieves context broker server information.
*
* @name NGSI.Connection@getServerDetails
* @memberof NGSI.Connection
* @method "getServerDetails"
*
* @param {Object} [options]
*
* Object with extra options:
*
* - `correlator` (`String`): Transaction id
*
* @returns {Promise}
*
* @example
*
* connection.getServerDetails().then(
* (response) => {
* // Server information retrieved successfully
* // response.details contains all the details returned by the server.
* // response.correlator transaction id associated with the server response
* }, (error) => {
* // Error retrieving server information
* // If the error was reported by Orion, error.correlator will be
* // filled with the associated transaction id
* }
* );
*/
NGSI.Connection.prototype.getServerDetails = function getServerDetails(options) {
if (options == null) {
options = {};
}

var url = new URL(NGSI.endpoints.SERVER_DETAILS, this.url);
return makeJSONRequest2.call(this, url, {
method: "GET",
requestHeaders: {
"FIWARE-Correlator": options.correlator,
}
}).then(function (response) {
var correlator = response.getHeader('Fiware-correlator');

if (response.status !== 200) {
return Promise.reject(new NGSI.InvalidResponseError('Unexpected error code: ' + response.status, correlator));
}

try {
var data = JSON.parse(response.responseText);
} catch (e) {
return Promise.reject(new NGSI.InvalidResponseError('Server returned invalid JSON content', correlator));
}

var result = {
details: data,
correlator: correlator
};

return Promise.resolve(result);
});
};


/**
* Registers context information (entities and attributes) into the NGSI
* server.
Expand Down Expand Up @@ -1763,7 +1831,7 @@
}

var payload = ngsi_build_register_context_request(entities, attributes, duration, providingApplication);
var url = new URL(NGSI.endpoints.REGISTER_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.REGISTER_CONTEXT, this.url);

makeJSONRequest.call(this, url, payload, parse_register_context_response, callbacks);
};
Expand Down Expand Up @@ -1835,7 +1903,7 @@
}

var payload = ngsi_build_register_context_request(entities, attributes, duration, providingApplication, regId);
var url = new URL(NGSI.endpoints.REGISTER_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.REGISTER_CONTEXT, this.url);

return makeJSONRequest.call(this, url, payload, parse_register_context_response, callbacks);
};
Expand Down Expand Up @@ -1927,7 +1995,7 @@
}

var payload = ngsi_build_discover_context_availability_request(entities, attributeNames);
var url = new URL(NGSI.endpoints.DISCOVER_CONTEXT_AVAILABILITY, this.url);
var url = new URL(NGSI.endpoints.v1.DISCOVER_CONTEXT_AVAILABILITY, this.url);

makeJSONRequest.call(this, url, payload, parse_discover_context_availability_response, callbacks);
};
Expand Down Expand Up @@ -1986,7 +2054,7 @@
throw new TypeError('A ngsi-proxy is needed for using local onNotify callbacks');
}

var url = new URL(NGSI.endpoints.SUBSCRIBE_CONTEXT_AVAILABILITY, this.url);
var url = new URL(NGSI.endpoints.v1.SUBSCRIBE_CONTEXT_AVAILABILITY, this.url);
if (typeof options.onNotify === 'function' && this.ngsi_proxy != null) {

var onNotify = function onNotify(payload) {
Expand Down Expand Up @@ -2079,7 +2147,7 @@
}

var payload = ngsi_build_subscribe_update_context_availability_request(entities, attributeNames, duration, restriction, subId);
var url = new URL(NGSI.endpoints.UPDATE_CONTEXT_AVAILABILITY_SUBSCRIPTION, this.url);
var url = new URL(NGSI.endpoints.v1.UPDATE_CONTEXT_AVAILABILITY_SUBSCRIPTION, this.url);

makeJSONRequest.call(this, url, payload, parse_subscribe_update_context_availability_response, callbacks);
};
Expand Down Expand Up @@ -2112,7 +2180,7 @@
}

var payload = ngsi_build_unsubscribe_context_availability_request(subId);
var url = new URL(NGSI.endpoints.UNSUBSCRIBE_CONTEXT_AVAILABILITY, this.url);
var url = new URL(NGSI.endpoints.v1.UNSUBSCRIBE_CONTEXT_AVAILABILITY, this.url);

makeJSONRequest.call(this, url, payload, parse_unsubscribe_context_availability_response, callbacks);
};
Expand Down Expand Up @@ -2181,7 +2249,7 @@

parameters = parse_pagination_options(options, 'off');

url = new URL(NGSI.endpoints.QUERY_CONTEXT, this.url);
url = new URL(NGSI.endpoints.v1.QUERY_CONTEXT, this.url);
payload = ngsi_build_query_context_request(entities, attributesName, options.restriction);
makeJSONRequest.call(this, url, payload, parse_query_context_response, options, parameters);
};
Expand Down Expand Up @@ -2232,7 +2300,7 @@
}

var payload = ngsi_build_update_context_request('UPDATE', update);
var url = new URL(NGSI.endpoints.UPDATE_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.UPDATE_CONTEXT, this.url);

makeJSONRequest.call(this, url, payload, parse_update_context_response, callbacks);
};
Expand Down Expand Up @@ -2282,7 +2350,7 @@
}

var payload = ngsi_build_update_context_request('APPEND', toAdd);
var url = new URL(NGSI.endpoints.UPDATE_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.UPDATE_CONTEXT, this.url);

makeJSONRequest.call(this, url, payload, parse_update_context_response, callbacks);
};
Expand Down Expand Up @@ -2345,7 +2413,7 @@
}

var payload = ngsi_build_update_context_request('DELETE', toDelete);
var url = new URL(NGSI.endpoints.UPDATE_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.UPDATE_CONTEXT, this.url);

makeJSONRequest.call(this, url, payload, parse_update_context_response, callbacks);
};
Expand Down Expand Up @@ -2431,7 +2499,7 @@
throw new TypeError('A ngsi-proxy is needed for using local onNotify callbacks');
}

var url = new URL(NGSI.endpoints.SUBSCRIBE_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.SUBSCRIBE_CONTEXT, this.url);
if (typeof options.onNotify === 'function' && this.ngsi_proxy != null) {

var onNotify = function onNotify(payload) {
Expand Down Expand Up @@ -2539,7 +2607,7 @@
}

var payload = ngsi_build_subscribe_update_context_request(subId, null, null, duration, throttling, cond);
var url = new URL(NGSI.endpoints.UPDATE_CONTEXT_SUBSCRIPTION, this.url);
var url = new URL(NGSI.endpoints.v1.UPDATE_CONTEXT_SUBSCRIPTION, this.url);

makeJSONRequest.call(this, url, payload, parse_update_context_subscription_response, options);
};
Expand Down Expand Up @@ -2593,7 +2661,7 @@
}.bind(this);
}
var payload = ngsi_build_unsubscribe_context_request(subId);
var url = new URL(NGSI.endpoints.UNSUBSCRIBE_CONTEXT, this.url);
var url = new URL(NGSI.endpoints.v1.UNSUBSCRIBE_CONTEXT, this.url);

makeJSONRequest.call(this, url, payload, parse_unsubscribe_context_response, options);
};
Expand Down Expand Up @@ -2632,7 +2700,7 @@
*
*/
NGSI.Connection.prototype.getAvailableTypes = function getAvailableTypes(options) {
var url = new URL(NGSI.endpoints.CONTEXT_TYPES, this.url);
var url = new URL(NGSI.endpoints.v1.CONTEXT_TYPES, this.url);
var parameters = parse_pagination_options(options, 'on');
makeJSONRequest.call(this, url, null, parse_available_types_response, options, parameters);
};
Expand Down Expand Up @@ -2674,7 +2742,7 @@
throw new TypeError("Invalid type parameter");
}

var url = new URL(NGSI.endpoints.CONTEXT_TYPES + '/' + encodeURIComponent(type), this.url);
var url = new URL(NGSI.endpoints.v1.CONTEXT_TYPES + '/' + encodeURIComponent(type), this.url);
makeJSONRequest.call(this, url, null, parse_type_info_response, options);
};

Expand Down
107 changes: 106 additions & 1 deletion tests/ConnectionSpec.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/*
* Copyright (c) 2017 CoNWeT Lab., Universidad Politécnica de Madrid
* Copyright (c) 2018 Future Internet Consulting and Development Solutions S.L.
*
* This file is part of ngsijs.
*
Expand Down Expand Up @@ -35,7 +36,7 @@
*
*/

/* globals NGSI */
/* globals ajaxMockFactory, NGSI */

(function () {

Expand Down Expand Up @@ -158,6 +159,110 @@

});

describe("getServerDetails([options])", () => {

var connection;
var ajaxMockup = ajaxMockFactory.createFunction();
const details = {
"orion": {
"version": "1.9.0",
"uptime": "2 d, 20 h, 14 m, 17 s",
"git_hash": "f942277924867ced3682244c31a6df63bfa066e9",
"compile_time": "Wed Nov 22 08:37:00 UTC 2017",
"compiled_by": "root",
"compiled_in": "c663f9f730c9",
"release_date": "Wed Nov 22 08:37:00 UTC 2017",
"doc": "https://fiware-orion.readthedocs.org/en/master/"
}
};

beforeEach(function () {
var options = {
requestFunction: ajaxMockup
};
connection = new NGSI.Connection('http://ngsi.server.com', options);
ajaxMockup.clear();
});

it("provides server details", function (done) {
ajaxMockup.addStaticURL("http://ngsi.server.com/version", {
method: "GET",
headers: {
'Fiware-correlator': 'correlatortoken',
},
responseText: JSON.stringify(details),
status: 200
});

connection.getServerDetails().then(function (result) {
expect(result).toEqual({
details: details,
correlator: 'correlatortoken'
});
done();
}, function (e) {
fail("Failure callback called");
});
});

it("supports the correlator option", function (done) {
ajaxMockup.addStaticURL("http://ngsi.server.com/version", {
method: "GET",
checkRequestContent: function (url, options) {
expect(options.requestHeaders).toEqual(jasmine.objectContaining({
'FIWARE-Correlator': 'customcorrelator'
}));
},
headers: {
'Fiware-correlator': 'customcorrelator',
},
responseText: JSON.stringify(details),
status: 200
});

connection.getServerDetails({correlator: "customcorrelator"}).then(function (result) {
expect(result).toEqual({
details: details,
correlator: 'customcorrelator'
});
done();
}, function (e) {
fail("Failure callback called");
});
});

it("unexpected error code", function (done) {
ajaxMockup.addStaticURL("http://ngsi.server.com/version", {
method: "GET",
status: 404
});

connection.getServerDetails().then(function (value) {
fail("Success callback called");
}, function (e) {
expect(e).toEqual(jasmine.any(NGSI.InvalidResponseError));
expect(e.correlator).toBeNull();
done();
});
});

it("handles responses with invalid payloads", function (done) {
ajaxMockup.addStaticURL("http://ngsi.server.com/version", {
method: "GET",
status: 200,
responseText: "invalid json content"
});

connection.getServerDetails().then(function (value) {
fail("Success callback called");
}, function (e) {
expect(e).toEqual(jasmine.any(NGSI.InvalidResponseError));
expect(e.correlator).toBeNull();
done();
});
});
});

});

})();

0 comments on commit e1ea985

Please sign in to comment.