gastly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b909060aee09401279b4c0745463834c652c296c
+  data.tar.gz: c604a639311a7ce2058705a02e67af139beb8f60
+SHA512:
+  metadata.gz: 1bfa49c1fb26bf1c62b4802f0be811b2b3e777bbe4348b70c0b8d820116d2b6cc8aa3a7696ffaf8328dc5d6f5a4e2056889d1d526ba4d21f4d130fb97b9bf42a
+  data.tar.gz: bc13634e04a8c794da3d4bae62b3ab2de28fbb7b8bd3769a5c7ac8cf281fa7622c43ac159e7775d1cdc8843f2d4f1e3c26797c83f587e60c84edcc27e02b3358

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gastly.gemspec
+gemspec

data/README.md

@@ -0,0 +1,69 @@
+# Gastly
+
+Create screenshots or previews of web pages using Gastly. Under the hood Phantom.js and MiniMagick. Gastly, I choose you!
+
+![Gastly](https://github.com/mgrachev/gastly/raw/master/gastly.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gastly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gastly
+
+## Usage
+
+```ruby
+Gastly.capture('http://google.com', 'output.png')
+```
+
+It is also possible to further customize the creation of screenshots and further processing of the resulting image:
+
+```ruby
+screenshot = Gastly.screenshot('http://google.com')
+screenshot.selector = '#hplogo' # By default, the full screen is captured
+screenshot.browser_width = 1280 # Default: 1440px
+screenshot.browser_height = 780 # Default: 900px
+screenshot.timeout = 1000 # Default: 0 seconds
+screenshot.cookies = { user_id: 1, auth_token: 'abcd' } # If you need
+image = screenshot.capture
+```
+
+Or
+
+```ruby
+screenshot = Gastly.screenshot('http://google.com', selector: '#hplogo', timeout: 1000)
+image = screenshot.capture
+```
+
+You can resize or change the format of the screenshot:
+
+```ruby
+image = screenshot.capture
+image.resize(width: 110, height: 110) # Creates a previews of web-page
+image.format('png')
+image.save('output.png')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gastly/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gastly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gastly.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/gastly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gastly'
+  spec.version       = Gastly::VERSION
+  spec.authors       = ['Mikhail Grachev']
+  spec.email         = ['work@mgrachev.com']
+
+  spec.summary       = %q{Create screenshots or previews of web pages using Gastly. Gastly, I choose you!}
+  spec.description   = %q{Create screenshots or previews of web pages using Gastly. Under the hood Phantom.js and MiniMagick.}
+  spec.homepage      = 'https://github.com/mgrachev/gastly'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'phantomjs', '~> 1.9'
+  spec.add_dependency 'mini_magick', '~> 4.2'
+  spec.add_dependency 'activesupport', '>= 3.1'
+end

data/lib/gastly.rb

@@ -0,0 +1,16 @@
+require_relative 'gastly/image'
+require_relative 'gastly/screenshot'
+require_relative 'gastly/version'
+
+module Gastly
+
+  def screenshot(url, **kwargs)
+    Screenshot.new(url, **kwargs)
+  end
+
+  def capture(url, path)
+    screenshot(url).capture.save(path)
+  end
+
+  module_function :screenshot, :capture
+end

data/lib/gastly/image.rb

@@ -0,0 +1,28 @@
+require 'mini_magick'
+
+module Gastly
+  class Image
+
+    attr_reader :file
+
+    def initialize(tempfile)
+      @file = MiniMagick::Image.open(tempfile.path, 'png')
+      tempfile.unlink
+    end
+
+    def resize(width:, height:)
+      dimensions = "#{width}x#{height}"
+      @file.resize(dimensions)
+    end
+
+    def format(ext)
+      @file.format(ext)
+    end
+
+    def save(output)
+      @file.write(output)
+      output
+    end
+
+  end
+end

data/lib/gastly/screenshot.rb

@@ -0,0 +1,60 @@
+require 'phantomjs'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+
+module Gastly
+  class Screenshot
+
+    SCRIPT_PATH = File.expand_path('../script.js', __FILE__)
+    DEFAULT_TIMEOUT = 0
+    DEFAULT_BROWSER_WIDTH = 1440
+    DEFAULT_BROWSER_HEIGHT = 900
+    DEFAULT_FILE_NAME = 'output'.freeze
+    DEFAULT_FILE_FORMAT = '.png'.freeze
+
+    attr_writer :timeout, :browser_width, :browser_height
+    attr_accessor :url, :selector, :cookies
+
+    def initialize(url, **kwargs)
+      kwargs.assert_valid_keys(:timeout, :browser_width, :browser_height, :selector, :cookies)
+
+      @url = url
+      self.cookies = kwargs.delete(:cookies)
+
+      kwargs.each { |key, value| instance_variable_set(:"@#{key}", value) }
+    end
+
+    def timeout
+      @timeout || DEFAULT_TIMEOUT
+    end
+
+    def browser_width
+      @browser_width || DEFAULT_BROWSER_WIDTH
+    end
+
+    def browser_height
+      @browser_height || DEFAULT_BROWSER_HEIGHT
+    end
+
+    def capture
+      tempfile = Tempfile.new([DEFAULT_FILE_NAME, DEFAULT_FILE_FORMAT])
+
+      params = {
+        url:      url,
+        timeout:  timeout,
+        width:    browser_width,
+        height:   browser_height,
+        output:   tempfile.path
+      }
+
+      params[:selector] = selector if selector.present?
+      params[:cookies]  = cookies.map { |k, v| "#{k}=#{v}" }.join(',') if cookies.present?
+      prepared_params   = params.map { |k, v| "#{k}=#{v}" }
+
+      Phantomjs.run(SCRIPT_PATH.to_s, *prepared_params)
+
+      Gastly::Image.new(tempfile)
+    end
+
+  end
+end

data/lib/gastly/script.js

@@ -0,0 +1,62 @@
+function extractDomain(url){
+    var domain;
+    // Remove protocol
+    if (url.indexOf("://") > -1){
+        domain = url.split('/')[2];
+    }
+    else {
+        domain = url.split('/')[0];
+    }
+
+    // Remove port number
+    domain = domain.split(':')[0];
+
+    return domain;
+}
+
+var i, pair,
+    args    = {},
+    system  = require('system'),
+    page    = require('webpage').create();
+
+for(i = 1; i < system.args.length; i++){
+    pair = system.args[i].split(/=(.*)/);
+    args[pair[0]] = pair[1];
+}
+
+if (args.cookies !== undefined){
+    var cookiesPair = args.cookies.split(',');
+
+    for(i = 0; i < cookiesPair.length; i++){
+        pair = cookiesPair[i].split(/=(.*)/);
+
+        page.addCookie({
+            'name': pair[0],
+            'value': pair[1],
+            'path': '/',
+            'domain': extractDomain(args.url)
+        });
+    }
+}
+
+page.open(args.url, function(){
+    window.setTimeout(function(){
+        page.viewportSize = { width: args.width, height: args.height };
+
+        if (args.selector !== undefined){
+            var clipRect = page.evaluate(function(s){
+                return document.querySelector(s).getBoundingClientRect();
+            }, args.selector);
+
+            page.clipRect = {
+                top:    clipRect.top,
+                left:   clipRect.left,
+                width:  clipRect.width,
+                height: clipRect.height
+            };
+        }
+
+        page.render(args.output);
+        phantom.exit();
+    }, args.timeout);
+});

data/lib/gastly/version.rb

@@ -0,0 +1,3 @@
+module Gastly
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: gastly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikhail Grachev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: phantomjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Create screenshots or previews of web pages using Gastly. Under the hood
+  Phantom.js and MiniMagick.
+email:
+- work@mgrachev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gastly.gemspec
+- gastly.png
+- lib/gastly.rb
+- lib/gastly/image.rb
+- lib/gastly/screenshot.rb
+- lib/gastly/script.js
+- lib/gastly/version.rb
+homepage: https://github.com/mgrachev/gastly
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Create screenshots or previews of web pages using Gastly. Gastly, I choose
+  you!
+test_files: []