primedia-endeca 0.9.0

data/spec/endeca/map_spec.rb

@@ -0,0 +1,81 @@
+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 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 "#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"
+    map = Endeca::Map.new(:field_list)
+    map.into(: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

data/spec/endeca/readers_spec.rb

@@ -0,0 +1,112 @@
+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"})
+  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 ".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
+  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
+  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 ".dim_reader" do
+    describe "with a symbol" do
+      it "adds a reader that returns the name of that dimension" do
+        @helper.dim_reader(:type)
+        dimensions = {"type" => mock('type', :name => 'a type')}
+        @a_helper.stub!(:dimensions).and_return(dimensions)
+        @a_helper.type.should == 'a type'
+      end
+    end
+
+    describe "with a string" do
+      it "adds a reader that returns the name of that dimension" do
+        @helper.dim_reader('type')
+        dimensions = {"type" => mock('type', :name => 'a type')}
+        @a_helper.stub!(:dimensions).and_return(dimensions)
+        @a_helper.type.should == 'a type'
+      end
+    end
+
+    describe "with a string that has spaces" do
+      it "adds a reader that returns the name of that dimension" do
+        @helper.dim_reader('type a lot' => :type_a_lot)
+        dimensions = {"type a lot" => mock('type', :name => 'a type')}
+        @a_helper.stub!(:dimensions).and_return(dimensions)
+        @a_helper.type_a_lot.should == 'a type'
+      end
+    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_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Refinement do
+  before do
+    @refinement = Endeca::Refinement.new
+  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
+end

data/spec/endeca/request_spec.rb

@@ -0,0 +1,65 @@
+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
+
+    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
+    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
+  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_params
+      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_params
+      end
+    end
+end

data/spec/endeca/transformer_spec.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Transformer do
+  class Helper
+    extend Endeca::Transformer
+
+    inherited_accessor :mappings, {}
+  end
+
+  before do
+    @helper = Helper.new
+  end
+
+  it "should add the map method to the class" do
+    Helper.should respond_to(:map)
+  end
+
+  it "should add the tranform_query_options method to the class" do
+    Helper.should respond_to(:transform_query_options)
+  end
+
+  describe ".map" do
+    it "should raise Argument error for more than one key=>value pair" do
+      lambda{Helper.map({:foo => :bar, :bizz => :bazz})}.
+        should raise_error(ArgumentError, "map only accepts one key=>value pair")
+    end
+
+    it "should add Map object to mappings" do
+      Helper.map :foo => :bar
+      Helper.mappings[:foo].class.should == Endeca::Map 
+    end
+
+    it "should add Map object to mappings with only one argument" do
+      Helper.map :foo
+      Helper.mappings[:foo].class.should == Endeca::Map 
+    end
+
+    it "should create a boolean mapping" do
+      Helper.map(:foo => :bar).should be_boolean
+    end
+  end
+
+  describe ".transform_query_options" do
+    it "should return new query based on transformation" do
+      Helper.map :foo => :bar
+      expected_query = {:bar  => :bazz}
+      Helper.transform_query_options(:foo => :bazz).should == expected_query
+    end
+  end
+end

data/spec/endeca_spec.rb

@@ -0,0 +1,12 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Endeca do
+  describe ".version" do
+    it "returns the version string" do
+      Endeca.version.should == Endeca::VERSION
+    end
+  end
+end
+
+# EOF

data/spec/rcov.opts

@@ -0,0 +1,5 @@
+--text-summary
+--exclude
+  json,FakeWeb,rcov.rb,rspec,spec
+--sort
+  coverage

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format
+  progress

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib endeca]))

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: primedia-endeca
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Rein Henrichs
+- Andy Stone
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
+description: An Endeca client library for Ruby.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- 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
+has_rdoc: true
+homepage: http://github.com/primedia/endeca-ruby
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: endeca-ruby
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An Endeca client library for Ruby
+test_files: []
+