sqmk · codetheweb · Aug 16, 2019 · Aug 16, 2019 · Aug 16, 2019 · Aug 16, 2019
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,6 @@
+# Playground
+/dev.js
+
 /node_modules
 /npm-debug.log
-/package-lock.json
 /benchmark
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://cdn.rawgit.com/sqmk/huejay/db9081ee1a22acf77abc93cbd3f2e8f6d20ee16b/media/huejay.svg" alt="Huejay" />
+  <img src="https://cdn.jsdelivr.net/gh/sqmk/huejay@db9081ee1a22acf77abc93cbd3f2e8f6d20ee16b/media/huejay.svg" alt="Huejay" />
 </p>
 
 # Huejay - Philips Hue client for Node.js
@@ -36,6 +36,7 @@ Philips Hue API version supported: **1.19.0**
 - [Bridge Discovery](#bridge-discovery)
 - [Errors](#errors)
 - [Client Usage](#client-usage)
+  - [Remote API](#using-the-remote-api)
   - [Users](#users)
   - [Bridge](#bridge)
   - [Portal](#portal)
@@ -133,6 +134,78 @@ client commands.
 The *timeout* option applies to bridge commands. The default value is 15000
 milliseconds (or 15 seconds).
 
+### Using the Remote API
+
+Philips provides a hosted API with an identical interface to that of the local bridge API.  Using the Remote API allows for bridges and the devices controlling them to be on seperate networks.
+
+To use it, an OAuth token must be generated first.
+
+After [adding a new Remote Hue API app](https://developers.meethue.com/my-apps/), open
+
+`https://api.meethue.com/oauth2/auth?clientid=<client-id>&appid=<app-id>&deviceid=<device-id>&devicename=<device-name>&state=<state>&response_type=code`
+
+in your browser to generate an authentication code.
+
+Parameters:
+
+| Parameter   | Meaning                                                    |
+|-------------|------------------------------------------------------------|
+| client-id   | Your app's client ID                                       |
+| app-id      | Your app ID                                                |
+| device-id   | Anything you want                                          |
+| device-name | Your app's name                                            |
+| state       | Anything you want, will be passed back in the redirect URL |
+
+Once a code has been generated, run
+
+```javascript
+const huejay = require('huejay');
+
+(async () => {
+  const token = new huejay.OAuthToken({
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret'
+  });
+
+  await token.getByCode('your-auth-code');
+
+  console.log(JSON.stringify(token)) // => your OAuth token
+})();
+```
+
+to generate an OAuth token.
+
+You can then use the OAuth token in future requests like so:
+
+```javascript
+const huejay = require('huejay');
+
+(async () => {
+  const token = new huejay.OAuthToken({
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret',
+    accessToken: 'your-access-token',
+    refreshToken: 'your-refresh-token'
+  });
+
+  const client = new huejay.Client({
+    remote: true,
+    oauthToken: token,
+    username: 'your-bridge-username'
+  });
+
+  // Refresh the access token
+  await token.refresh();
+
+  // Turn light `1` on
+  const light = await client.lights.getById(1);
+
+  light.on = true;
+
+  await client.lights.save(light);
+})();
+```
+
 ### Users
 
 Huejay provides several commands for managing users on Philips Hue bridges.
@@ -413,7 +486,7 @@ client.portal.get()
 ### Software Update
 
 Occasionally, Philips releases new updates for the bridge, lights, and devices.
-You can use Huejay to facilitate downloading and installation of updates.  
+You can use Huejay to facilitate downloading and installation of updates.
 
 #### client.softwareUpdate.get - Get software update details
 
@@ -1930,7 +2003,7 @@ Get bridge resource limits and timezones.
 
 Retrieve bridge light limits with the command `client.capabilities.lights`.
 This command will eventually return an object describe the limits of the bridge
-around the light resource. 
+around the light resource.
 
 ```js
 client.capabilities.lights()

diff --git a/lib/Action/ChangeGroupAction.js b/lib/Action/ChangeGroupAction.js
@@ -63,7 +63,7 @@ class ChangeGroupAction extends AbstractAction {
     }
 
     if (!!withUsername) {
-      address = `/api/${client.username}${address}`;
+      address = `${client.username}${address}`;
     }
 
     return {

diff --git a/lib/Action/ChangeLightState.js b/lib/Action/ChangeLightState.js
@@ -62,7 +62,7 @@ class ChangeLightState extends AbstractAction {
     }
 
     if (!!withUsername) {
-      address = `/api/${client.username}${address}`;
+      address = `${client.username}${address}`;
     }
 
     return {

diff --git a/lib/Action/ChangeSensorState.js b/lib/Action/ChangeSensorState.js
@@ -46,7 +46,7 @@ class ChangeSensorState extends AbstractAction {
     }
 
     if (!!withUsername) {
-      address = `/api/${client.username}${address}`;
+      address = `${client.username}${address}`;
     }
 
     return {

diff --git a/lib/Client.js b/lib/Client.js
@@ -1,10 +1,14 @@
 'use strict';
 
+const OAuthToken = require('./OAuthToken');
+
 const DEFAULT_CONFIG = {
-  host:     undefined,
-  port:     80,
-  username: undefined,
-  timeout:  15000,
+  host:         undefined,
+  port:         80,
+  remote:       false,
+  oauthToken:   new OAuthToken(),
+  username:     undefined,
+  timeout:      15000,
 };
 
 /**
@@ -59,6 +63,42 @@ class Client {
     this.config.port = Number(port);
   }
 
+  /**
+   * Get remote
+   *
+   * @return {boolean} Remote
+   */
+  get remote() {
+    return this.config.remote;
+  }
+
+  /**
+   * Set remote
+   *
+   * @param {boolean} remote Remote
+   */
+  set remote(remote) {
+    this.config.remote = Boolean(remote);
+  }
+
+  /**
+   * Get OAuthToken
+   *
+   * @return {string} OAuthToken
+   */
+  get oauthToken() {
+    return this.config.oauthToken;
+  }
+
+  /**
+   * Set OAuthToken
+   *
+   * @param {string} oauthToken OAuthToken
+   */
+  set oauthToken(token) {
+    this.config.oauthToken = token;
+  }
+
   /**
    * Get username
    *
@@ -223,7 +263,7 @@ class Client {
 
   /**
    * Get capabilities accessor
-   * 
+   *
    * @return {mixed} Capabilities accessor
    */
   get capabilities() {

diff --git a/lib/Command/Bridge/EnableLinkButton.js b/lib/Command/Bridge/EnableLinkButton.js
@@ -16,7 +16,7 @@ class EnableLinkButton {
   invoke(client) {
     let options = {
       method: 'PUT',
-      url:    `api/${client.username}/config`,
+      url:    `${client.username}/config`,
       data:   {
         'linkbutton': true
       }

diff --git a/lib/Command/Bridge/EnableTouchlink.js b/lib/Command/Bridge/EnableTouchlink.js
@@ -16,7 +16,7 @@ class EnableTouchlink {
   invoke(client) {
     let options = {
       method: 'PUT',
-      url:    `api/${client.username}/config`,
+      url:    `${client.username}/config`,
       data:   {
         'touchlink': true
       }

diff --git a/lib/Command/Bridge/GetBridge.js b/lib/Command/Bridge/GetBridge.js
@@ -18,8 +18,8 @@ class GetBridge {
   invoke(client) {
     let options = {
       url: client.username !== undefined
-        ? `api/${client.username}/config`
-        : 'api/config'
+        ? `${client.username}/config`
+        : 'config'
     };
 
     return client.getTransport()

diff --git a/lib/Command/Bridge/IsAuthenticated.js b/lib/Command/Bridge/IsAuthenticated.js
@@ -16,7 +16,7 @@ class IsAuthenticated {
   invoke(client) {
     let options = {
       // Time zone retrieval as it requires user and not resource intensive
-      url: `api/${client.username}/info/timezones`
+      url: `${client.username}/info/timezones`
     };
 
     return client.getTransport()

diff --git a/lib/Command/Bridge/Ping.js b/lib/Command/Bridge/Ping.js
@@ -15,7 +15,7 @@ class Ping {
    */
   invoke(client) {
     let options = {
-      url: 'api/config'
+      url: 'config'
     };
 
     return client.getTransport()

diff --git a/lib/Command/Bridge/SaveBridge.js b/lib/Command/Bridge/SaveBridge.js
@@ -76,7 +76,7 @@ class SaveBridge {
   saveBridgeAttribute(client, attribute, value) {
     let options = {
       method: 'PUT',
-      url:    `api/${client.username}/config`,
+      url:    `${client.username}/config`,
       data:   {}
     };
 

diff --git a/lib/Command/Capability/GetGroups.js b/lib/Command/Capability/GetGroups.js
@@ -15,7 +15,7 @@ class GetGroups {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetLights.js b/lib/Command/Capability/GetLights.js
@@ -15,7 +15,7 @@ class GetLights {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetResourceLinks.js b/lib/Command/Capability/GetResourceLinks.js
@@ -15,7 +15,7 @@ class GetResourceLinks {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetRules.js b/lib/Command/Capability/GetRules.js
@@ -15,7 +15,7 @@ class GetRules {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetScenes.js b/lib/Command/Capability/GetScenes.js
@@ -15,7 +15,7 @@ class GetScenes {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetSchedules.js b/lib/Command/Capability/GetSchedules.js
@@ -15,7 +15,7 @@ class GetSchedules {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetSensors.js b/lib/Command/Capability/GetSensors.js
@@ -15,7 +15,7 @@ class GetSensors {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Capability/GetTimeZones.js b/lib/Command/Capability/GetTimeZones.js
@@ -15,7 +15,7 @@ class GetTimeZones {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/capabilities`,
+      url: `${client.username}/capabilities`,
       raw: true
     };
 

diff --git a/lib/Command/Group/CreateGroup.js b/lib/Command/Group/CreateGroup.js
@@ -36,7 +36,7 @@ class CreateGroup {
   invoke(client) {
     let options = {
       method: 'POST',
-      url:    `api/${client.username}/groups`,
+      url:    `${client.username}/groups`,
       data:   {}
     };
 

diff --git a/lib/Command/Group/DeleteGroup.js b/lib/Command/Group/DeleteGroup.js
@@ -25,7 +25,7 @@ class DeleteGroup {
   invoke(client) {
     let options = {
       method: 'DELETE',
-      url:    `api/${client.username}/groups/${this.groupId}`
+      url:    `${client.username}/groups/${this.groupId}`
     };
 
     return client.getTransport()

diff --git a/lib/Command/Group/GetGroup.js b/lib/Command/Group/GetGroup.js
@@ -26,7 +26,7 @@ class GetGroup {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/groups/${this.groupId}`
+      url: `${client.username}/groups/${this.groupId}`
     };
 
     return client.getTransport()

diff --git a/lib/Command/Group/GetGroups.js b/lib/Command/Group/GetGroups.js
@@ -17,7 +17,7 @@ class GetGroups {
    */
   invoke(client) {
     let options = {
-      url: `api/${client.username}/groups`
+      url: `${client.username}/groups`
     };
 
     return client.getTransport()

diff --git a/lib/Command/Group/SaveGroup.js b/lib/Command/Group/SaveGroup.js
@@ -34,7 +34,7 @@ class SaveGroup {
   invoke(client) {
     let options = {
       method: 'PUT',
-      url:    `api/${client.username}/groups/${this.group.id}`,
+      url:    `${client.username}/groups/${this.group.id}`,
       data:   {}
     };
 

diff --git a/lib/Command/Group/SaveGroupAction.js b/lib/Command/Group/SaveGroupAction.js
@@ -47,7 +47,7 @@ class SaveGroupAction {
   invoke(client) {
     let options = {
       method: 'PUT',
-      url:    `api/${client.username}/groups/${this.group.id}/action`,
+      url:    `${client.username}/groups/${this.group.id}/action`,
       data:   {},
       multi:  true
     };