More exported features to prepare for first release.

n1k0 · n1k0 · commit a34a55d353e5 · 2015-03-13T10:41:23.000+01:00
diff --git a/Procfile b/Procfile
@@ -1 +1 @@
-web: node index.js
+web: node run.js
diff --git a/README.md b/README.md
@@ -81,6 +81,21 @@ Content sanitization disabled (default):
       "uri":"https://nicolas.perriault.net/code/2013/get-your-frontend-javascript-code-covered/"
     }
 
+### Usage from node
+
+#### scrape() function
+
+The `scrape` function scrapes a URL and returns a Promise with the JSON result object described above:
+
+```js
+var scrape = require("readable-proxy").scrape;
+var url = "https://nicolas.perriault.net/code/2013/get-your-frontend-javascript-code-covered/";
+
+scrape(url, {sanitize: true, userAgent: "My custom User-Agent string"})
+  .then(console.error.log(console))
+  .catch(console.error.bind(console));
+```
+
 Tests
 -----
 
diff --git a/index.js b/index.js
@@ -1 +1,4 @@
-require("./server").serve();
+module.exports = {
+  scrape: require("./scrape"),
+  server: require("./server")
+};
diff --git a/package.json b/package.json
@@ -4,28 +4,30 @@
   "description": "Node service attempting to fetch readable contents from any URL.",
   "main": "index.js",
   "scripts": {
-    "start": "node index.js",
+    "start": "node run.js",
     "test": "mocha"
   },
   "keywords": [
     "readable",
     "readability",
-    "fetch"
+    "fetch",
+    "proxy",
+    "scrape"
   ],
   "author": "Nicolas Perriault <nperriault@mozilla.com>",
   "license": "MPL",
   "dependencies": {
-    "bluebird": "^2.9.12",
-    "bootstrap": "^3.3.2",
-    "express": "^4.11.2",
-    "html-md": "^3.0.2",
-    "markdown": "^0.5.0",
-    "phantomjs": "^1.9.15",
-    "supertest": "^0.15.0"
+    "bluebird": "^2.9.*",
+    "bootstrap": "^3.3.*",
+    "express": "^4.11.*",
+    "html-md": "^3.0.*",
+    "markdown": "^0.5.*",
+    "phantomjs": "^1.9.*"
   },
   "devDependencies": {
-    "chai": "^2.1.0",
-    "mocha": "^2.1.0",
-    "sinon": "^1.12.2"
+    "chai": "^2.1.*",
+    "mocha": "^2.1.*",
+    "sinon": "^1.12.*",
+    "supertest": "^0.15.*"
   }
 }
diff --git a/phantom-scrape.js b/phantom-scrape.js
@@ -34,7 +34,7 @@ page.open(url, function(status) {
   if (!page.injectJs(readabilityPath)) {
     exitWithError("Couldn't inject " + readabilityPath);
   }
-  outputJSON(page.evaluate(function(url, userAgent) {
+  outputJSON(page.evaluate(function(url, userAgent, pageContent) {
     var location = document.location;
     var uri = {
       spec: location.href,
@@ -45,11 +45,27 @@ page.open(url, function(status) {
     };
     try {
       var result = new Readability(uri, document).parse();
-      result.userAgent = userAgent;
+      if (result) {
+        result.userAgent = userAgent;
+      } else {
+        result = {
+          error: {
+            message: "Empty result from Readability.js.",
+            sourceHTML: pageContent || "Empty page content."
+          }
+        };
+      }
       return result;
     } catch (err) {
-      return {error: err};
+      return {
+        error: {
+          message: err.message,
+          line: err.line,
+          stack: err.stack,
+          sourceHTML: pageContent || "Empty page content."
+        }
+      };
     }
-  }, url, page.settings.userAgent));
+  }, url, page.settings.userAgent, page.content));
   phantom.exit();
 });
diff --git a/run.js b/run.js
@@ -0,0 +1 @@
+require("./server").serve();
diff --git a/scrape.js b/scrape.js
@@ -23,7 +23,11 @@ module.exports = function scrape(url, options) {
       try {
         response = JSON.parse(stdout);
       } catch (e) {
-        error = "Unable to parse JSON proxy response.";
+        error = {
+          message: "Unable to parse JSON proxy response.",
+          line: e.line,
+          stack: e.stack
+        };
       }
       if (response && response.error) {
         error = response.error;
diff --git a/test/index.js b/test/index.js
@@ -57,7 +57,7 @@ describe("Tests", function() {
       });
 
       scrape("http://invalid.test/").catch(function(err) {
-        expect(err.error).to.match(/Unable to parse JSON proxy response/);
+        expect(err.error.message).to.match(/Unable to parse JSON proxy response/);
         done();
       });
     });
