osxscreenshot 0.0.2 → 0.0.3

data/README.txt

@@ -4,13 +4,15 @@
 
 == DESCRIPTION:
 
-Wrapper around webkit2png.py to easily and programmatically capture
-screenshots of websites, then crop and resize them. Mac OS X only.
+A Ruby wrapper around webkit2png.py to easily and programmatically
+capture screenshots of websites, then crop and resize them. Mac OS X
+only.
 
 == FEATURES/PROBLEMS:
 
 * Uses the Python built-in to Mac OS X.
 * You may be able to use snapurl instead of webkit2png.py: http://gemcutter.org/gems/snapurl
+* See examples in use at http://blog.peepcode.com/archives and http://news.peepcode.com/
 
 == REQUIREMENTS:
 
@@ -32,7 +34,7 @@ Or, pass some (optional) options.
 
     file_path =
       OSX::Screenshot.capture(my_url, {
-                         :tmp        => "#{Sinatra::Application.root}/tmp",
+                         :tmpdir     => "#{Sinatra::Application.root}/tmp",
                          :webkit2png => "#{Sinatra::Application.root}/bin/webkit2png.py",
                          :mogrify    => "/opt/local/bin/mogrify",
                          :width      => 220,

data/Rakefile

@@ -5,7 +5,9 @@ require 'hoe'
 
 Hoe.spec 'osxscreenshot' do
   developer('Geoffrey Grosenbach', 'boss@topfunky.com')
-
+  
+  extra_deps << ['open4']
+  
   # self.rubyforge_name = 'osxscreenshotx' # if different than 'osxscreenshot'
 end
 

data/lib/osxscreenshot.rb

@@ -1,6 +1,8 @@
+require 'open4'
+
 module OSX
-  module Screenshot
-    VERSION = '0.0.2'
+  class Screenshot
+    VERSION = '0.0.3'
 
     ##
     # Takes a screenshot of a website, optionally resizes it, and writes
@@ -29,55 +31,88 @@ module OSX
     #   system "mv #{output_screenshot_path} #{local_path}"
 
     def self.capture(url, options={})
+      obj = new(url, options)
+      obj.capture
+    end
+
+    def initialize(url, options)
       vendored_webkit2png = File.expand_path(File.join(File.dirname(__FILE__),
                                                        "..",
                                                        "vendor",
                                                        "webkit2png.py"))
-      options = {
+      @url = url
+      @options = {
         :tmpdir     => "/tmp",
         :webkit2png => vendored_webkit2png,
         :mogrify    => "mogrify",
         :width      => 320,
-        :height     => 480
+        :height     => 480,
+        :timeout    => 30
       }.merge(options)
+    end
 
-      random_id        = [url.length, Time.now.to_i.to_s, rand(10000)].join('-')
-      tmp_abs_filename = File.join(options[:tmpdir], "#{random_id}-full.png")
+    def capture
+      random_id        = [@url.length, Time.now.to_i.to_s, rand(10000)].join('-')
+      tmp_abs_filename = File.join(@options[:tmpdir], "#{random_id}-full.png")
       tmp_dir          = File.dirname(tmp_abs_filename)
       FileUtils.mkdir_p(tmp_dir)
 
-      webkit2png_command = options[:webkit2png]
+      webkit2png_command = [@options[:webkit2png],
+                            "--full",
+                            "--filename",    random_id,
+                            "--dir",         @options[:tmpdir],
+                            @url
+                           ].join(' ')
 
-      system(*[webkit2png_command,
-               "--full",
-               "--filename",    random_id,
-               "--dir",         options[:tmpdir],
-               url
-              ])
+      run_command(webkit2png_command) do
+        return resize(tmp_abs_filename, @options[:width], @options[:height])
+      end
+    end
 
+    def resize(tmp_abs_filename, width, height)
       # Example: mogrify -resize 320x peepcodecom-full.png -crop 320x480 peepcodecom-full.png
-      mogrify_command = options[:mogrify]
-      target_width    = options[:width]
-      target_height   = options[:height]
-      system(*[mogrify_command,
-               "-resize", "#{target_width}x",
-               tmp_abs_filename,
-               "-crop",   "#{target_width}x#{target_height}",
-               tmp_abs_filename
-              ])
 
-      output_filename = if File.exist?(tmp_abs_filename)
-                          # Add full width and height to image
-                          system(*[mogrify_command,
-                                   "-extent", "#{target_width}x#{target_height}",
-                                   tmp_abs_filename])
-                          tmp_abs_filename
-                        elsif File.exist?(tmp_abs_filename.gsub(/\.png/, '-0.png'))
-                          # Remove extra file generated by cropping.
-                          FileUtils.rm(tmp_abs_filename.gsub(/\.png/, '-1.png'))
-                          tmp_abs_filename.gsub(/\.png/, '-0.png')
-                        end
-      return output_filename
+      mogrify_command = [@options[:mogrify],
+                         "-resize", "#{width}x",
+                         tmp_abs_filename,
+                         "-crop",   "#{width}x#{height}",
+                         tmp_abs_filename
+                        ].join(' ')
+      run_command(mogrify_command) do
+        output_filename = if File.exist?(tmp_abs_filename)
+                            # Add full width and height to image
+                            extent_command = [@options[:mogrify],
+                                              "-extent", "#{width}x#{height}",
+                                              tmp_abs_filename].join(' ')
+                            run_command(extent_command) { return tmp_abs_filename }
+                          elsif File.exist?(tmp_abs_filename.gsub(/\.png/, '-0.png'))
+                            # Remove extra file generated by cropping.
+                            FileUtils.rm(tmp_abs_filename.gsub(/\.png/, '-1.png'))
+                            tmp_abs_filename.gsub(/\.png/, '-0.png')
+                          end
+        return output_filename
+      end
+    end
+
+    def run_command(cmd, &block)
+      pid = nil
+      status = nil
+
+      Timeout.timeout(@options[:timeout]) {
+        pid, i, o, e = open4(cmd)
+        ignored, status = Process::waitpid2 pid
+      }
+      
+      # Success
+      if (status.exitstatus == 0)
+        return yield
+      end
+      
+      # Error
+      system "kill -9 #{pid}"
+      raise "Command failed: #{cmd}"
+    rescue Timeout::Error => e
+      return nil
     end
 
   end

data/test/test_osxscreenshot.rb

@@ -2,7 +2,7 @@ require "test/unit"
 require "osxscreenshot"
 
 class TestOsxscreenshot < Test::Unit::TestCase
-  
+
   def test_loads_url
     @tmpfile = OSX::Screenshot.capture("http://example.com")
     assert_not_nil @tmpfile
@@ -15,15 +15,25 @@ class TestOsxscreenshot < Test::Unit::TestCase
     extra_file_name = @tmpfile.gsub(/-0\.png$/, "-1.png")
     assert !File.exist?(extra_file_name)
   end
-  
+
   def test_uses_custom_tmpdir
     @tmpfile = OSX::Screenshot.capture("http://example.com", :tmpdir => "./tmp")
     assert_match(/^\.\/tmp/, @tmpfile)
     assert File.exist?(@tmpfile)
   end
-  
+
+  def test_handles_timeout
+    @tmpfile = OSX::Screenshot.capture("http://example.com", {
+                                         :timeout => 1,
+                                         :webkit2png => "sleep 5 &&"
+                                       })
+    assert_nil @tmpfile
+  end
+
   def teardown
-    FileUtils.rm @tmpfile
+    if @tmpfile
+      FileUtils.rm @tmpfile
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: osxscreenshot
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Geoffrey Grosenbach
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 -08:00
+date: 2010-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rubyforge
   type: :development
@@ -43,8 +53,9 @@ dependencies:
         version: 2.5.0
     version: 
 description: |-
-  Wrapper around webkit2png.py to easily and programmatically capture
-  screenshots of websites, then crop and resize them. Mac OS X only.
+  A Ruby wrapper around webkit2png.py to easily and programmatically
+  capture screenshots of websites, then crop and resize them. Mac OS X
+  only.
 email: 
 - boss@topfunky.com
 executables: []
@@ -92,6 +103,6 @@ rubyforge_project: osxscreenshot
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Wrapper around webkit2png.py to easily and programmatically capture screenshots of websites, then crop and resize them
+summary: A Ruby wrapper around webkit2png.py to easily and programmatically capture screenshots of websites, then crop and resize them
 test_files: 
 - test/test_osxscreenshot.rb