endeca 1.4.2 → 1.5.0

data/endeca.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "1.4.2"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Primedia Team"]
-  s.date = %q{2010-02-19}
+  s.date = %q{2010-05-06}
   s.email = %q{}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
      "spec/endeca/dimension_spec.rb",
      "spec/endeca/document_collection_spec.rb",
      "spec/endeca/document_spec.rb",
+     "spec/endeca/logging_spec.rb",
      "spec/endeca/map_spec.rb",
      "spec/endeca/readers_spec.rb",
      "spec/endeca/refinement_dimension_spec.rb",
@@ -57,7 +58,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/primedia/endeca-ruby}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Endeca adapter for use with the Endeca Bridge}
   s.test_files = [
     "spec/endeca_spec.rb",
@@ -67,6 +68,7 @@ Gem::Specification.new do |s|
      "spec/endeca/request_spec.rb",
      "spec/endeca/transformer_spec.rb",
      "spec/endeca/breadcrumb_spec.rb",
+     "spec/endeca/logging_spec.rb",
      "spec/endeca/document_spec.rb",
      "spec/endeca/refinement_spec.rb",
      "spec/endeca/map_spec.rb",

data/lib/endeca.rb

@@ -1,30 +1,19 @@
 require 'curb'
 require 'yajl'
 require 'logger'
+require 'uri'
 
 $:.unshift(File.dirname(__FILE__))
 require 'core_ext'
 require 'endeca/logging'
 require 'endeca/benchmarking'
-require 'endeca/readers'
-require 'endeca/map'
-require 'endeca/transformer'
-require 'endeca/dimension'
-require 'endeca/refinement_dimension'
-require 'endeca/refinement'
-require 'endeca/breadcrumbs'
-require 'endeca/breadcrumb'
-require 'endeca/request'
-require 'endeca/document_collection'
-require 'endeca/document'
-
 
 module Endeca
   extend Benchmarking
   extend Logging
 
   # :stopdoc:
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
   # :startdoc:
 
   # Returns the version string for the library.
@@ -32,23 +21,27 @@ module Endeca
     VERSION
   end
 
-  # Set Endeca.debug = true to turn on query logging
-  # Set Endeca.benchmark = true to turn on query benchmarking
+  # Set ENV['ENDECA_DEBUG'] = true to turn on query logging
+  # Set ENV['ENDECA_BENCHMARK'] = true to turn on query benchmarking
   class << self
     attr_accessor :logger
-    attr_accessor :debug
-    attr_accessor :benchmark
     attr_accessor :timeout
 
     def analyze?
-      debug && logger && benchmark
+      debug? && benchmark?
+    end
+
+    def debug?
+      ENV['ENDECA_DEBUG'] == 'true' 
+    end
+
+    def benchmark?
+      ENV['ENDECA_BENCHMARK'] == 'true'
     end
 
   end
 
   self.logger = Logger.new(STDOUT)
-  self.debug  = false
-  self.benchmark  = false
   self.timeout = 8
 
   # Endeca URIs require colons to be escaped
@@ -57,4 +50,16 @@ module Endeca
   end
 end
 
+require 'endeca/readers'
+require 'endeca/map'
+require 'endeca/transformer'
+require 'endeca/dimension'
+require 'endeca/refinement_dimension'
+require 'endeca/refinement'
+require 'endeca/breadcrumbs'
+require 'endeca/breadcrumb'
+require 'endeca/request'
+require 'endeca/document_collection'
+require 'endeca/document'
+
 puts ">> Using Endeca gem version: #{Endeca::VERSION}"

data/lib/endeca/benchmarking.rb

@@ -3,34 +3,26 @@ module Endeca
     # Log and benchmark the workings of a single block. Will only be called if
     # Endeca.debug and Endeca.benchmark are true.
     def bm(metric_symbol, detail = nil)
-      if Endeca.analyze?
-        result = nil
-        ms = ::Benchmark.ms { result = yield }
-        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
+      result = nil
+      ms = ::Benchmark.ms { result = yield }
+      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
     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
+      Thread.current[:endeca] ||= {}
+      Thread.current[:endeca][metric_symbol] ||= 0
+      Thread.current[:endeca][metric_symbol] += up_value
     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
+      Thread.current[:endeca] ||= {}
+      Thread.current[:endeca]["#{label}_detail"] ||= []
+      Thread.current[:endeca]["#{label}_detail"] << {:detail => detail, :time => time} 
     end
   end
 end

data/lib/endeca/logging.rb

@@ -3,7 +3,8 @@ module Endeca
     # Log and benchmark the workings of a single block. Will only be called if
     # Endeca.benchmark is true
     def log(message)
-      Endeca.logger.debug(message) if Endeca.debug && Endeca.logger
+      logger = Endeca.logger
+      logger.debug(message) if Endeca.debug? && logger
     end
   end
 end

data/lib/endeca/map.rb

@@ -126,7 +126,7 @@ module Endeca
     end
 
     def inspect
-      perform({ 'old_key' => "inspect_data" }).inspect
+      perform({ @old_key  => "inspect_data" }).inspect
     end
 
     private

data/lib/endeca/request.rb

@@ -13,10 +13,17 @@ module Endeca
       @query = query
     end
 
-    def perform
-      raise RequestError, endeca_error[:message] if endeca_error?
-      Endeca.increase_metric(:request_count, 1)
-      return response
+    if Endeca.analyze?
+      def perform
+        raise RequestError, endeca_error[:message] if endeca_error?
+        Endeca.increase_metric(:request_count, 1)
+        return response
+      end
+    else
+      def perform
+        raise RequestError, endeca_error[:message] if endeca_error?
+        return response
+      end
     end
     
     def response
@@ -47,37 +54,61 @@ module Endeca
       !endeca_error.nil?
     end
 
-    def get_response #:nodoc:
-       Endeca.log "ENDECA ADAPTER REQUEST"
-       Endeca.log "    parameters => " + @query.inspect
-       Endeca.log "           uri => " + uri.to_s
-       Endeca.bm(:request_time, "#{@path} #{@query.inspect}") do 
-         begin
-           @response = Curl::Easy.perform(uri.to_s) do |curl|
-             curl.timeout = Endeca.timeout
-           end
-         rescue => e
-           raise RequestError, e.message
-         end
-       end
-
-       return @response
-     end
-
-     def handle_response(response) #:nodoc:
-       case response.response_code.to_s
-       when "200"
-         Endeca.bm :parse_time do
+    if Endeca.analyze?
+      def get_response #:nodoc:
+         Endeca.log "ENDECA ADAPTER REQUEST"
+         Endeca.log "    parameters => " + @query.inspect
+         Endeca.log "           uri => " + uri.to_s
+         Endeca.bm(:request_time, "#{@path} #{@query.inspect}") do 
            begin
-             @json = Yajl::Parser.parse(response.body_str)
-           rescue Yajl::ParseError => e
-             raise RequestError, "JSON Parse error: #{e}"
+             Curl::Easy.perform(uri.to_s) do |curl|
+               curl.timeout = Endeca.timeout
+             end
+           rescue => e
+             raise RequestError, e.message
            end
          end
-       else
-         raise RequestError, "#{response.response_code} HTTP Error"
        end
-     end
+    else
+      def get_response #:nodoc:
+        Curl::Easy.perform(uri.to_s) do |curl|
+          curl.timeout = Endeca.timeout
+        end
+      rescue => e
+        raise RequestError, e.message
+      end
+    end
+    
+    if Endeca.analyze?
+    
+      def handle_response(response) #:nodoc:
+        case response.response_code.to_s
+        when "200"
+          Endeca.bm :parse_time do
+            begin
+              Yajl::Parser.parse(response.body_str)
+            rescue Yajl::ParseError => e
+              raise RequestError, "JSON Parse error: #{e}"
+            end
+          end
+        else
+          raise RequestError, "#{response.response_code} HTTP Error"
+        end
+      end
+    else
+      def handle_response(response) #:nodoc:
+        case response.response_code.to_s
+        when "200"
+          begin
+            Yajl::Parser.parse(response.body_str)
+          rescue Yajl::ParseError => e
+            raise RequestError, "JSON Parse error: #{e}"
+          end
+        else
+          raise RequestError, "#{response.response_code} HTTP Error"
+        end
+      end
+    end
 
      def query_string
        @path.match(/\?(.*)$/)

data/spec/endeca/document_spec.rb

@@ -383,7 +383,7 @@ describe Endeca::Document do
 
   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"
+      Endeca::Document.inspect.should == "#<Endeca::Document>\nPath: \"http://endeca.example.com\"\nCollection Class: SubDocumentCollection\"\nMappings:\n\tfoo: {:new_foo=>\"inspect_data\"}\n\t \nDefaultParams:\n\t \n"
     end
   end
 end

data/spec/endeca/logging_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class Logit
+  include Endeca::Logging
+end
+
+describe Endeca::Logging do
+  before do
+    @logit = Logit.new
+  end
+
+  describe '.log' do
+    it 'calls endeca logger' do
+      logger = mock('logger')
+      Endeca.should_receive(:debug?).and_return(true)
+      Endeca.should_receive(:logger).and_return(logger)
+
+      logger.should_receive(:debug).with('hiya')
+
+      @logit.log('hiya')
+    end
+  end
+end

data/spec/endeca/map_spec.rb

@@ -116,7 +116,7 @@ describe Endeca::Map do
       map = Endeca::Map.new :foo
       map.into(:Ntk => :Ntt)
       map.inspect.should include(":Ntk=>\"foo\"")
-      map.inspect.should include(":Ntt=>\"\"")
+      map.inspect.should include(":Ntt=>\"inspect_data\"")
     end
   end
 end

data/spec/endeca_spec.rb

@@ -14,6 +14,34 @@ describe Endeca do
     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
+
+  it "#anaylze" do
+    Endeca.should_receive(:debug?).and_return(true)
+    Endeca.should_receive(:benchmark?).and_return(true)
+
+    Endeca.analyze?
+  end
+
+  it "#debug?" do
+    ENV['ENDECA_DEBUG'] = 'true'
+
+    Endeca.debug?.should == true
+
+    ENV['ENDECA_DEBUG'] = 'false'
+
+    Endeca.debug?.should == false
+  end
+
+  it "#benchmark?" do
+    ENV['ENDECA_BENCHMARK'] = 'true'
+
+    Endeca.benchmark?.should == true
+
+    ENV['ENDECA_BENCHMARK'] = 'false'
+
+    Endeca.benchmark?.should == false
+  end
+
 end
 
 # EOF

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: endeca
 version: !ruby/object:Gem::Version 
-  version: 1.4.2
+  prerelease: false
+  segments: 
+  - 1
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Primedia Team
@@ -9,39 +14,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-19 00:00:00 -05:00
+date: 2010-05-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: curb
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 6
+        - 0
         version: 0.6.6.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: yajl-ruby
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 1
         version: 0.7.1
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: 
 email: ""
 executables: []
@@ -79,6 +95,7 @@ files:
 - spec/endeca/dimension_spec.rb
 - spec/endeca/document_collection_spec.rb
 - spec/endeca/document_spec.rb
+- spec/endeca/logging_spec.rb
 - spec/endeca/map_spec.rb
 - spec/endeca/readers_spec.rb
 - spec/endeca/refinement_dimension_spec.rb
@@ -102,18 +119,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Endeca adapter for use with the Endeca Bridge
@@ -125,6 +144,7 @@ test_files:
 - spec/endeca/request_spec.rb
 - spec/endeca/transformer_spec.rb
 - spec/endeca/breadcrumb_spec.rb
+- spec/endeca/logging_spec.rb
 - spec/endeca/document_spec.rb
 - spec/endeca/refinement_spec.rb
 - spec/endeca/map_spec.rb