vuzitruby 1.2.1 → 2.0.0

data/README

@@ -5,7 +5,7 @@
 This is a library that allows developers to directly access the Vuzit Web 
 Service API through a simple Ruby script:
 
-http://vuzit.com/developer/documents_api
+http://vuzit.com/developer/web_service_api
 
 Below is a basic upload example:
 
@@ -95,6 +95,8 @@ Upload and View with the JavaScript API Example for a Rails RHTML file:
 
 == LICENSE
 
+Copyright (c) 2009-2010 Brent Matzelle, Vuzit LLC 
+
 Released under the MIT license: 
 
 http://www.opensource.org/licenses/mit-license.php

data/bin/vuzitcl

@@ -83,6 +83,8 @@ def help_command(args)
     print_usage_delete
   when "upload"
     print_usage_upload
+  when "search"
+    print_usage_search
   else
     error("Unknown option: [#{command}]")
   end
@@ -109,6 +111,51 @@ def load_command(args)
   end
 end
 
+# Performs the search command.  
+def search_command(args)
+  return if !global_parameters_load(args)
+
+  options = Hash.new
+  opts = OptionParser.new do |opts|
+    opts.on("-q", "--query [QUERY]", "") do |value|
+      options[:query] = value
+    end
+    
+    opts.on("-l", "--limit [LIMIT]", "") do |value|
+      options[:limit] = value
+    end
+
+    opts.on("-o", "--offset [OFFSET]", "") do |value|
+      options[:offset] = value
+    end
+  end
+
+  begin
+    opts.parse!(args)
+  rescue OptionParser::InvalidOption => e
+    e.recover(args)
+  end
+
+  begin
+    docs = Vuzit::Document.find_all(options)
+
+    docs.each do |doc|
+      puts "LOADED: #{doc.id}"
+      puts "title: #{doc.title}"
+      puts "subject: #{doc.subject}"
+      puts "pages: #{doc.page_count}"
+      puts "width: #{doc.page_width}"
+      puts "height: #{doc.page_height}"
+      puts "size: #{doc.file_size}"
+      puts "status: #{doc.status}"
+      puts "excerpt: #{doc.excerpt}"
+      puts ''
+    end
+  rescue Vuzit::ClientException => ex
+    puts "Error occurred: #{ex.code}, #{ex.message}" 
+  end
+end
+
 # Performs the load command.  
 def upload_command(args)
   path = args.pop
@@ -166,9 +213,10 @@ def print_usage_general
   puts ""
   puts "Available commands:"
   puts ""
-  puts "  upload"
   puts "  delete"
   puts "  load"
+  puts "  upload"
+  puts "  search"
   puts "  help"
 end
 
@@ -190,9 +238,22 @@ def print_usage_load
   print_usage_global
 end
 
+# Prints the search options
+def print_usage_search
+  puts "search: Searches for documents within Vuzit."
+  puts "usage: search [OPTIONS]"
+  puts ""
+  puts "Valid options:"
+  puts "  -q, --query                    Query keywords"
+  puts "  -l, --limit                    Limits the results to a number"
+  puts "  -o, --offset                   Offsets the results at this number"
+  puts ""
+  print_usage_global
+end
+
 # Prints the upload options
 def print_usage_upload
-  puts "upload: Upload a file to Vuzit."
+  puts "upload: Upload a document to Vuzit."
   puts "usage: upload [OPTIONS] PATH"
   puts ""
   puts "Valid options:"
@@ -212,6 +273,8 @@ case command
     load_command(ARGV)
   when "delete"
     delete_command(ARGV)
+  when "search"
+    search_command(ARGV)
   when "upload"
     upload_command(ARGV)
   when "help"

data/lib/vuzitruby/base.rb

@@ -33,6 +33,23 @@ module Vuzit
       return result
     end
 
+    # Returns the value of a child node. 
+    def self.node_value(node, key)
+      result = nil
+
+      if node.elements[key] != nil
+        result = node.elements[key].text
+      end
+
+      return result
+    end
+
+    # Returns the integer value of a child node or -1 if none.
+    def self.node_value_int(node, key)
+      text = node_value(node, key)
+      return (text == nil) ? -1 : text.to_i
+    end
+
     # Returns a clean version of the parameters hash table.  
     def self.parameters_clean(params)
       result = Hash.new
