webshot 0.0.3 → 0.0.4

data/CONTRIBUTORS

@@ -0,0 +1 @@
+Alex Avoyants

data/README.md

@@ -19,27 +19,49 @@ Or install it yourself as:
 
 ## Usage
 
-    # Setup Capybara
-    Webshot.capybara_setup!
-    webshot = Webshot::Screenshot.new
-
-    # Capture Google's home page
-    webshot.capture "http://www.google.com/", "google.png"
-
-    # Customize thumbnail
-    webshot.capture "http://www.google.com/", "google.png", width: 100, height: 90, quality: 85
-
-    # Customize thumbnail generation (MiniMagick)
-    # see: https://github.com/minimagick/minimagick
-    webshot.capture("http://www.google.com/", "google.png") do |magick|
-      magick.combine_options do |c|
-        c.thumbnail "100x"
-        c.background "white"
-        c.extent "100x90"
-        c.gravity "north"
-        c.quality 85
-      end
-    end
+```rb
+# Setup Capybara
+ws = Webshot::Screenshot.instance
+
+# Capture Google's home page
+ws.capture "http://www.google.com/", "google.png"
+
+# Customize thumbnail
+ws.capture "http://www.google.com/", "google.png", width: 100, height: 90, quality: 85
+
+# Customize thumbnail generation (MiniMagick)
+# see: https://github.com/minimagick/minimagick
+ws.capture("http://www.google.com/", "google.png") do |magick|
+  magick.combine_options do |c|
+    c.thumbnail "100x"
+    c.background "white"
+    c.extent "100x90"
+    c.gravity "north"
+    c.quality 85
+  end
+end
+
+```
+
+You can wait some time after visit page before capturing screenshot.
+
+```rb
+# Timeout in seconds
+ws.capture 'http://www.google.com/', 'google.png', timeout: 2
+
+```
+
+You can login before capturing screenshot.
+
+```rb
+ws.start_session do
+  visit 'https://github.com/login'
+  fill_in 'Username or Email', :with => 'user@example.com'
+  fill_in 'Password', :with => 'password'
+  click_button 'Sign in'
+end.capture 'https://github.com/username/', 'github.png'
+
+```
 
 ## Contributing
 

data/lib/webshot/screenshot.rb

@@ -1,8 +1,12 @@
+require "singleton"
+
 module Webshot
   class Screenshot
     include Capybara::DSL
+    include Singleton
 
     def initialize(opts = {})
+      Webshot.capybara_setup!
       width  = opts.fetch(:width, Webshot.width)
       height = opts.fetch(:height, Webshot.height)
       user_agent = opts.fetch(:user_agent, Webshot.user_agent)
@@ -14,44 +18,67 @@ module Webshot
       }
     end
 
+    def start_session(&block)
+      Capybara.reset_sessions!
+      Capybara.current_session.instance_eval(&block) if block_given?
+      @session_started = true
+      self
+    end
+
     # Captures a screenshot of +url+ saving it to +path+.
     def capture(url, path, opts = {})
-      # Default settings
-      width   = opts.fetch(:width, 120)
-      height  = opts.fetch(:height, 90)
-      gravity = opts.fetch(:gravity, "north")
-      quality = opts.fetch(:quality, 85)
+      begin
+        # Default settings
+        width   = opts.fetch(:width, 120)
+        height  = opts.fetch(:height, 90)
+        gravity = opts.fetch(:gravity, "north")
+        quality = opts.fetch(:quality, 85)
 
-      # Reset session before visiting url
-      Capybara.reset_sessions!
+        # Reset session before visiting url
+        Capybara.reset_sessions! unless @session_started
+        @session_started = false
 
-      # Open page
-      visit url
+        # Open page
+        visit url
 
-      # Check response code
-      if page.driver.status_code == 200
-        # Save screenshot to file
-        page.driver.save_screenshot(path, :full => true)
+        # Timeout
+        sleep opts[:timeout] if opts[:timeout]
 
-        # Resize screenshot
-        thumb = MiniMagick::Image.open(path)
-        if block_given?
-          # Customize MiniMagick options
-          yield thumb
-        else
-          thumb.combine_options do |c|
-            c.thumbnail "#{width}x"
-            c.background "white"
-            c.extent "#{width}x#{height}"
-            c.gravity gravity
-            c.quality quality
+        # Check response code
+        if page.driver.status_code == 200
+          tmp = Tempfile.new(["webshot", ".png"])
+          tmp.close
+          begin
+            # Save screenshot to file
+            page.driver.save_screenshot(tmp.path, :full => true)
+
+            # Resize screenshot
+            thumb = MiniMagick::Image.open(tmp.path)
+            if block_given?
+              # Customize MiniMagick options
+              yield thumb
+            else
+              thumb.combine_options do |c|
+                c.thumbnail "#{width}x"
+                c.background "white"
+                c.extent "#{width}x#{height}"
+                c.gravity gravity
+                c.quality quality
+              end
+            end
+
+            # Save thumbnail
+            thumb.write path
+            thumb
+          ensure
+            tmp.unlink
           end
+        else
+          raise WebshotError.new("Could not fetch page: #{url.inspect}, error code: #{page.driver.status_code}")
         end
-
-        # Save thumbnail
-        thumb.write path
-      else
-        raise WebshotError.new("Could not fetch page: #{url.inspect}, error code: #{page.driver.status_code}")
+      rescue Capybara::Poltergeist::BrowserError, Capybara::Poltergeist::DeadClient, Capybara::Poltergeist::TimeoutError, Errno::EPIPE => e
+        # TODO: Handle Errno::EPIPE and Errno::ECONNRESET
+        raise WebshotError.new("Capybara error: #{e.message.inspect}")
       end
     end
   end

data/lib/webshot/version.rb

@@ -1,3 +1,3 @@
 module Webshot
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/webshot_test.rb

@@ -5,8 +5,8 @@ class WebshotTest < Test::Unit::TestCase
   DATA_DIR = File.expand_path(File.dirname(__FILE__) + "/data")
 
   def setup
-    Webshot.capybara_setup!
-    @webshot = Webshot::Screenshot.new
+    FileUtils.mkdir_p(DATA_DIR) unless File.directory?(DATA_DIR)
+    @webshot = Webshot::Screenshot.instance
   end
 
   def test_http
@@ -46,12 +46,13 @@ class WebshotTest < Test::Unit::TestCase
         File.delete output if File.exists? output
 
         # Customize MiniMagick options
-        @webshot.capture("http://#{name}/", output) do |thumb|
+        result = @webshot.capture("http://#{name}/", output) do |thumb|
           thumb.combine_options do |c|
             c.thumbnail "100x90"
           end
         end
         assert File.exists? output
+        assert result.respond_to? :to_blob
       end
     end
   end

data/webshot.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
 
   spec.add_dependency "activesupport"
-  spec.add_dependency "poltergeist", "~> 1.2.0"
-  spec.add_dependency "mini_magick", "~> 3.5.0"
+  spec.add_dependency "poltergeist", "~> 1.3.0"
+  spec.add_dependency "faye-websocket", "= 0.4.7"
+  spec.add_dependency "mini_magick", "~> 3.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webshot
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +98,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
 description: Captures a web page as a screenshot using Poltergeist, Capybara and PhantomJS
 email:
 - vitalie@penguin.ro
@@ -99,6 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
 - Gemfile
 - LICENSE.txt
 - README.md