grimen-page_glimpse 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jonas Grimfelt
+
+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.textile

@@ -0,0 +1,51 @@
+h1. PAGE_GLIMPSE
+
+A little Ruby wrapper for the *PageGlimpse API* for generating webpage snapshots - glimpses - in a snap.
+
+h2. What Is PageGlimpse?
+
+"http://pageglimpse.com":http://pageglimpse.com
+
+h2. Installation
+
+Dependency:
+
+<pre>sudo gem install jnunemaker-httparty</pre>
+
+Gem:
+
+<pre>sudo gem install grimen-page_glimpse</pre>
+
+h2. PageGlimpse API Key
+
+You'll need a API key, which you can get for *free* here:
+
+"http://pageglimpse.com/signup":http://pageglimpse.com/signup
+
+h2. Usage/Examples
+
+h3. Initialize
+
+<pre>snapper = PageGlimse.new('ec0ccd....26df') # => nil</pre>
+
+h3. Tell PageGlimpse to generate a webpage thumbnail
+
+<pre>snapper.request!('http://mypage.com') # => true/false</pre>
+
+h3. Check if thumbnail exists for a webpage
+
+<pre>snapper.exists?('http://techcrunch.com', :size => :medium) # => true/false</pre>
+
+h3. Get thumbnail (PNG image) for a webpage
+
+<pre>snapper.thumbnail('http://techcrunch.com', :size => :small) # => [raw PNG data]</pre>
+
+h3. Save thumbnail into a file (PNG image) for a webpage
+
+<pre>snapper.save!('http://techcrunch.com', :size => :large) # => true/false</pre>
+
+h3. More?
+
+Yes, all the PageGlimpse API options are supported but not documented in this README right now. Peep the code and read more about the options: "http://www.pageglimpse.com/features/api":http://www.pageglimpse.com/features/api.
+
+Copyright (c) Jonas Grimfelt, released under the MIT-license.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+NAME = "page_glimpse"
+SUMMARY = %Q{A little Ruby wrapper for the PageGlimpse API (http://pageglimpse.com) for generating webpage snapshots - glimpses - in a snap.}
+HOMEPAGE = "http://github.com/grimen/#{NAME}/tree/master"
+AUTHOR = "Jonas Grimfelt"
+EMAIL = "grimen@gmail.com"
+SUPPORT_FILES = %w(README.textile)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = NAME
+    gem.summary = SUMMARY
+    gem.description = SUMMARY
+    gem.homepage = HOMEPAGE
+    gem.author = AUTHOR
+    gem.email = EMAIL
+    
+    gem.require_paths = %w{lib}
+    gem.files = SUPPORT_FILES + %w(MIT-LICENSE Rakefile) + Dir.glob(File.join('{bin,lib,test,rails}', '**', '*'))
+    gem.executables = %w()
+    gem.extra_rdoc_files = SUPPORT_FILES
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc %Q{Run unit tests for "#{NAME}".}
+task :default => :test
+
+desc %Q{Run unit tests for "#{NAME}".}
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc %Q{Generate documentation for "#{NAME}".}
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = NAME
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset=UTF-8'
+  rdoc.rdoc_files.include(SUPPORT_FILES)
+  rdoc.rdoc_files.include(File.join('lib', '**', '*.rb'))
+end

data/lib/page_glimse.rb

@@ -0,0 +1,131 @@
+require 'rubygems'
+
+gem 'httparty', '0.4.3'
+require 'httparty'
+
+class PageGlimse
+  
+  InvalidAPIKeyError = Class.new(StandardError)
+  
+  include HTTParty
+  
+  PG_API_URL = 'http://images.pageglimpse.com/v1'.freeze
+  PG_VALID_SIZE_VALUES = [:small, :medium, :large].freeze
+  PG_VALID_ROOT_VALUES = [:yes, :no].freeze
+  PG_IMAGE_FORMAT = :png
+  
+  ACTION_PARAMS = {
+      :thumbnails => [:devkey, :url, :size, :root, :nothumb],
+      :'thumbnails/exists' => [:devkey, :url, :size],
+      :'thumbnails/request' => [:devkey, :url]
+    }.freeze
+    
+  DEFAULT_OPTIONS = {
+      :size => :medium,
+      :root => true,
+      :nothumb => nil
+    }.freeze
+    
+  base_uri(PG_API_URL)
+  
+  attr_accessor :defaults,
+                :devkey,
+                :url,
+                :size,
+                :root,
+                :nothumb
+                
+  def initialize(devkey, defaults = {})
+    @defaults = DEFAULT_OPTIONS.merge(defaults)
+    @devkey = devkey
+  end
+  
+  # Get single thumbnail.
+  def thumbnail(url, options = {})
+    options = defaults.merge(options)
+    @url = url
+    @size = valid_size_value(options[:size])
+    @root = valid_root_value(options[:root])
+    @nothumb = options[:nothumb]
+    
+    query_url = generate_url('thumbnails')
+    response = self.class.get(query_url)
+    handle_response(response)
+    response.body
+  end
+  alias :thumbnails :thumbnail
+  
+  # Export single thumbnail into a file.
+  def save!(url, path, options = {})
+    begin
+      data = thumbnail(url, options)
+      path = File.join(path, "#{url.gsub(/(http:)|[\/]/, '')}.#{PG_IMAGE_FORMAT}") if File.directory?(path)
+      File.new(path, 'w')
+      File.open(path, 'w') { |f| f.write(data) }
+    rescue
+      false
+    else
+      true
+    end
+  end
+  
+  # Request URL to be captured.
+  def request!(url, options = {})
+    options = defaults.merge(options)
+    @url = url
+    
+    query_url = generate_url('thumbnails', 'request')
+    response = self.class.get(query_url)
+    handle_response(response.code)
+  end
+  
+  # Check if a thumbnail exists
+  def exists?(url, options = {})
+    options = defaults.merge(options)
+    @url = url
+    @size = valid_size_value(options[:size])
+    
+    query_url = generate_url('thumbnails', 'exists')
+    response = self.class.get(query_url)
+    handle_response(response.code)
+  end
+  alias :exist? :exists?
+  
+  private
+  
+  # Return value based on response code.
+  def handle_response(response_code)
+    case response_code.to_i
+    when 200 then
+      true
+    when 404 then
+      false
+    when 403 then
+      raise InvalidAPIKeyError, "Error: Invalid PageGlimse API key."
+    end
+  end
+  
+  # Validate/Format value for "root"-param.
+  def valid_root_value(root)
+    root ||= true
+    (root == true) ? :yes : :no
+  end
+  
+  # Validate/Format value for "size"-param.
+  def valid_size_value(size)
+    PG_VALID_SIZE_VALUES.include?(size.to_sym) ? size : :medium
+  end
+  
+  # Generate API query URL base on specified args.
+  def generate_url(*args)
+    action = args.join('/').to_sym
+    params = []
+    params << "url=#{@url}" if ACTION_PARAMS[action].include?(:url)
+    params << "size=#{@size}" if ACTION_PARAMS[action].include?(:size)
+    params << "root=#{@root}" if ACTION_PARAMS[action].include?(:thumbnail)
+    params << "nothumb=#{@nothumb}" if ACTION_PARAMS[action].include?(:nothumb) && @nothumb && !@nothumb.empty?
+    params << "devkey=#{@devkey}" if ACTION_PARAMS[action].include?(:devkey)
+    "/#{action}?#{params.join('&')}"
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), 'lib', '**', '*.rb'))).uniq.each do |file|
+  require file
+end

data/test/page_glimse_test.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'shoulda'
+
+class PageGlimpseTest < Test::Unit::TestCase
+  
+  VALID_API_KEY = 'ec0ccd30be1b39393d19cb5f410d26df'
+  INVALID_API_KEY = 'ec0ccd30be1b39393d19cb5f410d26d'
+  
+  def setup
+    @glimpser = PageGlimpse.new(TEST_API_KEY)
+  end
+  
+  should "be true" do
+    assert true
+  end
+  
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: grimen-page_glimpse
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonas Grimfelt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A little Ruby wrapper for the PageGlimpse API (http://pageglimpse.com) for generating webpage snapshots - glimpses - in a snap.
+email: grimen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- lib/page_glimse.rb
+- rails/init.rb
+- test/page_glimse_test.rb
+has_rdoc: false
+homepage: http://github.com/grimen/page_glimpse/tree/master
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A little Ruby wrapper for the PageGlimpse API (http://pageglimpse.com) for generating webpage snapshots - glimpses - in a snap.
+test_files: 
+- test/page_glimse_test.rb