@@ -80,13 +97,7 @@ module Vuzit
       timestamp = Time.now
       params[:timestamp] = timestamp.to_i # time since epoch
 
-      pages = ''
-      if params.has_key?(:included_pages)
-        pages = params[:included_pages]
-      end
-      label = ''
-
-      signature = Vuzit::Service::signature(method, id, timestamp, pages, label)
+      signature = Vuzit::Service::signature(method, id, timestamp, params)
       params[:signature] = signature
 
       return params
@@ -101,6 +112,12 @@ module Vuzit
       request = Net::HTTP::Post.new('/documents', {'User-Agent' => Vuzit::Service.user_agent})
       request.multipart_params = parameters_clean(fields)
 
+      # If the stream is over 3 megabytes in size
+      if fields[:upload].stat.size > (3 * 1048576)
+        # Set the timeout to 5 minutes
+        http.read_timeout = (5 * 60 * 1000)
+      end
+
       tries = 3
       begin
         tries -= 1

data/lib/vuzitruby/document.rb

@@ -13,11 +13,12 @@ module Vuzit
     attr_reader :page_height # Page height of the document in pixels
     attr_reader :file_size # File size of the original document bytes
     attr_reader :status # Status of the document
+    attr_reader :excerpt # Text excerpt of the document
 
     # Constructor.  
     def initialize #:nodoc:
       # Set the defaults
-      @id = @title = @subject = nil
+      @id = @title = @subject = @excerpt = nil
       @page_count = @page_width = @page_height = @file_size = @status = -1
     end
 
@@ -89,18 +90,47 @@ module Vuzit
 
       id = doc.root.elements['web_id']
       if id == nil
-        raise Vuzit::ClientException.new("Unknown error occurred");
+        raise Vuzit::ClientException.new("The web_id element missing - unknown error occurred");
       end
 
-      result = Vuzit::Document.new
-      result.send(:set_id, id.text)
-      result.send(:set_title, doc.root.elements['title'].text)
-      result.send(:set_subject, doc.root.elements['subject'].text)
-      result.send(:set_page_count, doc.root.elements['page_count'].text.to_i)
-      result.send(:set_page_width, doc.root.elements['width'].text.to_i)
-      result.send(:set_page_height, doc.root.elements['height'].text.to_i)
-      result.send(:set_file_size, doc.root.elements['file_size'].text.to_i)
-      result.send(:set_status, doc.root.elements['status'].text.to_i)
+      result = xml_to_document(doc.root)
+
+      return result
+    end
+
+    # Performs a search to return all documents as defined by the options.
+    def self.find_all(options = {})
+      raise ArgumentError, "Options must be a hash" unless options.kind_of? Hash
+
+      result = Array.new
+      options[:output] = "summary"
+      params = post_parameters("index", options)
+      url = parameters_to_url("documents", params)
+      http = http_connection
+
+      request = Net::HTTP::Get.new(url, {'User-Agent' => Vuzit::Service.user_agent})
+      response = http.start { http.request(request) }
+
+      # TODO: Check if response.code.to_i != 200
+
+      begin
+        doc = REXML::Document.new(response.body)
+      rescue Exception => ex
+        raise Vuzit::ClientException.new("XML error: #{ex.message}")
+      end
+
+      if doc.root == nil
+        raise Vuzit::ClientException.new("No response from server");
+      end
+
+      code = doc.root.elements['code']
+      if code != nil
+        raise Vuzit::ClientException.new(doc.root.elements['msg'].text, code.text.to_i);
+      end
+
+      doc.root.elements.each("document") do |node|
+        result << xml_to_document(node)
+      end
 
       return result
     end
@@ -115,12 +145,20 @@ module Vuzit
 
       params = post_parameters("create", options)
       response = nil
