simplificator-rwebthumb 0.0.1

data/README

@@ -0,0 +1,29 @@
+== rwebthumb
+
+= what is it
+A Ruby wrapper for the webthumb API from http://webthumb.bluga.net
+
+= dependencies
+ - tzinfo:http://tzinfo.rubyforge.org (install: sudo gem install tzinfo)
+
+= Usage
+# Creating a Webthumb Object. This is used as your main access point
+wt = Webthumb.new('YOUR API KEY')
+
+# Create a new thumbnail job
+job = wt.thumbnail(:url => 'http://simplificator.com')
+
+# fetch the thumbnail. this might throw an exception from server side
+# if thumb is not ready yet
+job.fetch(:large)
+
+# you can check the status of a job 
+job.check_status()
+ 
+# or fetch the thumbnail when it is complete
+job.fetch_when_complete(:large)
+
+# once thumbnails are fetched they are cached within the job. so a new fetch will not go to the server again
+
+# there is a helper method to write the images to disk
+job.write_file(, '/tmp/test.jpg')

data/init.rb

@@ -0,0 +1,2 @@
+require 'rwebthumb'
+puts "****"

data/lib/rwebthumb.rb

@@ -0,0 +1,4 @@
+require 'tzinfo'
+require 'rwebthumb/base'
+require 'rwebthumb/job'
+require 'rwebthumb/webthumb'

data/lib/rwebthumb/base.rb

@@ -0,0 +1,82 @@
+module Simplificator
+  module Webthumb
+    # 
+    #
+    #
+    #
+    class Base
+      # Valid output_types for thumbnail requests
+      VALID_OUTPUT_TYPES = [:jpg, :png]
+      # Valid values for size element in fetch requests
+      VALID_SIZES = [:small, :medium, :medium2, :large, :full, :excerpt, :effect, :custom, :zip]
+      
+      # Timezone to convert from MST (Webthumb) to UTC
+      MST_TIMEZONE = TZInfo::Timezone.get('MST')
+    
+      attr_reader :api_key
+      # Constructor
+      #  api_key: the Webthumb api key, not nil and not blank
+      #  
+      def initialize(api_key, api_endpoint = 'http://webthumb.bluga.net/api.php')
+        raise WebthumbException.new('Need an noot nil and not blank api_key') if api_key == nil || api_key == ''
+        @api_key = api_key
+        @api_endpoint = api_endpoint
+        @api_uri = URI.parse(@api_endpoint)
+      end
+
+      # Parse the datetime string and returns a DateTime object in UTC time 
+      # Webthumb returns the time in MST (Mountain Standard Time) which is some 7 hours
+      # behind UTC
+      def self.parse_webthumb_datetime(s)
+        MST_TIMEZONE.local_to_utc(DateTime.strptime(s, '%Y-%m-%d %H:%M:%S'))
+      end
+    
+      def do_request(xml)
+        request = Net::HTTP::Post.new(@api_uri.path)
+        request.body = xml.to_s
+        response = Net::HTTP.new(@api_uri.host, @api_uri.port).start {|p| p.request(request) }
+        case response
+        when Net::HTTPOK :
+          case response.content_type
+          when 'text/xml' : REXML::Document.new(response.body)
+          when 'image/jpg' 
+          when 'image/jpeg'
+          when 'image/png'
+            response.body
+          else
+            raise WebthumbException.new("usupported content type #{response.content_type}. Body was: \n#{response.body}")
+          end
+        else  
+          raise CommunicationException('Response code was not HTTP OK')
+        end
+      end
+    
+      # builds the root node for webthumb requtes
+      def  build_root_node()
+        root = REXML::Element.new('webthumb')
+        api = root.add_element('apikey')
+        api.text = @api_key
+        root
+      end
+      
+      protected
+      #
+      # add a XML element if value is present.
+      # can be used to create XML for webthumb requests from ruby options hash.
+      # 
+      # root: the root XML element where element is added to
+      # options: the hash where value is taken from
+      # key: the key to lookup the value in options
+      # name: the name of the XML element. defaults to key
+      #
+      def add_element(root, options, key, name = key.to_s)
+        root.add_element(name).add_text(options[key].to_s) if options.has_key?(key)
+      end
+
+    end
+    class WebthumbException < RuntimeError
+    end
+    class CommunicationException < RuntimeError
+    end
+  end
+end

data/lib/rwebthumb/job.rb

