osxscreenshot 0.0.1

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 / 2010-02-16
+
+* First release
+
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/osxscreenshot.rb
+test/test_osxscreenshot.rb
+vendor/webkit2png.py

data/README.txt

@@ -0,0 +1,60 @@
+= osxscreenshot
+
+* http://gemcutter.org/gems/osxscreenshot
+
+== DESCRIPTION:
+
+Wrapper around webkit2png.py to easily and programmatically capture
+screenshots, crop, and resize them on Mac OS X.
+
+== 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
+
+== REQUIREMENTS:
+
+* Uses Python's Cocoa support (standard in Mac OS X). 
+
+== INSTALL:
+
+* gem install osxscreenshot
+
+== DEVELOPERS:
+
+Call the +capture+ method with the desired URL and some (optional) options.
+
+    output_screenshot_path =
+      OSX::Screenshot.capture(my_url, {
+                         :tmp        => "#{Sinatra::Application.root}/tmp",
+                         :webkit2png => "#{Sinatra::Application.root}/bin/webkit2png.py",
+                         :mogrify    => "/opt/local/bin/mogrify",
+                         :width      => 220,
+                         :height     => 270
+                       })
+    system "mv #{output_screenshot_path} #{local_path}"
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Topfunky Corporation
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'osxscreenshot' do
+  developer('Geoffrey Grosenbach', 'boss@topfunky.com')
+
+  # self.rubyforge_name = 'osxscreenshotx' # if different than 'osxscreenshot'
+end
+
+# vim: syntax=ruby

data/lib/osxscreenshot.rb

@@ -0,0 +1,86 @@
+module OSX
+  module Screenshot
+    VERSION = '0.0.1'
+
+    ##
+    # Takes a screenshot of a website, optionally resizes it, and writes
+    # it to a temporary directory. Returns the file path to the
+    # temporary file.
+    #
+    # It's assumed that you will move the file to a permanent
+    # destination or store it in a database.
+    #
+    # Options include:
+    #
+    # tmpdir::     Path to tmp directory where files will be stored
+    # webkit2png:: Path to webkit2png.py command
+    # mogrify::    Path to mogrify command
+    #
+    # Usage:
+    #
+    #   output_screenshot_path =
+    #     OSX::Screenshot.capture(article_url, {
+    #                        :tmpdir     => "#{Sinatra::Application.root}/tmp",
+    #                        :webkit2png => "#{Sinatra::Application.root}/bin/webkit2png.py",
+    #                        :mogrify    => "/opt/local/bin/mogrify",
+    #                        :width      => 220,
+    #                        :height     => 270
+    #                      })
+    #   system "mv #{output_screenshot_path} #{local_path}"
+
+    def self.capture(url, options={})
+      vendored_webkit2png = File.expand_path(File.join(File.dirname(__FILE__),
+                                                       "..",
+                                                       "vendor",
+                                                       "webkit2png.py"))
+      options = {
+        :tmpdir     => "/tmp",
+        :webkit2png => vendored_webkit2png,
+        :mogrify    => "mogrify",
+        :width      => 320,
+        :height     => 480
+      }.merge(options)
+
+      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]
+
+      system(*[webkit2png_command,
+               "--full",
+               "--filename",    random_id,
+               "--dir",         options[:tmpdir],
+               url
+              ])
+
+      # 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
+    end
+
+  end
+end
+
+

data/test/test_osxscreenshot.rb

@@ -0,0 +1,29 @@
+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
+    assert File.exist?(@tmpfile)
+  end
+
+  def test_loads_tall_url
+    @tmpfile = OSX::Screenshot.capture("http://blog.peepcode.com/archives")
+
+    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 teardown
+    FileUtils.rm @tmpfile
+  end
+
+end

data/vendor/webkit2png.py

