Release v3.0.0 (#85)

* updated dependencies

* code linting

* added new app id & app secret

* cleanup requests payloads

* remove unused function

* update test cases

* enabled firmware tests

* refactor getDevice to use right api endpoint

* error messages improvements

* error messages improvements

* error messages improvements

* error messages improvements

* error messages improvements

* payload cleanup

* refactor setDevicePowerState to use right api endpoint

* update test exepectation

* removed deprecated class

* updated tests to reflect new error codes

* error messages improvements

* refactoring project structure: devices methods

refactoring project sturcture

* refactoring project structure: firmware methods

* refactoring project structure: temperature/humidity

* refactoring project structure: credentials methods

* refactoring project structure: power usage methods

* refactoring project structure: power state methods

* refactoring project structure: websocket methods

* removed deprecated login method from docs

* refactoring project structure: power usage methods

* refactoring project structure: zeroconf classes

* refactoring project structure: websocket classes

* refactoring project structure: zeroconf classes

* refactor and cleanup

* refactoring project structure: firmware methods

* moved parsers to own directory

* update tests with methods renames

* export missing temperature/humidity methods

* removed unused package

* refactor and cleanup

* fix test expectation

* refactoring project structure: moved data files

* refactoring project structure: moved data files

* refactoring project structure: moved helpers files

* refactoring project structure: moved helpers files

* refactoring project structure: moved payload files

* refactor and cleanup

* refactor getDevicePowerState

* setDevicePowerState returns channel

* convert error 400 to 404 for clarity

* updated test cases

* remove console.log

* cache path for zeroconf cache files

* installed nock

* using nock to simulate server requests during testing

* moved credentials file to config folder

* update request url when using nock

* refactor nock helper file

* move cooldown delay to setupTests file

* updating testing instructions

* restored delete code block

* fix wrong error code

* accept phone number to login to ewelink

* added test cases for initialize main class

* improvements on class initialization parameters

* allow login using phone number

* rename test file

* updated test case

* fixed regression bug

* Release v3.0.0 - use node-fetch (#87)

* replaced deprecated request library with node-fetch

* refactor: moved makeRequest to own mixin file

* refactor to use node-fetch

* fixes

* update config

* created helper method

* constant rename

* ignore files from final package

* version bump

Author: skydiver

.npmignore

@@ -0,0 +1,9 @@
+.idea/
+.vscode/
+docs/
+test/
+.editorconfig
+.eslintrc
+arp-table.json
+demo.js
+devices-cache.json

classes/PowerState/ChangeState.js

@@ -22,6 +22,5 @@
   * [getRegion](available-methods/getregion.md)
   * [getFirmwareVersion](available-methods/getfirmwareversion.md)
   * [saveDevicesCache](available-methods/savedevicescache.md)
-  * [login](available-methods/login.md) <sup>_*deprecated_</sup>
 * [Zeroconf (LAN mode)](zeroconf.md)
 * [Testing](testing.md)

classes/PowerState/index.js

@@ -17,7 +17,6 @@ Here is the list of available methods.
 * [getRegion](getregion.md)
 * [getFirmwareVersion](getfirmwareversion.md)
 * [saveDevicesCache](savedevicescache.md)
-* [login](login.md) <sup>_*deprecated_</sup>
 
 Remember to instantiate class before usage.
 

classes/PowerUsage/CurrentMonth.js

@@ -22,6 +22,7 @@ Query for specified device power status.
 ```js
   {
     status: 'ok',
-    state: 'off'
+    state: 'off',
+    channel: 1
   }
 ```

classes/PowerUsage/index.js

@@ -19,7 +19,7 @@ const connection = new ewelink({
 });
 
 // login into eWeLink
-await connection.login();
+await connection.getCredentials();
 
 // call openWebSocket method with a callback as argument
 const socket = await connection.openWebSocket(async data => {

docs/README.md

@@ -24,6 +24,7 @@ Possible states: `on`, `off`, `toggle`.
 ```js
   {
     status: 'ok',
-    state: 'on'
+    state: 'on',
+    channel: 1
   }
 ```

docs/available-methods/README.md

@@ -11,6 +11,15 @@
   });
 ```
 
+**_Using phone number and password_**
+```
+  const connection = new ewelink({
+    phoneNumber: '<your phone number>',
+    password: '<your ewelink password>',
+    region: '<your ewelink region>',
+  });
+```
+
 **_Using access token and api key_**
 ```
   const connection = new ewelink({
@@ -20,5 +29,8 @@
   });
 ```
 
+**_Using devices and arp table cache files_**
+Check [ZeroConf](zeroconf.md) docs for detailed information.
+
 > * If you don't know your region, use [getRegion](available-methods/getregion) method
 > * To get your access token and api key, use [getCredentials](available-methods/getcredentials) method

docs/available-methods/getdevicepowerstate.md

@@ -17,11 +17,11 @@ So, instead of using email and password on every api call, you can login the fir
     region: '<your ewelink region>',
   });
 
-  const login = await connection.login();
+  const credentials = await connection.getCredentials();
 
-  const accessToken = login.at;
-  const apiKey = login.user.apikey
-  const region = login.region;
+  const accessToken = credentials.at;
+  const apiKey = credentials.user.apikey
+  const region = credentials.region;
 
 })();
 ```

docs/available-methods/login.md

@@ -1,8 +1,26 @@
 # Testing
 
-Open `test/_setup/credentials.json` and update parameters.
+## Run test suite
+Copy `test/_setup/config/credentials.example.js` to `test/_setup/config/credentials.js` and update parameters with yours.
 
 In a terminal, `npm run test` or `npm run coverage`.
 
+Tests needs to be performed serially to prevent flooding eWeLink servers, so if run jest manually, add `--runInBand` parameter.
 
-> tests needs to be performed serially, so if run jest manually, add `--runInBand` parameter.
+> All devices needs to be connected before running test suite.
+
+
+## Using nock
+Running tests can take some time because there is many requests to eWeLink servers.
+
+To speedup this process, you need to enable nock "record & play" feature by opening `test/_setup/setupTests.js` and change `nockAction` to `record` or `play`.
+
+The first time you need to record all your requests then you can keep testing by "playing" recorded data.
+
+Recorded data will be stored on `test/_setup/tapes` and you can delete folder content anytime.
+
+Set `nockAction` to `false` to disable all nock functionality.
+
+
+## ZeroConf cache
+While testing ZeroConf functionalty, two temporary files will be created: `test/_setup/cache/arp-table.json` and `test/_setup/cache devices-cache.json`. These files can be safely deleted once tests finished.

docs/available-methods/openwebsocket.md

@@ -35,7 +35,7 @@ A file named `devices-cache.json` will be created.
 ## 2. Generate arp table cache file
 
 ```js
-const Zeroconf = require('ewelink-api/classes/Zeroconf');
+const Zeroconf = require('ewelink-api/src/classes/Zeroconf');
 
 await Zeroconf.saveArpTable({
   ip: '<your network addres, ex: 192.168.5.1>'
@@ -49,7 +49,7 @@ A file named `arp-table.json` will be created.
 
 ```js
 const ewelink = require('ewelink-api');
-const Zeroconf = require('ewelink-api/classes/Zeroconf');
+const Zeroconf = require('ewelink-api/src/classes/Zeroconf');
 
 /* load cache files */
 const devicesCache = await Zeroconf.loadCachedDevices();