primedia-endeca 0.12.0 → 0.14.0

data/Rakefile

@@ -13,6 +13,8 @@ rescue LoadError
   end
 end
 
+begin; require 'metric_fu'; rescue LoadError; end
+
 ensure_in_path 'lib'
 require 'endeca'
 

data/endeca.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "0.12.0"
+  s.version = "0.14.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rein Henrichs", "Andy Stone"]

data/lib/endeca/breadcrumb.rb

@@ -1,7 +1,7 @@
 module Endeca
   
   class Breadcrumb
-    extend Readers
+    include Readers
 
     def self.create(raw)
       name = raw['Type']

data/lib/endeca/dimension.rb

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

data/lib/endeca/document.rb

@@ -6,8 +6,8 @@ module Endeca
   # The +reader+ declaration provided by Readers can also handle basic data transformations (i.e.
   # typecasting) and a few basic examples are provided (i.e. +integer_reader+).
   class Document
+    include Readers
     extend ClassToProc
-    extend Readers
     extend Transformer
 
     inherited_accessor :mappings, {}
@@ -93,15 +93,16 @@ module Endeca
 
     # Returns the first Document matching the query options.
     def self.first(query_options={})
-      response  = request(query_options)
-      if response['AggrRecords'] 
-        record = response['AggrRecords'].first['Records'].first
+      response = request(query_options)
+      record = if response['AggrRecords'] 
+        response['AggrRecords'].first['Records'].first
+      elsif response['Records']
+        response['Records'].first
       else
-        record = response['Records'].first
+        nil
       end
+
       record && new(record)
-    rescue Exception 
-      nil
     end
 
     # Returns all Documents matching the query options.
@@ -131,6 +132,5 @@ module Endeca
         URI.unescape(query_options)
       end
     end
-
   end
 end

data/lib/endeca/document_collection.rb

@@ -17,8 +17,8 @@ module Endeca
   # as if it were an array of Document objects. (Array delegation pattern
   # borrowed from Rake::FileList)
   class DocumentCollection
+    include Readers
     extend ClassToProc
-    extend Readers
 
     attr_reader :raw
     def initialize(raw, document_klass=Document)

data/lib/endeca/readers.rb

@@ -2,78 +2,92 @@ module Endeca
   class ReaderError < ::StandardError; end
 
   module Readers
-    def add_reader(name, &block)
-      meta = (class << self; self; end)
-      meta.instance_eval do
-        define_method(name) { |*attrs| reader(*attrs, &block) }
+    module ClassMethods
+      def add_reader(name, &block)
+        meta = (class << self; self; end)
+        meta.instance_eval do
+          define_method(name) { |*attrs| reader(*attrs, &block) }
+        end
       end
-    end
 
-    # Maps key/value pairs from the data structure used to initialize a
-    # Endeca object. Allows attribute renaming. Use a block to perform data
-    # injunction on the value as it is set.
-    #
-    # ==== Examples
-    #
-    #   # Specify basic attributes
-    #   reader :title
-    #
-    #   # Attribute renaming
-    #   reader :long_desc => :description
-    #
-    #   # Data injunction
-    #   reader(:title => :upcased_title) { |title| title.upcase }
-    def reader(*attrs,&block)
-      hash = {}
-      block ||= lambda {|x| x}
+      # Maps key/value pairs from the data structure used to initialize a
+      # Endeca object. Allows attribute renaming. Use a block to perform data
+      # injunction on the value as it is set.
+      #
+      # ==== Examples
+      #
+      #   # Specify basic attributes
+      #   reader :title
+      #
+      #   # Attribute renaming
+      #   reader :long_desc => :description
+      #
+      #   # Data injunction
+      #   reader(:title => :upcased_title) { |title| title.upcase }
+      def reader(*attrs,&block)
+        hash = {}
+        block ||= lambda {|x| x}
 
-      hash.update(attrs.pop) if Hash === attrs.last
+        hash.update(attrs.pop) if Hash === attrs.last
 
-      attrs.each{ |attr| hash[attr] = attr }
+        attrs.each{ |attr| hash[attr] = attr }
 
-      hash.each do |variable, method|
-        reader_names << method if respond_to?(:reader_names)
-        define_method(method) do
-          begin
-            block.call(attributes[variable.to_s])
-          rescue StandardError => e
-            raise Endeca::ReaderError, e.message
+        hash.each do |variable, method|
+          reader_names << method if respond_to?(:reader_names)
+          define_method(method) do
+            begin
+              block.call(attributes[variable.to_s])
+            rescue StandardError => e
+              raise Endeca::ReaderError, e.message
+            end
           end
         end
       end
-    end
 
-    # Typecasts attributes as integers.
-    #
-    # ==== Examples
-    #   integer_reader :id, :rating
-    def integer_reader(*attrs)
-      reader(*attrs) { |value| Integer(value) }
-    end
+      # Typecasts attributes as integers.
+      #
+      # ==== Examples
+      #   integer_reader :id, :rating
+      def integer_reader(*attrs)
+        reader(*attrs) { |value| Integer(value) }
+      end
 