-
-      File.open(file, "rb") do |f|
-        params[:upload] = f
-        response = send_request 'create', params
+      
+      # Determine type and set to IO for data such as that from a database
+      case file
+      when IO 
+        f = file
+      when String
+        f = File.open(file, 'rb')
+      else
+        raise ArgumentError, 'Expects String or IO argument'
       end
 
+      params[:upload] = f
+      response = send_request 'create', params
+
       # TODO: check the response.code.to_i to make sure it's 201
 
       begin
@@ -151,6 +189,23 @@ module Vuzit
 
     private
 
+    # Converts an XML object to a Document instance.
+    def self.xml_to_document(node)
+      result = Vuzit::Document.new
+
+      result.send(:set_id, node_value(node, 'web_id'))
+      result.send(:set_title, node_value(node, 'title'))
+      result.send(:set_subject, node_value(node, 'subject'))
+      result.send(:set_page_count, node_value_int(node, 'page_count'))
+      result.send(:set_page_width, node_value_int(node, 'width'))
+      result.send(:set_page_height, node_value_int(node, 'height'))
+      result.send(:set_file_size, node_value_int(node, 'file_size'))
+      result.send(:set_status, node_value_int(node, 'status'))
+      result.send(:set_excerpt, node_value(node, 'excerpt'))
+
+      return result
+    end
+
     # Private setter methods so that you can set the internal variables but 
     # not allow the setting of the public methods.  
     def set_id(value) @id = value; end
@@ -161,5 +216,6 @@ module Vuzit
     def set_page_width(value) @page_width = value; end
     def set_page_height(value) @page_height = value; end
     def set_file_size(value) @file_size = value; end
+    def set_excerpt(value) @excerpt = value; end
   end
 end

data/lib/vuzitruby/service.rb

@@ -47,7 +47,7 @@ module Vuzit
     @@public_key = nil
     @@private_key = nil
     @@service_url = 'http://vuzit.com'
-    @@product_name = 'VuzitRuby Library 1.2.1'
+    @@product_name = 'VuzitRuby Library 2.0.0'
     @@user_agent = @@product_name
 
     # TODO: For all of the set variables do not allow nil values
@@ -103,7 +103,7 @@ module Vuzit
     # Returns The signature string.  NOTE: If you are going to use this 
     # with the Vuzit Javascript API then the value must be encoded with the 
     # CGI.escape function.  See the Wiki example for more information.  
-    def self.signature(service, id = '', time = nil, pages = '', label = '')
+    def self.signature(service, id = '', time = nil, options = {})
       if Vuzit::Service.public_key == nil || Vuzit::Service.private_key == nil
         raise Vuzit::ClientException.new("The public_key or private_key variables are nil")
       end
@@ -117,7 +117,14 @@ module Vuzit
         raise Vuzit::ClientException.new("Vuzit::Service.private_key not set")
       end
 
-      msg = "#{service}#{id}#{@@public_key}#{time}#{pages}#{label}"
+      msg = "#{service}#{id}#{@@public_key}#{time}"
+
+      ['included_pages', 'watermark', 'query'].each do |item|
+        if options.include?(item.to_sym)
+          msg << options[item.to_sym].to_s
+        end
+      end
+
       hmac = hmac_sha1(@@private_key, msg)
       result = Base64::encode64(hmac).chomp
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vuzitruby
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors: 
 - Brent Matzelle
@@ -9,11 +9,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-31 00:00:00 -04:00
+date: 2010-02-08 00:00:00 -05:00
 default_executable: vuzitcl
 dependencies: []
 
-description: This is a library for the Vuzit Web Services API.  For  more information on the platform, visit  http://vuzit.com/developer
+description: |-
+  This is a library for the Vuzit Web Services API.  For 
+                       more information on the platform, visit 
+                       http://vuzit.com/developer
 email: support@vuzit.com
 executables: 
 - vuzitcl
@@ -31,6 +34,8 @@ files:
 - lib/vuzitruby/service.rb
 has_rdoc: true
 homepage: http://vuzit.com/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -52,9 +57,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: vuzitruby
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ruby client library for the Vuzit Web Services API
 test_files: []