primedia-endeca 1.3.3 → 1.3.4

data/endeca.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "1.3.3"
+  s.version = "1.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rein Henrichs", "Andy Stone"]
-  s.date = %q{2009-08-10}
+  s.date = %q{2009-08-25}
   s.description = %q{An Endeca client library for Ruby.}
   s.email = %q{}
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
@@ -15,6 +15,6 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{endeca}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{An Endeca client library for Ruby}
 end

data/lib/endeca/benchmarking.rb

@@ -4,15 +4,35 @@ module Endeca
   module Benchmarking
     # Log and benchmark the workings of a single block. Will only be called if
     # Endeca.debug and Endeca.benchmark are true.
-    def bm(title)
-      if Endeca.debug && Endeca.logger && Endeca.benchmark
+    def bm(metric_symbol, detail = nil)
+      if Endeca.analyze?
         result = nil
         ms = ::Benchmark.ms { result = yield }
-        Endeca.logger.debug("#{title}#{'%.1f' % ms}ms")
+        add_bm_detail(metric_symbol,ms,detail) if detail.to_s.strip.length > 0
+        increase_metric(metric_symbol, ms)
+        Endeca.logger.debug("#{metric_symbol.to_s}: #{'%.1f' % ms}ms")
         result
       else
         yield
       end
     end
+
+    def increase_metric(metric_symbol, up_value)
+      if Endeca.analyze?
+        Thread.current[:endeca] ||= {}
+        Thread.current[:endeca][metric_symbol] ||= 0
+        Thread.current[:endeca][metric_symbol] += up_value
+      end
+    end
+
+    private
+
+    def add_bm_detail(label,time,detail)
+      if Endeca.analyze?
+        Thread.current[:endeca] ||= {}
+        Thread.current[:endeca]["#{label}_detail"] ||= []
+        Thread.current[:endeca]["#{label}_detail"] << {:detail => detail, :time => time} 
+      end
+    end
   end
 end

data/lib/endeca/request.rb

@@ -1,15 +1,6 @@
 require 'uri'
 require 'endeca/caching'
 
-begin
-  require 'system_timer'
-  RequestTimer = SystemTimer
-rescue LoadError
-  require 'timeout'
-  RequestTimer = Timeout
-end
-
-
 module Endeca
   class RequestError < ::StandardError; end
 
@@ -26,6 +17,7 @@ module Endeca
 
     def perform
       raise RequestError, endeca_error[:message] if endeca_error?
+      Endeca.increase_metric(:request_count, 1)
       return response
     end
     
@@ -63,8 +55,8 @@ module Endeca
       Endeca.log "ENDECA ADAPTER REQUEST"
       Endeca.log "    parameters => " + @query.inspect
       Endeca.log "           uri => " + uri.to_s
-      Endeca.bm  "  request time => " do 
-        RequestTimer.timeout(Endeca.timeout) do
+      Endeca.bm(:request_time, "#{@path} #{@query.inspect}") do 
+        Endeca.timer.timeout(Endeca.timeout) do
           @response = Net::HTTP.get_response(uri) 
         end
       end
@@ -76,7 +68,9 @@ module Endeca
     def handle_response(response) #:nodoc:
       case response
       when Net::HTTPSuccess
-        JSON.parse(response.body)
+        Endeca.bm :parse_time do
+          @json = JSON.parse(response.body)
+        end
       else
         response.error! # raises exception corresponding to http error Net::XXX
       end

data/lib/endeca.rb

@@ -27,7 +27,7 @@ module Endeca
   extend Logging
 
   # :stopdoc:
-  VERSION = '1.3.3'
+  VERSION = '1.3.4'
   # :startdoc:
 
   # Returns the version string for the library.
@@ -42,15 +42,36 @@ module Endeca
     attr_accessor :debug
     attr_accessor :benchmark
     attr_accessor :timeout
+
+    def analyze?
+      debug && logger && benchmark
+    end
+
+    def timer
+      @timer ||= get_timer
+    end
+
+    private
+
+    def get_timer
+      require 'system_timer'
+      SystemTimer
+    rescue LoadError
+      require 'timeout'
+      Timeout
+    end
   end
 
   self.logger = Logger.new(STDOUT)
   self.debug  = false
   self.benchmark  = false
