Merge pull request #15 from electricimp/develop

v1.2.0

Author: Pavel Petroshenko

README.md

@@ -23,11 +23,19 @@ Each of these steps are described in the following sections.
 npm install -g imp-central-api
 ```
 
+#### Proxy Setup ####
+
+If *imp-central-api* is going to connect to the impCentral API via a proxy, one of the following environment variables should be set to a value in URL format:
+- `HTTPS_PROXY` (or `https_proxy`) — for the proxy which passes HTTPs requests.
+- `HTTP_PROXY` (or `http_proxy`) — for the proxy which passes HTTP requests.
+
+Note, the default impCentral API base endpoint is working over HTTPs.
+
 ### Instantiation ###
 
 To instantiate this library, call the [ImpCentralApi class](./lib/ImpCentralApi.js) constructor.
 
-By default, *imp-central-api* works with the following impCentral API base endpoint: *api.electricimp.com/v5*. You can optionally pass an alternative impCentral API base endpoint into the constructor. This can be used to connect to Private impCloud™ installations. The class method *apiEndpoint()* can be used to obtain the current impCentral API base endpoint.
+By default, *imp-central-api* works with the following impCentral API base endpoint: `https://api.electricimp.com/v5`. You can optionally pass an alternative impCentral API base endpoint into the constructor. This can be used to connect to Private impCloud™ installations. The class method *apiEndpoint()* can be used to obtain the current impCentral API base endpoint.
 
 After instantiation, use [ImpCentralApi class](./lib/ImpCentralApi.js) methods to obtain the subclasses which provide the methods you will use to access specific impCentral API resources. For example:
 

lib/LogStreams.js

@@ -26,6 +26,7 @@
 
 const EventSource = require('eventsource');
 const Util = require('util');
+const Url = require('url');
 const ParamsChecker = require('./util/ParamsChecker');
 const HttpHelper = require('./util/HttpHelper');
 const Errors = require('./Errors');
@@ -97,7 +98,9 @@ class LogStreams {
             return new Promise((resolve, reject) => {
                 const logStreamId = result.data.id;
                 const formatQuery = '?format=' + format;
-                const eventSource = new EventSource(HttpHelper.apiEndpoint + this._getPath(logStreamId) + formatQuery);
+                const eventSource = new EventSource(
+                    HttpHelper.apiEndpoint + this._getPath(logStreamId) + formatQuery,
+                    this._getEventSourceOptions());
 
                 eventSource.onopen = function() {
                     this._logStreams[logStreamId] = eventSource;
@@ -110,7 +113,7 @@ class LogStreams {
 
                 eventSource.onerror = function(error) {
                     if (error.status) {
-                        const err = new Errors.ImpCentralApiError(null, error.status);
+                        const err = new Errors.ImpCentralApiError('impCentral API error HTTP/' + error.status, error.status);
                         if (errorHandler) {
                             errorHandler(err);
                         }
@@ -191,6 +194,20 @@ class LogStreams {
         }
     }
 
+    _getEventSourceOptions() {
+        let endpoint = Url.parse(HttpHelper.apiEndpoint);
+        let proxy = null;
+        if (endpoint.protocol === 'https:') {
+            proxy = process.env.HTTPS_PROXY || process.env.https_proxy || null;
+        }
+        else if (endpoint.protocol === 'http:') {
+            proxy = process.env.HTTP_PROXY || process.env.http_proxy || null;
+        }
+        return {
+            proxy : proxy
+        };
+    }
+
     _getPath(logStreamId = null) {
         if (logStreamId) {
             return '/logstream/' + logStreamId;