websnapshot 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-04-12
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/websnapshot
+dependencies.memo.text
+lib/websnapshot.rb
+lib/websnapshot/cli.rb
+script/console
+script/destroy
+script/generate
+spec/spec.opts
+spec/spec_helper.rb
+spec/websnapshot_spec.rb
+tasks/rspec.rake
+test/test_helper.rb
+test/test_websnapshot.rb
+test/test_websnapshot_cli.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on websnapshot, see http://websnapshot.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= websnapshot
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 FIXME full name
+
+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,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/websnapshot'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'websnapshot' do
+  self.developer 'Takashi Oguma', 'bear.mini@gmail.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['gtk2','>= 0.90.8']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/websnapshot

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2011-4-16.
+#  Copyright (c) 2011. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/websnapshot")
+require "websnapshot/cli"
+
+Websnapshot::CLI.execute(STDOUT, ARGV)

data/dependencies.memo.text

@@ -0,0 +1,10 @@
+
+= Install Prerequisite Packages
+
+Ubuntu:
+  $ sudo apt-get install ruby-gnome2-dev webkit-1.0 libgtk2.0-dev
+    # atk1.0 libcairo2-dev
+
+Mac OS X:
+  $ sudo port install rb-gnome webkit-gtk
+

data/lib/websnapshot/cli.rb

@@ -0,0 +1,55 @@
+require 'optparse'
+require 'lib/websnapshot.rb'
+
+module Websnapshot
+  unless defined? Websnapshot::CLI
+
+    class CLI
+      def self.execute(stdout, arguments=[])
+
+        options = {
+          :max_width     => 960,
+          :max_height    => 640,
+        }
+        mandatory_options = %w(  )
+
+        parser = OptionParser.new do |opts|
+          opts.banner = <<-BANNER.gsub(/^          /,'')
+            This is an application to capture snapshot images of web pages.
+          
+            Usage: #{File.basename($0)} [options] [URL]...
+          
+            Options are:
+          BANNER
+          opts.separator ""
+          opts.on("-x", "--max-width WIDTH", Integer,
+                  "Maximum width (in pixels) of an artifact image.",
+                  "If the page you want to take an snapshot image has ",
+                  "width less than the specified value, the original size",
+                  "will be preserved.",
+                  "Default: 960") { |arg| options[:max_width] = arg }
+          opts.on("-y", "--max-height HEIGHT", Integer,
+                  "Maximum height (in pixels) of an artifact image.",
+                  "If the page you want to take an snapshot image has ",
+                  "height less than the specified value, the original size",
+                  "will be preserved.",
+                  "Default: 640") { |arg| options[:max_height] = arg }
+          opts.on("-h", "--help",
+                  "Show this help message.") { stdout.puts opts; exit }
+          opts.on("-v", "--version",
+                  "Show the version number of this application.") { stdout.puts Websnapshot::VERSION; exit }
+          opts.parse!(arguments)
+
+          if (mandatory_options && mandatory_options.find { |option| options[option.to_sym].nil? }) || arguments.length == 0
+            stdout.puts opts; exit
+          end
+        end
+
+        # do stuff
+        arguments.each do |url|
+          Websnapshot::take(url, options)
+        end
+      end
+    end
+  end
+end

data/lib/websnapshot.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/ruby
+# vim: set ts=2 sts=2 sw=2 tw=0 ff=unix expandtab :
+
+unless defined? Websnapshot
+
+  require 'gtk2'
+  require 'webkit'  # https://github.com/danlucraft/rbwebkitgtk
+
+
+  module Websnapshot
+    VERSION = '0.0.1'
+
+    def self.take(url, options = {})
+      saved_filename = nil
+
+      w = Gtk::Window.new
+      w.signal_connect('destroy') do |*args|
+        Gtk.main_quit
+      end
+
+      v = Gtk::WebKit::WebView.new
+      v.open(url)
+
+      # load-finished is deprecated. We should use notify::load-status
+      v.signal_connect('load-finished') do |instance, *signal_related_args|
+        begin
+          options[:max_width] ||= 960
+          options[:max_height] ||= 640
+          options[:output_filename] ||= 'snapshot.png'
+          options[:output_format] ||= 'png'
+
+          saved_filename = save_viewport(instance.parent_window, options)
+        rescue
+          puts $!
+          puts $@
+        ensure
+          Gtk.main_quit
+        end
+      end
+
+      v.signal_connect('notify::load-status') do |instance, *signal_related_args|
+        #puts 'notify::load-status ' + v.load_status.to_s
+      end
+
+      w.add(v)
+      w.show_all
+
+      Gtk.main
+
+      saved_filename
+    end
+
+    private
+
+    def self.save_viewport(gdk_window, options)
+      win = gdk_window
+      win.raise
+      win.focus(0)
+      win.resize(options[:max_width], options[:max_height])
+      win.freeze_updates
+      x, y, w, h = win.geometry
+      pixbuf = Gdk::Pixbuf.from_drawable(nil, win, 0, 0, [options[:max_width], w].min, [options[:max_height], h].min)
+      pixbuf.save(options[:output_filename], options[:output_format])
+      return options[:output_filename]
+    end
+
+  end
+end
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/websnapshot.rb'}"
+puts "Loading websnapshot gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'rspec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'rspec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'websnapshot'

