solr-ruby 0.0.1

data/test/unit/dismax_request_test.rb

@@ -0,0 +1,26 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+class DismaxRequestTest < Test::Unit::TestCase
+  
+  def test_basic_query
+    request = Solr::Request::Dismax.new(:query => 'query', :phrase_slop => '1000', :sort => [{:deedle => :descending}])
+    assert_match(/q=query/, request.to_s)
+    assert_match(/qt=dismax/, request.to_s)
+    assert_match(/ps=1000/, request.to_s)
+    assert_match(/sort=deedle%20desc/, request.to_s)
+  end
+  
+end

data/test/unit/document_test.rb

@@ -0,0 +1,59 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+class DocumentTest < Test::Unit::TestCase
+
+  def test_xml
+    doc = Solr::Document.new
+    doc << Solr::Field.new(:creator => 'Erik Hatcher')
+    assert_kind_of Solr::XML::Element, doc.to_xml
+    assert_match(/<doc>[\s]*<field name=['"]creator['"]>Erik Hatcher<\/field>[\s]*<\/doc>/m, doc.to_xml.to_s)
+  end
+
+  def test_repeatable
+    doc = Solr::Document.new
+    doc << Solr::Field.new(:creator => 'Erik Hatcher')
+    doc << Solr::Field.new(:creator => 'Otis Gospodnetic')
+    assert_kind_of Solr::XML::Element, doc.to_xml
+    assert_match(/<doc>[\s]*<field name=['"]creator['"]>Erik Hatcher<\/field>[\s]*<field name=['"]creator['"]>Otis Gospodnetic<\/field>[\s]*<\/doc>/m, doc.to_xml.to_s)
+  end
+  
+  def test_repeatable_in_hash
+    doc = Solr::Document.new({:creator => ['Erik Hatcher', 'Otis Gospodnetic']})
+    assert_match(/<doc>[\s]*<field name=['"]creator['"]>Erik Hatcher<\/field>[\s]*<field name=['"]creator['"]>Otis Gospodnetic<\/field>[\s]*<\/doc>/m, doc.to_xml.to_s)
+  end
+  
+  def test_bad_doc
+    doc = Solr::Document.new
+    assert_raise(RuntimeError) do
+      doc << "invalid"
+    end
+  end
+
+  def test_hash_shorthand
+    doc = Solr::Document.new :creator => 'Erik Hatcher', :title => 'Lucene in Action'
+    assert_equal 'Erik Hatcher', doc[:creator]
+    assert_equal 'Lucene in Action', doc[:title]
+    assert_equal nil, doc[:foo]
+    
+    doc = Solr::Document.new
+    doc << {:creator => 'Erik Hatcher', :title => 'Lucene in Action'}
+    doc[:subject] = 'Search'
+    assert_equal 'Erik Hatcher', doc[:creator]
+    assert_equal 'Lucene in Action', doc[:title]
+    assert_equal 'Search', doc[:subject]
+  end
+
+end

data/test/unit/field_test.rb

@@ -0,0 +1,42 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+class FieldTest < Test::Unit::TestCase
+  
+  def test_xml
+    field = Solr::Field.new :creator => 'Erik Hatcher'
+    assert_kind_of Solr::XML::Element, field.to_xml
+    assert_match(/<field name=["']creator["']>Erik Hatcher<\/field>/, field.to_xml.to_s)
+  end
+  
+  def test_escaped_xml
+    field = Solr::Field.new :creator => 'Erik Hatcher & His Amazing Leaping Ability'
+    assert_kind_of Solr::XML::Element, field.to_xml
+    assert_match(/<field name=["']creator["']>Erik Hatcher &amp; His Amazing Leaping Ability<\/field>/, field.to_xml.to_s)
+  end
+  
+  def test_xml_date
+    field = Solr::Field.new :time => Time.now
+    assert_kind_of Solr::XML::Element, field.to_xml
+    assert_match(/<field name=["']time["']>[\d]{4}-[\d]{2}-[\d]{2}T[\d]{2}:[\d]{2}:[\d]{2}Z<\/field>/, field.to_xml.to_s)
+  end
+  
+  def test_i18n_xml
+    field = Solr::Field.new :i18nstring => 'Äêâîôû Öëäïöü'
+    assert_kind_of Solr::XML::Element, field.to_xml
+    assert_match(/<field name=["']i18nstring["']>Äêâîôû Öëäïöü<\/field>/m, field.to_xml.to_s)
+  end
+  
+end

data/test/unit/ping_test.rb

@@ -0,0 +1,51 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'solr_mock_base'
+
+class PingTest < SolrMockBaseTestCase 
+
+  def test_ping_response
+    xml = 
+<<PING_RESPONSE
+
+<?xml-stylesheet type="text/xsl" href="ping.xsl"?>
+
+<solr>
+  <ping>
+
+  </ping>
+</solr>
+PING_RESPONSE
+    conn = Solr::Connection.new('http://localhost:9999')
+    set_post_return(xml)
+    response = conn.send(Solr::Request::Ping.new)
+    assert_kind_of Solr::Response::Ping, response
+    assert_equal true, response.ok? 
+
+    # test shorthand
+    assert true, conn.ping
+  end
+
+  def test_bad_ping_response
+    xml = "<foo>bar</foo>"
+    conn = Solr::Connection.new('http://localhost:9999')
+    set_post_return(xml)
+    response = conn.send(Solr::Request::Ping.new)
+    assert_kind_of Solr::Response::Ping, response
+    assert_equal false, response.ok?
+
+    # test shorthand
+    assert_equal false, conn.ping
+  end
+
+end

data/test/unit/request_test.rb

@@ -0,0 +1,61 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+class BadRequest < Solr::Request::Base
+end
+
+class RequestTest < Test::Unit::TestCase
+
+  def test_commit_request
+    request = Solr::Request::Commit.new
+    assert_equal :xml, request.response_format
+    assert_equal 'update', request.handler
+    assert_equal '<commit/>', request.to_s
+  end
+  
+  def test_add_doc_request
+    request = Solr::Request::AddDocument.new(:title => "title")
+    assert_match(/<add>[\s]*<doc>[\s]*<field name=["']title["']>title<\/field>[\s]*<\/doc>[\s]*<\/add>/m, request.to_s)
+    assert_equal :xml, request.response_format
+    assert_equal 'update', request.handler
+    
+    assert_raise(RuntimeError) do
+      Solr::Request::AddDocument.new("invalid")
+    end
+  end
+  
+  def test_add_multidoc_request
+    request = Solr::Request::AddDocument.new([{:title => "title1"}, {:title => "title2"}])
+    assert_match(/<add>[\s]*<doc>[\s]*<field name=["']title["']>title1<\/field>[\s]*<\/doc>[\s]*<doc>[\s]*<field name=["']title["']>title2<\/field>[\s]*<\/doc>[\s]*<\/add>/m, request.to_s)
+    assert_equal :xml, request.response_format
+    assert_equal 'update', request.handler
+  end
+  
+  def test_ping_request
+    request = Solr::Request::Ping.new
+    assert_equal :xml, request.response_format
+  end
+
+  def test_bad_request_class
+    assert_raise(RuntimeError) do
+      BadRequest.new.response_format
+    end
+    
+    assert_raise(RuntimeError) do
+      BadRequest.new.handler
+    end
+  end
+
+end

data/test/unit/response_test.rb

@@ -0,0 +1,42 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+require 'solr_mock_base'
+
+
+class ResponseTest < SolrMockBaseTestCase
+
+  def test_response_xml_error
+    begin
+      Solr::Response::Xml.new("<broken>invalid xml&")
+      flunk("failed to get Solr::Exception as expected") 
+    rescue Exception => exception
+      assert_kind_of Solr::Exception, exception
+      assert_match 'invalid response xml', exception.to_s
+    end
+  end
+  
+  def test_invalid_ruby
+    assert_raise(Solr::Exception) do
+      Solr::Response::Ruby.new(' {...')
+    end
+  end
+  
+  def test_bogus_request_handling
+    assert_raise(Solr::Exception) do
+      Solr::Response::Base.make_response(Solr::Request::Select.new, "response data")
+    end
+  end
+
+end

data/test/unit/solr_mock_base.rb

@@ -0,0 +1,40 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+# TODO: Maybe replace this with flexmock
+class SolrMockBaseTestCase < Test::Unit::TestCase
+  include Solr
+  
+  def setup
+    Connection.send(:alias_method, :orig_post, :post)
+  end
+  
+  def teardown
+    Connection.send(:alias_method, :post, :orig_post)
+  end
+    
+  def set_post_return(value)
+    Connection.class_eval %{
+      def post(request)
+        %q{#{value}}
+      end
+    }
+  end
+  
+  def test_dummy
+    # So Test::Unit is happy running this class
+  end
+    
+end

data/test/unit/standard_request_test.rb

@@ -0,0 +1,108 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+class StandardRequestTest < Test::Unit::TestCase
+
+  def test_basic_query
+    request = Solr::Request::Standard.new(:query => 'query')
+    assert_equal :ruby, request.response_format
+    assert_equal 'select', request.handler
+    assert_equal 'query', request.to_hash[:q]
+    assert_match /q=query/, request.to_s
+  end
+  
+  def test_bad_params
+    assert_raise(RuntimeError) do
+      Solr::Request::Standard.new(:foo => "invalid")
+    end
+    
+    assert_raise(RuntimeError) do
+      Solr::Request::Standard.new(:query => "valid", :foo => "invalid")
+    end
+    
+    assert_raise(RuntimeError) do
+      Solr::Request::Standard.new(:query => "valid", :operator => :bogus)
+    end
+  end
+  
+  def test_common_params
+    request = Solr::Request::Standard.new(:query => 'query', :start => 10, :rows => 50,
+           :filter_queries => ['fq1', 'fq2'], :field_list => ['id','title','score'], :operator => :and)
+    assert_equal 10, request.to_hash[:start]
+    assert_equal 50, request.to_hash[:rows]
+    assert_equal ['fq1','fq2'], request.to_hash[:fq]
+    assert_equal "id,title,score", request.to_hash[:fl]
+    assert_equal "AND", request.to_hash["q.op"]
+  end
+    
+  def test_missing_params
+    request = Solr::Request::Standard.new(:query => 'query', :debug_query => false, :facets => {:fields =>[:category_facet]})
+    assert_nil request.to_hash[:rows]
+    assert_no_match /rows/, request.to_s
+    assert_no_match /facet\.sort/, request.to_s
+    assert_match /debugQuery/, request.to_s
+  end
+  
+  def test_facet_params_all
+    request = Solr::Request::Standard.new(:query => 'query',
+       :facets => {
+         :fields => [:genre,           
+                     # field that overrides the global facet parameters
+                     {:year => {:limit => 50, :mincount => 0, :missing => false, :sort => :term, :prefix=>"199"}}], 
+         :queries => ["q1", "q2"],
+         :prefix => "cat",
+         :limit => 5, :zeros => true, :mincount => 20, :sort => :count  # global facet parameters
+        }
+    )
+    
+    hash = request.to_hash
+    assert_equal true, hash[:facet]
+    assert_equal [:genre, :year], hash["facet.field"]
+    assert_equal ["q1", "q2"], hash["facet.query"]
+    assert_equal 5, hash["facet.limit"]
+    assert_equal 20, hash["facet.mincount"]
+    assert_equal true, hash["facet.sort"]
+    assert_equal "cat", hash["facet.prefix"]
+    assert_equal 50, hash["f.year.facet.limit"]
+    assert_equal 0, hash["f.year.facet.mincount"]
+    assert_equal false, hash["f.year.facet.sort"]
+    assert_equal "199", hash["f.year.facet.prefix"]
+  end
+
+  def test_basic_sort
+    request = Solr::Request::Standard.new(:query => 'query', :sort => [{:title => :descending}])
+    assert_equal 'query;title desc', request.to_hash[:q]
+  end
+  
+  def test_highlighting
+    request = Solr::Request::Standard.new(:query => 'query',
+      :highlighting => {
+        :field_list => ['title', 'author'],
+        :max_snippets => 3,
+        :require_field_match => true,
+        :prefix => "<blink>",
+        :suffix => "</blink>"
+      }
+    )
+    
+    hash = request.to_hash
+    assert_equal true, hash[:hl]
+    assert_equal "title,author", hash["hl.fl"]
+    assert_equal true, hash["hl.requireFieldMatch"]
+    assert_equal "<blink>", hash["hl.simple.pre"]
+    assert_equal "</blink>", hash["hl.simple.post"]
+  end
+
+end

data/test/unit/standard_response_test.rb

@@ -0,0 +1,174 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'solr_mock_base'
+
+class StandardResponseTest <  SolrMockBaseTestCase
+
+  def test_basic
+    ruby_code = 
+<<RUBY_CODE
+{
+     'responseHeader'=>{
+      'status'=>0,
+      'QTime'=>1,
+      'params'=>{
+      'wt'=>'ruby',
+      'rows'=>'10',
+      'explainOther'=>'',
+      'start'=>'0',
+      'hl.fl'=>'',
+      'indent'=>'on',
+      'q'=>'guido',
+      'fl'=>'*,score',
+      'qt'=>'standard',
+      'version'=>'2.2'}},
+     'response'=>{'numFound'=>1,'start'=>0,'maxScore'=>0.67833745,'docs'=>[
+      {
+       'name'=>'guido von rossum',
+       'id'=>'123',
+       'timestamp'=>'2007-01-16T09:55:30.589Z',
+       'score'=>0.67833745}]
+     }}
+RUBY_CODE
+    conn = Solr::Connection.new 'http://localhost:9999'
+    set_post_return(ruby_code)
+    response = conn.send(Solr::Request::Standard.new(:query => 'foo'))
+    assert_equal true, response.ok?
+    assert response.query_time
+    assert_equal 1, response.total_hits
+    assert_equal 0, response.start
+    assert_equal 0.67833745, response.max_score
+    assert_equal 1, response.hits.length
+  end
+
+  def test_iteration
+    ruby_code = 
+<<RUBY_CODE
+{
+     'responseHeader'=>{
+      'status'=>0,
+      'QTime'=>0,
+      'params'=>{
+      'wt'=>'ruby',
+      'rows'=>'10',
+      'explainOther'=>'',
+      'start'=>'0',
+      'hl.fl'=>'',
+      'indent'=>'on',
+      'q'=>'guido',
+      'fl'=>'*,score',
+      'qt'=>'standard',
+      'version'=>'2.2'}},
+     'response'=>{'numFound'=>22,'start'=>0,'maxScore'=>0.53799295,'docs'=>[
+      {
+       'name'=>'guido von rossum the 0',
+       'id'=>'0',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 1',
+       'id'=>'1',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 2',
+       'id'=>'2',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 3',
+       'id'=>'3',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 4',
+       'id'=>'4',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 5',
+       'id'=>'5',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 6',
+       'id'=>'6',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 7',
+       'id'=>'7',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 8',
+       'id'=>'8',
+       'score'=>0.53799295},
+      {
+       'name'=>'guido von rossum the 9',
+       'id'=>'9',
+       'score'=>0.53799295}]
+     }}
+RUBY_CODE
+    conn = Solr::Connection.new 'http://localhost:9999'
+    set_post_return(ruby_code)
+
+    count = 0
+    conn.query('foo') do |hit|
+      assert_equal "guido von rossum the #{count}", hit['name']
+      count += 1
+    end
+
+    assert_equal 10, count
+  end
+  
+  def test_facets
+    ruby_code =
+    <<RUBY_CODE
+    {
+     'responseHeader'=>{
+      'status'=>0,
+      'QTime'=>1897,
+      'params'=>{
+    	'facet.limit'=>'20',
+    	'wt'=>'ruby',
+    	'rows'=>'0',
+    	'facet'=>'true',
+    	'facet.mincount'=>'1',
+    	'facet.field'=>[
+    	 'subject_genre_facet',
+    	 'subject_geographic_facet',
+    	 'subject_format_facet',
+    	 'subject_era_facet',
+    	 'subject_topic_facet'],
+    	'indent'=>'true',
+    	'fl'=>'*,score',
+    	'q'=>'[* TO *]',
+    	'qt'=>'standard',
+    	'facet.sort'=>'true'}},
+     'response'=>{'numFound'=>49999,'start'=>0,'maxScore'=>1.0,'docs'=>[]
+     },
+     'facet_counts'=>{
+      'facet_queries'=>{},
+      'facet_fields'=>{
+    	'subject_genre_facet'=>[
+    	  'Biography.',2605,
+    	 'Congresses.',1837,
+    	 'Bibliography.',672,
+    	 'Exhibitions.',642,
+    	 'Periodicals.',615,
+    	 'Sources.',485]}}
+  	 }
+RUBY_CODE
+    set_post_return(ruby_code)
+    conn = Solr::Connection.new "http://localhost:9999"
+    response = conn.query('foo')
+    facets = response.field_facets('subject_genre_facet')
+    assert_equal 2605, facets[0].value
+    assert_equal 485, facets[5].value
+  end
+
+end
+