@@ -0,0 +1,99 @@
+module Simplificator
+  module Webthumb 
+    class Job < Base
+      
+      attr_reader :duration_estimate, :submission_datetime, :cost, :job_id, :url
+      
+      # Constant for the status attribute when job is beeing processed
+      STATUS_PROCESSING = 100
+      # Constant for the status attribute when job is done
+      STATUS_PICKUP = 200
+    
+      # Factory method to build a Job object from a REXML xml element
+      def self.from_thumbnail_xml(api_key, xml)
+        job_element = REXML::XPath.first(xml, '/webthumb/jobs/job')
+        submission_datetime = self.parse_webthumb_datetime(job_element.attributes['time'])
+        Job.new(api_key, job_element.text, job_element.attributes['url'], submission_datetime, job_element.attributes['estimate'].to_i, job_element.attributes['cost'].to_i)
+      end 
+      
+      def self.from_status_xml(api_key, xml)
+        status_element = REXML::XPath.first(xml, '/webthumb/jobStatus/status')
+        submission_datetime = self.parse_webthumb_datetime(status_element.attributes['submissionTime'])
+        job = Job.new(api_key, status_element.attributes['id'], nil, submission_datetime, 5, nil, 
+          status_element.text == 'Complete' ? STATUS_PICKUP : STATUS_PROCESSING)
+      end
+    
+      def initialize(api_key, job_id, url, submission_datetime, duration_estimate, cost, status = STATUS_PROCESSING)
+        super(api_key)
+        @job_id = job_id
+        @url = url
+        @submission_datetime = submission_datetime
+        @duration_estimate = duration_estimate
+        @cost = cost
+        @status = status
+        @cache = {}
+      end
+    
+      def request_status
+        response = do_request(build_status_xml())
+        @status = REXML::XPath.first(response, '/webthumb/jobStatus/status').text == 'Complete' ? STATUS_PICKUP : STATUS_PROCESSING
+        if pickup?
+          @completion_time = response.attributes['completionTime']
+          @duration = 'not yet... need to convert times first' 
+        end
+        @status
+      end
+      
+      def fetch_when_complete(size = :small)
+        while not pickup?
+          puts "waiting for #{@duration_estimate}"
+          sleep @duration_estimate
+          request_status
+        end
+        fetch(size)
+      end
+      
+      def fetch(size = :small)
+        unless @cache.has_key?(size)
+          response = do_request(build_fetch_xml(size))
+          @cache[size] = response
+        end
+        @cache[size]
+      end
+      
+      def write_file(data, name)
+        File.open(name, 'wb+') do |file|
+          file.write(data)
+          file.close
+        end
+      end
+      
+      def pickup?
+        @status == STATUS_PICKUP
+      end	
+      def processing?
+        @status == STATUS_PROCESSING
+      end
+      
+      private
+      def build_fetch_xml(size = :small)
+        raise WebthumbException.new("size parameter must be one of #{VALID_SIZES.join(', ')} but was #{size}") unless Base::VALID_SIZES.include?(size)
+        root = build_root_node()
+        fetch = root.add_element('fetch')
+        fetch.add_element('job').add_text(@job_id)
+        fetch.add_element('size').add_text(size.to_s)
+        root
+      end
+      def build_status_xml()
+        root = build_root_node()
+        status = root.add_element('status')
+        status.add_element('job').add_text(@job_id)
+        root
+      end
+
+      def to_s
+        "Job: #{@job_id} / Status: #{@status} / Submission Time #{@submission_time} / Duration Estimate #{@duration_estimate}"
+      end
+    end
+  end
+end

data/lib/rwebthumb/webthumb.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'rexml/document'
+require 'date'
+module Simplificator
+  module Webthumb
+
+	
+    class Webthumb < Base
+      def thumbnail(options = {})
+        Job.from_thumbnail_xml(@api_key, do_request(build_thumbnail_xml(options)))
+      end
+
+      def job_status(job_id)
+        Job.from_status_xml(@api_key, do_request(build_job_status_xml(job_id)))
+      end
+      
+      def credits()
+        root = build_root_node()
+        root.add_element('credits')
+        elements = do_request(root).elements['webthumb'].elements['credits'].elements
+        {:reserve => elements['reserve'].text.to_i, :subscription => elements['subscription'].text.to_i}
+      end
+      
+      private 
+      def build_thumbnail_xml(options)
+        validate_thumbnail_options(options)
+        
+        
+        root = build_root_node()
+        request = root.add_element('request')
+        request.add_element('url').add_text(options[:url])
+        add_element(request, options, :output_type, 'outputType')
+        [:width, :height, :effect, :delay, :notofy].each {|item| add_element(request, options, item)}
+			
+        if options[:fullthumb] == true
+          request.add_element('fullthumb').add_text('1')
+        end
+        if options.has_key?(:custom_thumbnail)
+          request.add_element('customThumbnail', 
+            'width' => options[:custom_thumbnail][:width].to_s, 
+            'height' => options[:custom_thumbnail][:height].to_s)
+				
+        end
+        if options.has_key?(:excerpt)
+          excerpt = request.add_element('excerpt')
+          [:x, :y, :width, :height].each {|item| add_element(excerpt, options[:excerpt], item)}
+        end
+        root
+      end
+      
+      def build_job_status_xml(job_id)
+        root = build_root_node()
+        root.add_element('status').add_element('job').add_text(job_id)
+        root
+      end
+      
+      def validate_thumbnail_options(options)
+        raise WebthumbException.new('Need an URL') if options[:url] == nil || options[:url] == ''
+        raise WebthumbException.new("output_type is invalid: #{options[:output_type]}") if options.has_key?(:output_type) and (not Base::VALID_OUTPUT_TYPES.include?(options[:output_type]))
+        
+      end
+    end
+
+  end
+end
+
+
+
+

