Bridge async configuration issue

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,42 @@
+name: "Code scanning - action"
+
+on:
+  push:
+  schedule:
+    - cron: '0 10 * * 4'
+
+jobs:
+  CodeQL-Build:
+
+    # CodeQL runs on ubuntu-latest and windows-latest
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

Changelog.md

@@ -1,5 +1,9 @@
 # Change Log
 
+#5.0.0-alpha.1
+- Providing a fix for the discovery portal (N-UPnP search) issues where a user has multiple bridges, where some of 
+them are invalid. This changes the return value for discovery requiring a major version bump. Issue #168.
+
 #4.0.5
 - Various TypeScript definition fixes including Issue #166.
 

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -69,7 +69,7 @@ $ npm install node-hue-api
 
 Node.js using yarn:
 ```
-$ yarn install node-hue-api
+$ yarn add node-hue-api
 ```
 
 ## v3 API
@@ -268,7 +268,7 @@ async function discoverAndCreateUser() {
     const authenticatedApi = await hueApi.createLocal(ipAddress).connect(createdUser.username);
 
     // Do something with the authenticated user/api
-    const bridgeConfig = await authenticatedApi.configuration.get();
+    const bridgeConfig = await authenticatedApi.configuration.getConfiguration();
     console.log(`Connected to Hue Bridge: ${bridgeConfig.name} :: ${bridgeConfig.ipaddress}`);
 
   } catch(err) {

docs/discovery.md

@@ -33,7 +33,7 @@ async function getBridge() {
 getBridge();
 ```
 
-The results will be an array of discovered bridges with the following structure:
+The results will be an array of valid discovered bridges with the following structure:
 
 ```json
 [
@@ -46,6 +46,22 @@ The results will be an array of discovered bridges with the following structure:
 ]
 ```
 
+If a bridge is registered in the Hue portal and returned from the discovery endpoint that is queried but cannot be 
+connected to for any reason (i.e. it is offline), then the bridge data will be provided in an error object of the form:
+
+```json
+{
+  "error": {
+    "message": "An error message",
+    "description": "Failed to connect and load configuration from the bridge at ip address xxx.xxx.xxx.xxx",
+    "ipaddress": "xxx.xxx.xxx.xxx",
+    "id": "xxxxxxxxxxxxxxxx"
+  }
+}
+```
+ The `message` value will be that of the underlying error when attempting to resolve the bridge configuration. The `id` 
+ is the mac address reported from the discovery portal and the `ipaddress` is that of the recorded ip address from the 
+ discovery portal.
 
 
 ## UPnP Search

examples/v3/capabilities/getAllCapabilities.js

@@ -1,16 +1,16 @@
 'use strict';
 
-const v3 = require('../../../index').v3;
+const hueApi = require('../../../index');
 // If using this code outside of this library the above should be replaced with
-// const v3 = require('node-hue-api').v3;
+// const hueApi = require('node-hue-api');
 
 // Replace this with your username for accessing the bridge
 const USERNAME = require('../../../test/support/testValues').username;
 
-v3.discovery.nupnpSearch()
+hueApi.discovery.nupnpSearch()
   .then(searchResults => {
     const host = searchResults[0].ipaddress;
-    return v3.api.createLocal(host).connect(USERNAME);
+    return hueApi.v3.api.createLocal(host).connect(USERNAME);
   })
   .then(api => {
     return api.capabilities.getAll();

examples/v3/discoverAndCreateUserScript.js

@@ -1,7 +1,8 @@
 const v3 = require('../../index').v3
+  , discovery = require('../../index').discovery
   // If using this code outside of the examples directory, you will want to use the line below and remove the
   // const v3 = require('node-hue-api').v3
-  , discovery = v3.discovery
+  // const discovery = require('node-hue-api').discovery
   , hueApi = v3.api
 ;
 
@@ -42,7 +43,7 @@ async function discoverAndCreateUser() {
     const authenticatedApi = await hueApi.createLocal(ipAddress).connect(createdUser.username);
 
     // Do something with the authenticated user/api
-    const bridgeConfig = await authenticatedApi.configuration.get();
+    const bridgeConfig = await authenticatedApi.configuration.getConfiguration();
     console.log(`Connected to Hue Bridge: ${bridgeConfig.name} :: ${bridgeConfig.ipaddress}`);
 
   } catch(err) {

examples/v3/discoverBridgeViaNupnp.js

@@ -1,13 +1,13 @@
 'use strict';
 
-const v3 = require('../../index').v3
+const discovery = require('../../index').discovery
 ;
 
 // For this to work properly you need to be connected to the same network that the Hue Bridge is running on.
 // It will not function across VLANs or different network ranges.
 
 async function getBridge() {
-  const results = await v3.discovery.nupnpSearch();
+  const results = await discovery.nupnpSearch();
 
   // Results will be an array of bridges that were found
   console.log(JSON.stringify(results, null, 2));

examples/v3/discoverBridgeViaUpnp.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const v3 = require('../../index').v3
+const discovery = require('../../index').discovery
 ;
 
 async function getBridge() {
-  const results = await v3.discovery.upnpSearch();
+  const results = await discovery.upnpSearch();
 
   // Results will be an array of bridges that were found
   console.log(JSON.stringify(results, null, 2));

examples/v3/lights/getLight.js

@@ -16,7 +16,7 @@ v3.discovery.nupnpSearch()
     return v3.api.createLocal(host).connect(USERNAME);
   })
   .then(api => {
-    return api.lights.get(LIGHT_ID);
+    return api.lights.getLight(LIGHT_ID);
   })
   .then(light => {
     // Display the details of the light

index.js

@@ -5,11 +5,13 @@
 //
 
 const v3 = require('./lib/v3')
+  , discovery = require('./lib/api/discovery')
   , ApiError = require('./lib/ApiError')
 ;
 
 module.exports = {
   v3: v3,
+  discovery: discovery,
 
   // This was present in the old API, may need to deprecate it
   ApiError: ApiError,