vuzitruby 2.0.0 → 2.1.0

data/bin/vuzitcl

@@ -81,6 +81,10 @@ def help_command(args)
     print_usage_load
   when "delete"
     print_usage_delete
+  when "page"
+    print_usage_page
+  when "event"
+    print_usage_event
   when "upload"
     print_usage_upload
   when "search"
@@ -106,6 +110,113 @@ def load_command(args)
     puts "height: #{doc.page_height}"
     puts "size: #{doc.file_size}"
     puts "status: #{doc.status}"
+    puts "Download URL: #{Vuzit::Document.download_url(id, 'pdf')}"
+  rescue Vuzit::ClientException => ex
+    puts "Error occurred: #{ex.code}, #{ex.message}" 
+  end
+end
+
+# Performs the event command.  
+def event_command(args)
+  return if !global_parameters_load(args)
+
+  id = args.pop
+
+  options = Hash.new
+  opts = OptionParser.new do |opts|
+    opts.on("-e", "--event EVENT", "") do |value|
+      options[:event] = value
+    end
+    
+    opts.on("-c", "--custom CUSTOM", "") do |value|
+      options[:custom] = 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
+    events = Vuzit::Event.find_all(id, options)
+
+    events.each do |event|
+      print "[#{event.requested_at.strftime('%Y-%m-%d %H:%M:%S')}] "
+
+      if event.event == "page_view"
+        print "#{event.duration}s - "
+      end
+      print "#{event.event}"
+
+      if event.page != -1
+        print ", p#{event.page}"
+      end
+
+      if !event.custom.nil?
+        print " (#{event.custom})"
+      end
+
+      if !event.referer.nil?
+        print " - #{event.referer[8, 7]}"
+      end
+      print " - #{event.remote_host}"
+      puts " - #{event.user_agent[0, 8]}"
+    end
+
+    puts ""
+    puts "#{events.length} events found"
+  rescue Vuzit::ClientException => ex
+    puts "Error occurred: #{ex.code}, #{ex.message}" 
+  end
+end
+
+# Performs the page command.  
+def page_command(args)
+  id = args.pop
+  return if !global_parameters_load(args)
+
+  options = Hash.new
+  opts = OptionParser.new do |opts|
+    opts.on("-i", "--included [PAGES]", "") do |value|
+      options[:included_pages] = 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
+    pages = Vuzit::Page.find_all(id, options)
+
+    pages.each do |page|
+      puts "Page: #{page.number}"
+      puts "#{page.text}"
+      puts ''
+    end
+
+    puts ""
+    puts "#{pages.length} pages found"
   rescue Vuzit::ClientException => ex
     puts "Error occurred: #{ex.code}, #{ex.message}" 
   end
@@ -128,6 +239,10 @@ def search_command(args)
     opts.on("-o", "--offset [OFFSET]", "") do |value|
       options[:offset] = value
     end
+
+    opts.on("-O", "--output [OUTPUT]", "") do |value|
+      options[:output] = value
+    end
   end
 
   begin
@@ -141,16 +256,22 @@ def search_command(args)
 
     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 ''
+
+      if doc.page_count != -1
+        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
     end
+
+    puts ""
+    puts "#{docs.length} documents found"
   rescue Vuzit::ClientException => ex
     puts "Error occurred: #{ex.code}, #{ex.message}" 
   end
@@ -214,12 +335,28 @@ def print_usage_general
   puts "Available commands:"
   puts ""
   puts "  delete"
+  puts "  event"
   puts "  load"
+  puts "  page"
   puts "  upload"
   puts "  search"
   puts "  help"
 end
 
+# Prints the event options
+def print_usage_event
+  puts "page: Loads document event analytics."
+  puts "usage: event [OPTIONS] WEB_ID"
+  puts ""
+  puts "Valid options:"
+  puts "  -e, --event                    Event type to load"
+  puts "  -c, --custom                   Custom value to load"
+  puts "  -l, --limit                    Limits the number of results"
+  puts "  -o, --offset                   Offset the results at this number"
+  puts ""
+  print_usage_global
+end
+
 # Prints the global options
 def print_usage_global
   puts "Global Options:"
@@ -238,6 +375,19 @@ def print_usage_load
   print_usage_global
 end
 
+# Prints the search options
+def print_usage_page
+  puts "page: Loads page text for a document."
+  puts "usage: page [OPTIONS] WEB_ID"
+  puts ""
+  puts "Valid options:"
+  puts "  -i, --included                 Set range of pages to load (e.g '5,10-19')"
+  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 search options
 def print_usage_search
   puts "search: Searches for documents within Vuzit."
