endeca 1.3.7

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2009-01-20
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,37 @@
+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/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_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

data/README.rdoc

@@ -0,0 +1,60 @@
+endeca
+  by Rein Henrichs and Andy Stone
+
+== DESCRIPTION:
+
+An Endeca client library for Ruby.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+  class Listing < Endeca::Document
+    path 'http://endeca.example.com/api'
+ 
+    map :id => 'R'
+    map(:expand_refinements => :expand_all_dims).into(:M)
+ 
+    float_reader \
+      :latitude,
+      :longitude,
+ 
+    integer_reader :endeca_id
+ 
+    boolean_reader :isawesome => :awesome?
+  end
+
+  Listing.find(1234).awesome?              # => true
+  Listing.find(:all, :per_page => 10).size # => 10
+
+== REQUIREMENTS:
+
+* FakeWeb (for running tests)
+
+== INSTALL:
+
+  sudo gem install primedia-endeca --source=http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 PRIMEDIA Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,52 @@
+# 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.
+
+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
+
+ensure_in_path 'lib'
+require 'endeca'
+
+task :default => 'rcov'
+
+desc "Simple benchmarking"
+task :benchmark do
+  sh('ruby example/benchmark.rb')
+end
+task :bm => :benchmark
+
+desc "Flog your code for Justice!"
+task :flog do
+  sh('flog lib/**/*.rb')
+end
+
+desc "Run all specs and rcov in a non-sucky way"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_opts = IO.readlines("spec/spec.opts").map {|l| l.chomp.split " "}.flatten
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  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

data/endeca.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{endeca}
+  s.version = "1.3.7"
+
+  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-09-15}
+  s.description = %q{An Endeca client library for Ruby.}
+  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.homepage = %q{http://github.com/primedia/endeca}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{endeca}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An Endeca client library for Ruby}
+end

data/example/benchmark.rb

@@ -0,0 +1,13 @@
+require 'benchmark'
+
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
+require 'lib/endeca'
+require 'listing'
+
+RUNS = 10
+Benchmark.bmbm do |results|
+  results.report('Full Request') {RUNS.times{Listing.all}}
+  results.report('Parse JSON') {RUNS.times{Endeca::Request.perform(Listing.get_path,'')}}
+  results.report('Get Net Response') {RUNS.times{Endeca::Request.new(Listing.get_path,'').send(:get_response)}}
+end
+

data/example/listing.rb

@@ -0,0 +1,33 @@
+require 'lib/endeca'
+class Listing < Endeca::Document
+  path "http://10.130.83.75:9888/bridge/JSONControllerServlet.do"
+
+  reader \
+    :address,
+    :contact,
+    :description,
+    :header,
+    :phone
+
+  integer_reader \
+    'RecordSpec' => :listing_id
+
+  float_reader \
+    :longitude,
+    :latitude
+
+  decimal_reader :rent => :price
+
+  boolean_reader :showemail => :show_email?
+
+  reader(:rh_url => :details_url) {|url| "/{url}"}
+
+  add_reader(:caret_delimited_reader) {|string| string.split('^+^')}
+
+  caret_delimited_reader \
+    :thumbnails,
+    :graphicurl => :graphic_urls
+
+  def coordinates; [latitude, longitude] end
+  def image_url; (graphic_urls || thumbnails).first rescue nil end
+end

data/lib/class_to_proc.rb

@@ -0,0 +1,5 @@
+module ClassToProc
+  def to_proc
+    proc(&method(:new))
+  end
+end

data/lib/core_ext.rb

@@ -0,0 +1,106 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end
+
+class Array
+  def to_endeca_params
+    join('&').to_endeca_params
+  end
+end
+
+require 'benchmark'
+class << Benchmark
+  # Earlier Ruby had a slower implementation.
+  if RUBY_VERSION < '1.8.7'
+    remove_method :realtime
+
+    def realtime
+      r0 = Time.now
+      yield
+      r1 = Time.now
+      r1.to_f - r0.to_f
+    end
+  end
+
+  def ms
+    1000 * realtime { yield }
+  end
+end
+
+
+class Class
+  def inherited_property(accessor, default = nil)
+    instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+      @#{accessor} = default
+
+      def set_#{accessor}(value)
+        @#{accessor} = value
+      end
+      alias #{accessor} set_#{accessor}
+
+      def get_#{accessor}
+        return @#{accessor} if instance_variable_defined?(:@#{accessor})
+        superclass.send(:get_#{accessor})
+      end
+    RUBY
+
+    # @path = default
+    #
+    # def set_path(value)
+    #   @path = value
+    # end
+    # alias_method path, set_path
+
+    # def get_path
+    #   return @path if instance_variable_defined?(:path)
+    #   superclass.send(:path)
+    # end
+  end
+
+  def inherited_accessor(accessor, default = nil)
+    instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+      class << self; attr_writer :#{accessor}; end
+      @#{accessor} = default
+
+      def #{accessor}
+        @#{accessor} ||= superclass.send(:#{accessor}).dup
+      end
+    RUBY
+  end
+end
+
+class Hash
+  def to_endeca_params
+    map { |k, v|
+      if v.instance_of?(Hash)
+        v.map { |sk, sv|
+          "#{k}[#{sk}]=#{sv}"
+        }.join('&')
+      else
+        "#{k}=#{v}"
+      end
+    }.join('&').to_endeca_params
+  end
+
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+end
+
+class NilClass
+  def to_endeca_params
+    ''
+  end
+end
+
+class String
+  def to_endeca_params
+    Endeca.escape(self)
+  end
+end

data/lib/endeca.rb

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'net/http'
+require 'json'
+require 'logger'
+
+$:.unshift(File.dirname(__FILE__))
+require 'core_ext'
+require 'class_to_proc'
+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.3.7'
+  # :startdoc:
+
+  # Returns the version string for the library.
+  def self.version
+    VERSION
+  end
+
+  # Set Endeca.debug = true to turn on query logging
+  # Set 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
+    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 = 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/lib/endeca/benchmarking.rb

@@ -0,0 +1,38 @@
+require 'benchmark'
+
+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(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
+    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