capit 0.1.2 → 0.2.0

data/.gitignore

@@ -3,5 +3,6 @@
 Gemfile.lock
 pkg/*
 doc/*
+coverage/*
 .yardoc
 .DS_STORE

data/Gemfile

@@ -1,5 +1,14 @@
+# encoding: UTF-8
+
 source "http://rubygems.org"
 
-gem 'postrank-uri', '~> 1.0.7'
+group :test do
+  gem 'rspec', '~> 2.5.0'
+  gem 'simplecov', '~> 0.4.0', :require => false
+  gem 'guard', '~> 0.3.0'
+  gem 'growl', '~> 1.0.3'
+  gem 'guard-bundler', '~> 0.1.2'
+  gem 'guard-rspec', '~> 0.2.0'
+end
 
 gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2, :cli => '-c' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end
+
+guard 'bundler', :notify => true do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ezekiel Templin
+
+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.md

@@ -33,7 +33,6 @@ Usage
     require 'capit'
     capit = CapIt::Capture("http://www.github.com")
 
-
 Notes
 -----
 Don't use this yet.

data/Rakefile

@@ -1,2 +1,8 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test    => :spec
+task :default => :spec

data/capit.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+
 require 'capit/version'
 
 Gem::Specification.new do |s|
@@ -8,14 +9,24 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Ezekiel Templin"]
   s.email       = ["ezkl@me.com"]
-  s.date        = %q{2011-03-24}
+  s.date        = %q{2011-03-26}
   s.homepage    = "http://github.com/meadvillerb/capit"
   s.summary     = %q{Easy screen captures with the help of CutyCapt}
   s.description = %q{CapIt provides a simple Ruby interface to Björn Höhrmann's CutyCapt.}
+  
   s.extra_rdoc_files = [
-    "README.md"
+    "README.md",
+    "LICENSE"
   ]
+  
   s.files         = `git ls-files`.split("\n")
-  s.add_runtime_dependency(%q<postrank-uri>, ["1.0.7"])
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  
   s.require_paths = ["lib"]
+  s.add_development_dependency('rspec', '~> 2.5.0')
+  s.add_development_dependency('simplecov', '~> 0.4.0')
+  s.add_development_dependency('guard', '~> 0.3.0')
+  s.add_development_dependency('growl', '~> 1.0.3')
+  s.add_development_dependency('guard-bundler', '~> 0.1.2')
+  s.add_development_dependency('guard-rspec', '~> 0.2.0')
 end

data/lib/capit.rb

@@ -1,10 +1,18 @@
 # encoding: UTF-8
 
-# To ensure clean URI's
-require 'postrank-uri'
-
 # Primary namespace of the capit gem
 module CapIt
+  
+  # Raised when OS isn't Linux or Mac
+  class InvalidOSError < StandardError; end
+
+  # Raised when a filename with an invalid extension is entered.
+  # @abstract
+  class InvalidExtensionError < StandardError; end
+  
+  # Raised when CutyCapt isn't installed.
+  # @abstract
+  class CutyCaptError < StandardError; end  
 end
 
 require 'capit/version'

data/lib/capit/capture.rb

@@ -14,6 +14,10 @@ module CapIt
   end
   
   class Capture
+    
+    # All extensions CutyCapt can use to infer format of output
+    EXTENSIONS = /\A[\w]+\.(svg|ps|pdf|itext|html|rtree|png|jpeg|jpg|mng|tiff|gif|bmp|ppm|xvm|xpm)\z/i
+    
     # The URL of the page to be captured
     attr_reader   :url
     
@@ -29,12 +33,15 @@ module CapIt
     #   capit.folder = "/home/user/screenshots"
     #
     def initialize url, options = {}
-      @url        = PostRank::URI.clean(url)              
+      cutycapt_installed?
+      @url        = url              
       @folder     = options[:folder] || Dir.pwd
       @filename   = options[:filename] || "capit.jpg"
       @user_agent = options[:user_agent] || "CapIt! [http://github.com/meadvillerb/capit]"
       @max_wait   = options[:max_wait] || 15000
       @delay      = options[:delay]
+      
+      valid_extension?(@filename)
     end
     
     # Performs the page capture.
@@ -43,61 +50,71 @@ module CapIt
     #   capit = CapIt::Capture.new("http://mdvlrb.com", :filename => "mdvlrb.png", :folder => "/home/user/screenshots")
     #   capit.capture
     #
-    # @return [true, false]
+    # @return [String, false]
     # 
     def capture      
       `#{capture_command}`
       successful?
     end
-
-    protected
     
-      # Determines whether the capture was successful
-      # by checking for the existence of the output file.
-      # Sets {@output} if true.
-      #
-      # @return [true, false]
-      #
-      def successful?
-        if FileTest.exists?("#{@folder}/#{@filename}")
-          @output = "#{@folder}/#{@filename}"
-          true
-        else
-          false
-        end  
-      end
-      
-      # Produces the command used to run CutyCapt. 
-      # 
-      # @return [String]
-      #
-      def capture_command        
-        cmd = "CutyCapt"
-        cmd += " --url='#{@url}'"
-        cmd += " --out='#{@folder}/#{@filename}'"
-        cmd += " --max-wait=#{@max_wait}"
-        cmd += " --delay=#{@delay}" if @delay
-        cmd += " --user-agent='#{@user_agent}'"
-        
-        if determine_os == :linux
-          xvfb = 'xvfb-run --server-args="-screen 0, 1024x768x24" '
-          xvfb.concat(cmd)
-        else
-          cmd
-        end        
+    def filename=(filename)
+      valid_extension?(filename)
+      @filename = filename 
+    end
+    
+    def valid_extension?(filename)
+      unless !filename[EXTENSIONS].nil?
+        raise InvalidExtensionError, "You must supply a valid extension!"
       end
+    end
+  
+    # Determines whether the capture was successful
+    # by checking for the existence of the output file.
+    # Sets {@output} if true.
+    #
+    # @return [true, false]
+    #
+    def successful?
+      if FileTest.exists?("#{@folder}/#{@filename}")
+        @output = "#{@folder}/#{@filename}"
+      end  
+    end
+    
+    # Produces the command used to run CutyCapt. 
+    # 
+    # @return [String]
+    #
+    def capture_command        
+      cmd = "CutyCapt"
+      cmd += " --url='#{@url}'"
+      cmd += " --out='#{@folder}/#{@filename}'"
+      cmd += " --max-wait=#{@max_wait}"
+      cmd += " --delay=#{@delay}" if @delay
+      cmd += " --user-agent='#{@user_agent}'"
       
-      # Uses RUBY_PLATFORM to determine the operating system.
-      # Not foolproof, but good enough for the time being.
-      # 
-      # @return [Symbol]
-      # 
-      def determine_os
-        case RUBY_PLATFORM
-          when /darwin/ then :mac
-          when /linux/ then :linux
-          else :error
-        end
+      if determine_os == :linux
+        xvfb = 'xvfb-run --server-args="-screen 0, 1024x768x24" '
+        xvfb.concat(cmd)
+      else
+        cmd
+      end        
+    end
+    
+    # Uses RUBY_PLATFORM to determine the operating system.
+    # Not foolproof, but good enough for the time being.
+    # 
+    # @return [Symbol]
+    # 
+    def determine_os
+      case RUBY_PLATFORM
+        when /darwin/i then :mac
+        when /linux/i then :linux
+        else raise InvalidOSError, "CapIt currently only works on the Mac and Linux platforms"
       end
+    end
+    
+    def cutycapt_installed?
+      raise CutyCaptError, "CutyCapt must be installed and available on PATH" if `which CutyCapt`.empty?
+    end
   end
 end

data/lib/capit/version.rb

@@ -5,5 +5,5 @@ module CapIt
   # 
   # The version number
   # 
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/capit/capture_spec.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CapIt::Capture do  
+  describe "Convenience Method" do
+    it "should have a Convenience Method" do
+      @folder = Dir.pwd + '/spec/temporary'
+      `mkdir #{@folder}`
+      @capit = CapIt::Capture("http://mdvlrb.com/", :filename => 'mdvlrb.png', :folder => @folder).should == @folder + "/mdvlrb.png"
+      `rm -rf #{@folder}`
+    end
+  end
+  
+  describe "Capture Class" do
+    subject { CapIt::Capture.new("http://mdvlrb.com/", :filename => 'mdvlrb.png') }
+    
+    describe "#initialize" do
+      it "should have defaults" do
+        subject.folder.should == Dir.pwd
+        subject.filename.should == "mdvlrb.png"
+        subject.user_agent.should == "CapIt! [http://github.com/meadvillerb/capit]"
+        subject.max_wait.should == 15000
+      end
+
+      it "should respond to input" do
+        subject.should respond_to :url, :folder, :filename, :user_agent, :max_wait, :delay
+      end
+      
+      it "should allow filename to be changed if extension is valid" do
+        @capit = CapIt::Capture.new("http://mdvlrb.com/")
+        @capit.filename = "mdvlrb.png"
+        @capit.filename.should == "mdvlrb.png"
+      end
+    end
+    
+    describe "#capture" do
+      before(:all) do
+        @folder = Dir.pwd + '/spec/temporary'
+        @capit = CapIt::Capture.new("http://mdvlrb.com/", :filename => 'mdvlrb.jpeg', :folder => @folder)
+        `mkdir #{@folder}`
+      end
+      
+      it "should return the full path to the screenshot" do
+        @capit.capture.should == @folder + "/mdvlrb.jpeg"
+      end
+      
+      it "should capture the proper screenshot" do
+        @capit.output.should == @folder + "/mdvlrb.jpeg"
+      end
+      
+      after(:all) do
+        `rm -rf #{@folder}`
+      end
+    end
+    
+    describe "#capture_command" do
+      it "should prefix xvfb when platform is Linux" do
+        @capit = CapIt::Capture.new("http://mdvlrb.com/")
+        RUBY_PLATFORM = "linux"
+        @capit.capture_command.should match /^xvfb/
+      end
+      
+      it "shouldn't prefix anything when platform is Mac" do
+        @capit = CapIt::Capture.new("http://mdvlrb.com/")
+        RUBY_PLATFORM = "darwin"
+        @capit.capture_command.should match /^CutyCapt/
+      end
+      
+    end
+    
+    describe "Errors" do
+      
+      it "should raise an error if CutyCapt isn't available" do
+        path = ENV['PATH']
+        expect { ENV['PATH'] = ""; CapIt::Capture.new("http://mdvlrb.com/") }.to raise_error(/CutyCapt/)
+        ENV['PATH'] = path
+      end
+      
+      it "should raise an error if OS isn't Linux or Mac" do
+        RUBY_PLATFORM = "mingw"
+        expect { subject.determine_os }.to raise_error(/platforms/)
+        RUBY_PLATFORM = "darwin"
+      end
+      
+      it "should not accept filenames without a valid extension" do
+        expect { CapIt::Capture.new("http://mdvlrb.com/", :filename => 'capit.foo') }.to raise_error(/valid extension/)
+        expect { subject.filename = "capit.foo" }.to raise_error(/valid extension/)
+      end
+    end
+    
+  end
+end

data/spec/capit_spec.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe CapIt do
+  describe "Basic Module" do
+    it "should have a VERSION" do
+      CapIt::VERSION.should_not be_nil
+    end    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+require 'simplecov'
+
+SimpleCov.start do
+  coverage_dir 'coverage'
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'capit'

metadata

@@ -2,7 +2,7 @@
 name: capit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ezekiel Templin
@@ -10,20 +10,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -04:00
+date: 2011-03-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: postrank-uri
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.7
-  type: :runtime
+        version: 2.5.0
+  type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard-bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :development
+  version_requirements: *id006
 description: "CapIt provides a simple Ruby interface to Bj\xC3\xB6rn H\xC3\xB6hrmann's CutyCapt."
 email: 
 - ezkl@me.com
@@ -33,15 +88,22 @@ extensions: []
 
 extra_rdoc_files: 
 - README.md
+- LICENSE
 files: 
+- .gemtest
 - .gitignore
 - Gemfile
+- Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - capit.gemspec
 - lib/capit.rb
 - lib/capit/capture.rb
 - lib/capit/version.rb
+- spec/capit/capture_spec.rb
+- spec/capit_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/meadvillerb/capit
 licenses: []
@@ -70,5 +132,7 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Easy screen captures with the help of CutyCapt
-test_files: []
-
+test_files: 
+- spec/capit/capture_spec.rb
+- spec/capit_spec.rb
+- spec/spec_helper.rb