-  self.timeout = 5
+  self.timeout = 8
+
 
   # Endeca URIs require colons to be escaped
   def self.escape(str)
     URI.escape(str, /[^-_.!~*'()a-zA-Z\d;\/?@&=+$,\[\]]/n)
   end
 end
+
+puts ">> Using Endeca gem version: #{Endeca::VERSION}"

data/spec/endeca/benchmarking_spec.rb

@@ -4,6 +4,7 @@ describe Endeca::Benchmarking do
   class Helper
     extend Endeca::Benchmarking
   end
+
   describe "#benchmark" do
     before do
       @logger = mock('Logger')
@@ -15,8 +16,18 @@ describe Endeca::Benchmarking do
     end
 
     it "should log the title and the time to the Endeca logger" do
-      @logger.should_receive(:debug).with("title => 1.0ms")
-      Endeca.bm("title => "){ 1 }
+      @logger.should_receive(:debug).with("metric: 1.0ms")
+      Endeca.bm(:metric){ 1 }
+    end
+  end
+
+  describe "#add_bm_detail" do
+    it "should add info to the current thread" do
+      Endeca.stub!(:analyze?).and_return(true)
+
+      Endeca.send(:add_bm_detail, :metric, 1.1, 'query query')
+
+      Thread.current[:endeca]["metric_detail"][0].should == {:detail => "query query", :time => 1.1}
     end
   end
 end

data/spec/endeca/document_spec.rb

@@ -77,7 +77,7 @@ describe Endeca::Document do
       end
     end
 
-    describe '#inspect' do
+    describe '.inspect' do
       it "includes the class name" do
         @document.inspect.should include(Endeca::Document.name)
       end
@@ -370,4 +370,9 @@ describe Endeca::Document do
     end
   end
 
+  describe "#inspect" do
+    it "should return details of the Document class" do
+      Endeca::Document.inspect.should == "#<Endeca::Document>\nPath: \"http://endeca.example.com\"\nCollection Class: SubDocumentCollection\"\nMappings:\n\tfoo: {:new_foo=>nil}\n\t \nDefaultParams:\n\t \n"
+    end
+  end
 end

data/spec/endeca/map_spec.rb

@@ -109,4 +109,14 @@ describe Endeca::Map do
         should == {:F => "first_name:1|last_name:1|email:1"}
     end
   end
+
+  describe ".inspect" do
+    it "should return details of the map" do
+      query = {:foo => "bazz", :bizz => "somevalue"}
+      map = Endeca::Map.new :foo
+      map.into(:Ntk => :Ntt)
+      map.inspect.should include(":Ntk=>\"foo\"")
+      map.inspect.should include(":Ntt=>\"\"")
+    end
+  end
 end

data/spec/endeca_spec.rb

@@ -7,6 +7,31 @@ describe Endeca do
       Endeca.version.should == Endeca::VERSION
     end
   end
+
+  describe "#escape" do
+    query = 'N=5875 5922&Nf=geocode|GCLT 26.121900,-80.143600 32.18688&Nu=mgtcoid&Ns=searchonly|0||isapartment|1||sortorder|0&Ntk=showapartment|mgtcologodisplay&F=cityseopath:1|mediummgtcologo:1|mgtcodescription:1|mgtcoid:1|mgtcologo:1|mgtcologodisplay:1|mgtconame:1|msa_code:1|propertycity:1|propertystatelong:1|smallmgtcologo:1|webtollfree:1|mvtphone:1&Ntt=1|1&M=recs_per_page:99999|expand_all_dims:0'
+
+    Endeca.escape(query).should == 'N=5875%205922&Nf=geocode%7CGCLT%2026.121900,-80.143600%2032.18688&Nu=mgtcoid&Ns=searchonly%7C0%7C%7Cisapartment%7C1%7C%7Csortorder%7C0&Ntk=showapartment%7Cmgtcologodisplay&F=cityseopath%3A1%7Cmediummgtcologo%3A1%7Cmgtcodescription%3A1%7Cmgtcoid%3A1%7Cmgtcologo%3A1%7Cmgtcologodisplay%3A1%7Cmgtconame%3A1%7Cmsa_code%3A1%7Cpropertycity%3A1%7Cpropertystatelong%3A1%7Csmallmgtcologo%3A1%7Cwebtollfree%3A1%7Cmvtphone%3A1&Ntt=1%7C1&M=recs_per_page%3A99999%7Cexpand_all_dims%3A0'
+
+  end
+
+  describe "#get_timer" do
+    it "without system_timer available returns Timeout" do
+      Endeca.should_receive(:require).
+        with('system_timer').and_raise(LoadError)
+      Endeca.should_receive(:require).
+        with('timeout').and_return(true)
+
+      Endeca.send(:get_timer).should == Timeout
+    end
+
+    it "will return SystemTimer if available" do
+      Endeca.should_receive(:require).
+        with('system_timer').and_return(true)
+
+      Endeca.send(:get_timer).should == SystemTimer
+    end
+  end
 end
 
 # EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-10 00:00:00 -07:00
+date: 2009-08-25 00:00:00 -07:00
 default_executable: 
 dependencies: []