data/spec/websnapshot_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+def tidy(fname)
+  File.unlink(fname)
+end
+
+def image_size(fname)
+  %x{file #{fname}} =~ /([0-9]+ x [0-9]+)/
+  return $1
+end
+
+
+describe Websnapshot do
+  describe 'take' do
+    it 'returns a saved file name in relative form' do
+      fname = Websnapshot.take('spec/testpage_960x640.html')
+      fname.should == 'snapshot.png'
+      tidy fname
+    end
+
+    context 'only a URL is specified' do
+      context 'the URL is point to a local file' do
+        it "saves 960x640 snapshot.png for 960x640 page without any options" do
+          fname = Websnapshot.take('spec/testpage_960x640.html')
+          fname.should == 'snapshot.png'
+          image_size(fname).should == '960 x 640'
+          tidy fname
+        end
+      end
+
+      context 'the URL is point to a remote file (http)' do
+      end
+
+      context 'the URL is point to a remote file (https)' do
+      end
+    end
+
+    context 'a URL and size options are specified' do
+    end
+
+    context 'a specified URL cannot be loaded' do
+    end
+  end
+
+end

data/tasks/rspec.rake

@@ -0,0 +1,20 @@
+begin
+  require 'rspec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'rspec'
+end
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/websnapshot'

data/test/test_websnapshot.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestWebsnapshot < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_take
+    # without options
+    Websnapshot.take('http://google.co.jp')
+    assert_image('screenshot.png', 960, 640, 'png')
+
+    Websnapshot.take('testpage_128x128.html')
+    assert_image('screenshot.png', 128, 128, 'png')
+
+    Websnapshot.take('testpage_1280x720.html')
+    assert_image('screenshot.png', 960, 640, 'png')
+
+    # with max_width option
+    Websnapshot.take('testpage_960x640.html', :max_width => 320)
+    assert_image('screenshot.png', 320, 640, 'png')
+
+    Websnapshot.take('testpage_128x128.html', :max_width => 320)
+    assert_image('screenshot.png', 128, 128, 'png')
+
+    Websnapshot.take('testpage_1280x720.html', :max_width => 320)
+    assert_image('screenshot.png', 320, 640, 'png')
+
+    # with max_height option
+    Websnapshot.take('testpage_960x640.html', :max_height => 240)
+    assert_image('screenshot.png', 960, 240, 'png')
+
+    Websnapshot.take('testpage_128x128.html', :max_height => 240)
+    assert_image('screenshot.png', 128, 128, 'png')
+
+    Websnapshot.take('testpage_1280x720.html', :max_height => 240)
+    assert_image('screenshot.png', 960, 240, 'png')
+
+    # with max_width and max_height options
+
+    # with output_filename option
+
+    # with output_format option
+  end
+
+  def assert_image(filename, expected_width, expected_height, expected_image_format)
+  end
+
+end

data/test/test_websnapshot_cli.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+require 'websnapshot/cli'
+
+class TestWebsnapshotCli < Test::Unit::TestCase
+  def setup
+    Websnapshot::CLI.execute(@stdout_io = StringIO.new, [])
+    @stdout_io.rewind
+    @stdout = @stdout_io.read
+  end
+
+  def test_print_default_output
+    assert_match(/To update this executable/, @stdout)
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: websnapshot
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Takashi Oguma
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gtk2
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 359
+        segments: 
+        - 0
+        - 90
+        - 8
+        version: 0.90.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 9
+        - 4
+        version: 2.9.4
+  type: :development
+  version_requirements: *id002
+description: FIX (describe your package)
+email: 
+- bear.mini@gmail.com
+executables: 
+- websnapshot
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/websnapshot
+- dependencies.memo.text
+- lib/websnapshot.rb
+- lib/websnapshot/cli.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/websnapshot_spec.rb
+- tasks/rspec.rake
+- test/test_helper.rb
+- test/test_websnapshot.rb
+- test/test_websnapshot_cli.rb
+- .gemtest
+homepage: http://github.com/#{github_username}/#{project_name}
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: websnapshot
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: FIX (describe your package)
+test_files: 
+- test/test_helper.rb
+- test/test_websnapshot.rb
+- test/test_websnapshot_cli.rb