endeca 1.3.8 → 1.4.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.swp
+.swn
+.swp
+.DS_Store
+coverage/
+pkg/
+doc/

data/Rakefile

@@ -1,22 +1,10 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
+require 'rubygems'
 
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  begin
-    load 'tasks/setup.rb'
-  rescue LoadError
-    raise RuntimeError, '### please install the "bones" gem ###'
-  end
-end
-
-begin; require 'metric_fu'; rescue LoadError; end
+require File.join(File.dirname(__FILE__),'lib', 'endeca')
 
-ensure_in_path 'lib'
-require 'endeca'
+desire('rake')
+desire('rcov')
+desire('spec/rake/spectask')
 
 task :default => 'rcov'
 
@@ -39,14 +27,18 @@ Spec::Rake::SpecTask.new(:rcov) do |t|
   t.rcov_opts = IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
 end
 
-PROJ.name = 'endeca'
-PROJ.authors = ['Rein Henrichs', 'Andy Stone']
-PROJ.email = ''
-PROJ.url = 'http://github.com/primedia/endeca-ruby'
-PROJ.version = Endeca::VERSION
-PROJ.rubyforge.name = 'endeca'
-PROJ.readme_file = "README.rdoc"
-PROJ.exclude << '.swp'
-PROJ.exclude << '.gitignore'
-
-# EOF
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "endeca"
+    gemspec.version = Endeca.version
+    gemspec.summary = "Endeca adapter for use with the Endeca Bridge"
+    gemspec.email = ""
+    gemspec.homepage = 'http://github.com/primedia/endeca-ruby'
+    gemspec.authors = ["Primedia Team"]
+    gemspec.add_development_dependency('rspec')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/endeca.gemspec

@@ -1,33 +1,92 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "1.3.8"
+  s.version = "1.4.0"
 
   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-11-13}
