page_glimpse 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+0.0.1 - Current
+
+* Initial public release based on Relax 0.1.1 or later.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nathaniel E. Bibler
+
+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.rdoc

@@ -0,0 +1,12 @@
+= PageGlimpse
+
+{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 
+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.
+
+== Copyright
+
+Copyright (c) 2009 Nathaniel E. Bibler.  Released under the MIT License.  
+See the LICENSE file for more details.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "page_glimpse"
+    gem.summary = %Q{A Ruby library for the PageGlimpse.com service}
+    gem.email = "gem@nathanielbibler.com"
+    gem.homepage = "http://github.com/nbibler/page_glimpse"
+    gem.authors = ["Nathaniel Bibler"]
+    gem.rubyforge_project = 'page-glimpse'
+    
+    gem.add_dependency('relax', '~> 0.1.1')
+    gem.add_dependency('json', '~> 1.1.6')
+ 
+    gem.add_development_dependency('thoughtbot-shoulda', '~> 2.10.1')
+    gem.add_development_dependency('mocha', '~> 0.9.5')
+    gem.add_development_dependency('fakeweb', '~> 1.2.2')
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "page_glimpse #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/lib/page_glimpse/api.rb

@@ -0,0 +1,41 @@
+require 'page_glimpse/exceptions'
+require 'page_glimpse/image_parser'
+require 'page_glimpse/json_parser'
+
+module PageGlimpse
+  
+  class API < Relax::Service
+    
+    defaults do
+      parameter :devkey,  :required => true
+      parameter :url,     :required => true
+    end
+    
+    endpoint 'http://images.pageglimpse.com/v1' do
+      
+      action :thumbnail,  :url => '/thumbnails' do
+        parameter :size
+        parameter :root
+        parameter :nothumb
+        
+        parser ImageParser do
+        end
+      end
+      
+      action :queue,      :url => '/thumbnails/request' do
+        parser JsonParser do
+        end
+      end
+      
+      action :exists?,    :url => '/thumbnails/exists' do
+        parameter :size
+        
+        parser JsonParser do
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/page_glimpse/exceptions.rb

@@ -0,0 +1,7 @@
+module PageGlimpse
+  
+  class Exception < RuntimeError; end
+  
+  class InvalidDeveloperKeyError < Exception; end
+  
+end

data/lib/page_glimpse/image.rb

@@ -0,0 +1,12 @@
+module PageGlimpse
+  
+  class Image
+    attr_accessor :content_type,
+                  :content_length,
+                  :content,
+                  :filename
+                  
+    alias :body :content
+  end
+  
+end

data/lib/page_glimpse/image_parser.rb

@@ -0,0 +1,31 @@
+require 'page_glimpse/image'
+
+module PageGlimpse
+  
+  class ImageParser
+    
+    def initialize(options = {}, &block)
+    end
+    
+    def parse(response)
+      image = Image.new
+      image.content_type    = response.headers[:content_type]
+      image.filename        = parse_filename(response.headers[:content_disposition])
+      image.content_length  = (response.headers[:content_length] || 0).to_i
+      image.content         = response.to_s
+      image
+    end
+    
+    
+    private
+    
+    
+    def parse_filename(disposition)
+      if disposition =~ /filename="([^"]*)"/i
+        $1
+      end
+    end
+    
+  end
+  
+end

data/lib/page_glimpse/json_parser.rb

@@ -0,0 +1,17 @@
+gem 'json', '~> 1.1.6'
+require 'json'
+
+module PageGlimpse
+  
+  class JsonParser
+  
+    def initialize(options = {}, &block)
+    end
+  
+    def parse(response)
+      JSON.parse response
+    end
+  
+  end
+
+end

data/lib/page_glimpse.rb

@@ -0,0 +1,72 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+gem 'relax' #, '~>0.1.0'
+require 'relax'
+
+require 'page_glimpse/api'
+
+module PageGlimpse
+  
+  THUMBNAIL_EXISTS  = 'yes'
+  QUEUE_SUCCESS     = 'success'
+  
+  ##
+  # Sets the developer key to use with the requests.
+  # 
+  def self.developer_key=(key)
+    @@developer_key = key
+  end
+  
+  ##
+  # Returns +true+ if the thumbnail exists on PageGlimpse, +false+ otherwise.
+  # 
+  def self.exists?(url, options = {})
+    options[:url] = url
+    response = api.exists?(options)
+    response.kind_of?(Array) && response.size == 2 && response[1] == THUMBNAIL_EXISTS
+  rescue RestClient::ResourceNotFound
+    return false
+  rescue RestClient::RequestFailed
+    handle_failure($!)
+  end
+  
+  ##
+  # Returns the binary data for the thumbnail requested.
+  # 
+  def self.get(url, options = {})
+    options[:url] = url
+    exists?(url, options) ? api.thumbnail(options) : nil
+  rescue RestClient::RequestFailed
+    handle_failure($!)
+  end
+  
+  def self.queue(url)
+    response = api.queue(:url => url)
+    response.kind_of?(Array) && response.size == 2 && response[1] == QUEUE_SUCCESS
+  rescue RestClient::RequestFailed
+    handle_failure($!)
+  end
+  
+  
+  private
+  
+  
+  def self.developer_key #:nodoc:
+    @@developer_key
+  end
+  
+  def self.api #:nodoc:
+    @@api ||= API.new(:devkey => self.developer_key)
+  end
+  
+  def self.handle_failure(exception)
+    raise exception unless exception.respond_to?(:http_code)
+    case exception.http_code
+    when 403
+      raise InvalidDeveloperKeyError, "Check your developer key: it was either mistyped or has been invalidated"
+    else
+      raise exception
+    end
+  end
+  
+end