@@ -273,6 +423,10 @@ case command
     load_command(ARGV)
   when "delete"
     delete_command(ARGV)
+  when "event"
+    event_command(ARGV)
+  when "page"
+    page_command(ARGV)
   when "search"
     search_command(ARGV)
   when "upload"

data/lib/vuzitruby/base.rb

@@ -68,17 +68,14 @@ module Vuzit
     end
 
     # Converts a set of parameters to a URL. 
-    def self.parameters_to_url(resource, params, id = nil, extension = 'xml')
+    def self.parameters_to_url(base_url, params)
       params = parameters_clean(params)
 
       # The Ruby HTTP library does not want the "http://domain.com" in the 
       # URL as most other libraries do.  If the service URL is provided
       # then less tolerant web servers like IIS will reject it. 
       result = ''
-      result << "/" << resource
-
-      result << ("/" << id) if !id.nil?
-      result << "." << extension << "?"
+      result << "/" << base_url << "?"
 
       params.each_pair do |key, value|
         result << (key.to_s << "=" << CGI.escape(value.to_s) << "&")

data/lib/vuzitruby/document.rb

@@ -25,8 +25,10 @@ module Vuzit
     # Deletes a document by the ID.  Returns true if it succeeded.  It throws
     # a Vuzit::ClientException on failure.  It returns _true_ on success.  
     def self.destroy(id)
+      raise Vuzit::ClientException.new("id cannot be null") if id.nil?
+
       params = post_parameters("destroy", nil, id)
-      url = parameters_to_url("documents", params, id)
+      url = parameters_to_url("documents/#{id}.xml", params)
       http = http_connection
 
       request = Net::HTTP::Delete.new(url, {'User-Agent' => Vuzit::Service.user_agent})
@@ -56,16 +58,20 @@ module Vuzit
 
     # Returns a download URL. 
     def self.download_url(id, file_extension)
+      raise Vuzit::ClientException.new("id cannot be null") if id.nil?
+
       params = post_parameters("show", nil, id)
-      return parameters_to_url("documents", params, id, file_extension)
+      return Vuzit::Service.service_url + 
+             parameters_to_url("documents/#{id}.#{file_extension}", params)
     end
 
     # Finds a document by the ID.  It throws a Vuzit::ClientException on failure. 
     def self.find(id, options = {})
       raise ArgumentError, "Options must be a hash" unless options.kind_of? Hash
+      raise Vuzit::ClientException.new("id cannot be null") if id.nil?
 
       params = post_parameters("show", options, id)
-      url = parameters_to_url("documents", params, id)
+      url = parameters_to_url("documents/#{id}.xml", params)
       http = http_connection
 
       request = Net::HTTP::Get.new(url, {'User-Agent' => Vuzit::Service.user_agent})
@@ -103,9 +109,8 @@ module Vuzit
       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)
+      url = parameters_to_url("documents.xml", params)
       http = http_connection
 
       request = Net::HTTP::Get.new(url, {'User-Agent' => Vuzit::Service.user_agent})
@@ -193,7 +198,12 @@ module Vuzit
     def self.xml_to_document(node)
       result = Vuzit::Document.new
 
-      result.send(:set_id, node_value(node, 'web_id'))
+      id = node_value(node, "web_id")
+      if id == nil
+        raise Vuzit::ClientException.new("Unknown error occurred: #{response_body}");
+      end
+
+      result.send(:set_id, 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'))

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 2.0.0'
+    @@product_name = 'VuzitRuby Library 2.1.0'
     @@user_agent = @@product_name
 
     # TODO: For all of the set variables do not allow nil values

data/lib/vuzitruby.rb

@@ -4,7 +4,9 @@ $:.unshift(File.dirname(__FILE__))
 require 'rubygems'
 
 require 'vuzitruby/base'
+require 'vuzitruby/event'
 require 'vuzitruby/service'
 require 'vuzitruby/document'
+require 'vuzitruby/page'
 require 'vuzitruby/client_exception'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vuzitruby
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Brent Matzelle
@@ -9,14 +9,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 -05:00
+date: 2010-04-20 00:00:00 -04: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
+  Code library that allows developers to directly access 
+                       the Vuzit Document Viewer Web Service API through Ruby.
 email: support@vuzit.com
 executables: 
 - vuzitcl
@@ -33,7 +32,7 @@ files:
 - lib/vuzitruby/client_exception.rb
 - lib/vuzitruby/service.rb
 has_rdoc: true
-homepage: http://vuzit.com/
+homepage: http://wiki.github.com/vuzit/vuzitruby/
 licenses: []
 
 post_install_message: