page_glimpse 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,4 +1,4 @@
-= PageGlimpse
+= Page Glimpse
 
 {PageGlimpse.com}[http://www.pageglimpse.com] is a SaaS provider which has a 
 REST API for downloading website thumbnails by URI.  This library wraps that 
@@ -6,7 +6,42 @@ interface to provide a Ruby-like means of interacting with it.
 
 <b>Note:</b> The author of this gem is entirely unaffiliated with the PageGlimpse.com web service.
 
+== Getting Started
+
+The following example shows how to use the PageGlimpse API:
+
+    gem 'page_glimpse'
+    require 'page_glimpse'
+    
+    PageGlimpse.developer_key = 'abc123def456ghi789jkl123mno456pq'
+    
+    if PageGlimpse.exist?('http://www.github.com')
+      image = PageGlimpse.get('http://www.github.com')
+      puts "Image type:     #{image.content_type}"    # => "image/jpeg"
+      puts "Image size:     #{image.content_length}"  # => 2572
+      puts "Image filename: #{image.filename}"        # => nil or a name
+      
+      # Save the transmitted binary (image.content) as a local file
+      File.open('github.jpg', File::CREAT|File::WRONLY|File::TRUNC) do |file|
+        file.write image.content
+      end
+    else
+      PageGlimpse.queue('http://www.github.com')
+      # and then try back later ...
+    end
+
+== Contributing
+
+To contribute to this library, fork it on 
+{GitHub}[http://www.github.com/nbibler/page_glimpse] and follow the 
+{contribution guide}[https://rails.lighthouseapp.com/projects/8994/sending-patches]
+provided for the Ruby on Rails project.
+
 == Copyright
 
-Copyright (c) 2009 Nathaniel E. Bibler.  Released under the MIT License.  
-See the LICENSE file for more details.
+PageGlimpse.com is owned and operated by {RADSense Software}[http://www.radsense.com/], 
+Copyright (c) 2006 - 2009.  Any and all questions about the Page Glimpse 
+service should be directed toward <tt>support [at] PageGlimpse.com</tt>.
+
+Copyright (c) 2009 {Nathaniel E. Bibler}[http://www.nathanielbibler.com].  
+Released under the MIT License.  See the LICENSE file for more details.

data/Rakefile

@@ -58,6 +58,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "page_glimpse #{version}"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 2
 :major: 0
 :minor: 0

data/lib/page_glimpse/api.rb

@@ -4,7 +4,10 @@ require 'page_glimpse/json_parser'
 
 module PageGlimpse
   
-  class API < Relax::Service
+  class API < Relax::Service #:nodoc:
+    
+    THUMBNAIL_EXISTS  = 'yes'
+    QUEUE_SUCCESS     = 'success'
     
     defaults do
       parameter :devkey,  :required => true
@@ -27,7 +30,7 @@ module PageGlimpse
         end
       end
       
-      action :exists?,    :url => '/thumbnails/exists' do
+      action :exist?,    :url => '/thumbnails/exists' do
         parameter :size
         
         parser JsonParser do

data/lib/page_glimpse/exceptions.rb

@@ -1,7 +1,11 @@
 module PageGlimpse
   
+  ##
+  # Catch-all exception for anything raised by the PageGlimpse library.
+  # 
   class Exception < RuntimeError; end
   
-  class InvalidDeveloperKeyError < Exception; end
+  class InvalidDeveloperKeyError < Exception #:nodoc:
+  end
   
 end

data/lib/page_glimpse/image.rb

@@ -1,5 +1,10 @@
 module PageGlimpse
   
+  ##
+  # An instance of this class is returned with a successful <tt>PageGlimpse.get</tt>
+  # request.  This object wraps the information returned by Page Glimpse about
+  # the thumbnail requested.
+  # 
   class Image
     attr_accessor :content_type,
                   :content_length,

data/lib/page_glimpse/image_parser.rb

@@ -2,7 +2,7 @@ require 'page_glimpse/image'
 
 module PageGlimpse
   
-  class ImageParser
+  class ImageParser #:nodoc:
     
     def initialize(options = {}, &block)
     end

data/lib/page_glimpse/json_parser.rb

@@ -3,7 +3,7 @@ require 'json'
 
 module PageGlimpse
   
-  class JsonParser
+  class JsonParser #:nodoc:
   
     def initialize(options = {}, &block)
     end

data/lib/page_glimpse.rb

@@ -7,9 +7,6 @@ require 'page_glimpse/api'
 
 module PageGlimpse
   
-  THUMBNAIL_EXISTS  = 'yes'
-  QUEUE_SUCCESS     = 'success'
-  
   ##
   # Sets the developer key to use with the requests.
   # 
@@ -18,12 +15,12 @@ module PageGlimpse
   end
   
   ##
-  # Returns +true+ if the thumbnail exists on PageGlimpse, +false+ otherwise.
+  # Returns +true+ if the thumbnail exists on Page Glimpse, +false+ otherwise.
   # 
-  def self.exists?(url, options = {})
+  def self.exist?(url, options = {})
     options[:url] = url
-    response = api.exists?(options)
-    response.kind_of?(Array) && response.size == 2 && response[1] == THUMBNAIL_EXISTS
+    response = api.exist?(options)
+    response.kind_of?(Array) && response.size == 2 && response[1] == API::THUMBNAIL_EXISTS
   rescue RestClient::ResourceNotFound
     return false
   rescue RestClient::RequestFailed
@@ -35,14 +32,17 @@ module PageGlimpse
   # 
   def self.get(url, options = {})
     options[:url] = url
-    exists?(url, options) ? api.thumbnail(options) : nil
+    exist?(url, options) ? api.thumbnail(options) : nil
   rescue RestClient::RequestFailed
     handle_failure($!)
   end
   
+  ##
+  # Instructs Page Glimpse to enqueue the thumbnailing of a specific URL.
+  # 
   def self.queue(url)
     response = api.queue(:url => url)
-    response.kind_of?(Array) && response.size == 2 && response[1] == QUEUE_SUCCESS
+    response.kind_of?(Array) && response.size == 2 && response[1] == API::QUEUE_SUCCESS
   rescue RestClient::RequestFailed
     handle_failure($!)
   end

data/page_glimpse.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{page_glimpse}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathaniel Bibler"]

data/test/integrations/page_glimpse_test.rb

@@ -4,14 +4,14 @@ class PageGlimpseTest < Test::Unit::TestCase
   
   context 'PageGlimpse' do
     
-    context 'exists?' do
+    context 'exist?' do
       
       should 'be true for thumbnails which exist' do
-        assert PageGlimpse.exists?('http://goodurl.local/', :size => 'large')
+        assert PageGlimpse.exist?('http://goodurl.local/', :size => 'large')
       end
 
       should 'be false for thumbnails which do not exist' do
-        assert !PageGlimpse.exists?('http://badurl.local/', :size => 'large')
+        assert !PageGlimpse.exist?('http://badurl.local/', :size => 'large')
       end
       
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: page_glimpse
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nathaniel Bibler