website_screenshot 1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Mircea, OkapiStudio
+
+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.

data/README.rdoc

@@ -0,0 +1,55 @@
+= Website Screenshot
+
+Creates a new webkit window using the QT framework of a specified url and saves a screenshot when the page has finished loading.
+
+
+== Usage
+
+From ruby:
+
+  ws = WebsiteScreenshot.new :url => "http://google.com"
+  ws.get
+
+Check the docs for additional options.
+
+Command line:
+
+  $ website-screenshot -u http://google.com
+
+You'll probably want to use this library on a webserver. You can easily do so without installing the full X stack by launching it using xvfb:
+
+  $ xvfb-run --server-args="-screen 0, 1400x900x24" --size=1400x900 --url=http://viseztrance.com --file=vise.png
+
+
+== Flash and other plugins
+
+If flash or any other plugin is installed it will be used while rendering the page. Locations can be set with environment variables such as $QTWEBKIT_PLUGIN_PATH.
+
+
+== Limitations
+
+Webkit segfaults on rare occasions killing the entire ruby process with it - that's why I encourage calling the script from the command line.
+
+The basic qt webkit browser doesn't handle multiple redirects very well, for this reason the _url_ is initially discovered using _curl_. Feel free to fork this and get around the limitation.
+
+
+== Source code
+
+The source code is hosted on Github: http://github.com/viseztrance/website_screenshot
+
+To get WebsiteScreenshot from source:
+
+  git clone git@github.com:viseztrance/website_screenshot.git
+
+
+== Aknowledgements and implementations
+
+This code is the heart of a pet project I wrote in my spare time named {mywebsit.es}[http://mywebsit.es].
+
+I also wrote a {web service}[http://github.com/viseztrance/website_screenshot_service] which I hope is a good starting point to anyone who implements this code.
+
+
+== License
+
+This package is licensed under the MIT license and/or the Creative
+Commons Attribution-ShareAlike.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/rdoctask'
+
+
+spec = Gem::Specification.load(File.expand_path("website_screenshot.gemspec", File.dirname(__FILE__)))
+
+# Create the documentation.
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include "README.rdoc", "lib/**/*.rb"
+  rdoc.options = spec.rdoc_options
+end
+
+desc "Push new release to rubyforge and git tag"
+task :push do
+  sh "git push"
+  puts "Tagging version #{spec.version} .."
+  sh "git tag v#{spec.version}"
+  sh "git push --tag"
+  puts "Building and pushing gem .."
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem push #{spec.name}-#{spec.version}.gem"
+end
+
+desc "Install #{spec.name} locally"
+task :install do
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem install #{spec.name}-#{spec.version}.gem"
+end

data/bin/website-screenshot

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "website_screenshot"
+
+options = {}
+
+ARGV.options do |opt|
+  script_name = File.basename($0)
+
+  opt.set_summary_indent("  ")
+  opt.banner = "Usage: #{script_name} [options]"
+  opt.define_head "Takes screenshots of webpages."
+
+  opt.separator ""
+
+  opt.on("-u", "--url=val", String,
+         "Website url, eg. http://google.com") { |options[:url]| }
+  opt.on("-s", "--size=val", String,
+         "Window size, eg. 1024x768") { |options[:size]| }
+  opt.on("-f", "--file=val", String,
+         "Image file name for the saved output. Can also be a path.") { |options[:file_name]| }
+  opt.on("-v", "--verbose=val", String,
+         "Display progress during loading.") { |options[:verbose]| }
+  opt.on("-t", "--timeout=val", Integer,
+         "Timeout before killing the page.") { |options[:render_timeout]| }
+
+  opt.separator ""
+
+  opt.on_tail("-h", "--help", "Show this help message.") { puts opt; exit }
+
+  opt.parse!
+
+  if options[:url].nil?
+    puts "The url option is required (--url). -h for additional information."
+  else
+    screenshot = WebsiteScreenshot.new options
+    puts screenshot.get
+  end
+
+end

data/lib/website_screenshot.rb

@@ -0,0 +1,150 @@
+#
+# = website_screenshot.rb - Takes screenshots of webpages
+#
+# Author:: Daniel Mircea daniel@viseztrance.com
+# Copyright:: Copyright (c) 2011 Daniel Mircea
+# License:: MIT and/or Creative Commons Attribution-ShareAlike
+
+require "Qt4"
+require "qtwebkit"
+
+class WebsiteScreenshot
+
+  VERSION = Gem::Specification.load(File.expand_path("../website_screenshot.gemspec", File.dirname(__FILE__))).version.to_s
+
+  @@state      = "waiting"
+  @@progress   = 0
+  @@started_at = nil
+
+  # Timeout before killing the page.
+  attr_accessor :render_timeout
+
+  attr_accessor :check_loading_status_interval #:nodoc:
+
+  # Filename to save the file to.
+  attr_accessor :file_name
+
+  # Window size.
+  attr_accessor :size
+
+  # Page url.
+  attr_accessor :url
+
+  attr_accessor :verbose #:nodoc:
+
+  # Instantiates a new object.
+  # ==== Options:
+  # [*url*] Website path. URL redirects are automatically resolved using +curl+.
+  # [*file_name*] Name of the saved image. Defaults to output.png.
+  # [*render_timeout*] Timeout before killing the page. Defaults at two minutes.
+  # [*check_loading_status_interval*] Interval between page status checks.
+  # [*size*] Window size the page is being rendered into. Defaults at 1360x768.
+  # [*verbose*] Outputs page load progress.
+  def initialize(args)
+    self.render_timeout                = args[:render_timeout] || 120
+    self.check_loading_status_interval = args[:check_loading_status_interval] || 0.1
+    self.file_name                     = args[:file_name] || "output.png"
+    self.size                          = args[:size] || "1360x768"
+    self.url                           = args[:url]
+    self.verbose                       = args[:verbose] # default FALSE
+  end
+
+  # Renders the website and saves a screenshot.
+  # ==== Returns:
+  # * If the webpage began rendering, the load percentage. A screenshot is saved if the page has been +50%+ loaded or more.
+  # * +false+ if for some reason the +url+ could not be opened, or the browser initialized.
+  def get
+
+    app = Qt::Application.new(ARGV)
+    webview = Qt::WebView.new()
+
+    webview.connect(SIGNAL("loadStarted()")) do
+      @@started_at = Time.now.to_i
+    end
+
+    webview.connect(SIGNAL("loadFinished(bool)")) do |result|
+      if result
+        @@state = "finished-success"
+      else
+        @@state = "finished-fail"
+        @@progress = false
+      end
+      suspend_thread # Give it enough time to switch to the sentinel thread and avoid an empty exec loop.
+    end
+
+    webview.connect(SIGNAL("loadProgress(int)")) do |progress|
+      puts "#{progress}%" if verbose
+      @@progress = progress
+      suspend_thread if has_reached_time_out?
+    end
+
+    # Enable flash, javascript and some other sensible browsing options.
+    webview::settings()::setAttribute(Qt::WebSettings::PluginsEnabled, true)
+    webview::settings()::setAttribute(Qt::WebSettings::JavascriptCanOpenWindows, false)
+    webview::settings()::setAttribute(Qt::WebSettings::PrivateBrowsingEnabled, true)
+    webview::settings()::setAttribute(Qt::WebSettings::JavascriptEnabled, true)
+
+    # Hide the scrollbars.
+    webview.page.mainFrame.setScrollBarPolicy(Qt::Horizontal, Qt::ScrollBarAlwaysOff)
+    webview.page.mainFrame.setScrollBarPolicy(Qt::Vertical, Qt::ScrollBarAlwaysOff)
+
+    webview.load(Qt::Url.new(url))
+    webview.resize(size)
+    webview.show
+    render_page_thread = Thread.new do
+      app.exec
+    end
+
+    check_status_thread = Thread.new do
+      while true do
+        sleep check_loading_status_interval
+        if @@state =~ /^finished/ || has_reached_time_out?
+          # Save a screenshot if page finished loaded or it has timed out with 50%+ completion.
+          save(webview) if @@state == "finished-success" || @@progress >= 50
+          render_page_thread.kill
+          break
+        end
+      end
+    end
+
+    check_status_thread.join
+    render_page_thread.join
+
+    return @@progress
+
+  end
+
+  # Sets the window size.
+  #
+  # The geometry must have the following format: _widthxheight_.
+  # ==== Returns:
+  # A Qt::Size object.
+  def size=(geometry)
+    geometry_information = geometry.split("x")
+    @size = Qt::Size.new(geometry_information.first.to_i, geometry_information.last.to_i)
+  end
+
+  # Sets the website url.
+  #
+  # Calls the operating systems +curl+ command to follow redirects.
+  def url=(path)
+    @url = %x[curl "#{path}" -A "Mozilla/5.0 (QtWebkit; WebsiteScreenshot)" -L -o /dev/null -w %{url_effective}]
+  end
+
+  private
+
+  def has_reached_time_out?
+    Time.now.to_i >= (@@started_at + render_timeout)
+  end
+
+  def suspend_thread
+    sleep(30)
+  end
+
+  def save(webview)
+    sleep(5) # Wait a few seconds to allow some/any of the animations to take place
+    pixmap = Qt::Pixmap.grabWindow(webview.window.winId)
+    pixmap.save(file_name, File.extname(file_name).tr(".",""))
+  end
+
+end

data/website_screenshot.gemspec

@@ -0,0 +1,20 @@
+spec = Gem::Specification.new do |spec|
+  spec.name = "website_screenshot"
+  spec.version = "1.0"
+  spec.summary = "Takes screenshots of webpages"
+  spec.description = <<-EOF
+Creates a new webkit window using the QT framework of a specified url and saves a screenshot when the page has finished loading.
+EOF
+
+  spec.authors << "Daniel Mircea"
+  spec.email = "daniel@viseztrance.com"
+  spec.homepage = "http://github.com/viseztrance/website_screenshot"
+
+  spec.files = Dir["{bin,lib,docs}/**/*"] + ["README.rdoc", "LICENSE", "Rakefile", "website_screenshot.gemspec"]
+  spec.executables = "website-screenshot"
+
+  spec.has_rdoc = true
+  spec.rdoc_options << "--main" << "README.rdoc" << "--title" <<  "Website Screenshot" << "--line-numbers"
+                       "--webcvs" << "http://github.com/viseztrance/website_screenshot"
+  spec.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: website_screenshot
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Daniel Mircea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |
+  Creates a new webkit window using the QT framework of a specified url and saves a screenshot when the page has finished loading.
+
+email: daniel@viseztrance.com
+executables: 
+- website-screenshot
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- bin/website-screenshot
+- lib/website_screenshot.rb
+- README.rdoc
+- LICENSE
+- Rakefile
+- website_screenshot.gemspec
+has_rdoc: true
+homepage: http://github.com/viseztrance/website_screenshot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- Website Screenshot
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Takes screenshots of webpages
+test_files: []
+