Skip to content

Commit d76337b

Browse files
author
zeeshan-tfw
committed
Added user-agent-api and updated README.md file
1 parent 3498967 commit d76337b

File tree

5 files changed

+207
-41
lines changed

5 files changed

+207
-41
lines changed

‎GeolocationParams.js‎

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
module.exports = class GeolocationParams {
1+
module.exports = class GeolocationParams {
22

33
constructor() {
44
var ipAdress = '';
5+
var ipAdresses = [];
56
var fields = '*';
67
var excludes = '';
78
var lang = 'en';
8-
var ipAdresses = [];
9+
var includeHostname = false;
10+
var includeLiveHostname = false;
11+
var includeHostnameFallbackLive = false;
12+
var includeSecurity = false;
13+
var includeUserAgent = false;
914
}
1015

1116
setIPAddress(ipAddress = '') {
@@ -41,7 +46,7 @@ module.exports = class GeolocationParams {
4146
}
4247

4348
setIPAddresses(ipAdresses = []) {
44-
if(ipAdresses.length > 50) {
49+
if (ipAdresses.length > 50) {
4550
console.log("Max. number of IP addresses cannot be more than 50.");
4651
} else {
4752
this.ipAdresses = ipAdresses;
@@ -51,5 +56,45 @@ module.exports = class GeolocationParams {
5156
getIPAddresses() {
5257
return this.ipAdresses;
5358
}
59+
60+
setIncludeHostname(b = false) {
61+
this.includeHostname = b;
62+
}
63+
64+
setIncludeHostnameFallbackLive(b = false) {
65+
this.includeHostnameFallbackLive = b;
66+
}
67+
68+
setIncludeLiveHostname(b = false) {
69+
this.includeLiveHostname = b;
70+
}
71+
72+
setIncludeSecurity(b = false) {
73+
this.includeSecurity = b;
74+
}
75+
76+
setIncludeUserAgent(b = false) {
77+
this.includeUserAgent = b;
78+
}
79+
80+
isIncludeHostname() {
81+
return this.includeHostname;
82+
}
83+
84+
isIncludeHostnameFallbackLive() {
85+
return this.includeHostnameFallbackLive;
86+
}
87+
88+
isIncludeLiveHostname() {
89+
return this.includeLiveHostname;
90+
}
91+
92+
isIncludeSecurity() {
93+
return this.includeSecurity;
94+
}
95+
96+
isIncludeUserAgent() {
97+
return this.includeUserAgent;
98+
}
5499
}
55100

‎IPGeolocationAPI.js‎

Lines changed: 99 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ module.exports = class IPGeolocationAPI {
99
}
1010

1111
getGeolocation(callback, geolocationParams = null) {
12-
if(geolocationParams && geolocationParams.getIPAddresses()) {
12+
if (geolocationParams && geolocationParams.getIPAddresses()) {
1313
var jsonData = JSON.stringify({
1414
'ips': geolocationParams.getIPAddresses()
1515
});
@@ -19,11 +19,31 @@ module.exports = class IPGeolocationAPI {
1919
getRequest('ipgeo', buildGeolocationUrlParams(this.apiKey, geolocationParams), callback);
2020
}
2121
}
22-
22+
2323
getTimezone(callback, timezoneParams = null) {
2424
return getRequest('timezone', buildTimezoneUrlParams(this.apiKey, timezoneParams), callback);
2525
}
2626

27+
getUserAgent(callback, uaString ="") {
28+
var jsonData = "{\"uaString\":\"" + uaString + "\"}";
29+
postRequest('user-agent', "apiKey=" + this.apiKey, jsonData, callback);
30+
}
31+
32+
getBulkUserAgent(callback, uaStrings = []) {
33+
var jsonData = "{\"uaStrings\":[";
34+
for(let i = 0; i < uaStrings.length; i++){
35+
if(i === 0){
36+
jsonData = jsonData.concat("\"" + uaStrings[i] + "\"");
37+
} else{
38+
jsonData = jsonData.concat(",");
39+
jsonData = jsonData.concat("\"" + uaStrings[i] + "\"");
40+
}
41+
}
42+
jsonData = jsonData.concat("]}");
43+
44+
postRequest('user-agent-bulk', "apiKey=" + this.apiKey, jsonData, callback);
45+
}
46+
2747
getApiKey() {
2848
return this.apiKey;
2949
}
@@ -36,80 +56,124 @@ module.exports = class IPGeolocationAPI {
3656
function buildGeolocationUrlParams(apiKey = '', geolocationParams = null) {
3757
var urlParams = '';
3858

39-
if(apiKey) {
59+
if (apiKey) {
4060
urlParams = urlParams.concat('apiKey=', apiKey);
4161
}
4262

43-
if(geolocationParams) {
44-
if(geolocationParams.getIPAddress()) {
45-
if(urlParams) {
63+
if (geolocationParams) {
64+
if (geolocationParams.getIPAddress()) {
65+
if (urlParams) {
4666
urlParams = urlParams.concat('&');
4767
}
4868

4969
urlParams = urlParams.concat('ip=', geolocationParams.getIPAddress());
5070
}
51-
52-
if(geolocationParams.getFields()) {
53-
if(urlParams) {
71+
72+
if (geolocationParams.getFields()) {
73+
if (urlParams) {
5474
urlParams = urlParams.concat('&');
5575
}
5676

5777
urlParams = urlParams.concat('fields=', geolocationParams.getFields());
5878
}
59-
60-
if(geolocationParams.getExcludes()) {
61-
if(urlParams) {
79+
80+
if (geolocationParams.getExcludes()) {
81+
if (urlParams) {
6282
urlParams = urlParams.concat('&');
6383
}
6484

6585
urlParams = urlParams.concat('excludes=', geolocationParams.getExcludes());
6686
}
67-
68-
if(geolocationParams.getLang()) {
69-
if(urlParams) {
87+
88+
if (geolocationParams.getLang()) {
89+
if (urlParams) {
7090
urlParams = urlParams.concat('&');
7191
}
7292

7393
urlParams = urlParams.concat('lang=', geolocationParams.getLang());
7494
}
95+
96+
if (geolocationParams.isIncludeHostname() || geolocationParams.isIncludeHostnameFallbackLive() || geolocationParams.isIncludeLiveHostname() || geolocationParams.isIncludeSecurity() || geolocationParams.isIncludeUserAgent()) {
97+
var val = "";
98+
var includeHost = false;
99+
if (geolocationParams.isIncludeHostname()) {
100+
val = "hostname";
101+
includeHost = true;
102+
} else if (geolocationParams.isIncludeHostnameFallbackLive()) {
103+
val = "hostnameFallbackLive";
104+
includeHost = true;
105+
} else if (geolocationParams.isIncludeLiveHostname()) {
106+
val = "liveHostname";
107+
includeHost = true;
108+
}
109+
if (geolocationParams.isIncludeSecurity()) {
110+
if (includeHost) {
111+
val = val + ",security";
112+
} else {
113+
val = "security";
114+
}
115+
}
116+
if (geolocationParams.isIncludeUserAgent()) {
117+
if (includeHost || geolocationParams.isIncludeSecurity()) {
118+
val = val + ",useragent";
119+
} else {
120+
val = "useragent";
121+
}
122+
}
123+
if (urlParams) {
124+
urlParams = urlParams.concat('&');
125+
}
126+
urlParams = urlParams.concat('include=', val);
127+
128+
}
129+
75130
}
76131
return urlParams;
77132
}
78133

79134
function buildTimezoneUrlParams(apiKey = '', timezoneParams = null) {
80135
var urlParams = '';
81136

82-
if(apiKey) {
137+
if (apiKey) {
83138
urlParams = urlParams.concat('apiKey=', apiKey);
84139
}
85140

86-
if(timezoneParams) {
87-
if(timezoneParams.getIPAddress()) {
88-
if(urlParams) {
141+
if (timezoneParams) {
142+
if (timezoneParams.getIPAddress()) {
143+
if (urlParams) {
89144
urlParams = urlParams.concat('&');
90145
}
91146

92147
urlParams = urlParams.concat('ip=', timezoneParams.getIPAddress());
93148
}
94149

95-
if(timezoneParams.getTimezone()) {
96-
if(urlParams) {
150+
if (timezoneParams.getTimezone()) {
151+
if (urlParams) {
97152
urlParams = urlParams.concat('&');
98153
}
99154

100155
urlParams = urlParams.concat('tz=', timezoneParams.getTimezone());
101156
}
102157

103-
if(timezoneParams.getLatitude() !== '1000.0' && timezoneParams.getLongitude() !== '1000.0') {
104-
if(urlParams) {
158+
if (timezoneParams.getLocation()) {
159+
if (urlParams) {
105160
urlParams = urlParams.concat('&');
106161
}
107162

108-
urlParams = urlParams.concat('lat=', timezoneParams.getLatitude(), '&long=', timezoneParams.getLongitude());
163+
urlParams = urlParams.concat('location=', timezoneParams.getLocation());
164+
}
165+
166+
if (timezoneParams.getLatitude() !== '1000.0' && timezoneParams.getLongitude() !== '1000.0') {
167+
if ((timezoneParams.getLatitude() >= -90 && timezoneParams.getLatitude() <= 90) && (timezoneParams.getLongitude() >= -180 && timezoneParams.getLongitude() <= 180)) {
168+
if (urlParams) {
169+
urlParams = urlParams.concat('&');
170+
}
171+
urlParams = urlParams.concat('lat=', timezoneParams.getLatitude(), '&long=', timezoneParams.getLongitude());
172+
}
109173
}
110-
111-
if(timezoneParams.getLang()) {
112-
if(urlParams) {
174+
175+
if (timezoneParams.getLang()) {
176+
if (urlParams) {
113177
urlParams = urlParams.concat('&');
114178
}
115179

@@ -124,17 +188,17 @@ function getRequest(subUrl, urlParams = '', callback) {
124188
var XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest;
125189
var xhr = new XMLHttpRequest();
126190

127-
xhr.onreadystatechange = function() {
191+
xhr.onreadystatechange = function () {
128192
if (this.readyState === 4) {
129-
if (this.status == 0){
193+
if (this.status == 0) {
130194
jsonData = {
131195
'message': 'Internet is not connected!'
132196
};
133197
} else {
134198
jsonData = JSON.parse(this.responseText);
135199
}
136200

137-
if (callback && typeof(callback) === typeof(Function)) {
201+
if (callback && typeof (callback) === typeof (Function)) {
138202
callback(jsonData);
139203
} else {
140204
console.error(`Passed callback '${callback}' is not a valid Function.`)
@@ -148,21 +212,21 @@ function getRequest(subUrl, urlParams = '', callback) {
148212
}
149213

150214
function postRequest(subUrl, urlParams = '', requestData = {}, callback) {
151-
var jsonData = {};
215+
var jsonData = {};
152216
var XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest;
153217
var xhr = new XMLHttpRequest();
154218

155-
xhr.onreadystatechange = function() {
219+
xhr.onreadystatechange = function () {
156220
if (this.readyState === 4) {
157221
if (this.status == 0) {
158222
jsonData = {
159223
'message': 'Internet is not connected!'
160224
};
161225
} else {
162-
jsonData = JSON.parse(this.responseText);
226+
jsonData = JSON.parse(this.responseText);
163227
}
164-
165-
if (callback && typeof(callback) === typeof(Function)) {
228+
229+
if (callback && typeof (callback) === typeof (Function)) {
166230
callback(jsonData);
167231
} else {
168232
console.error(`Passed callback '${callback}' is not a valid Function.`)

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@ Internet connection is required to run this component.
3030
```cli
3131
$ npm install ip-geolocation-api-javascript-sdk
3232
```
33+
## Documentation
34+
Use the following URL to visit documentation
35+
[https://ipgeolocation.io/documentation.html](https://ipgeolocation.io/documentation.html)
3336

3437
## Basic Usage
3538

@@ -124,6 +127,17 @@ ipgeolocationApi.getTimezone(handleResponse, timezoneParams);
124127
ipgeolocationApi.getTimezone(handleResponse);
125128
```
126129

130+
### UserAgent API
131+
132+
```ts
133+
// Get user agent information for single user agent string
134+
ipgeolocationApi.getUserAgent(handleResponse, "AppleTV6,2/11.1");
135+
136+
// Get user agents information in bulk by providing array of user agent strings
137+
const uaStrings = ["AppleTV6,2/11.1", "Roku4640X/DVP-7.70 (297.70E04154A)", "Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU"];
138+
ipgeolocationApi.getBulkUserAgent(handleResponse, uaStrings);
139+
```
140+
127141
** IPGeolocation provides geolocation information in the following languages:
128142

129143
* English (en)

‎TimezoneParams.js‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ module.exports = class TimezoneParams {
66
var lang = 'en';
77
var latitude = '1000.0';
88
var longitude = '1000.0';
9+
var location = "";
910
}
1011

1112
setTimezone(tz = '') {
@@ -32,9 +33,11 @@ module.exports = class TimezoneParams {
3233
return this.lang;
3334
}
3435

35-
setCoordinates(latitude = '1000.0', longitude = '1000.0') {
36-
this.latitude = latitude;
37-
this.longitude = longitude;
36+
setCoordinates(la = '1000.0', lo = '1000.0') {
37+
if ((la >= -90 && la <= 90) && (lo >= -180 && lo <= 180)) {
38+
this.latitude = la;
39+
this.longitude = lo;
40+
}
3841
}
3942

4043
getLatitude() {
@@ -44,6 +47,12 @@ module.exports = class TimezoneParams {
4447
getLongitude() {
4548
return this.longitude;
4649
}
50+
getLocation() {
51+
return this.location;
52+
}
53+
setLocation(loc = "") {
54+
this.location = loc;
55+
}
4756
}
4857

4958

0 commit comments

Comments
 (0)