data/test/base_test.rb

@@ -0,0 +1,23 @@
+require 'helper'
+class BaseTest < Test::Unit::TestCase
+  def test_api_key_required
+    assert_raises(WebthumbException) { Base.new('') }
+    assert_raises(WebthumbException) { Base.new(nil) }
+  end
+  
+  def test_parse_webthumb_date
+    [['2000-1-1 14:00:00', '2000-1-1 07:00:00'], ['2000-1-1 07:00:00', '2000-1-1 00:00:00'], ['2000-8-1 07:44:2', '2000-8-1 00:44:02']].each do |item|
+      utc = DateTime.strptime(item[0], '%Y-%m-%d %H:%M:%S')
+      mst = Base.parse_webthumb_datetime(item[1])
+      assert_equal(utc, mst)
+    end
+  end
+  
+  def test_build_root_node()
+    root = Base.new('1234').build_root_node()
+    assert_not_nil(root)
+    assert_not_nil(REXML::XPath.first(root, '/'))
+    assert_not_nil(REXML::XPath.first(root, '/apikey'))
+    assert_equal('1234', REXML::XPath.first(root, '/apikey').text)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'rubygems'
+require 'rwebthumb'
+include Simplificator::Webthumb

data/test/job_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+class JobTest < Test::Unit::TestCase
+  def setup()
+    xml = <<-EOF
+      <webthumb>
+        <jobs>
+          <job estimate='20' time='2008-02-27 12:49:48' url='http://blog.joshuaeichorn.com' cost='1'>wt47c5f71c37c3a</job>
+        </jobs>
+      </webthumb>
+    EOF
+    job_xml = REXML::Document.new(xml)
+    @job = Job.from_thumbnail_xml('1234', job_xml)
+  end
+  def test_from_thumbnail_xml
+    
+    assert_equal('1234', @job.api_key)
+    assert_equal(20, @job.duration_estimate)
+    assert_equal(DateTime.strptime('2008-02-27 19:49:48', '%Y-%m-%d %H:%M:%S'), @job.submission_datetime)
+    assert_equal('http://blog.joshuaeichorn.com', @job.url)
+    assert_equal(1, @job.cost)
+    assert_equal('wt47c5f71c37c3a', @job.job_id)
+  end
+  
+  
+  def test_build_fetch()
+    xml = @job.send(:build_fetch_xml)
+    assert_equal('small', REXML::XPath.first(xml, 'fetch/size').text)
+    assert_equal('wt47c5f71c37c3a', REXML::XPath.first(xml, 'fetch/job').text)
+  end
+  
+  def test_build_status_xml()
+    xml = @job.send(:build_status_xml)
+    assert_equal('wt47c5f71c37c3a', REXML::XPath.first(xml, 'status/job').text)
+  end
+end

data/test/webthumb_test.rb

@@ -0,0 +1,15 @@
+require 'helper'
+class WebthumbTest < Test::Unit::TestCase
+  
+  
+  
+  def test_build_fetch()
+    xml = Webthumb.new('1234').send(:build_thumbnail_xml, :url => 'http://simplificator.com')
+    assert_equal('http://simplificator.com', REXML::XPath.first(xml, 'request/url').text)
+  end
+
+  def test_build_job_status_xml()
+    xml = Webthumb.new('1234').send(:build_job_status_xml, 'abcd')
+    assert_equal('abcd', REXML::XPath.first(xml, 'status/job').text)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: simplificator-rwebthumb
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simplificator GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: rwebthumb provides a ruby interface for the webthumb.bluga.net
+email: gems@simplificator.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rwebthumb.rb
+- lib/rwebthumb/base.rb
+- lib/rwebthumb/job.rb
+- lib/rwebthumb/webthumb.rb
+- test/base_test.rb
+- test/helper.rb
+- test/job_test.rb
+- test/run_test.rb
+- test/webthumb_test.rb
+- README
+- init.rb
+has_rdoc: false
+homepage: http://labs.simplificator.com/
+post_install_message: 
+rdoc_options: []
+
+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: 2
+summary: rwebthumb provides a ruby interface for the webthumb.bluga.net
+test_files: []
+