endeca 1.3.7

data/spec/endeca/map_spec.rb

@@ -0,0 +1,122 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Map do
+  before do
+    @query = {:foo => "bazz", :bizz => "somevalue"}
+    @map = Endeca::Map.new :foo, :bizz
+
+  end
+
+  describe ".perform" do
+    it "should return correctly mapped hash" do
+      @map.perform(@query).should == {:bizz => "bazz"}
+    end
+
+    it "should be indifferent to string or symbol keys" do
+      @map.perform("foo" => "bazz").should == {:bizz => "bazz"}
+    end
+
+    it "should transform the value based on the block" do
+      map = @map.transform{|val| val.to_s.upcase}
+      map.perform(@query).should == {:bizz => "BAZZ"}
+    end
+
+    it "should nest in parent_hash" do
+      @map.into({:bip => :bop}).perform(@query).
+        should == {:bip => "bizz", :bop => "bazz"}
+    end
+
+    it "should join the new value with the existing value" do
+      map = @map.join('|')
+      map.perform(@query).should == {:bizz => "somevalue|bazz"}
+    end
+  end
+
+  describe "#into" do
+    it "should assign the hash to map the given query hash into" do
+      @map.into(:foo => :bar).instance_variable_get(:@into).should == {:foo => :bar}
+    end
+
+    it "should assign the default character to join keys to values with" do
+      @map.into(:foo => :bar).instance_variable_get(:@with).should == ':'
+    end
+
+    it "should assign the default character used to join key/value pairs" do
+      @map.into(:foo => :bar).instance_variable_get(:@join).should == '|'
+    end
+  end
+
+  describe "#perform_into" do
+    describe "with an enclosing string" do
+      it "wraps the parameter" do
+        map = Endeca::Map.new(:foo, :bar)
+        map.into(:bizz).enclose(:AND)
+        map.perform(:foo => :quux).should == {:bizz => 'AND(bar:quux)'}
+      end
+    end
+
+    describe "with replace" do
+      it "replaces the existing parameter" do
+        map = Endeca::Map.new(:foo, :bar)
+        map.into(:bizz).replace!
+        map.perform(:foo => :quux, :bizz => :foobar).should == {:bizz => 'bar:quux'}
+      end
+    end
+
+    describe "with enclose and replace" do
+      it "wraps the parameter and replaces the existing parameter" do
+        map = Endeca::Map.new(:foo, :bar)
+        map.into(:bizz).enclose(:AND).replace!
+        map.perform(:foo => :quux, :bizz => :foobar).should == {:bizz => 'AND(bar:quux)'}
+      end
+    end
+  end
+
+  describe "#with" do
+    it "should assign the character to join keys to values with" do
+      @map.with('*').instance_variable_get(:@with).should == '*'
+    end
+  end
+
+  describe "#join" do
+    it "should assign the character used to join key/value pairs" do
+      @map.join('*').instance_variable_get(:@join).should == '*'
+    end
+  end
+
+  describe "#boolean" do
+    it "should convert a true value to its integral equivalent" do
+      @map.boolean.perform(:foo => true).should == {:bizz => 1}
+    end
+
+    it "should convert a false value to its integral equivalent" do
+      @map.boolean.perform(:foo => false).should == {:bizz => 0}
+    end
+  end
+
+  describe "#==" do
+    it "is true if the keys, join and transformations are equivalent" do
+      Endeca::Map.new(:foo, :bar).into(:M).should == Endeca::Map.new(:foo, :bar).into(:M)
+    end
+  end
+
+  describe "#transform" do
+    it "should execute the transformation block on the query" do
+      map = Endeca::Map.new(:field_list, :F).transform do |fields_array|
+        fields_array.collect{|field| "#{field.to_s}:1"}.join('|')
+      end
+      map.perform(:field_list => [:first_name, :last_name, :email]).
+        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/readers_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Readers do
+  class Helper
+    extend Endeca::Readers
+  end
+
+  before do
+    @helper = Class.new(Endeca::Document)
+    @a_helper = @helper.new('Properties' => {'helper_id' => "1", 'nil_id' => nil, 'empty_field' => ''})
+  end
+
+  describe ".add_reader" do
+    it "should add a method named for the argument" do
+      @helper.add_reader(:float_reader) {|x| x.to_f}
+      @helper.should respond_to(:float_reader)
+    end
+  end
+  
+  describe ".field_names" do
+    it "should include added readers" do
+      @helper.reader(:helper_id)
+      @helper.field_names.should include(:helper_id)
+    end    
+  end
+
+  describe ".reader" do
+    
+    describe "with a symbol" do
+      it "adds a reader that returns the attribute by that key" do
+        @helper.reader(:helper_id)
+        @a_helper.should respond_to(:helper_id)
+        @a_helper.helper_id.should == "1"
+      end
+    end
+
+    describe "with a hash" do
+      it "adds a reader that returns the corresponding element" do
+        @helper.reader(:helper_id => :new_helper_id)
+        @a_helper.should respond_to(:new_helper_id)
+        @a_helper.new_helper_id.should == "1"
+      end
+    end
+
+    describe "with a hash and a block" do
+      it "adds a reader that returns the corresponding element, cast by calling the block" do
+        @helper.reader(:helper_id => :succ_helper_id){|id| id.succ}
+        @a_helper.should respond_to(:succ_helper_id)
+        @a_helper.succ_helper_id.should == "1".succ
+      end
+    end
+  end
+
+  describe ".integer_reader" do
+    it "adds a reader that casts the value to an integer" do
+      @helper.integer_reader(:helper_id)
+      @a_helper.helper_id.should == 1
+    end
+    
+    describe "when the value is nil" do
+      it "should return 0" do
+        @helper.integer_reader(:nil_id)
+        @a_helper.nil_id.should == 0
+      end
+    end
+    
+    describe "when the field does not exist" do
+      it "should return 0" do
+        @helper.integer_reader(:non_existant_field)
+        @a_helper.non_existant_field.should == 0
+      end
+    end
+
+    describe "when the value is an empty string" do
+      it "should return 0" do
+        @helper.integer_reader(:empty_field)
+        @a_helper.empty_field.should == 0
+      end
+    end
+  end
+
+  describe ".decimal_reader" do
+    it "adds a reader that casts the value to an decimal" do
+      @helper.decimal_reader(:helper_id)
+      @a_helper.helper_id.should == BigDecimal.new("1")
+    end
+  end
+
+  describe ".float_reader" do
+    it "adds a reader that casts the value to an float" do
+      @helper.float_reader(:helper_id)
+      a_helper = @helper.new('Properties' => {'helper_id' => "1.9234"})
+      a_helper.helper_id.should == Float("1.9234")
+    end
+
+    it "adds a reader that casts the value to an float" do
+      @helper.float_reader(:helper_id)
+      a_helper = @helper.new('Properties' => {'unhelpful_id' => "1.9234"})
+      a_helper.helper_id.should == nil
+    end
+  end
+
+  describe ".boolean_reader" do
+    it "adds a reader that casts the value to an boolean" do
+      @helper.boolean_reader(:helper_id)
+      @a_helper.helper_id.should == true
+    end
+  end
+
+  describe "exception handling" do
+    it "should raise an Endeca::Reader error if the call fails" do
+      helper = Class.new(Endeca::Document)
+      helper.integer_reader(:helper_id)
+      helper = helper.new('Properties' => {'helper_id' => 'W'})
+      lambda{helper.helper_id}.should raise_error(Endeca::ReaderError, %{invalid value for Integer: "W"})
+    end
+  end
+end

