Update product name, cleanup annotations (#13)

update .travis.yml

.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '*.*'
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 13.x, 14.x]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test
+      - name: Coverage
+        run: |
+          npm install -g codecov
+          npm run report-coverage
+  gh-pages:
+    needs: ['test']
+    if: success() && github.event_name == 'push' && github.repository_owner == 'retailcrm' && github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 10.x
+      - name: Install dependencies
+        run: npm install
+      - name: Generate doc
+        run: npm run doc
+      - name: Deploy doc
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./out
+  deploy:
+    needs: ['test']
+    if: success() && github.event_name == 'push' && github.repository_owner == 'retailcrm' && github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 10.x
+      - name: Install dependencies
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Publish
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -61,6 +61,5 @@ typings/
 .next
 .idea
 
-package-lock.json
 out/
-dist/
+dist/

.npmignore

@@ -0,0 +1,64 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+.idea
+
+out/

.travis.yml

@@ -1,19 +0,0 @@
-language: node_js
-
-node_js:
-  - "11"
-  - "10"
-  - "8"
-
-script: npm run test
-
-after_success: npm run doc
-
-deploy:
-  provider: pages
-  skip-cleanup: true
-  github-token: $GITHUB_TOKEN
-  keep-history: true
-  local-dir: out
-  on:
-    branch: master

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 retailCRM
+Copyright (c) 2018-2020 RetailDriver LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,10 @@
-[![Build Status](https://img.shields.io/travis/retailcrm/mg-bot-api-client-js/master.svg?logo=travis&style=flat-square)](https://travis-ci.org/retailcrm/mg-bot-api-client-js)
-[![GitHub release](https://img.shields.io/github/release/retailcrm/mg-bot-api-client-js.svg?style=flat-square)](https://github.com/retailcrm/mg-bot-api-client-js/releases)
-[![Node version](https://img.shields.io/node/v/mg-api-client.svg?style=flat-square)](https://www.npmjs.com/package/mg-api-client)
+[![Build Status](https://github.com/retailcrm/mg-bot-api-client-js/workflows/ci/badge.svg)](https://github.com/retailcrm/mg-bot-api-client-js/actions)
+[![Coverage](https://img.shields.io/codecov/c/gh/retailcrm/mg-bot-api-client-js/master.svg?logo=codecov&logoColor=white)](https://codecov.io/gh/retailcrm/mg-bot-api-client-js)
+[![Latest stable](https://img.shields.io/npm/v/mg-api-client.svg?logo=npm&logoColor=white)](https://npmjs.com/package/mg-api-client)
+[![Node version](https://img.shields.io/node/v/mg-api-client.svg?logo=node.js&logoColor=white)](https://www.npmjs.com/package/mg-api-client)
+[![JS Doc](https://img.shields.io/badge/doc-github_pages-green)](https://retailcrm.github.io/mg-bot-api-client-js/)
 
-
-# retailCRM Message Gateway Bot API JS client
-
-This is js retailCRM bot API client.
+# Message Gateway Bot API JavaScript client
 
 # Installation
 ```

lib/request.js

@@ -40,15 +40,16 @@ export default class Request {
      * @param {string} endpoint
      * @param {string} method
      * @param {Object} data
+     * @param {boolean} serializable
      * @returns {Promise}
      * @throws {Error}
      * @private
-    */
-    _request(endpoint, method, data = {}) {
+     */
+    _request(endpoint, method, data = {}, serializable = true) {
         let path = this._getPath(endpoint);
         let response = '';
 
-        if (method === 'GET' && data.length > 0) {
+        if (method === 'GET' && Object.keys(data).length > 0) {
             path += '?' + querystring.stringify(data);
         }
 
@@ -87,7 +88,14 @@ export default class Request {
             });
 
             if (['POST', 'PUT', 'PATCH'].includes(method)) {
-                request.write(JSON.stringify(data));
+                let sendData;
+                if (serializable) {
+                    sendData = JSON.stringify(data);
+                } else {
+                    sendData = data;
+                }
+
+                request.write(sendData);
             }
 
             request.end();
@@ -112,15 +120,16 @@ export default class Request {
      * Method POST
      * @param {string} endpoint
      * @param {Object} data
+     * @param {boolean} serializable
      * @returns {Promise}
      * @throws {Error}
      */
-    post(endpoint, data) {
+    post(endpoint, data, serializable = true) {
         if (!data) {
             throw new Error('Body is not be empty');
         }
 
-        return this._request(endpoint, 'POST', data);
+        return this._request(endpoint, 'POST', data, serializable);
     };
 
     /**

lib/v1/client.js

@@ -83,6 +83,21 @@ export default class Client {
         return this._request.patch(this._version + '/dialogs/'+ dialog_id + '/assign', dialog);
     };
 
+    /**
+     * Unassign dialog
+     * @param {Number} dialog_id - Dialog id
+     * @returns {Promise}
+     * @throws {Error}
+     * @memberOf Client
+     */
+    unassignDialog(dialog_id) {
+        if (!dialog_id) {
+            throw new Error('Parameter `dialog_id` is required');
+        }
+
+        return this._request.patch(this._version + '/dialogs/'+ dialog_id + '/unassign', {});
+    }
+
     /**
      * Close dialog
      * @param {Number} dialog_id - Dialog id
@@ -210,6 +225,49 @@ export default class Client {
         return this._request.get(this._version + '/users', params);
     };
 
+    /**
+     * Get file information
+     * @param {string} file_id - File identifier
+     * @returns {Promise}
+     * @throws {Error}
+     * @memberOf Client
+     */
+    getFile(file_id) {
+        if (!file_id) {
+            throw new Error('Parameter `file_id` is required');
+        }
+
+        return this._request.get(this._version + '/files/' + file_id)
+    }
+
+    /**
+     * Upload file
+     *
+     * @param {string} data - Binary data
+     * @returns {Promise}
+     * @throws {Error}
+     * @memberOf Client
+     */
+    filesUpload(data) {
+        return this._request.post(this._version + '/files/upload', data, false);
+    }
+
+    /**
+     * Upload file by url
+     *
+     * @param {string} url - File url address
+     * @returns {Promise}
+     * @throws {Error}
+     * @memberOf Client
+     */
+    filesUploadByUrl(url) {
+        if (!url) {
+            throw new Error('Parameter `url` is required');
+        }
+
+        return this._request.post(this._version + '/files/upload_by_url', {url})
+    }
+
     /**
      * Get websocket url
      * @param {array<string>} events - Array of strings with websocket events

package.json

@@ -1,19 +1,20 @@
 {
   "name": "mg-api-client",
-  "description": "JS client for retailCRM Bot API",
+  "description": "JavaScript client for Message Gateway Bot API",
   "tags": [
     "API",
-    "retailCRM",
+    "RetailCRM",
     "Bot",
     "Chat"
   ],
-  "version": "1.0.1",
+  "version": "1.1.0",
   "scripts": {
     "doc": "./node_modules/.bin/jsdoc lib/v1/client.js lib/consts.js -R README.md",
     "build": "./node_modules/.bin/rollup -c",
-    "test": "./node_modules/.bin/_mocha --require @babel/register ./tests/."
+    "test": "./node_modules/.bin/nyc ./node_modules/.bin/_mocha --require @babel/register ./tests/.",
+    "report-coverage": "./node_modules/.bin/nyc report --reporter=text-lcov > coverage.lcov && codecov"
   },
-  "author": "retailCRM",
+  "author": "RetailCRM",
   "license": "MIT",
   "main": "./dist/index.js",
   "bugs": {
@@ -21,22 +22,21 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@babel/cli": "^7.2.3",
-    "@babel/core": "^7.3.3",
-    "@babel/preset-env": "^7.3.1",
-    "@babel/register": "^7.0.0",
+    "@babel/cli": "^7.10.5",
+    "@babel/core": "^7.10.5",
+    "@babel/preset-env": "^7.10.4",
+    "@babel/register": "^7.10.5",
+    "@rollup/plugin-babel": "^5.2.0",
     "babelrc-rollup": "^3.0.0",
     "chai": "^4.2.0",
     "jsdoc": "^3.5.5",
-    "mocha": "^5.2.0",
+    "mocha": "^8.1.1",
     "nock": "^10.0.6",
-    "rollup": "^1.2.2",
-    "rollup-plugin-babel": "^4.3.2",
-    "rollup-plugin-node-builtins": "^2.1.2",
-    "rollup-plugin-node-globals": "^1.4.0"
+    "nyc": "^15.1.0",
+    "rollup": "^2.26.3"
   },
   "engines": {
-    "node": ">= 4.0.0"
+    "node": ">= 10.0.0"
   },
   "homepage": "https://github.com/retailcrm/mg-bot-api-client-js#readme",
   "repository": {

rollup.config.js

@@ -1,4 +1,4 @@
-import babel from 'rollup-plugin-babel';
+import babel from '@rollup/plugin-babel';
 
 let pluginOptions = [
     babel({
@@ -14,4 +14,4 @@ export default [{
         format: 'umd',
     },
     plugins: pluginOptions,
-}];
+}];

tests/test_v1_client.js

@@ -1,5 +1,6 @@
 import nock from 'nock'
 import chai from 'chai'
+import https from 'https'
 import MgBotApiClient from '../index'
 
 describe('#API client v1', function() {
@@ -25,9 +26,9 @@ describe('#API client v1', function() {
     });
 
     it('Get empty bots list', function () {
-        nock('https://api.example.com/api/bot/v1').get('/bots').reply(200, []);
+        nock('https://api.example.com/api/bot/v1').get('/bots?id=1').reply(200, []);
 
-        api.getBots().then(function (value) {
+        api.getBots({id: 1}).then(function (value) {
             chai.expect(value).to.be.an('array');
             chai.expect(value).to.be.empty;
         });
@@ -156,6 +157,20 @@ describe('#API client v1', function() {
         chai.expect(api.assignDialog.bind(api)).to.throw('Parameter `dialog_id` is required');
     });
 
+    it('Unassign dialog', function () {
+        nock('https://api.example.com/api/bot/v1').patch('/dialogs/1/unassign').reply(200, {
+            previous_responsible: {type: 'user', id: 1, assigned_at: '2019-01-22T11:50:13Z'}
+        });
+
+        api.unassignDialog(1).then(function (value) {
+            chai.expect(value).to.be.an('object');
+        });
+    });
+
+    it('Unassign dialog incorrect', function () {
+        chai.expect(api.unassignDialog.bind(api)).to.throw('Parameter `dialog_id` is required');
+    });
+
     it('Close dialog', function () {
         nock('https://api.example.com/api/bot/v1').delete('/dialogs/1/close').reply(200, {});
 
@@ -336,6 +351,83 @@ describe('#API client v1', function() {
         });
     });
 
+    it('Get file', function () {
+        nock('https://api.example.com/api/bot/v1').get('/files/1').reply(200, {
+            id: '1',
+            size: 100,
+            type: 'image',
+            url: 'https://file.url'
+        });
+
+        api.getFile('1').then(function (value) {
+            chai.expect(value).to.be.an('object');
+            chai.expect(value.id).to.be.equal('1');
+            chai.expect(value.size).to.be.equal(100);
+            chai.expect(value.type).to.be.equal('image');
+            chai.expect(value.url).to.be.equal('https://file.url');
+        });
+    });
+
+    it('Get file incorrect', function () {
+        chai.expect(api.getFile.bind(api)).to.throw('Parameter `file_id` is required');
+    });
+
+    it('File upload', function () {
+        const options = {
+            host: 'via.placeholder.com',
+            path: '/300'
+        };
+
+        const req = https.get(options, function (res) {
+            let data = Buffer.from('', 'binary');
+            res.on('data', function (chunk) {
+                data = Buffer.concat([data, Buffer.from(chunk, 'binary')])
+            });
+
+            res.on('end', function () {
+                nock('https://api.example.com/api/bot/v1').post('/files/upload', data).reply(200, {
+                    id: '1',
+                    size: 1132,
+                    type: 'image'
+                });
+
+                api.filesUpload(data).then(function (value) {
+                    chai.expect(value).to.be.an('object');
+                    chai.expect(value.id).to.be.equal('1');
+                    chai.expect(value.size).to.be.equal(1132);
+                    chai.expect(value.type).to.be.equal('image');
+                });
+            });
+        });
+
+        req.end();
+    });
+
+    it('File upload incorrect', function () {
+        chai.expect(api.filesUpload.bind(api)).to.throw('Body is not be empty');
+    });
+
+    it('File upload by url', function () {
+        nock('https://api.example.com/api/bot/v1').post('/files/upload_by_url', {url: 'https://fileurl.com'}).reply(200, {
+            id: '123',
+            size: 1132,
+            type: 'image',
+            url: 'https://file.url'
+        });
+
+        api.filesUploadByUrl('https://fileurl.com').then(function (value) {
+            chai.expect(value).to.be.an('object');
+            chai.expect(value.id).to.be.equal('123');
+            chai.expect(value.size).to.be.equal(1132);
+            chai.expect(value.type).to.be.equal('image');
+            chai.expect(value.url).to.be.equal('https://file.url');
+        });
+    });
+
+    it('File upload by url incorrect', function () {
+        chai.expect(api.filesUploadByUrl.bind(api)).to.throw('Parameter `url` is required');
+    });
+
     it('Get websocket data', function () {
         const wsData = api.getWebsocketData([MgBotApiClient.types().wsMessageNew, MgBotApiClient.types().wsMessageUpdated]);
         const expectedUrl = 'wss://api.example.com/api/bot/v1/ws?events=message_new,message_updated';