Merge pull request #8 from WURFL/3.1.0

3.1.0

Author: silvio-terzi

CHANGELOG.txt

@@ -1,3 +1,7 @@
+3.1.0 - Oct 29th, 2024
+------------------------------------
+- Deprecated method setRequestedCapabilities()
+
 3.0.0
 ------------------------------------
 - Complete rewrite of all API using async/await. NOT compatible with older versions

README.md

@@ -61,6 +61,7 @@ const example = async () => {
     console.log('Static capabilities loaded: ' + client.staticCaps.length)
     console.log('Virtual capabilities loaded: ' + client.virtualCaps.length + '\n')
     separate()
+    // Get server info
     try {
         let info = await client.getInfo()
         console.log('Server info: \n')
@@ -71,7 +72,7 @@ const example = async () => {
         console.log("Unable to load WURFL Info")
     }
     separate()
-    // Perform a detection using passing a whole HTTP request to WM server API
+    // Perform a detection using a whole HTTP request to WM server API
     // When building a request object for node, headers must be lowercase, according to Node standard
     let req_headers = {
         'accept': 'text/html, application/xml;q=0.9, application/xhtml+xml, image/png, image/webp, image/jpeg, image/gif, image/x-xbitmap, */*;q=0.1',
@@ -89,6 +90,7 @@ const example = async () => {
         'x-operamini-phone-Ua': 'Mozilla/5.0 (Linux; Android 8.1.0; SM-J610G Build/M1AJQ; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/69.0.3497.100 Mobile Safari/537.36',
     }
 
+    // Request refer a local WM server. Change the host and port to your WM server if needed
     let options = {
         protocol: 'http:',
         host: 'localhost',
@@ -100,6 +102,8 @@ const example = async () => {
     let req = http.request(options)
     req.headers = req_headers
     req.end()
+
+    // Get device info using wmclient
     let device
     try {
         device = await client.lookupRequest(req)
@@ -121,7 +125,9 @@ const example = async () => {
         }
     }
     separate()
-    // Get all the device manufacturers, and print the first twenty
+    // Get some data using wmclient
+
+    // Get all the device manufacturers, and print the first twenty returned
     let deviceMakes = await client.getAllDeviceMakes()
     let limit = 20
     console.log("Print the first " + limit + " Brand of " + deviceMakes.length)
@@ -131,7 +137,7 @@ const example = async () => {
         console.log(" - " + deviceMakes[i])
     }
     separate()
-    // Now call the WM server to get all device model and marketing names produced by Apple
+    // Get all device model and marketing names produced by Apple
     let brandName = "Apple"
     try {
         let devsForMake = await client.getAllDevicesForMake(brandName)
@@ -149,7 +155,7 @@ const example = async () => {
         console.log(`Error looking for  models for device, brand ${error.message}`)
     }
     separate()
-    // Now call the WM server to get all operative system names
+    // Get all operative system names
     let oses = await client.getAllOSes()
     // Sort and print all OS names
     console.log("Print the list of OSes")
@@ -158,7 +164,7 @@ const example = async () => {
         console.log(" - " + oses[i])
     }
 
-    // Let's call the WM server to get all version of the Android OS
+    // Get all Android OS versions
     let os = 'Android'
     try {
         let versions = await client.getAllVersionsForOS(os)

example.js

@@ -14,8 +14,8 @@
    limitations under the License.
  */
 
-// this must be used when executing directly from source code downloaded from git repo
-//let wmclient = require('./src/app/wmclient')
+// Use the commented require to refer local source code instead of client installed from NPM repo
+// let wmclient = require('./src/app/wmclient')
 let wmclient = require('wmclient')
 const http = require("http")
 const TEXT_SEPARATOR = '---------------------------------------------------------------------------------'
@@ -36,6 +36,7 @@ const example = async () => {
     console.log('Static capabilities loaded: ' + client.staticCaps.length)
     console.log('Virtual capabilities loaded: ' + client.virtualCaps.length + '\n')
     separate()
+    // Get server info
     try {
         let info = await client.getInfo()
         console.log('Server info: \n')
@@ -46,7 +47,7 @@ const example = async () => {
         console.log("Unable to load WURFL Info")
     }
     separate()
-    // Perform a detection using passing a whole HTTP request to WM server API
+    // Perform a detection using a whole HTTP request to WM server API
     // When building a request object for node, headers must be lowercase, according to Node standard
     let req_headers = {
         'accept': 'text/html, application/xml;q=0.9, application/xhtml+xml, image/png, image/webp, image/jpeg, image/gif, image/x-xbitmap, */*;q=0.1',
@@ -64,6 +65,7 @@ const example = async () => {
         'x-operamini-phone-Ua': 'Mozilla/5.0 (Linux; Android 8.1.0; SM-J610G Build/M1AJQ; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/69.0.3497.100 Mobile Safari/537.36',
     }
 
+    // Request refer a local WM server. Change the host and port to your WM server if needed
     let options = {
         protocol: 'http:',
         host: 'localhost',
@@ -75,6 +77,8 @@ const example = async () => {
     let req = http.request(options)
     req.headers = req_headers
     req.end()
+
+    // Get device info using wmclient
     let device
     try {
         device = await client.lookupRequest(req)
@@ -96,7 +100,9 @@ const example = async () => {
         }
     }
     separate()
-    // Get all the device manufacturers, and print the first twenty
+    // Get some data using wmclient
+
+    // Get all the device manufacturers, and print the first twenty returned
     let deviceMakes = await client.getAllDeviceMakes()
     let limit = 20
     console.log("Print the first " + limit + " Brand of " + deviceMakes.length)
@@ -106,7 +112,7 @@ const example = async () => {
         console.log(" - " + deviceMakes[i])
     }
     separate()
-    // Now call the WM server to get all device model and marketing names produced by Apple
+    // Get all device model and marketing names produced by Apple
     let brandName = "Apple"
     try {
         let devsForMake = await client.getAllDevicesForMake(brandName)
@@ -124,7 +130,7 @@ const example = async () => {
         console.log(`Error looking for  models for device, brand ${error.message}`)
     }
     separate()
-    // Now call the WM server to get all operative system names
+    // Get all operative system names
     let oses = await client.getAllOSes()
     // Sort and print all OS names
     console.log("Print the list of OSes")
@@ -133,7 +139,7 @@ const example = async () => {
         console.log(" - " + oses[i])
     }
 
-    // Let's call the WM server to get all version of the Android OS
+    // Get all Android OS versions
     let os = 'Android'
     try {
         let versions = await client.getAllVersionsForOS(os)

src/app/__tests__/wmclientTest.js

@@ -37,7 +37,7 @@ describe("Wm client", () => {
 
 
             let wm = await wmClient.create('http:', 'localhost', '8080', '')
-            expect(wm.importantHeaders.length).toBe(7)
+            expect(wm.importantHeaders.length).toBeGreaterThan(0)
             expect(wm.virtualCaps.length).toBeGreaterThan(0)
             expect(wm.staticCaps.length).toBeGreaterThan(0)
         }
@@ -48,14 +48,14 @@ describe("Wm client", () => {
 
     test('create client should work when schema is provided without the column', async () => {
         let wm = await wmClient.create('http', 'localhost', '8080', '')
-        expect(wm.importantHeaders.length).toBe(7)
+        expect(wm.importantHeaders.length).toBeGreaterThan(0)
         expect(wm.virtualCaps.length).toBeGreaterThan(0)
         expect(wm.staticCaps.length).toBeGreaterThan(0)
     });
 
     test('create client should pass when schema is not passed, defaulting to http', async () => {
         let wm = await wmClient.create('', 'localhost', '8080', '')
-        expect(wm.importantHeaders.length).toBe(7)
+        expect(wm.importantHeaders.length).toBeGreaterThan(0)
         expect(wm.virtualCaps.length).toBeGreaterThan(0)
         expect(wm.staticCaps.length).toBeGreaterThan(0)
     })
@@ -193,8 +193,7 @@ describe("Wm client", () => {
         expect(device.capabilities['brand_name']).toBe('Asus')
         expect(device.capabilities['is_robot']).toBe('false')
         expect(device.capabilities['model_name']).toBe('Z017D')
-        expect(device.capabilities['model_name']).toBe('Z017D')
-        expect(device.capabilities['form_factor']).toBe('Smartphone')
+        expect(device.capabilities['form_factor']).toBe('Feature Phone')
         expect(client.getCapabilityCount(device)).toBe(5)
 
         // These caps have not been defined
@@ -248,7 +247,7 @@ describe("Wm client", () => {
         expect(device.capabilities['brand_name']).toBe('Asus')
         expect(device.capabilities['model_name']).toBe('Z017D')
         expect(device.capabilities['is_robot']).toBe('false')
-        expect(device.capabilities['form_factor']).toBe('Smartphone')
+        expect(device.capabilities['form_factor']).toBe('Feature Phone')
         expect(device.APIVersion).toBeDefined()
         expect(device.mtime).toBeGreaterThan(0)
         // This capability is not included in the filter

src/app/package.json

@@ -7,10 +7,13 @@
     "testResultsProcessor": "jest-teamcity-reporter"
   },
   "description": "WURFL by ScientiaMobile. WURFL Microservice Client",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "license": "Apache-2.0",
   "main": "./wmclient.js",
-  "repository": "https://github.com/WURFL/wurfl-microservice-client-nodejs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WURFL/wurfl-microservice-client-nodejs.git"
+  },
   "author": {
     "name": "Andrea Castello, ScientiaMobile Inc.",
     "email": "support@scientiamobile.com"

src/app/wmclient.js

@@ -150,6 +150,8 @@ checkData = (jsonInfoData) => {
  * setRequestedCapabilities - set the given capability names to that the client requires to the WM server
  * @param caps {array} list of capabilities that you want to select from the ones exposed by the server
  * @return {void} Nothing
+ *
+ * @deprecated This method is deprecated and will be removed in a future version.
  */
 WmClient.prototype.setRequestedCapabilities = function (caps) {
 
@@ -424,7 +426,7 @@ WmClient.prototype.genericRequest = async function (method, path, reqData, parse
  * @return {string} this client API version
  */
 WmClient.prototype.getApiVersion = () => {
-    return '3.0.0'
+    return '3.1.0'
 }
 
 /**