data/spec/endeca/refinement_dimension_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Endeca::RefinementDimension do
+  describe ".new" do
+    it "should set the raw attribute" do
+      dimension = Endeca::RefinementDimension.new(:raw)
+
+      dimension.raw.should == :raw
+    end
+  end
+  
+  describe "#to_endeca_params" do
+    before do
+      @dimension = Endeca::RefinementDimension.new("ExpansionLink" => "expansion link")
+    end
+    
+    it() {@dimension.to_endeca_params.should == "expansion link"}
+
+  end
+
+  describe "#inspect" do
+    before do
+      @dimension = Endeca::RefinementDimension.new
+    end
+
+    it "should include the class" do
+      @dimension.inspect.should include(Endeca::RefinementDimension.name)
+    end
+
+    it "should include the hex formatted object_id" do
+      id = 123
+      @dimension.stub!(:object_id).and_return(id)
+      @dimension.inspect.should include("0x#{id.to_s(16)}")
+    end
+
+    it "should include the id" do
+      id = 123
+      @dimension.stub!(:id).and_return(id)
+      @dimension.inspect.should include("id=#{id}")
+    end
+
+    it "should include the inspected name" do
+      name = 'name'
+      @dimension.stub!(:name).and_return(name)
+      @dimension.inspect.should include("name=#{name.inspect}")
+    end
+  end
+
+  describe "#==" do
+    it "should compare ids" do
+      dim_1 = Endeca::RefinementDimension.new
+      dim_2 = Endeca::RefinementDimension.new
+      dim_2.stub!(:id).and_return(dim_1.id)
+
+      (dim_1 == dim_2).should be_true
+    end
+  end
+
+  describe "#<=>" do
+    it "should compare names" do
+      name = mock('name')
+
+      dim_1 = Endeca::RefinementDimension.new
+      dim_2 = Endeca::RefinementDimension.new
+
+      dim_1.stub!(:name).and_return(name)
+      dim_2.stub!(:name).and_return(name)
+
+      name.should_receive(:<=>).with(name)
+
+      dim_1 <=> dim_2
+    end
+  end
+end

