Initial commit

Author: kevva

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_size = 4
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.json]
+indent_size = 2
+indent_style = space
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

@@ -0,0 +1 @@
+node_modules

.jshintrc

@@ -0,0 +1,16 @@
+{
+	"bitwise": true,
+	"browser": true,
+	"camelcase": true,
+	"curly": true,
+	"eqeqeq": true,
+	"esnext": true,
+	"immed": true,
+	"newcap": true,
+	"noarg": true,
+	"node": true,
+	"quotmark": "single",
+	"strict": true,
+	"undef": true,
+	"unused": "vars"
+}

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - '0.10'

LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) Kevin Mårtensson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,26 @@
+# screenshot-stream [![Build Status](http://img.shields.io/travis/kevva/screenshot-stream.svg?style=flat)](https://travis-ci.org/kevva/screenshot-stream)
+
+> Capture screenshot of a website and return it as a stream
+
+## Install
+
+```sh
+$ npm install --save screenshot-stream
+```
+
+## Usage
+
+```js
+var fs = require('fs');
+var screenshot = require('screenshot-stream');
+
+var stream = screenshot('http://google.com', '1024x768', {
+	crop: true
+});
+
+stream.pipe(fs.createWriteStream('google.com-1024x768.png'));
+```
+
+## License
+
+MIT © [Kevin Mårtensson](https://github.com/kevva)

index.js

@@ -0,0 +1,52 @@
+'use strict';
+
+var base64 = require('base64-stream');
+var path = require('path');
+var parseCookie = require('parse-cookie-phantomjs');
+var phantomjs = require('phantomjs').path;
+var spawn = require('child_process').spawn;
+
+/**
+ * Screenshot stream
+ *
+ * @param {String} url
+ * @param {String} size
+ * @param {Object} opts
+ * @api public
+ */
+
+module.exports = function (url, size, opts) {
+	opts = opts || {};
+	opts.url = url;
+	opts.width = size.split(/x/i)[0];
+	opts.height = size.split(/x/i)[1];
+	opts.cookies = (opts.cookies || []).map(function (cookie) {
+		return typeof cookie === 'string' ? parseCookie(cookie) : cookie;
+	});
+
+	var args = [
+		path.join(__dirname, 'lib/index.js'),
+		JSON.stringify(opts)
+	];
+
+	var cp = spawn(phantomjs, args);
+	var stream = cp.stdout.pipe(base64.decode());
+
+	process.stderr.setMaxListeners(0);
+
+	cp.stderr.setEncoding('utf8');
+	cp.stderr.on('data', function (data) {
+		if (/ phantomjs\[/.test(data)) {
+			return;
+		}
+
+		if (/^WARN: /.test(data)) {
+			stream.emit('warn', data.replace(/^WARN: /, ''));
+			return;
+		}
+
+		stream.emit('error', new Error(data));
+	});
+
+	return stream;
+};

lib/index.js

@@ -0,0 +1,132 @@
+/* global phantom */
+'use strict';
+
+var assign = require('object-assign');
+var log = console.log;
+var opts = JSON.parse(phantom.args[0]);
+var page = require('webpage').create();
+var system = require('system');
+
+/**
+ * Format trace
+ *
+ * @param {Object} trace
+ * @api private
+ */
+
+function format(trace) {
+	var src = trace.file || trace.sourceURL;
+	var fn = (trace.function ? ' in function ' + trace.function : '');
+	return '→ ' + src + ' on line ' + trace.line + fn;
+}
+
+/**
+ * Make sure phantom never outputs to stdout
+ */
+
+console.log = console.error = function () {
+	system.stderr.writeLine([].slice.call(arguments).join(' '));
+};
+
+/**
+ * Add HTTP auth
+ */
+
+if (opts.username && opts.password) {
+	opts.customHeaders = assign({}, opts.customHeaders, {
+		'Authorization': 'Basic ' + btoa(opts.username + ':' + opts.password)
+	});
+}
+
+/**
+ * Add cookies
+ */
+
+opts.cookies.forEach(function (cookie) {
+	if (!phantom.addCookie(cookie)) {
+		console.error('Couldn\'t add cookie: ' + cookie).trim();
+		phantom.exit(1);
+	}
+});
+
+/**
+ * Handle PhantomJS errors
+ */
+
+phantom.onError = function (err, trace) {
+	console.error([
+		'PHANTOM ERROR: ' + err,
+		format(trace[0])
+	].join('\n').trim());
+
+	phantom.exit(1);
+};
+
+/**
+ * Handle page errors
+ */
+
+page.onError = function (err, trace) {
+	console.error([
+		'WARN: ' + err,
+		format(trace[0])
+	].join('\n').trim());
+};
+
+/**
+ * Set viewport size
+ */
+
+page.viewportSize = {
+	width: opts.width,
+	height: opts.height
+};
+
+/**
+ * Set custom headers
+ */
+
+page.customHeaders = opts.customHeaders || {};
+
+/**
+ * Open page
+ */
+
+page.open(opts.url, function (status) {
+	if (status === 'fail') {
+		console.error('Couldn\'t load url');
+		phantom.exit(1);
+	}
+
+	if (opts.crop) {
+		page.clipRect = {
+			top: 0,
+			left: 0,
+			width: opts.width,
+			height: opts.height
+		};
+	}
+
+	if (opts.selector) {
+		page.clipRect = page.evaluate(function (el) {
+			return document
+				.querySelector(el)
+				.getBoundingClientRect();
+		}, opts.selector);
+	}
+
+	page.evaluate(function () {
+		var bgColor = window
+			.getComputedStyle(document.body)
+			.getPropertyValue('background-color');
+
+		if (!bgColor || bgColor === 'rgba(0, 0, 0, 0)') {
+			document.body.style.backgroundColor = 'white';
+		}
+	});
+
+	window.setTimeout(function () {
+		log.call(console, page.renderBase64('png'));
+		phantom.exit();
+	}, opts.delay * 1000);
+});

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "screenshot-stream",
+  "version": "1.0.0",
+  "description": "Capture screenshot of a website and return it as a stream",
+  "license": "MIT",
+  "repository": "kevva/screenshot-stream",
+  "author": {
+    "name": "Kevin Mårtensson",
+    "email": "kevinmartensson@gmail.com",
+    "url": "https://github.com/kevva"
+  },
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "test": "node test.js"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "keywords": [],
+  "dependencies": {
+    "base64-stream": "^0.1.2",
+    "object-assign": "^1.0.0",
+    "parse-cookie-phantomjs": "^1.0.0",
+    "phantomjs": "^1.9.10"
+  },
+  "devDependencies": {
+    "ava": "0.0.4",
+    "concat-stream": "^1.4.6",
+    "image-size": "^0.3.3"
+  }
+}

test.js

@@ -0,0 +1,58 @@
+'use strict';
+
+var concat = require('concat-stream');
+var imageSize = require('image-size');
+var screenshot = require('./');
+var test = require('ava');
+
+test('crop image using the `crop` option', function (t) {
+	t.plan(2);
+
+	var stream = screenshot('http://yeoman.io', '1024x768', {
+		crop: true
+	});
+
+	stream.pipe(concat(function (data) {
+		t.assert(imageSize(data).width === 1024);
+		t.assert(imageSize(data).height === 768);
+	}));
+});
+
+test('capture a DOM element using the `selector` option', function (t) {
+	t.plan(2);
+
+	var stream = screenshot('http://yeoman.io', '1024x768', {
+		selector: '.page-header'
+	});
+
+	stream.pipe(concat(function (data) {
+		t.assert(imageSize(data).width === 1024);
+		t.assert(imageSize(data).height === 80);
+	}));
+});
+
+test('auth using the `username` and `password` options', function (t) {
+	t.plan(1);
+
+	var stream = screenshot('http://httpbin.org/basic-auth/user/passwd', '1024x768', {
+		username: 'user',
+		password: 'passwd'
+	});
+
+	stream.on('data', function (data) {
+		t.assert(data.length);
+	});
+});
+
+test('have a `delay` option', function (t) {
+	t.plan(2);
+
+	var now = new Date();
+	var stream = screenshot('http://yeoman.io', '1024x768', {
+		delay: 2
+	});
+
+	stream.on('data', function (data) {
+		t.assert((new Date()) - now > 2000);
+	});
+});