data/page_glimpse.gemspec

@@ -0,0 +1,73 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{page_glimpse}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathaniel Bibler"]
+  s.date = %q{2009-06-04}
+  s.email = %q{gem@nathanielbibler.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/page_glimpse.rb",
+     "lib/page_glimpse/api.rb",
+     "lib/page_glimpse/exceptions.rb",
+     "lib/page_glimpse/image.rb",
+     "lib/page_glimpse/image_parser.rb",
+     "lib/page_glimpse/json_parser.rb",
+     "page_glimpse.gemspec",
+     "test/integrations/page_glimpse_test.rb",
+     "test/mocks/page_glimpse.rb",
+     "test/test_helper.rb",
+     "test/units/page_glimpse_test.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/nbibler/page_glimpse}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{page-glimpse}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{A Ruby library for the PageGlimpse.com service}
+  s.test_files = [
+    "test/integrations/page_glimpse_test.rb",
+     "test/mocks/page_glimpse.rb",
+     "test/test_helper.rb",
+     "test/units/page_glimpse_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<relax>, ["~> 0.1.1"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.1.6"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, ["~> 2.10.1"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.5"])
+      s.add_development_dependency(%q<fakeweb>, ["~> 1.2.2"])
+    else
+      s.add_dependency(%q<relax>, ["~> 0.1.1"])
+      s.add_dependency(%q<json>, ["~> 1.1.6"])
+      s.add_dependency(%q<thoughtbot-shoulda>, ["~> 2.10.1"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.5"])
+      s.add_dependency(%q<fakeweb>, ["~> 1.2.2"])
+    end
+  else
+    s.add_dependency(%q<relax>, ["~> 0.1.1"])
+    s.add_dependency(%q<json>, ["~> 1.1.6"])
+    s.add_dependency(%q<thoughtbot-shoulda>, ["~> 2.10.1"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.5"])
+    s.add_dependency(%q<fakeweb>, ["~> 1.2.2"])
+  end
+end

data/test/integrations/page_glimpse_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class PageGlimpseTest < Test::Unit::TestCase
+  
+  context 'PageGlimpse' do
+    
+    context 'exists?' do
+      
+      should 'be true for thumbnails which exist' do
+        assert PageGlimpse.exists?('http://goodurl.local/', :size => 'large')
+      end
+
+      should 'be false for thumbnails which do not exist' do
+        assert !PageGlimpse.exists?('http://badurl.local/', :size => 'large')
+      end
+      
+    end
+    
+    context 'get' do
+      
+      context 'with a thumbnail available' do
+        
+        setup do
+          @thumbnail = PageGlimpse.get('http://goodurl.local/', :size => 'large')
+        end
+        
+        should 'return an Image' do
+          assert_kind_of PageGlimpse::Image, @thumbnail
+        end
+
+        should 'have a content type' do
+          assert_equal 'image/jpeg', @thumbnail.content_type
+        end
+
+        should 'have a content length' do
+          assert_equal 3124, @thumbnail.content_length
+        end
+
+        should 'have content' do
+          assert_not_nil @thumbnail.content
+        end
+
+        should 'have a filename' do
+          assert_equal 'invalid_devkey.150x108.jpg', @thumbnail.filename
+        end
+        
+      end
+      
+      context 'with no thumbnail available' do
+        
+        should 'return nil' do
+          assert_nil PageGlimpse.get('http://badurl.local/', :size => 'large')
+        end
+        
+      end
+      
+    end
+    
+    context 'queue' do
+      
+      should 'return true' do
+        assert PageGlimpse.queue('http://goodurl.local/')
+      end
+      
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mocks/page_glimpse'
+require 'page_glimpse'
+
+DEVELOPER_KEY = 'testdeveloperkey123'
+PageGlimpse.developer_key = DEVELOPER_KEY

data/test/units/page_glimpse_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class PageGlimpseTest < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: page_glimpse
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathaniel Bibler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: relax
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.10.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: 
+description: 
+email: gem@nathanielbibler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/page_glimpse.rb
+- lib/page_glimpse/api.rb
+- lib/page_glimpse/exceptions.rb
+- lib/page_glimpse/image.rb
+- lib/page_glimpse/image_parser.rb
+- lib/page_glimpse/json_parser.rb
+- page_glimpse.gemspec
+- test/integrations/page_glimpse_test.rb
+- test/mocks/page_glimpse.rb
+- test/test_helper.rb
+- test/units/page_glimpse_test.rb
+has_rdoc: true
+homepage: http://github.com/nbibler/page_glimpse
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: page-glimpse
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: A Ruby library for the PageGlimpse.com service
+test_files: 
+- test/integrations/page_glimpse_test.rb
+- test/mocks/page_glimpse.rb
+- test/test_helper.rb
+- test/units/page_glimpse_test.rb