added detection service

Author: doripjonov

core/compre_face.js

@@ -15,6 +15,7 @@
  */
 import { RecognitionService } from '../services/recognition_service.js';
 import { VerificationService } from '../services/verification_service.js';
+import { DetectionService } from '../services/detection_service.js';
 // main class
 class CompreFace {
     constructor(server, port, options){
@@ -37,10 +38,20 @@ class CompreFace {
      * @param {String} api_key 
      * @returns {Object}
      */
-     initFaceVerificationService(api_key){
+    initFaceVerificationService(api_key){
         let verification_object = new VerificationService(this.server, this.port, this.options, api_key)
         return verification_object;
     }
+
+    /**
+     * Initialize DetectionService instance
+     * @param {String} api_key 
+     * @returns {Object}
+     */
+     initFaceDetectionService(api_key){
+        let detection_object = new DetectionService(this.server, this.port, this.options, api_key)
+        return detection_object;
+    }
 }
 
 export { CompreFace };

endpoints/detection_endpoints.js

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2020 the original author or authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+import axios from 'axios';
+import fs from 'fs';
+import FormData from 'form-data';
+
+const detection_endpoints = {
+    /**
+     * Detect faces from given image
+     * @param {String} image_path
+     * @param {String} api_key
+     * @returns {Promise}
+     */
+    async detect_request(image_path, url, api_key){
+        var bodyFormData = new FormData();
+        bodyFormData.append('file', fs.createReadStream(image_path), { knownLength: fs.statSync(image_path).size }); 
+        
+        return new Promise( async (resolve, reject) => {
+            try {
+                const response = await axios.post( url, bodyFormData, {
+                    headers: {
+                        ...bodyFormData.getHeaders(),
+                        "Content-Length": bodyFormData.getLengthSync(),
+                        "x-api-key": api_key
+                    },
+                })
+
+                resolve(response)
+            } catch (error) {
+                reject(error)
+            }
+        })
+    }
+}
+
+export { detection_endpoints }
+
+
+
+
+

services/detection_service.js

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2020 the original author or authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+import { detection_endpoints } from '../endpoints/detection_endpoints.js';
+
+class DetectionService {
+    constructor(server, port, options, key){
+        this.server = server;
+        this.port = port;
+        this.options = options;
+        this.key = key;
+    }
+
+    /**
+     * Construct full url from given server and port number
+     * @returns {String}
+     */
+    get_full_url(){
+        let destination = 'api/v1/detection/detect';
+        let full_url = `${this.server}:${this.port}/${destination}`;
+
+        return full_url;
+    }
+    /**
+     * Add extra options to url
+     * @param {Object} options 
+     * @returns {String}
+     */
+    add_options_to_url(url, localOptions, required_parameters){
+        // merge options passed by localy and globally NOTE: global options will override local on if same value passed from both of them
+        let uniqueOptions = {...localOptions, ...this.options};
+        let isThereAnyOptions = Object.keys(uniqueOptions);
+        
+        // check whether any parameters passed
+        if(isThereAnyOptions.length > 0){
+            // check whether limit parameter passed and it is required for particular endpoint (ex: it is not requrid for add())
+            if(uniqueOptions['limit'] >= 0 && required_parameters['limit']){
+                url = `${url}?limit=${uniqueOptions['limit']}`
+            }
+
+            // check whether det_prob_threshold parameter passed and is it required for particular endpoint
+            if(uniqueOptions['det_prob_threshold'] >= 0 && required_parameters['det_prob_threshold']){
+                url = `${url}&det_prob_threshold=${uniqueOptions['det_prob_threshold']}`
+            }
+
+            // check whether prediction_count passed and is it required for particular endpoint
+            if(uniqueOptions['prediction_count'] >= 0 && required_parameters['prediction_count']){
+                url = `${url}&prediction_count=${uniqueOptions['prediction_count']}`
+            }
+
+            // check whether face_plugins passed and is it required for particular endpoint
+            if(uniqueOptions['face_plugins'] && required_parameters['face_plugins']){
+                url = `${url}&face_plugins=${uniqueOptions['face_plugins']}`
+            }
+
+            // check whether status passed and is it required for particular endpoint
+            if(uniqueOptions['status'] && required_parameters['status']){
+                url = `${url}&status=${uniqueOptions['status']}`
+            }
+        }
+
+        return url;
+    }
+
+    detect(image_path, options){
+        // add extra parameter(s) name with true value if it is referenced in API documentation for particular endpoint
+        // add_options_to_url() adds this parameter to url if user passes some value as option otherwise function ignores this parameter
+        let required_url_parameters = { 
+            limit: true,
+            det_prob_threshold: true, 
+            prediction_count: true,
+            face_plugins: true,
+            status: true
+        };
+        // add parameters to basic url
+        let url = this.add_options_to_url(this.get_full_url(), options, required_url_parameters);
+       
+        return new Promise((resolve, reject) => {
+            detection_endpoints.detect_request(image_path, url, this.key)
+                .then(response => {
+                    resolve(response.data)
+                })
+                .catch(error => {
+                    reject(error.response.data)
+                })
+        })
+    }
+}
+
+export { DetectionService }