-  s.description = %q{An Endeca client library for Ruby.}
+  s.authors = ["Primedia Team"]
+  s.date = %q{2010-02-19}
   s.email = %q{}
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
-  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "endeca.gemspec", "example/benchmark.rb", "example/listing.rb", "lib/class_to_proc.rb", "lib/core_ext.rb", "lib/endeca.rb", "lib/endeca/benchmarking.rb", "lib/endeca/breadcrumb.rb", "lib/endeca/breadcrumbs.rb", "lib/endeca/dimension.rb", "lib/endeca/document.rb", "lib/endeca/document_collection.rb", "lib/endeca/logging.rb", "lib/endeca/map.rb", "lib/endeca/readers.rb", "lib/endeca/refinement.rb", "lib/endeca/refinement_dimension.rb", "lib/endeca/request.rb", "lib/endeca/transformer.rb", "spec/core_ext_spec.rb", "spec/endeca/benchmarking_spec.rb", "spec/endeca/breadcrumb_spec.rb", "spec/endeca/dimension_spec.rb", "spec/endeca/document_collection_spec.rb", "spec/endeca/document_spec.rb", "spec/endeca/map_spec.rb", "spec/endeca/readers_spec.rb", "spec/endeca/refinement_dimension_spec.rb", "spec/endeca/refinement_spec.rb", "spec/endeca/request_spec.rb", "spec/endeca/transformer_spec.rb", "spec/endeca_spec.rb", "spec/rcov.opts", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "endeca.gemspec",
+     "example/benchmark.rb",
+     "example/listing.rb",
+     "lib/core_ext.rb",
+     "lib/endeca.rb",
+     "lib/endeca/benchmarking.rb",
+     "lib/endeca/breadcrumb.rb",
+     "lib/endeca/breadcrumbs.rb",
+     "lib/endeca/dimension.rb",
+     "lib/endeca/document.rb",
+     "lib/endeca/document_collection.rb",
+     "lib/endeca/logging.rb",
+     "lib/endeca/map.rb",
+     "lib/endeca/readers.rb",
+     "lib/endeca/refinement.rb",
+     "lib/endeca/refinement_dimension.rb",
+     "lib/endeca/request.rb",
+     "lib/endeca/transformer.rb",
+     "spec/core_ext_spec.rb",
+     "spec/endeca/benchmarking_spec.rb",
+     "spec/endeca/breadcrumb_spec.rb",
+     "spec/endeca/dimension_spec.rb",
+     "spec/endeca/document_collection_spec.rb",
+     "spec/endeca/document_spec.rb",
+     "spec/endeca/map_spec.rb",
+     "spec/endeca/readers_spec.rb",
+     "spec/endeca/refinement_dimension_spec.rb",
+     "spec/endeca/refinement_spec.rb",
+     "spec/endeca/request_spec.rb",
+     "spec/endeca/transformer_spec.rb",
+     "spec/endeca_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
   s.homepage = %q{http://github.com/primedia/endeca-ruby}
-  s.rdoc_options = ["--main", "README.rdoc"]
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{endeca}
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{An Endeca client library for Ruby}
+  s.summary = %q{Endeca adapter for use with the Endeca Bridge}
+  s.test_files = [
+    "spec/endeca_spec.rb",
+     "spec/core_ext_spec.rb",
+     "spec/endeca/document_collection_spec.rb",
+     "spec/endeca/readers_spec.rb",
+     "spec/endeca/request_spec.rb",
+     "spec/endeca/transformer_spec.rb",
+     "spec/endeca/breadcrumb_spec.rb",
+     "spec/endeca/document_spec.rb",
+     "spec/endeca/refinement_spec.rb",
+     "spec/endeca/map_spec.rb",
+     "spec/endeca/refinement_dimension_spec.rb",
+     "spec/endeca/dimension_spec.rb",
+     "spec/endeca/benchmarking_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bones>, [">= 2.4.0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<bones>, [">= 2.4.0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<bones>, [">= 2.4.0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
+

data/lib/core_ext.rb

@@ -1,4 +1,18 @@
+module Kernel
+  def desire(library)
+    require library
+    true
+  rescue LoadError
+    STDERR.puts "warning: #{library} gem desired but not found."
+    false
+  end
+end
+
 class Object
+  def self.ruby_version
+    RUBY_VERSION
+  end
+
   def blank?
     respond_to?(:empty?) ? empty? : !self
   end
@@ -13,7 +27,7 @@ end
 require 'benchmark'
 class << Benchmark
   # Earlier Ruby had a slower implementation.
-  if RUBY_VERSION < '1.8.7'
+  if ruby_version < '1.8.7'
     remove_method :realtime
 
     def realtime

data/lib/endeca.rb

@@ -1,11 +1,9 @@
-require 'rubygems'
-require 'net/http'
-require 'json'
+require 'curb'
+require 'yajl'
 require 'logger'
 
 $:.unshift(File.dirname(__FILE__))
 require 'core_ext'
-require 'class_to_proc'
 require 'endeca/logging'
 require 'endeca/benchmarking'
 require 'endeca/readers'
@@ -26,7 +24,7 @@ module Endeca
   extend Logging
 
   # :stopdoc:
-  VERSION = '1.3.8'
+  VERSION = '1.4.0'
   # :startdoc:
 
   # Returns the version string for the library.
@@ -46,19 +44,6 @@ module Endeca
       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)
@@ -66,7 +51,6 @@ module Endeca
   self.benchmark  = false
   self.timeout = 8
 
-
   # Endeca URIs require colons to be escaped
   def self.escape(str)
     URI.escape(str, /[^-_.!~*'()a-zA-Z\d;\/?@&=+$,\[\]]/n)

data/lib/endeca/benchmarking.rb

@@ -1,5 +1,3 @@
-require 'benchmark'
-
 module Endeca
   module Benchmarking
     # Log and benchmark the workings of a single block. Will only be called if

data/lib/endeca/breadcrumb.rb

@@ -17,10 +17,6 @@ module Endeca
       breadcrumb_class.new(raw)
     end
     
-    def self.to_proc
-      proc(&method(:create))
-    end
-
     attr_reader :raw
     def initialize(raw={})
       @raw = raw

data/lib/endeca/dimension.rb

@@ -2,7 +2,6 @@ module Endeca
   class Dimension
     include Comparable
     include Readers
-    extend ClassToProc
 
     reader \
       "DimValueName"  => :name,

data/lib/endeca/document.rb

@@ -7,7 +7,6 @@ module Endeca
   # typecasting) and a few basic examples are provided (i.e. +integer_reader+).
   class Document
     include Readers
-    extend ClassToProc
     extend Transformer
 
     inherited_accessor :mappings, {}
@@ -52,7 +51,7 @@ DefaultParams:\n\t#{get_default_params.collect{|k,v| "#{k}: #{v.inspect}\n\t"}.t
       @dimensions = {}
       (raw['Dimensions'] || {}).each do |name, values|
         values = [values] unless Array === values
-        @dimensions[name] = values.map(&Dimension)
+        @dimensions[name] = values.map{|value| Dimension.new(value)}
       end
       @dimensions
     end
@@ -87,7 +86,7 @@ DefaultParams:\n\t#{get_default_params.collect{|k,v| "#{k}: #{v.inspect}\n\t"}.t
     #   Listing.find(:first, :available => true)
     def self.find(what, query_options={})
       case what
-      when Integer, /^[A-Z\d]+$/
+      when Integer, /^[A-Za-z\d]+$/
         by_id(what, query_options)
       when String
         all(what)

data/lib/endeca/document_collection.rb

@@ -18,7 +18,6 @@ module Endeca
   # borrowed from Rake::FileList)
   class DocumentCollection
     include Readers
-    extend ClassToProc
 
     attr_reader :raw
     def initialize(raw, document_klass=Document)
@@ -59,9 +58,9 @@ module Endeca
     # The internal collection of Document objects. Array methods are delegated here. 
     def documents
       if @raw['Records']
-        @documents ||= @raw['Records'].map(&@document_klass)
+        @documents ||= @raw['Records'].map{|record| @document_klass.new(record)}
       elsif aggregate?
-        @documents ||= @raw['AggrRecords'].map{|aggregate| aggregate['Records'].first}.map(&@document_klass)
+        @documents ||= @raw['AggrRecords'].map{|aggregate| aggregate['Records'].first}.map{|record| @document_klass.new(record)}
       else
         []
       end
@@ -73,12 +72,12 @@ module Endeca
 
     # The collection of Refinement objects for the collection.
     def refinements
-      @refinements ||= (@raw['Refinements'] || []).map(&Refinement)
+      @refinements ||= (@raw['Refinements'] || []).map{|data| Refinement.new(data)}
     end
 
     # The collection of Breadcrumb objects for the collection.
     def breadcrumbs
-      @breadcrumbs ||= (@raw['Breadcrumbs'] || []).map(&Breadcrumb)
+      @breadcrumbs ||= (@raw['Breadcrumbs'] || []).map{|data| Breadcrumb.create(data)}
     end
 
     # Return the refinement by name

data/lib/endeca/refinement.rb

@@ -1,7 +1,6 @@
 module Endeca
   class Refinement
     include Readers
-    extend ClassToProc
 
     reader 'DimensionName' => :name,
       'ExpansionLink' => :expansion_link,
@@ -10,11 +9,11 @@ module Endeca
     integer_reader 'DimensionID' => :id
 
     reader('DimensionValues' => :dimension_values) do |values|
-      values.map(&Dimension) if values
+      values.map{|value| Dimension.new(value)} if values
     end
 
     reader('Dimensions' => :dimensions) do |values|
-      values.map(&RefinementDimension) if values
+      values.map{|value| RefinementDimension.new(value)} if values
     end
 
     attr_reader :raw

data/lib/endeca/refinement_dimension.rb

@@ -2,7 +2,6 @@ module Endeca
   class RefinementDimension
     include Comparable
     include Readers
-    extend ClassToProc
 
     reader \
       "DimensionName"  => :name,

data/lib/endeca/request.rb

@@ -1,4 +1,3 @@
-require 'uri'
 
 module Endeca
   class RequestError < ::StandardError; end
@@ -27,10 +26,8 @@ module Endeca
     def uri
       return @uri if @uri
 
-      @uri = URI.parse(@path)
-      @uri.query = query_string unless !@query || @query.include?("/_/")
-      @uri = URI.parse("#{@path}#{@query}") if @query && @query.include?("/_/")
-      @uri
+      path_query = query_string
+      @uri = path_query ? "#{@path}?#{path_query}" : @path
     end
 
     private
@@ -51,38 +48,43 @@ module Endeca
     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 
-        Endeca.timer.timeout(Endeca.timeout) do
-          @response = Net::HTTP.get_response(uri) 
-        end
-      end
+       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
-
-    # Raises exception Net::XXX (http error code) if an http error occured
-    def handle_response(response) #:nodoc:
-      case response
-      when Net::HTTPSuccess
-        Endeca.bm :parse_time do
-          @json = JSON.parse(response.body)
-        end
-      else
-        response.error! # raises exception corresponding to http error Net::XXX
-      end
+       return @response
+     end
 
-    rescue => e
-      raise RequestError, e.message
-    end
+     def handle_response(response) #:nodoc:
+       case response.response_code.to_s
+       when "200"
+         Endeca.bm :parse_time do
+           begin
+             @json = 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
 
-    def query_string
-      query_string_parts = [@uri.query, @query.to_endeca_params]
-      query_string_parts.reject!{ |s| s.nil? || s.empty? }
+     def query_string
+       @path.match(/\?(.*)$/)
+       query_string_parts = [$1, @query.to_endeca_params]
+       query_string_parts.reject!{ |s| s.nil? || s.empty? }
 
-      query_string_parts.empty? ? nil : query_string_parts.join('&')
-    end
+       query_string_parts.empty? ? nil : query_string_parts.join('&')
+     end
   end
 end