vuzitruby 2.1.0 → 2.1.1

data/bin/vuzitcl

@@ -349,10 +349,10 @@ def print_usage_event
   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 "  -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
@@ -381,9 +381,9 @@ def print_usage_page
   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 "  -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
@@ -394,9 +394,10 @@ def print_usage_search
   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 "  -q, --query         Query keywords"
+  puts "  -o, --offset        Offsets the results at this number"
+  puts "  -l, --limit         Limits the results to a number"
+  puts "  -O, --output        Output more document info including title and excerpt"
   puts ""
   print_usage_global
 end

data/lib/vuzitruby/event.rb

@@ -0,0 +1,98 @@
+require 'rexml/document'
+
+module Vuzit
+
+  # Class for loading document event analytics.  
+  class Event < Base
+    attr_reader :web_id
+    attr_reader :event
+    attr_reader :remote_host
+    attr_reader :referer
+    attr_reader :user_agent
+    attr_reader :custom
+    attr_reader :requested_at
+    attr_reader :page
+    attr_reader :duration
+
+    # Constructor.  
+    def initialize #:nodoc:
+      # Set the defaults
+      @web_id = @page = @duration = -1
+      @event = @remote_host = @referer = @user_agent = @custom = @requested_at = nil
+    end
+
+    # Performs a search to return all documents as defined by the options.
+    def self.find_all(id, options = {})
+      raise Vuzit::ClientException.new("id cannot be null") if id.nil?
+      raise ArgumentError, "Options must be a hash" unless options.kind_of? Hash
+
+      result = Array.new
+      params = post_parameters("show", options, id)
+      params[:web_id] = id
+      url = parameters_to_url("events.xml", 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("event") do |node|
+        result << xml_to_event(node)
+      end
+
+      return result
+    end
+
+    private
+
+    # Converts an XML object to an Event instance.
+    def self.xml_to_event(node)
+      result = Vuzit::Event.new
+
+      id = node_value(node, "web_id")
+      if id == nil
+        raise Vuzit::ClientException.new("Unknown error occurred: #{response_body}");
+      end
+
+      result.send(:set_web_id, id)
+      result.send(:set_event, node_value(node, 'event'))
+      result.send(:set_remote_host, node_value(node, 'remote_host'))
+      result.send(:set_referer, node_value(node, 'referer'))
+      result.send(:set_user_agent, node_value(node, 'user_agent'))
+      result.send(:set_custom, node_value(node, 'custom'))
+      result.send(:set_requested_at, node_value_int(node, 'requested_at'))
+      result.send(:set_page, node_value_int(node, 'page'))
+      result.send(:set_duration, node_value_int(node, 'duration'))
+
+      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_web_id(value) @web_id = value; end
+    def set_event(value) @event = value; end
+    def set_remote_host(value) @remote_host = value; end
+    def set_referer(value) @referer = value; end
+    def set_user_agent(value) @user_agent = value; end
+    def set_custom(value) @custom = value; end
+    def set_requested_at(value) @requested_at = Time.at(value); end
+    def set_page(value) @page = value; end
+    def set_duration(value) @duration = value; end
+  end
+end

data/lib/vuzitruby/page.rb

@@ -0,0 +1,70 @@
+require 'rexml/document'
+
+module Vuzit
+
+  # Class for loading the Vuzit pages API.  
+  class Page < Base
+    attr_reader :number
+    attr_reader :text
+
+    # Constructor.  
+    def initialize #:nodoc:
+      # Set the defaults
+      @number = -1
+      @text = nil
+    end
+
+    # Performs a search to return all documents as defined by the options.
+    def self.find_all(id, options = {})
+      raise Vuzit::ClientException.new("id cannot be null") if id.nil?
+      raise ArgumentError, "Options must be a hash" unless options.kind_of? Hash
+
+      result = Array.new
+      params = post_parameters("index", options, id)
+      url = parameters_to_url("documents/#{id}/pages.xml", 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("page") do |node|
+        result << xml_to_page(node)
+      end
+
+      return result
+    end
+
+    private
+
+    # Converts an XML object to a Page instance.
+    def self.xml_to_page(node)
+      result = Vuzit::Page.new
+
+      result.send(:set_number, node_value_int(node, 'number'))
+      result.send(:set_text, node_value(node, 'text'))
+
+      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_number(value) @number = value; end
+    def set_text(value) @text = 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 2.1.0'
+    @@product_name = 'VuzitRuby Library 2.1.1'
     @@user_agent = @@product_name
 
     # TODO: For all of the set variables do not allow nil values

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vuzitruby
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors: 
 - Brent Matzelle
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 -04:00
+date: 2010-04-22 00:00:00 -04:00
 default_executable: vuzitcl
 dependencies: []
 
@@ -29,6 +29,8 @@ files:
 - lib/vuzitruby.rb
 - lib/vuzitruby/base.rb
 - lib/vuzitruby/document.rb
+- lib/vuzitruby/event.rb
+- lib/vuzitruby/page.rb
 - lib/vuzitruby/client_exception.rb
 - lib/vuzitruby/service.rb
 has_rdoc: true