gastly 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c192b43a0068cbba91b24d1a7e5647d846b386d9
-  data.tar.gz: bf9af7de29d4482a18daafa105e84abd91a41767
+  metadata.gz: 327d0941c591a2f1b07c19b013307d917f9c744e
+  data.tar.gz: 0f87c8fc8905ffc76e0dccb6395302214f13ca71
 SHA512:
-  metadata.gz: 4c0c5705e90950d8ab2e23e9ea4739b2110e6ab5f0ce6bc10d409c56bd2046085640a96513d7eebe130353517caed0e7f9d2af7befbdd08f59850cd1893a8653
-  data.tar.gz: 61c0cf280a979d41fe03c02ae77f9916bd2eff7383d991f3cc67a4fcc4b3cc13849331f4f4528eed6e9f4405c780d92352eab15a387f08ade40fc4317776c5b7
+  metadata.gz: bd7e4f76405c0c344427fc052950ff8b36abf56269becf515cd278527a2af2e09dd48f31891fa1646653117e26c52d1146edbe273f4316f4384c5b449d79c8cc
+  data.tar.gz: c49f95e949893ef171c9d6d9366aa327d10300db95cc8e91b03db5a82717c6981855f097973be6b1a640d7096727a066ad30c15919ed369f1103743dc0bd7ec5

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+## 0.2.2 (19/08/2015)
+
+### Enhancements
+
+* Improved exception handling and error
+* Capture all page if selector not found
+
+## 0.2.1 (10/08/2015)
+
+### Bug Fixes
+
+* Stop PhantomJS if a site unavailable
+
+## 0.2.0 (23/07/2015)
+
+### Features
+
+* Add proxy support
+
+### Enhancements
+
+* Update dependencies
+
+## 0.1.1 (13/07/2015)
+
+### Enhancements
+
+* Update version Phantomjs to 2.0
+
+## 0.1.0 (13/07/2015)
+
+* Initial release

data/lib/gastly.rb

@@ -1,5 +1,6 @@
 require_relative 'gastly/image'
 require_relative 'gastly/screenshot'
+require_relative 'gastly/exceptions'
 require_relative 'gastly/version'
 
 module Gastly

data/lib/gastly/exceptions.rb

@@ -0,0 +1,11 @@
+module Gastly
+  class FetchError < StandardError
+    attr_reader :url
+
+    def initialize(url)
+      super("Unable to load #{url}")
+    end
+  end
+
+  PhantomJSError = Class.new(StandardError)
+end

data/lib/gastly/screenshot.rb

@@ -5,8 +5,6 @@ require 'active_support/core_ext/object/blank'
 module Gastly
   class Screenshot
 
-    FetchError = Class.new(StandardError)
-
     SCRIPT_PATH = File.expand_path('../script.js', __FILE__)
     DEFAULT_TIMEOUT = 0
     DEFAULT_BROWSER_WIDTH = 1440
@@ -16,11 +14,13 @@ module Gastly
 
     attr_writer :timeout, :browser_width, :browser_height
     attr_accessor :url, :selector, :cookies, :proxy_host, :proxy_port
+    attr_reader :tempfile
 
     def initialize(url, **kwargs)
       kwargs.assert_valid_keys(:timeout, :browser_width, :browser_height, :selector, :cookies, :proxy_host, :proxy_port)
 
       @url = url
+      @tempfile = Tempfile.new([DEFAULT_FILE_NAME, DEFAULT_FILE_FORMAT])
       self.cookies = kwargs.delete(:cookies)
 
       kwargs.each { |key, value| instance_variable_set(:"@#{key}", value) }
@@ -39,8 +39,24 @@ module Gastly
     end
 
     def capture
-      tempfile = Tempfile.new([DEFAULT_FILE_NAME, DEFAULT_FILE_FORMAT])
+      Phantomjs.proxy_host = proxy_host if proxy_host
+      Phantomjs.proxy_port = proxy_port if proxy_port
+
+      output = Phantomjs.run(proxy_options, SCRIPT_PATH.to_s, *prepared_params)
+
+      handle_exception(output) if output.present?
+
+      Gastly::Image.new(tempfile)
+    end
+
+    private
+
+    def proxy_options
+      return '' if proxy_host.blank? && proxy_port.blank?
+      "--proxy=#{proxy_host}:#{proxy_port}"
+    end
 
+    def prepared_params
       params = {
         url:      url,
         timeout:  timeout,
@@ -50,23 +66,22 @@ module Gastly
       }
 
       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.proxy_host = proxy_host if proxy_host
-      Phantomjs.proxy_port = proxy_port if proxy_port
-      output = Phantomjs.run(proxy_options, SCRIPT_PATH.to_s, *prepared_params)
+      params[:cookies]  = hash_to_array(cookies).join(',') if cookies.present?
 
-      raise FetchError, output if output.present?
+      hash_to_array(params)
+    end
 
-      Gastly::Image.new(tempfile)
+    def hash_to_array(data)
+      data.map { |key, value| "#{key}=#{value}" }
     end
 
-    private
+    def handle_exception(output)
+      error = case output
+              when /^FetchError:(.+)/     then Gastly::FetchError
+              when /^RuntimeError:(.+)/m  then Gastly::PhantomJSError
+              end
 
-    def proxy_options
-      return '' if proxy_host.blank? && proxy_port.blank?
-      "--proxy=#{proxy_host}:#{proxy_port}"
+      raise error, $1
     end
 
   end

data/lib/gastly/script.js

@@ -1,13 +1,11 @@
 function extractDomain(url){
     var domain;
     // Remove protocol
-    if (url.indexOf("://") > -1){
+    if (url.indexOf("://") > -1) {
         domain = url.split('/')[2];
-    }
-    else {
+    } else {
         domain = url.split('/')[0];
     }
-
     // Remove port number
     domain = domain.split(':')[0];
 
@@ -19,16 +17,16 @@ var i, pair,
     system  = require('system'),
     page    = require('webpage').create();
 
-for(i = 1; i < system.args.length; i++){
-    pair = system.args[i].split(/=(.*)/);
+system.args.forEach(function(arg) {
+    pair = arg.split(/=(.*)/);
     args[pair[0]] = pair[1];
-}
+});
 
-if (args.cookies !== undefined){
+if (args.cookies !== undefined) {
     var cookiesPair = args.cookies.split(',');
 
-    for(i = 0; i < cookiesPair.length; i++){
-        pair = cookiesPair[i].split(/=(.*)/);
+    cookiesPair.forEach(function(cookie) {
+        pair = cookie.split(/=(.*)/);
 
         page.addCookie({
             'name': pair[0],
@@ -36,28 +34,52 @@ if (args.cookies !== undefined){
             'path': '/',
             'domain': extractDomain(args.url)
         });
+    });
+}
+
+phantom.onError = function(message, trace){
+    var messageStack = ['RuntimeError:' + message];
+
+    if (trace && trace.length) {
+        messageStack.push('Trace:');
+
+        trace.forEach(function(t) {
+            messageStack.push(' -> ' + t.file + ': ' + t.line + (t.function ? ' (in function "' + t.function +'")' : ''));
+        });
     }
+
+    console.log(messageStack.join('\n'));
+    phantom.exit(1);
 }
 
 page.open(args.url, function(status){
     if(status !== 'success') {
-        console.log('Unable to load: ' + args.url);
+        console.log('FetchError:' + args.url);
         phantom.exit();
     } else {
         window.setTimeout(function(){
             page.viewportSize = { width: args.width, height: args.height };
 
             if (args.selector !== undefined){
+                // Returns ClientRect object or null if selector not found
                 var clipRect = page.evaluate(function(s){
-                    return document.querySelector(s).getBoundingClientRect();
+                    var result, selector = document.querySelector(s);
+
+                    if (selector !== null) {
+                        result = selector.getBoundingClientRect();
+                    }
+
+                    return result;
                 }, args.selector);
 
-                page.clipRect = {
-                    top:    clipRect.top,
-                    left:   clipRect.left,
-                    width:  clipRect.width,
-                    height: clipRect.height
-                };
+                if (clipRect !== null) {
+                    page.clipRect = {
+                        top:    clipRect.top,
+                        left:   clipRect.left,
+                        width:  clipRect.width,
+                        height: clipRect.height
+                    };
+                }
             }
 
             page.render(args.output);

data/lib/gastly/version.rb

@@ -1,3 +1,3 @@
 module Gastly
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gastly
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Mikhail Grachev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -98,6 +99,7 @@ files:
 - gastly.gemspec
 - gastly.png
 - lib/gastly.rb
+- lib/gastly/exceptions.rb
 - lib/gastly/image.rb
 - lib/gastly/screenshot.rb
 - lib/gastly/script.js