= osxscreenshot

* http://github.com/topfunky/osxscreenshot

== DESCRIPTION:

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:

* Uses Python's Cocoa support (standard in Mac OS X). 
* Uses ImageMagick's command-line tools to resize the image (mogrify). See http://github.com/masterkain/ImageMagick-sl. I hope to replace this with MacRuby or RubyCocoa instead.

== INSTALL:

* gem install osxscreenshot

== DEVELOPERS:

Call the +capture+ method which returns the path to a tempfile containing the image:

    file_path = OSX::Screenshot.capture("http://peepcode.com")
    # => "/tmp/20293-202020293-2020-full.png" at 320x480

Or, pass some (optional) options.

    file_path =
      OSX::Screenshot.capture(my_url, {
                         :tmpdir     => "#{Sinatra::Application.root}/tmp",
                         :webkit2png => "#{Sinatra::Application.root}/bin/webkit2png.py",
                         :mogrify    => "/opt/local/bin/mogrify",
                         :width      => 220,
                         :height     => 270
                       })
    system "mv #{file_path} #{permanent_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.