-    # Typecasts attributes as BigDecimal
-    #
-    # ==== Examples
-    #   decimal_reader :price
-    def decimal_reader(*attrs)
-      require 'bigdecimal' unless defined?(BigDecimal)
-      reader(*attrs) { |value| BigDecimal(value.to_s) }
-    end
+      # Typecasts attributes as BigDecimal
+      #
+      # ==== Examples
+      #   decimal_reader :price
+      def decimal_reader(*attrs)
+        require 'bigdecimal' unless defined?(BigDecimal)
+        reader(*attrs) { |value| BigDecimal(value.to_s) }
+      end
+
+      # Typecasts attributes as floats 
+      #
+      # ==== Examples
+      #   float_reader :latitude, :longitude
+      def float_reader(*attrs)
+        reader(*attrs) { |value| Float(value) if value }
+      end
+
+      # Typecasts attributes as a Perly boolean ("0" == false, "1" == true")
+      #
+      # ==== Examples
+      #   boolean_reader :price
+      def boolean_reader(*attrs)
+        reader(*attrs) { |value| value == "1" ? true : false }
+      end
 
-    # Typecasts attributes as floats 
-    #
-    # ==== Examples
-    #   float_reader :latitude, :longitude
-    def float_reader(*attrs)
-      reader(*attrs) { |value| Float(value) if value }
     end
 
-    # Typecasts attributes as a Perly boolean ("0" == false, "1" == true")
-    #
-    # ==== Examples
-    #   boolean_reader :price
-    def boolean_reader(*attrs)
-      reader(*attrs) { |value| value == "1" ? true : false }
+    module InstanceMethods      
+      def method_missing(method_id)
+        raise NoMethodError, "undefined method '#{method_id}' for #{self.inspect}. Do you need to add a reader for it?"
+      end
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
     end
   end
-end
+end

data/lib/endeca/refinement.rb

@@ -1,7 +1,7 @@
 module Endeca
   class Refinement
+    include Readers
     extend ClassToProc
-    extend Readers
 
     reader 'DimensionName' => :name,
       'ExpansionLink' => :expansion_link,

data/lib/endeca/refinement_dimension.rb

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

data/lib/endeca/request.rb

@@ -15,25 +15,29 @@ module Endeca
     end
 
     def perform
-      response = handle_response(get_response)
-      raise RequestError, endeca_error(response)[:message] if endeca_error?(response)
+      raise RequestError, endeca_error[:message] if endeca_error?
       return response
     end
+    
+    def response
+      handle_response(get_response)
+    end
 
     def uri
       return @uri if @uri
 
       @uri = URI.parse(@path)
-      @uri.query = query_string
+      @uri.query = query_string unless !@query || @query.include?("/_/")
+      @uri = URI.parse("#{@path}#{@query}") if @query && @query.include?("/_/")
       @uri
     end
 
     private
     
-    def endeca_error(response)
+    def endeca_error
       method_response = response["methodResponse"]
-      fault = method_response && response["methodResponse"]["fault"]
-      values = fault && response["methodResponse"]["fault"]["value"]
+      fault = method_response && method_response["fault"]
+      values = fault && fault["value"]
       return nil unless values
       {
         :code => values["faultCode"].to_i,
@@ -41,8 +45,8 @@ module Endeca
       }
     end
 
-    def endeca_error?(response)
-      !endeca_error(response).nil?
+    def endeca_error?
+      !endeca_error.nil?
     end
 
     def get_response #:nodoc:

data/lib/endeca.rb

@@ -26,7 +26,7 @@ module Endeca
   extend Logging
 
   # :stopdoc:
-  VERSION = '0.12.0'
+  VERSION = '0.11.0'
   # :startdoc:
 
   # Returns the version string for the library.

data/spec/endeca/document_spec.rb

@@ -353,5 +353,12 @@ describe Endeca::Document do
       end
     end
   end
+  
+  describe "#method_missing" do
+    it "should include a suggestion to add a reader" do
+      lambda{ @document.missing_method }.
+        should raise_error(NoMethodError, "undefined method 'missing_method' for #{@document.inspect}. Do you need to add a reader for it?")
+    end
+  end
 
 end

data/spec/endeca/request_spec.rb

@@ -71,12 +71,26 @@ describe Endeca::Request do
 
   end
 
-  describe '#uri'
-  describe "with a hash of query options" do
-    it "should append the query options onto the url" do
-      query = {:foo => :bar}
-      Endeca::Request.new(@path, query).uri.query.should == query.to_endeca_params
+  describe '#uri' do
+    
+    describe "with a hash of query options" do
+      
+      it "should append the query options onto the url" do
+        query = {:foo => :bar}
+        Endeca::Request.new(@path, query).uri.query.should == query.to_endeca_params
+      end
+      
     end
+    
+    describe "with a query with '/_/' in it" do
+      
+      it "should not insert the ? before the query" do
+        query = "/Beds-2/Baths-3/Dishwasher/_/N=324432/Ne=listing?test=true"
+        Endeca::Request.new(@path, query).uri.to_s.should == "#{@path}#{query}"
+      end
+      
+    end
+    
   end
 
   describe "with a string of query options" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors: 
 - Rein Henrichs