data/spec/endeca/refinement_spec.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Refinement do
+  before do
+    @dimension_value = {
+      "DimValueID" => "4294965335",
+      "SelectionLink" => "N=4294965335&Ne=3",
+      "DimValueName" => "Winter Park",
+      "NumberofRecords" => "44"
+    }
+
+    dimensions = { "Dimensions" => [ 
+      { 
+        "DimensionID" => "3",
+        "DimensionName" => "state", 
+        "ContractionLink" => "N=",
+        "DimensionValues" => [@dimension_value] 
+      }
+     ]
+    }
+    @refinement = Endeca::Refinement.new( dimensions )
+  end
+
+  describe '#==' do
+    it "should compare refinements by id" do
+      doc_1, doc_2 = Endeca::Refinement.new, Endeca::Refinement.new
+      doc_1.stub!(:id).and_return(1)
+      doc_2.stub!(:id).and_return(1)
+      (doc_1 == doc_2).should be_true
+
+      doc_2.stub!(:id).and_return(2)
+      (doc_1 == doc_2).should be_false
+    end
+  end
+
+  describe '#inspect' do
+    it "includes the class name" do
+      @refinement.inspect.should include(Endeca::Refinement.name)
+    end
+
+    it "includes the hex string of the object id" do
+      @refinement.inspect.should include("0x#{@refinement.object_id.to_s(16)}")
+    end
+
+    it "includes the id" do
+      @refinement.stub!(:id).and_return(1)
+      @refinement.inspect.should include('id=1')
+    end
+
+    it "includes the inspected name" do
+      @refinement.stub!(:name).and_return('A Name')
+      @refinement.inspect.should include('name="A Name"')
+    end
+  end
+
+  it "should return to_endeca_params on the contraction link " do
+    @refinement.to_endeca_params.should == "N="
+  end
+
+  it "should return an array of dimensions for dimension_values" do
+    my_dimension = Endeca::Dimension.new(@dimension_value)
+    @refinement.dimension_values.should == [my_dimension]
+  end
+
+  it "should return an array of dimensions" do
+    refinement_dim_raw = mock("raw dimension refinement")
+    refinement_dim = mock(Endeca::RefinementDimension)
+    @refinement.attributes['Dimensions'] = [refinement_dim_raw]
+    Endeca::RefinementDimension.should_receive(:new).with(refinement_dim_raw).and_return(refinement_dim)
+    @refinement.dimensions.should == [refinement_dim]
+  end
+end

data/spec/endeca/request_spec.rb

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'fake_web'
+require 'json'
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Request do
+  before do
+    @path = 'http://example.com/foobar'
+  end
+
+  describe '.perform' do
+    it "initalializes a new request object and performs the request" do
+      path = 'path'
+      query = 'query'
+      request = mock('Endeca::Request')
+      request.should_receive(:perform)
+      Endeca::Request.should_receive(:new).with(path, query).and_return(request)
+
+      Endeca::Request.perform(path, query)
+    end
+  end
+
+  describe '#perform' do
+    before do
+      @request = Endeca::Request.new(@path)
+    end
+    
+    it "should not make more than one request" do
+      @request.should_receive(:handle_response).exactly(1).times.and_return({})
+      @request.perform
+    end    
+
+    describe "when successful" do
+      before do
+        @response_hash = {"foo" => "bar"}
+        FakeWeb.register_uri(@path, :string => @response_hash.to_json)
+      end
+
+      it "should return the parsed JSON of the response body" do
+        @request.perform.should == @response_hash
+      end
+    
+      it "should not raise an error" do
+        lambda { @request.perform }.should_not raise_error
+      end
+    end
+
+    describe "when unsuccessful" do
+      before do
+        FakeWeb.register_uri(@path, :status => ['404', 'Not Found'])
+      end
+
+      it "should raise an Endeca::RequestError" do
+        lambda {@request.perform}.should raise_error(Endeca::RequestError, '404 "Not Found"')
+      end
+
+    end
+    
+    describe "when the response contains an error hash" do
+      before do
+        @error_message = "com.endeca.soleng.urlformatter.QueryBuildException: com.endeca.navigation.UrlENEQueryParseException: java.lang.NumberFormatException: For input string: \"asdjkhfgasdfjkhg\""
+        @error_response = {
+          "methodResponse"=>
+            {"fault"=>
+              {"value"=>
+                {"faultCode"=>"-1",
+                 "faultString"=> @error_message}}}}
+        @error_request = Endeca::Request.new(@path)
+        @error_request.stub!(:handle_response).and_return(@error_response)
+      end
+      
+      it "should raise an Endeca::RequestError" do
+        lambda { @error_request.perform }.should raise_error(Endeca::RequestError, @error_message)
+      end
+    end
+
+  end
+
+  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
+    it "should append the query options string onto the url" do
+      query = 'N=56'
+      Endeca::Request.new(@path, query).uri.query.should == query.to_endeca_params
+    end
+  end
+end