toonapi

Node.js package for Eneco/Quby Toon API (unofficial)

• Node.js
• Package on npm
• Toon API
• API documentation

Beta notice

This package is not ready for production while it is in the v0.x.x version range. Once it's released as v1.0.0 or higher it is stable for production uses.

Installation

npm i toonapi --save

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org

Author

Franklin van de Meent

0.3.1 (2016-7-12)

Bug Fixes

• errors: Catch all three kinds of xml errors (6ce10d71)

0.3.0 (2016-7-12)

Documentation Changes

• readme: Added link to npm package (053cf96d)

New Features

• request: Get accessToken when needed (670d7e64)

Bug Fixes

• errors: Renamed message var (86e4c7e1)
• main: Catch all xml API errors (050ce45b)
• response:
  • Default empty body to obj.success true (3f9dbc63)
  • Default empty body to empty object (71aad0fc)

Tests

• main:
  • Check data.success value (abe01f92)
  • Added method devices.update (ac13328a)
  • Run oauth.getTokenFromPassword after other methods (09496cab)
  • Fixed missing cache object (80b2deb6)
  • Fixed minor typos (52781c48)
  • Added method devices.device.get test (4a5a5f07)
  • Check device uuid, cache list (68ed9610)
  • Fixed wrong method name in last commit (16e2d9b6)
  • Added method devices.list test (6e77a6ca)

0.2.0 (2016-7-9)

Chores

• cleanup: Removed trailing spaces (2fc11a97)
• methods: Renamed method function names (54062313)

Documentation Changes

• readme:
  • Added beta notice (ffa2dc27)
  • Added basic readme (f2486de4)

New Features

• errors: Added error endpoint missing (d19659a4)
• oauth: Added method getTokenFromPassword (5252d4ba)
• setup: Added username and password settings (d1d2e921)

Bug Fixes

• pushEvent: Fixed bad request path (93e8b81c)
• devices: Fixed bad request path (56c9d986)
• consumption: Fixed bad request path (1411fca1)
• temperature: Fixed request paths (cb07a91b)
• errors: Fixed missing body for invalid response (3de07430)
• display: Fixed status API path (1bc3088c)
• oauth: Disable Authorization header (35ff3a9b)
• response:
  • Added /revoke handling (a8d9fe9f)
  • Parse XML error from API (046f931b)
• setup: Fixed fatal error when object is missing (3b4930d6)
• methods: Fixed agreements API path (6e57de0d)
• reponse: Consistent return (a03c3ead)

Refactors

• main:
  • Moved methods to app object (9ffdfa6a)
  • Removed unavailable agreements.update method (fdb595ba)
  • Cleaner object props assignment (152dd2d7)
• temperature: Removed method temperature.update (e8d9b02d)
• errors:
  • Removed xml ams:fault parsing (e59c14b5)
  • Rewrite doError() with optional callback (b76819d5)
  • Add headers and statusCode when response data (ad11a91f)
  • Process API errors in doErrors() (180589ef)
  • Handle res details in doError() (86d653a4)
  • Moved errors to dedicated function (d753afa4)
• request:
  • Added setting to disable Authorization header (81c93781)
  • Added request headers setting (bc5244af)
• oauth:
  • Refresh and revoke tokens are required (3dae02fc)
  • Removed methods that are not ready (b9ad921f)
  • Clean up getToken (bf683d34)
• methods: Split agreements into .list and .update (aedd23a6)

Code Style Changes

• methods: Method .agreements clean up (c1e0b599)

Tests

• main:
  • Added method display.status (abe9c500)
  • Added method agreements.list (09143c04)
  • Reload toonapi with new config (4899e721)
  • Added method oauth.revokeToken (10117971)
  • Added method oauth.refreshToken (41900b1c)
  • Store accessToken and refreshToken (68725dd2)
  • Fixed label typo (0660c41c)
  • Timeout error use normal endpoint (a6320aac)
  • Renamed API error to API error - xml ams:fault (fd2badbe)
  • Added API error - xml <fault> (ddaa5f6f)
  • Added method oauth.getTokenFromPassword (7e077aba)
  • Added env vars for username and password (6b7f6fc4)
  • Added more env vars (65d57b8c)
  • Check if API error.error is an object (401087a4)
  • Added timeout error (36d3fe69)
  • Added API error (c8a9dde7)
• lint: Updated eslint config to ES6 (dfa93165)