primedia-endeca 0.9.7 → 0.9.8

data/endeca.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "0.9.7"
+  s.version = "0.9.8"
 
   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-01-30}
+  s.date = %q{2009-02-02}
   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/dimension.rb", "lib/endeca/document.rb", "lib/endeca/document_collection.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/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"]
+  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/breadcrumb.rb", "lib/endeca/dimension.rb", "lib/endeca/document.rb", "lib/endeca/document_collection.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/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"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/primedia/endeca-ruby}
   s.rdoc_options = ["--main", "README.rdoc"]

data/lib/endeca/breadcrumb.rb

@@ -0,0 +1,33 @@
+module Endeca
+  class Breadcrumb
+    extend ClassToProc
+    extend Readers
+
+    reader \
+      'DimensionName' => :name,
+      'Type' => :type,
+      'DimensionRemovalLink' => :to_params
+
+    reader('DimensionValues' => :dimension_values) do |values|
+      values.map(&Dimension) if values
+    end
+
+    attr_reader :raw
+    def initialize(raw={})
+      @raw = raw
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def inspect
+      "#<#{self.class}=0x#{self.object_id.to_s(16)} name=#{name.inspect}>"
+    end
+
+    def attributes
+      (@raw['Dimensions'] || []).first || {}
+    end
+
+  end
+end

data/lib/endeca/document_collection.rb

@@ -67,6 +67,11 @@ module Endeca
       @refinements ||= (@raw['Refinements'] || []).map(&Refinement)
     end
 
+    # The collection of Breadcrumb objects for the collection.
+    def breadcrumbs
+      @breadcrumbs ||= (@raw['Breadcrumbs'] || []).map(&Breadcrumb)
+    end
+
     # Return the refinement by name
     def refinement_by_name(name)
       refinements.find{|ref| ref.name.downcase == name.downcase}

data/lib/endeca.rb

@@ -11,6 +11,7 @@ require 'endeca/map'
 require 'endeca/transformer'
 require 'endeca/dimension'
 require 'endeca/refinement'
+require 'endeca/breadcrumb'
 require 'endeca/request'
 require 'endeca/document_collection'
 require 'endeca/document'
@@ -18,7 +19,7 @@ require 'endeca/document'
 module Endeca
 
   # :stopdoc:
-  VERSION = '0.9.7'
+  VERSION = '0.9.8'
   # :startdoc:
 
   # Returns the version string for the library.

data/spec/endeca/breadcrumb_spec.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Breadcrumb do
+  before do
+    @dimension_value = {
+      "DimValueID" => "4343565665",
+      "RemovalLink" => "N=",
+      "DimValueName" => "Apartment"
+    }
+
+    dimensions = { "Dimensions" => [ 
+      { 
+        "Type" => "Navigation",
+        "DimensionName" => "property type", 
+        "DimensionRemovalLink" => "N=", 
+        "DimensionValues" => [@dimension_value] 
+      }
+     ]
+    }
+    @Breadcrumb = Endeca::Breadcrumb.new( dimensions )
+  end
+
+  describe '#==' do
+    it "should compare Breadcrumbs by name" do
+      doc_1, doc_2 = Endeca::Breadcrumb.new, Endeca::Breadcrumb.new
+      doc_1.stub!(:name).and_return('property type')
+      doc_2.stub!(:name).and_return('property type')
+      (doc_1 == doc_2).should be_true
+
+      doc_2.stub!(:name).and_return('something else')
+      (doc_1 == doc_2).should be_false
+    end
+  end
+
+  describe '#inspect' do
+    it "includes the class name" do
+      @Breadcrumb.inspect.should include(Endeca::Breadcrumb.name)
+    end
+
+    it "includes the hex string of the object id" do
+      @Breadcrumb.inspect.should include("0x#{@Breadcrumb.object_id.to_s(16)}")
+    end
+
+    it "includes the inspected name" do
+      @Breadcrumb.stub!(:name).and_return('A Name')
+      @Breadcrumb.inspect.should include('name="A Name"')
+    end
+  end
+
+  it "should return to_params on the dimension removal link " do
+    @Breadcrumb.to_params.should == "N="
+  end
+
+  it "should return an array of dimensions for dimension_values" do
+    my_dimension = Endeca::Dimension.new(@dimension_value)
+    @Breadcrumb.dimension_values.should == [my_dimension]
+  end
+end

data/spec/endeca/document_collection_spec.rb

@@ -8,11 +8,16 @@ describe Endeca::DocumentCollection do
                                 "ExpansionLink" =>  "N=&Ne=7",
                                 "DimensionName" => "city",
                                 "DimensionID"  => "7" } ] }
+    @breadcrumb = { "Dimensions" => [ {
+                                "DimensionName" => "property type",
+                                "DimensionRemovalLink" =>  "N=",
+                                "Type"  => "Navigation" } ] }
 
     @raw = {
       'Records'     => [@document],
       'MetaInfo'    => @metainfo,
-      'Refinements' => [@refinement]
+      'Refinements' => [@refinement],
+      'Breadcrumbs' => [@breadcrumb]
     }
     @document_collection = Endeca::DocumentCollection.new(@raw)
   end
@@ -101,6 +106,12 @@ describe Endeca::DocumentCollection do
     end
   end
 
+  describe '#breadcrumbs' do
+    it 'should return a collection of Breadcrumb objects' do
+      @document_collection.breadcrumbs.should == [Endeca::Breadcrumb.new(@breadcrumb)]
+    end
+  end
+
   describe "#each" do
     it "should yield to the documents" do
       block = lambda{1}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-30 00:00:00 -08:00
+date: 2009-02-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - lib/class_to_proc.rb
 - lib/core_ext.rb
 - lib/endeca.rb
+- lib/endeca/breadcrumb.rb
 - lib/endeca/dimension.rb
 - lib/endeca/document.rb
 - lib/endeca/document_collection.rb
@@ -52,6 +53,7 @@ files:
 - lib/endeca/request.rb
 - lib/endeca/transformer.rb
 - spec/core_ext_spec.rb
+- spec/endeca/breadcrumb_spec.rb
 - spec/endeca/dimension_spec.rb
 - spec/endeca/document_collection_spec.rb
 - spec/endeca/document_spec.rb