First commit

Kikobeats · Kikobeats · commit a7f7bdafff2e · 2017-09-06T00:03:39.000+02:00
diff --git a/.bumpedrc b/.bumpedrc
@@ -0,0 +1,21 @@
+files:
+  - package.json
+plugins:
+  prerelease:
+    Linting config files:
+      plugin: bumped-finepack
+  postrelease:
+    Generating CHANGELOG file:
+      plugin: bumped-changelog
+    Committing new version:
+      plugin: bumped-terminal
+      command: 'git add CHANGELOG.md package.json && git commit -m "Release $newVersion"'
+    Detecting problems before publish:
+      plugin: bumped-terminal
+      command: 'git-dirty && npm test'
+    Publishing tag to GitHub:
+      plugin: bumped-terminal
+      command: 'git tag $newVersion && git push && git push --tags'
+    Publishing to NPM:
+      plugin: bumped-terminal
+      command: npm publish
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,22 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+indent_brace_style = 1TBS
+spaces_around_operators = true
+quote_type = auto
+
+[package.json]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,32 @@
+############################
+# npm
+############################
+node_modules
+npm-debug.log
+
+############################
+# tmp, editor & OS files
+############################
+.tmp
+*.swo
+*.swp
+*.swn
+*.swm
+.DS_Store
+*#
+*~
+.idea
+*sublime*
+nbproject
+
+############################
+# Tests
+############################
+testApp
+coverage
+.nyc_output
+
+############################
+# Other
+############################
+.node_history
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,16 @@
+.idea
+.project
+*.sublime-*
+.DS_Store
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.swp
+*.swo
+node_modules
+coverage
+*.tgz
+*.xml
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+unsafe-perm=true
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "node"
+  - "lts/*"
+after_success: npm run coveralls
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2017 Kiko Beats <josefrancisco.verdu@gmail.com> (kikobeats.com)
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,60 @@
+# frowser
+
+<p align="center">
+  <br>
+  <img src="https://i.imgur.com/Mh13XWB.gif" alt="frowser">
+  <br>
+</p>
+
+![Last version](https://img.shields.io/github/tag/Kikobeats/frowser.svg?style=flat-square)
+[![Build Status](https://img.shields.io/travis/Kikobeats/frowser/master.svg?style=flat-square)](https://travis-ci.org/Kikobeats/frowser)
+[![Coverage Status](https://img.shields.io/coveralls/Kikobeats/frowser.svg?style=flat-square)](https://coveralls.io/github/Kikobeats/frowser)
+[![Dependency status](https://img.shields.io/david/Kikobeats/frowser.svg?style=flat-square)](https://david-dm.org/Kikobeats/frowser)
+[![Dev Dependencies Status](https://img.shields.io/david/dev/Kikobeats/frowser.svg?style=flat-square)](https://david-dm.org/Kikobeats/frowser#info=devDependencies)
+[![NPM Status](https://img.shields.io/npm/dm/frowser.svg?style=flat-square)](https://www.npmjs.org/package/frowser)
+[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/Kikobeats)
+
+**NOTE:** more badges availables in [shields.io](https://shields.io/)
+
+> Accessing to browser from the Upside Down
+
+## Install
+
+```bash
+$ npm install frowser --save
+```
+
+## Usage
+
+```js
+const frowser = require('frowser')
+
+frowser('do something')
+//=> return something
+```
+
+## API
+
+### frowser(input, [options])
+
+#### input
+
+*Required*<br>
+Type: `string`
+
+Lorem ipsum.
+
+#### options
+
+##### foo
+
+Type: `boolean`<br>
+Default: `false`
+
+Lorem ipsum.
+## License
+
+**frowser** © [Kiko Beats](https://kikobeats.com), Released under the [MIT](https://github.com/Kikobeats/frowser/blob/master/LICENSE.md) License.<br>
+Authored and maintained by Kiko Beats with help from [contributors](https://github.com/Kikobeats/frowser/contributors).
+
+> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/kikobeats) · Twitter [@kikobeats](https://twitter.com/kikobeats)
diff --git a/index.js b/index.js
@@ -0,0 +1,32 @@
+'use strict'
+
+const createTempFile = require('create-temp-file2')
+const puppeteer = require('puppeteer')
+
+async function getHTML (url, opts = {}) {
+  const browser = await puppeteer.launch()
+  const page = await browser.newPage()
+  await page.goto(url, opts)
+  const bodyHTML = await page.evaluate(() => document.documentElement.innerHTML)
+  browser.close()
+  return bodyHTML
+}
+
+async function takeScreenshot (url, opts = {}) {
+  const { type = 'png' } = opts
+  const tempFile = createTempFile({ ext: `.${type}` })
+  const { path } = tempFile
+
+  const browser = await puppeteer.launch()
+  const page = await browser.newPage()
+  await page.goto(url)
+  await page.screenshot(Object.assign({ path, type }, opts))
+  browser.close()
+
+  return Promise.resolve(tempFile)
+}
+
+module.exports = {
+  getHTML,
+  takeScreenshot
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,61 @@
+{
+  "name": "frowser",
+  "description": "Accessing to browser from the Upside Down",
+  "homepage": "https://documentup.com/Kikobeats/frowser",
+  "version": "0.0.0",
+  "main": "index.js",
+  "author": {
+    "email": "josefrancisco.verdu@gmail.com",
+    "name": "Kiko Beats",
+    "url": "https://kikobeats.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kikobeats/frowser.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kikobeats/frowser/issues"
+  },
+  "keywords": [],
+  "dependencies": {
+    "create-temp-file2": "~2.0.0",
+    "puppeteer": "~0.10.2"
+  },
+  "devDependencies": {
+    "coveralls": "latest",
+    "git-dirty": "latest",
+    "husky": "latest",
+    "lint-staged": "latest",
+    "mocha": "latest",
+    "nyc": "latest",
+    "prettier-standard": "latest",
+    "should": "latest",
+    "standard": "latest",
+    "standard-markdown": "latest"
+  },
+  "engines": {
+    "node": ">= 6"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "coveralls": "nyc report --reporter=text-lcov | coveralls",
+    "lint": "standard-markdown && standard",
+    "precommit": "lint-staged",
+    "prelint": "npm run pretty",
+    "pretest": "npm run lint",
+    "pretty": "prettier-standard --single-quote {core,test,bin}/**/*.js",
+    "test": "nyc mocha"
+  },
+  "license": "MIT",
+  "lint-staged": {
+    "*.js": [
+      "prettier-standard",
+      "git add"
+    ]
+  },
+  "standard": {
+    "env": [
+      "mocha"
+    ]
+  }
+}
diff --git a/test/example.jpeg b/test/example.jpeg
diff --git a/test/example.png b/test/example.png
diff --git a/test/html.txt b/test/html.txt
@@ -0,0 +1,49 @@
+<head>
+    <title>Example Domain</title>
+
+    <meta charset="utf-8">
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <style type="text/css">
+    body {
+        background-color: #f0f0f2;
+        margin: 0;
+        padding: 0;
+        font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
+        
+    }
+    div {
+        width: 600px;
+        margin: 5em auto;
+        padding: 50px;
+        background-color: #fff;
+        border-radius: 1em;
+    }
+    a:link, a:visited {
+        color: #38488f;
+        text-decoration: none;
+    }
+    @media (max-width: 700px) {
+        body {
+            background-color: #fff;
+        }
+        div {
+            width: auto;
+            margin: 0 auto;
+            border-radius: 0;
+            padding: 1em;
+        }
+    }
+    </style>    
+</head>
+
+<body>
+<div>
+    <h1>Example Domain</h1>
+    <p>This domain is established to be used for illustrative examples in documents. You may use this
+    domain in examples without prior coordination or asking for permission.</p>
+    <p><a href="http://www.iana.org/domains/example">More information...</a></p>
+</div>
+
+
+</body>
diff --git a/test/index.js b/test/index.js
@@ -0,0 +1,41 @@
+'use strict'
+
+const should = require('should')
+const path = require('path')
+const fs = require('fs')
+
+const frowser = require('..')
+
+const htmlFixture = fs.readFileSync(path.resolve(__dirname, 'html.txt'), 'utf8')
+
+describe('frowser', () => {
+  describe('.getHTML', () => {
+    it('get full HTML from a link', () =>
+      frowser.getHTML('http://example.com').then(html => {
+        // fs.writeFileSync(path.resolve(__dirname, 'html.txt'), html, 'utf8')
+        should(html).be.eql(htmlFixture)
+      }))
+  })
+
+  describe('.takeScreenshot', () => {
+    it('png', () =>
+      frowser.takeScreenshot('http://example.com').then(tmpStream => {
+        should(fs.readFileSync(tmpStream.path)).be.eql(
+          fs.readFileSync('test/example.png')
+        )
+        should(path.extname(tmpStream.path)).be.equal('.png')
+        tmpStream.cleanupSync()
+      }))
+
+    it('jpeg', () =>
+      frowser
+        .takeScreenshot('http://example.com', { type: 'jpeg' })
+        .then(tmpStream => {
+          should(fs.readFileSync(tmpStream.path)).be.eql(
+            fs.readFileSync('test/example.jpeg')
+          )
+          should(path.extname(tmpStream.path)).be.equal('.jpeg')
+          tmpStream.cleanupSync()
+        }))
+  })
+})
diff --git a/test/mocha.opts b/test/mocha.opts
@@ -0,0 +1,6 @@
+--require should
+--reporter spec
+--timeout 120000
+--slow 300
+--bail
+--recursive
