Added custom headers support

Author: kami4ka

README.md

@@ -138,6 +138,20 @@ client.scrape('https://httpbin.org/cookies', { cookies: 'cookieName1=cookieVal1;
     .catch(err => console.error(err.message));
 ```
 
+### Adding custom headers
+
+```js
+const ScrapingAntClient = require('@scrapingant/scrapingant-client');
+
+const client = new ScrapingAntClient({ apiKey: '<YOUR-SCRAPINGANT-API-KEY>' });
+
+// Scrape the httpbin.org site and get all the headers that would be sent before
+client.scrape('https://httpbin.org/headers', { headers: { scraping: "is cool!" } })
+    .then(res => console.log(res))
+    .catch(err => console.error(err.message));
+```
+
+
 ### Executing custom JS snippet
 
 ```js

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrapingant/scrapingant-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "ScrapingAnt API client for JavaScript",
   "main": "src/index.js",
   "keywords": [

src/index.js

@@ -48,6 +48,7 @@ class ScrapingAntClient {
      * @param {object} [parameters]
      * @param {boolean} [parameters.browser]
      * @param {string} [parameters.cookies]
+     * @param {object} [parameters.headers]
      * @param {string} [parameters.js_snippet]
      * @param {string} [parameters.proxy_type] 'datacenter' or 'residential'
      * @param {string} [parameters.proxy_country]

src/scraping_client.js

@@ -22,20 +22,28 @@ class ScrapingClient {
      * @param {object} [parameters]
      * @param {boolean} [parameters.browser]
      * @param {string} [parameters.cookies]
+     * @param {object} [parameters.headers]
      * @param {string} [parameters.js_snippet]
      * @param {string} [parameters.proxy_type] 'datacenter' or 'residential'
      * @param {string} [parameters.proxy_country]
      * @param {string} [parameters.wait_for_selector]
      * @param {boolean} [parameters.return_text]
      */
     async call(url, parameters = {}) {
+        const transformedHeaders = parameters.headers && typeof parameters.headers === 'object'
+            ? this._transformCustomHeaders(parameters.headers)
+            : {};
+
+        const defaultHeaders = {
+            'Content-Type': 'application/json',
+            'x-api-key': this.apiKey,
+        };
+
+        const headers = Object.assign(defaultHeaders, transformedHeaders);
         const response = await this.httpClient.call({
             url: `${constants.baseUrl}/v1/general`,
             method: 'post',
-            headers: {
-                'Content-Type': 'application/json',
-                'x-api-key': this.apiKey,
-            },
+            headers,
             data: {
                 url,
                 ...(typeof parameters.browser !== 'undefined' && { browser: !!parameters.browser }),
@@ -50,6 +58,16 @@ class ScrapingClient {
 
         return response.data;
     }
+
+    _transformCustomHeaders(headers = {}) {
+        const returnHeaders = {};
+
+        Object.keys(headers).forEach((key) => {
+            returnHeaders[`ant-${key}`] = headers[key];
+        });
+
+        return returnHeaders;
+    }
 }
 
 module.exports = ScrapingClient;