arndtjenssen-picothumbs 0.1.1

data/HISTORY

@@ -0,0 +1,2 @@
+21-09-2009: added rdoc, bumped to v0.1.1
+20-09-2009: initial version 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Arndt Jenssen
+ 
+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

@@ -0,0 +1,43 @@
+Picothumbs
+
+== Description
+Picothumbs is a ruby gem to allow easy access the web thumbnail generation service at http://www.picothumbs.com
+
+== Installation
+sudo gem install arndtjenssen-picothumbs -s http://gems.github.com
+
+== Usage
+You need to register (for free) at www.picothumbs.com and retrieve your api-key and storage-key from the profile page.
+
+Then in your (rails) application you can do:
+
+# create a service request class
+thumbs = Picothumbs.new("your-api-key", "your-storage-key")
+
+# request to create the thumbnail from google.com
+thumb.simple_request("www.google.com")
+> request-key
+
+# poll if the thumbnail has been created
+thumbs.poll
+> one of: "ok" or "queued"
+
+# download the thumbnail to a local path with a specific size
+thumbs.download("/tmp", Picothumbs::MEDIUM)
+> stores a thumbnail in tmp
+
+For other possible sizes see http://www.picothumbs.com/features
+
+== Gem Home
+* Github Home: http://github.com/arndtjenssen/picothumbs
+* Gem Home: http://www.picothumbs.com/ruby_gem
+
+
+== Limitations
+Very first version does cover only simple api requests.
+
+== Todos
+* Create specs
+* Add rdoc
+* Make request fault tolerant
+* Add REST API requests

data/TODO

@@ -0,0 +1,4 @@
+* Create specs
+* Add rdoc
+* Make request fault tolerant
+* Add REST API requests

data/lib/picothumbs.rb

@@ -0,0 +1,66 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'open-uri'
+
+
+#
+# Service class to access the API on www.picothumbs.com to create thumbnails of web pages
+#
+
+class Picothumbs
+  VERSION = '0.1.1'
+  
+  BASE_API_URL = "http://www.picothumbs.com/api"
+  BASE_THUMBNAIL_URL = "http://www.picothumbs.com/images/thumbs"
+  
+  # poll return resposnes
+  POLL_OK = "ok"
+  POLL_QUEUED = "queued"
+  POLL_ERROR = "thumbnail error"
+  POLL_EXPIRED = "expired"
+  
+  # thumbnail sizes
+  TINY = "tiny"
+  SMALL = "small"
+  MEDIUM = "medium"
+  NORMAL = "normal"
+  LARGE = "large"
+  EXTRA = "extra"
+  ALL_SIZES = %w(tiny small medium normal large extra)
+  
+  attr_reader :response, :request_key, :last_url
+  attr_accessor :api_key, :storage_key
+  
+  def initialize(api_key, storage_key)
+    @api_key = api_key
+    @storage_key = storage_key
+  end
+  
+  # Creates a request to create a thumbnail of page with url
+  def simple_request(url)
+    @last_url = url
+    @request_key = open("#{BASE_API_URL}/simple?key=#{@api_key}&url=#{url}"){ |f| f.read }
+  end
+  
+  # Polls if a request has been processed
+  def poll(request_key = nil)
+    request_key = @request_key if request_key.nil?
+    @response = open("#{BASE_API_URL}/poll?key=#{@api_key}&request_key=#{request_key}"){|f| f.read}
+  end
+  
+  # returns a value > 0 on succesful download and 0 if thumbnail is not yet ready
+  # if request_key is nil or not given, the last request key from the simple_request method is used
+  # file is stored in path and named 'request_key-size.jpg'
+  def download(path, size, request_key = nil, poll_before_download = true)
+    if poll_before_download
+      return 0 if poll(request_key) != POLL_OK
+    end
+    
+    request_key = @request_key if request_key.nil?
+    file = File.join(path, "#{request_key}-#{size}.jpg")
+    
+    open(file, "wb").write(open("#{BASE_THUMBNAIL_URL}/#{@storage_key}/#{request_key}-#{size}.jpg").read)
+  end
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: arndtjenssen-picothumbs
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Arndt Jenssen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Allows easy access to the web thumbnail service of www.picothumbs.com
+email: gem@picothumbs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- HISTORY
+- TODO
+- lib/picothumbs.rb
+has_rdoc: true
+homepage: http://github.com/arndtjenssen/picothumbs
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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: picothumbs
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows easy access to the web thumbnail service of www.picothumbs.com
+test_files: []
+