Merge pull request #45 from electricimp/develop

v2.4.0

Author: Pavel Petroshenko

Diff for: README.md

@@ -38,6 +38,7 @@
   - [Including JavaScript Libraries](#including-javascript-libraries)
     - [Binding the Context Object Correctly](#binding-the-context-object-correctly)
   - [Cache for Remote Includes](#cache-for-remote-includes)
+  - [Proxy for Remote Includes](#proxy-for-remote-includes)
 - [Testing](#testing)
 - [License](#license)
 
@@ -46,7 +47,7 @@
 
 _Builder_ combines a preprocessor with an expression language and advanced imports.
 
-#### Current version: 2.3.1
+#### Current version: 2.4.0
 
 # Syntax
 
@@ -682,6 +683,15 @@ To reset the cache use both the `--cache` and the `--clear-cache` options.
 
 If a resource should never be cached, it needs to be added to the *exclude-list.builder* file. You can use wildcard characters to mask file names.
 
+## Proxy for Remote Includes
+
+To specify proxy that should be used to include files from remote resources (GitHub or remote HTTP/HTTPs servers), set environment variable(s) `HTTP_PROXY`/`http_proxy` and/or `HTTPS_PROXY`/`https_proxy` for HTTP and HTTPS protocols respectively.
+
+For example, to use a proxy is running at IP `192.168.10.2` on port 3128 for HTTP requests you should set the environment variable:
+`HTTP_PROXY='http://192.168.10.2:3128'`. This will make all the Builder's HTTP requests to go through the proxy.
+
+**Note**: files from GitHub (`github:` protocol) are always included via HTTPS protocol, so the HTTPS_PROXY (if any) should be used to specify proxy in this case.
+
 ### Wildcard pattern matching
 
 Pattern matching syntax is a similar to that of *.gitignore*. A string is a wildcard pattern if it contains '```?```' or '```*```' characters. Empty strings or strings that starts with '```#```' are ignored.

Diff for: package.json

@@ -1,6 +1,6 @@
 {
   "name": "Builder",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "Builder Language Implementation",
   "main": "src/index.js",
   "bin": {
@@ -22,7 +22,7 @@
   "homepage": "https://github.com/electricimp/Builder#readme",
   "dependencies": {
     "clone": "^1.0.2",
-    "github": "^0.2.4",
+    "@octokit/rest": "^15.2.6",
     "glob": "^7.1.2",
     "jsep": "^0.3.1",
     "request": "^2.71.0",

Diff for: src/Readers/GithubReader.js

@@ -24,8 +24,9 @@
 
 'use strict';
 
+const HttpsProxyAgent = require('https-proxy-agent');
 const path = require('path');
-const GitHubApi = require('github');
+const GitHubApi = require('@octokit/rest');
 const childProcess = require('child_process');
 const packageJson = require('../../package.json');
 const AbstractReader = require('./AbstractReader');
@@ -122,7 +123,7 @@ class GithubReader extends AbstractReader {
     const parsed = GithubReader.parseUrl(source);
     return {
       __FILE__: path.basename(parsed.path),
-      __PATH__: `github:${parsed.user}/${parsed.repo}/${path.dirname(parsed.path)}`
+      __PATH__: `github:${parsed.owner}/${parsed.repo}/${path.dirname(parsed.path)}`
     };
   }
 
@@ -131,17 +132,21 @@ class GithubReader extends AbstractReader {
    * @param {string} source
    */
   static fetch(source, username, password) {
-
+    var agent = null;
+    if (process.env.HTTPS_PROXY) {
+      agent = HttpsProxyAgent(process.env.HTTPS_PROXY);
+    } else if (process.env.https_proxy) {
+      agent = HttpsProxyAgent(process.env.https_proxy);
+    }
     const github = new GitHubApi({
-      version: '3.0.0',
       debug: false,
-      protocol: 'https',
-      host: 'api.github.com',
+      baseUrl: 'https://api.github.com',
       timeout: 5000,
       headers: {
         'user-agent': packageJson.name + '/' + packageJson.version,
         'accept': 'application/vnd.github.VERSION.raw'
-      }
+      },
+      agent: agent
     });
 
     // authorization
@@ -176,7 +181,7 @@ class GithubReader extends AbstractReader {
         process.exit(STATUS_FETCH_FAILED);
 
       } else {
-        process.stdout.write(res);
+        process.stdout.write(res['data']);
       }
     });
   }
@@ -194,7 +199,7 @@ class GithubReader extends AbstractReader {
 
     if (m) {
       const res = {
-        'user': m[1],
+        'owner': m[1],
         'repo': m[2],
         'path': m[3]
       };