@@ -0,0 +1,285 @@
+#!/usr/bin/env python
+
+# webkit2png - makes screenshots of webpages
+# http://www.paulhammond.org/webkit2png
+
+__version__ = "0.5"
+
+# Copyright (c) 2009 Paul Hammond
+#
+# 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.
+#
+                
+import sys
+import optparse
+
+try:
+  import Foundation
+  import WebKit
+  import AppKit
+  import objc
+except ImportError:
+  print "Cannot find pyobjc library files.  Are you sure it is installed?"
+  sys.exit() 
+
+
+
+class AppDelegate (Foundation.NSObject):
+    # what happens when the app starts up
+    def applicationDidFinishLaunching_(self, aNotification):
+        webview = aNotification.object().windows()[0].contentView()
+        webview.frameLoadDelegate().getURL(webview)
+        self.performSelector_withObject_afterDelay_( "timeout:", None, 60 )
+
+    def timeout_(self, obj):
+        NSLog("timed out!")
+        NSApplication.sharedApplication().terminate_(None)
+
+class WebkitLoad (Foundation.NSObject, WebKit.protocols.WebFrameLoadDelegate):
+
+    # what happens if something goes wrong while loading
+    def webView_didFailLoadWithError_forFrame_(self,webview,error,frame):
+        print " ... something went wrong: "+error.localizedDescription()
+        self.getURL(webview)
+
+    def webView_didFailProvisionalLoadWithError_forFrame_(self,webview,error,frame):
+        print " ... something went wrong: "+error.localizedDescription()
+        self.getURL(webview)
+
+    def makeFilename(self,URL,options):
+       # make the filename
+       if options.filename:
+         filename = options.filename
+       elif options.md5:
+         try:
+                import md5
+         except ImportError:
+                print "--md5 requires python md5 library"
+                AppKit.NSApplication.sharedApplication().terminate_(None)
+         filename = md5.new(URL).hexdigest()
+       else:
+         import re
+         filename = re.sub('\W','',URL);
+         filename = re.sub('^http','',filename);
+       if options.datestamp:
+         import time
+         now = time.strftime("%Y%m%d")
+         filename = now + "-" + filename
+       import os
+       dir = os.path.abspath(os.path.expanduser(options.dir))
+       return os.path.join(dir,filename)
+
+    def saveImages(self,bitmapdata,filename,options):
+        # save the fullsize png
+        if options.fullsize:
+            bitmapdata.representationUsingType_properties_(AppKit.NSPNGFileType,None).writeToFile_atomically_(filename + "-full.png",objc.YES)
+
+        if options.thumb or options.clipped:
+            # work out how big the thumbnail is
+            width = bitmapdata.pixelsWide()
+            height = bitmapdata.pixelsHigh()
+            thumbWidth = (width * options.scale)
+            thumbHeight = (height * options.scale)
+
+            # make the thumbnails in a scratch image
+            scratch = AppKit.NSImage.alloc().initWithSize_(
+                    Foundation.NSMakeSize(thumbWidth,thumbHeight))
+            scratch.lockFocus()
+            AppKit.NSGraphicsContext.currentContext().setImageInterpolation_(
+                    AppKit.NSImageInterpolationHigh)
+            thumbRect = Foundation.NSMakeRect(0.0, 0.0, thumbWidth, thumbHeight)
+            clipRect = Foundation.NSMakeRect(0.0, 
+                    thumbHeight-options.clipheight, 
+                    options.clipwidth, options.clipheight)
+            bitmapdata.drawInRect_(thumbRect)
+            thumbOutput = AppKit.NSBitmapImageRep.alloc().initWithFocusedViewRect_(thumbRect)
+            clipOutput = AppKit.NSBitmapImageRep.alloc().initWithFocusedViewRect_(clipRect)
+            scratch.unlockFocus()
+           
+            # save the thumbnails as pngs 
+            if options.thumb:
+                thumbOutput.representationUsingType_properties_(
+                        AppKit.NSPNGFileType,None
+                    ).writeToFile_atomically_(filename + "-thumb.png",objc.YES)
+            if options.clipped:
+                clipOutput.representationUsingType_properties_(
+                        AppKit.NSPNGFileType,None
+                    ).writeToFile_atomically_(filename + "-clipped.png",objc.YES)
+
+    def getURL(self,webview):
+        if self.urls:
+            if self.urls[0] == '-':
+                url = sys.stdin.readline().rstrip()
+                if not url: AppKit.NSApplication.sharedApplication().terminate_(None)
+            else: 
+                url = self.urls.pop(0)
+        else:
+            AppKit.NSApplication.sharedApplication().terminate_(None)
+        print "Fetching", url, "..."
+        self.resetWebview(webview)
+        webview.mainFrame().loadRequest_(Foundation.NSURLRequest.requestWithURL_(Foundation.NSURL.URLWithString_(url)))
+        if not webview.mainFrame().provisionalDataSource():
+            print " ... not a proper url?"
+            self.getURL(webview)
+     
+    def resetWebview(self,webview):
+        rect = Foundation.NSMakeRect(0,0,self.options.initWidth,self.options.initHeight)
+        webview.window().setContentSize_((self.options.initWidth,self.options.initHeight))
+        webview.setFrame_(rect)
+    
+    def resizeWebview(self,view):
+        view.window().display()
+        view.window().setContentSize_(view.bounds().size)
+        view.setFrame_(view.bounds())
+
+    def captureView(self,view):
+        view.lockFocus()
+        bitmapdata = AppKit.NSBitmapImageRep.alloc()
+        bitmapdata.initWithFocusedViewRect_(view.bounds())
+        view.unlockFocus()
+        return bitmapdata
+ 
+    # what happens when the page has finished loading
+    def webView_didFinishLoadForFrame_(self,webview,frame):
+        # don't care about subframes
+        if (frame == webview.mainFrame()):
+            Foundation.NSTimer.scheduledTimerWithTimeInterval_target_selector_userInfo_repeats_( self.options.delay, self, self.doGrab, webview, False)
+
+    def doGrab(self,timer):
+            webview = timer.userInfo()
+            view = webview.mainFrame().frameView().documentView()
+            
+            self.resizeWebview(view)
+
+            URL = webview.mainFrame().dataSource().initialRequest().URL().absoluteString()
+            filename = self.makeFilename(URL, self.options) 
+
+            bitmapdata = self.captureView(view)  
+            self.saveImages(bitmapdata,filename,self.options)
+
+            print " ... done"
+            self.getURL(webview)
+
+
+def main():
+
+    # parse the command line
+    usage = """%prog [options] [http://example.net/ ...]
+
+examples:
+%prog http://google.com/            # screengrab google
+%prog -W 1000 -H 1000 http://google.com/ # bigger screengrab of google
+%prog -T http://google.com/         # just the thumbnail screengrab
+%prog -TF http://google.com/        # just thumbnail and fullsize grab
+%prog -o foo http://google.com/     # save images as "foo-thumb.png" etc
+%prog -                             # screengrab urls from stdin
+%prog -h | less                     # full documentation"""
+
+    cmdparser = optparse.OptionParser(usage,version=("webkit2png "+__version__))
+    # TODO: add quiet/verbose options
+    cmdparser.add_option("-W", "--width",type="float",default=800.0,
+       help="initial (and minimum) width of browser (default: 800)")
+    cmdparser.add_option("-H", "--height",type="float",default=600.0,
+       help="initial (and minimum) height of browser (default: 600)")
+    cmdparser.add_option("--clipwidth",type="float",default=200.0,
+       help="width of clipped thumbnail (default: 200)",
+       metavar="WIDTH")
+    cmdparser.add_option("--clipheight",type="float",default=150.0,
+       help="height of clipped thumbnail (default: 150)",
+       metavar="HEIGHT")
+    cmdparser.add_option("-s", "--scale",type="float",default=0.25,
+       help="scale factor for thumbnails (default: 0.25)")
+    cmdparser.add_option("-m", "--md5", action="store_true",
+       help="use md5 hash for filename (like del.icio.us)")
+    cmdparser.add_option("-o", "--filename", type="string",default="",
+       metavar="NAME", help="save images as NAME-full.png,NAME-thumb.png etc")
+    cmdparser.add_option("-F", "--fullsize", action="store_true",
+       help="only create fullsize screenshot")
+    cmdparser.add_option("-T", "--thumb", action="store_true",
+       help="only create thumbnail sreenshot")
+    cmdparser.add_option("-C", "--clipped", action="store_true",
+       help="only create clipped thumbnail screenshot")
+    cmdparser.add_option("-d", "--datestamp", action="store_true",
+       help="include date in filename")
+    cmdparser.add_option("-D", "--dir",type="string",default="./",
+       help="directory to place images into")
+    cmdparser.add_option("--delay",type="float",default=0,
+       help="delay between page load finishing and screenshot")
+    cmdparser.add_option("--noimages", action="store_true",
+       help="don't load images")
+    cmdparser.add_option("--debug", action="store_true",
+       help=optparse.SUPPRESS_HELP)
+    (options, args) = cmdparser.parse_args()
+    if len(args) == 0:
+        cmdparser.print_usage()
+        return
+    if options.filename:
+        if len(args) != 1 or args[0] == "-":
+          print "--filename option requires exactly one url"
+          return
+    if options.scale == 0:
+      cmdparser.error("scale cannot be zero")
+    # make sure we're outputing something
+    if not (options.fullsize or options.thumb or options.clipped):
+      options.fullsize = True
+      options.thumb = True
+      options.clipped = True
+    # work out the initial size of the browser window
+    #  (this might need to be larger so clipped image is right size)
+    options.initWidth = (options.clipwidth / options.scale)
+    options.initHeight = (options.clipheight / options.scale)
+    if options.width>options.initWidth:
+       options.initWidth = options.width
+    if options.height>options.initHeight:
+       options.initHeight = options.height
+      
+    app = AppKit.NSApplication.sharedApplication()
+    
+    # create an app delegate
+    delegate = AppDelegate.alloc().init()
+    AppKit.NSApp().setDelegate_(delegate)
+
+    # create a window
+    rect = Foundation.NSMakeRect(0,0,100,100)
+    win = AppKit.NSWindow.alloc()
+    win.initWithContentRect_styleMask_backing_defer_ (rect, 
+            AppKit.NSBorderlessWindowMask, 2, 0)
+    if options.debug:
+      win.orderFrontRegardless()
+    # create a webview object
+    webview = WebKit.WebView.alloc()
+    webview.initWithFrame_(rect)
+    # turn off scrolling so the content is actually x wide and not x-15
+    webview.mainFrame().frameView().setAllowsScrolling_(objc.NO)
+
+    webview.setPreferencesIdentifier_('webkit2png')
+    webview.preferences().setLoadsImagesAutomatically_(not options.noimages)
+
+    # add the webview to the window
+    win.setContentView_(webview)
+    
+    # create a LoadDelegate
+    loaddelegate = WebkitLoad.alloc().init()
+    loaddelegate.options = options
+    loaddelegate.urls = args
+    webview.setFrameLoadDelegate_(loaddelegate)
+    
+    app.run()    
+
+if __name__ == '__main__' : main()

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: osxscreenshot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Geoffrey Grosenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: |-
+  Wrapper around webkit2png.py to easily and programmatically capture
+  screenshots, crop, and resize them on Mac OS X.
+email: 
+- boss@topfunky.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/osxscreenshot.rb
+- test/test_osxscreenshot.rb
+- vendor/webkit2png.py
+has_rdoc: true
+homepage: http://gemcutter.org/gems/osxscreenshot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: osxscreenshot
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Wrapper around webkit2png.py to easily and programmatically capture screenshots, crop, and resize them on Mac OS X.
+test_files: 
+- test/test_osxscreenshot.rb