fiftyone.devicedetection.onpremise 4.3.8 → 4.3.12

package/constants.js

@@ -0,0 +1,46 @@
+/* *********************************************************************
+ * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+ * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
+ * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
+ *
+ * This Original Work is licensed under the European Union Public Licence (EUPL)
+ * v.1.2 and is subject to its terms as set out below.
+ *
+ * If a copy of the EUPL was not distributed with this file, You can obtain
+ * one at https://opensource.org/licenses/EUPL-1.2.
+ *
+ * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+ * amended by the European Commission) shall be deemed incompatible for
+ * the purposes of the Work and the provisions of the compatibility
+ * clause in Article 5 of the EUPL shall not apply.
+ *
+ * If using the Work as, or as part of, a network application, by
+ * including the attribution notice(s) required under Article 5 of the EUPL
+ * in the end user terms of the application under an appropriate heading,
+ * such notice(s) shall fulfill the requirements of that article.
+ * ********************************************************************* */
+
+module.exports = {
+  /* Match metrics description */
+  deviceIdDescription: 'Consists of four components separated by a ' +
+    'hyphen symbol: Hardware-Platform-Browser-IsCrawler where each ' +
+    'Component represents an ID of the corresponding Profile.',
+  userAgentsDescription: 'The matched User-Agents.',
+  differenceDescription: 'Used when detection method is not Exact or ' +
+     'None. This is an integer value and the larger the value the less ' +
+     'confident the detector is in this result.',
+  methodDescription: 'The method used to determine the match result.',
+  matchedNodesDescription: 'Indicates the number of hash nodes matched ' +
+     'within the evidence.',
+  driftDescription: 'Total difference in character positions where the ' +
+     'substrings hashes were found away from where they were expected.',
+  iterationsDescription: 'The number of iterations carried out in order ' +
+     'to find a match. This is the number of nodes in the graph which ' +
+     'have been visited.',
+
+  /* Match methods */
+  none: 'NONE',
+  performance: 'PERFORMANCE',
+  combined: 'COMBINED',
+  predictive: 'PREDICTIVE'
+};

package/deviceDetectionOnPremise.js

@@ -33,6 +33,7 @@ const path = require('path');
 const EvidenceKeyFilter = core.BasicListEvidenceKeyFilter;
 const fs = require('fs');
 const util = require('util');
+const constants = require('./constants');
 
 /**
  * @typedef {import('fiftyone.pipeline.engines').DataKeyedCache} DataKeyedCache
@@ -347,21 +348,28 @@ class DeviceDetectionOnPremise extends Engine {
           name: 'DeviceId',
           type: 'string',
           category: 'Device metrics',
-          description: 'Consists of four components separated by a hyphen symbol: Hardware-Platform-Browser-IsCrawler where each Component represents an ID of the corresponding Profile.'
+          description: constants.deviceIdDescription
         };
 
         current.properties.userAgents = {
           name: 'UserAgents',
           type: 'string[]',
           category: 'Device metrics',
-          description: 'The matched User-Agents.'
+          description: constants.userAgentsDescription
         };
 
         current.properties.difference = {
           name: 'Difference',
           type: 'int',
           category: 'Device metrics',
-          description: 'Used when detection method is not Exact or None. This is an integer value and the larger the value the less confident the detector is in this result.'
+          description: constants.differenceDescription
+        };
+
+        current.properties.method = {
+          name: 'Method',
+          type: 'string',
+          category: 'Device metrics',
+          description: constants.methodDescription
         };
 
         if (swigWrapperType === 'Hash') {
@@ -369,14 +377,21 @@ class DeviceDetectionOnPremise extends Engine {
             name: 'MatchedNodes',
             type: 'int',
             category: 'Device metrics',
-            description: 'Indicates the number of hash nodes matched within the evidence.'
+            description: constants.matchedNodesDescription
           };
 
           current.properties.drift = {
             name: 'Drift',
             type: 'int',
             category: 'Device metrics',
-            description: 'Total difference in character positions where the substrings hashes were found away from where they were expected.'
+            description: constants.driftDescription
+          };
+
+          current.properties.iterations = {
+            name: 'Iterations',
+            type: 'int',
+            category: 'Device metrics',
+            description: constants.iterationsDescription
           };
         }
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.onpremise",
-  "version": "4.3.8",
+  "version": "4.3.12",
   "description": "Device detection on-premise services for the 51Degrees Pipeline API",
   "main": "index.js",
   "directories": {
@@ -22,10 +22,10 @@
     "Tung Pham <tung@51degrees.com> (https://51degrees.com)"
   ],
   "dependencies": {
-    "fiftyone.devicedetection.shared": "^4.3.8",
-    "fiftyone.pipeline.core": "^4.3.6",
-    "fiftyone.pipeline.engines": "^4.3.6",
-    "fiftyone.pipeline.engines.fiftyone": "^4.3.6",
+    "fiftyone.devicedetection.shared": "^4.3.12",
+    "fiftyone.pipeline.core": "^4.3.8",
+    "fiftyone.pipeline.engines": "^4.3.8",
+    "fiftyone.pipeline.engines.fiftyone": "^4.3.8",
     "n-readlines": "^1.0.1"
   },
   "devDependencies": {

package/swigData.js

@@ -27,6 +27,8 @@ const swigHelpers = require('./swigHelpers');
 
 const DataFileMissingPropertyService = require('./dataFileMissingPropertyService');
 
+const constants = require('./constants');
+
 /**
  * @typedef {import('fiftyone.pipeline.core').FlowElement} FlowElement
  */
@@ -97,7 +99,21 @@ class SwigData extends AspectData {
     }
 
     if (key === 'method') {
-      result.value = this.swigResults.getMethod();
+      const method = this.swigResults.getMethod();
+      switch (method) {
+        case 1:
+          result.value = constants.performance;
+          break;
+        case 2:
+          result.value = constants.combined;
+          break;
+        case 3:
+          result.value = constants.predictive;
+          break;
+        default:
+          result.value = constants.none;
+          break;
+      }
 
       return result;
     }

package/swigHelpers.js

@@ -47,7 +47,9 @@ module.exports = {
     const date = new Date();
 
     date.setFullYear(swigDate.getYear());
-    date.setMonth(swigDate.getMonth());
+    // Minus one as Jan starts at 0
+    const month = swigDate.getMonth();
+    date.setMonth(month > 0 ? month - 1 : month);
     date.setDate(swigDate.getDay());
 
     return date;