capit 0.1.1 → 0.1.2

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc/*
+.yardoc
+.DS_STORE

data/lib/capit.rb

@@ -1,5 +1,11 @@
-require 'capit/version'
-require 'capit/capture'
+# encoding: UTF-8
+
+# To ensure clean URI's
+require 'postrank-uri'
 
+# Primary namespace of the capit gem
 module CapIt
 end
+
+require 'capit/version'
+require 'capit/capture'

data/lib/capit/capture.rb

@@ -1,16 +1,33 @@
-require 'postrank-uri'
+# encoding: UTF-8
 
 module CapIt
   class << self
+    
+    # Capture image from URL. Convenience method for {CapIt::Capture}
+    # 
+    # @example
+    #   CapIt::Capture("http://mdvlrb.com", :filename => "mdvlrb.jpg")
+    #
     def Capture url, options = {}
       CapIt::Capture.new(url, options).capture
     end
   end
   
   class Capture
+    # The URL of the page to be captured
     attr_reader   :url
-    attr_accessor :folder, :filename, :user_agent, :max_wait, :delay
     
+    
+    attr_accessor :folder, :filename, :user_agent, :max_wait, 
+                  :delay, :output
+    
+    # Initialize a new Capture
+    #
+    # @example
+    #   capit = CapIt::Capture.new("http://mdvlrb.com", :filename => "mdvlrb.png")
+    #   capit.max_wait = 5000
+    #   capit.folder = "/home/user/screenshots"
+    #
     def initialize url, options = {}
       @url        = PostRank::URI.clean(url)              
       @folder     = options[:folder] || Dir.pwd
@@ -19,21 +36,41 @@ module CapIt
       @max_wait   = options[:max_wait] || 15000
       @delay      = options[:delay]
     end
-  
+    
+    # Performs the page capture.
+    # 
+    # @example
+    #   capit = CapIt::Capture.new("http://mdvlrb.com", :filename => "mdvlrb.png", :folder => "/home/user/screenshots")
+    #   capit.capture
+    #
+    # @return [true, false]
+    # 
     def capture      
       `#{capture_command}`
-      FileTest.exists?("#{@folder}/#{@filename}")
+      successful?
     end
 
-    protected      
-      def determine_os
-        case RUBY_PLATFORM
-          when /darwin/ then :mac
-          when /linux/ then :linux
-          else :error
-        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}'"
@@ -49,5 +86,18 @@ module CapIt
           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/ then :mac
+          when /linux/ then :linux
+          else :error
+        end
+      end
   end
 end

data/lib/capit/version.rb

@@ -1,3 +1,9 @@
+# encoding: UTF-8
+
 module CapIt
-  VERSION = "0.1.1"
+  
+  # 
+  # The version number
+  # 
+  VERSION = "0.1.2"
 end

metadata

@@ -2,7 +2,7 @@
 name: capit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ezekiel Templin