solr-ruby 0.0.1

data/lib/solr/response/index_info.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.
+
+class Solr::Response::IndexInfo < Solr::Response::Ruby
+  def initialize(ruby_code)
+    super(ruby_code)
+  end
+
+  def num_docs
+    return @data['index']['numDocs']
+  end
+  
+  def field_names
+    return @data['fields'].keys
+  end
+
+end

data/lib/solr/response/optimize.rb

@@ -0,0 +1,14 @@
+# 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.
+
+class Solr::Response::Optimize < Solr::Response::Commit
+end

data/lib/solr/response/ping.rb

@@ -0,0 +1,28 @@
+# 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 'rexml/xpath'
+
+class Solr::Response::Ping < Solr::Response::Xml
+
+  def initialize(xml)
+    super(xml)
+    @ok = REXML::XPath.first(@doc, './solr/ping') ? true : false
+  end
+
+  # returns true or false depending on whether the ping
+  # was successful or not
+  def ok?
+    @ok
+  end
+
+end

data/lib/solr/response/ruby.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.
+
+class Solr::Response::Ruby < Solr::Response::Base
+  attr_reader :data
+
+  def initialize(ruby_code)
+    super(ruby_code)
+    begin
+      #TODO: what about pulling up data/header/response to ResponseBase,
+      #      or maybe a new middle class like SelectResponseBase since
+      #      all Select queries return this same sort of stuff??
+      #      XML (&wt=xml) and Ruby (&wt=ruby) responses contain exactly the same structure.
+      #      a goal of solrb is to make it irrelevant which gets used under the hood, 
+      #      but favor Ruby responses.
+      @data = eval(ruby_code)
+      @header = @data['responseHeader']
+      raise "response should be a hash" unless @data.kind_of? Hash
+      raise "response header missing" unless @header.kind_of? Hash
+    rescue SyntaxError => e
+      raise Solr::Exception.new("invalid ruby code: #{e}")
+    end
+  end
+
+  def ok?
+    @header['status'] == 0
+  end
+
+  def query_time
+    @header['QTime']
+  end
+
+end

data/lib/solr/response/standard.rb

@@ -0,0 +1,60 @@
+# 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.
+
+class Solr::Response::Standard < Solr::Response::Ruby
+  FacetValue = Struct.new(:name, :value)
+  include Enumerable
+  
+  def initialize(ruby_code)
+    super(ruby_code)
+    @response = @data['response']
+    raise "response section missing" unless @response.kind_of? Hash
+  end
+
+  def total_hits
+    @response['numFound']
+  end
+
+  def start
+    @response['start']
+  end
+
+  def hits
+    @response['docs']
+  end
+
+  def max_score
+    @response['maxScore']
+  end
+  
+  def field_facets(field)
+    facets = []
+    values = @data['facet_counts']['facet_fields'][field]
+    0.upto(values.size / 2 - 1) do |i|
+      n = i * 2
+      facets << FacetValue.new(values[n], values[n+1])
+    end
+    
+    facets
+  end
+  
+  def highlighted(id, field)
+    @data['highlighting'][id.to_s][field.to_s]
+  end
+  
+  # supports enumeration of hits
+  # TODO revisit - should this iterate through *all* hits by re-requesting more?
+  def each
+    @response['docs'].each {|hit| yield hit}
+  end
+
+end

data/lib/solr/response/xml.rb

@@ -0,0 +1,37 @@
+# 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 'rexml/document'
+require 'solr/exception'
+
+class Solr::Response::Xml < Solr::Response::Base
+  attr_reader :doc, :status_code, :status_message
+
+  def initialize(xml)
+    super(xml)
+    # parse the xml
+    @doc = REXML::Document.new(xml)
+    # look for the result code and string 
+    result = REXML::XPath.first(@doc, './result')
+    if result
+      @status_code =  result.attributes['status']
+      @status_message = result.text
+    end
+  rescue REXML::ParseException => e
+    raise Solr::Exception.new("invalid response xml: #{e}")
+  end
+
+  def ok?
+    return @status_code == '0'
+  end
+
+end

data/lib/solr/xml.rb

@@ -0,0 +1,47 @@
+# 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.
+
+module Solr::XML
+end
+
+begin
+  
+  # If we can load rubygems and libxml-ruby...
+  require 'rubygems'
+  require 'xml/libxml'
+  
+  # then make a few modifications to XML::Node so it can stand in for REXML::Element
+  class XML::Node
+    # element.add_element(another_element) should work
+    alias_method :add_element, :<<
+
+    # element.attributes['blah'] should work
+    def attributes
+      self
+    end
+
+    # element.text = "blah" should work
+    def text=(x)
+      self << x.to_s
+    end
+  end
+  
+  # And use XML::Node for our XML generation
+  Solr::XML::Element = XML::Node
+  
+rescue LoadError => e # If we can't load either rubygems or libxml-ruby
+  
+  # Just use REXML.
+  require 'rexml/document'
+  Solr::XML::Element = REXML::Element
+  
+end

data/test/unit/add_document_test.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 'solr_mock_base'
+
+class AddDocumentTest < SolrMockBaseTestCase
+
+  def test_add_document_response
+    conn = Solr::Connection.new('http://localhost:9999/solr')
+    set_post_return('<result status="0"></result>')
+    doc = {:id => '123', :text => 'Tlon, Uqbar, Orbis Tertius'}
+    response = conn.send(Solr::Request::AddDocument.new(doc))
+    assert_equal true, response.ok?
+  end
+
+  def test_bad_add_document_response
+    conn = Solr::Connection.new('http://localhost:9999/solr')
+    set_post_return('<result status="400"></result>')
+    doc = {:id => '123', :text => 'Tlon, Uqbar, Orbis Tertius'}
+    response = conn.send(Solr::Request::AddDocument.new(doc))
+    assert_equal false, response.ok?
+  end
+
+  def test_shorthand
+    conn = Solr::Connection.new('http://localhost:9999/solr')
+    set_post_return('<result status="0"></result>')
+    doc = {:id => '123', :text => 'Tlon, Uqbar, Orbis Tertius'}
+    assert_equal true, conn.add(:id => '123', :text => 'Tlon, Uqbar, Orbis Tetius')
+  end
+
+end

data/test/unit/commit_test.rb

@@ -0,0 +1,41 @@
+# 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 CommitTest < SolrMockBaseTestCase
+
+  def test_commit
+    xml = '<result status="0"></result>'
+    conn = Solr::Connection.new('http://localhost:9999/solr')
+    set_post_return(xml)
+    response = conn.send(Solr::Request::Commit.new)
+    assert_kind_of Solr::Response::Commit, response
+    assert true, response.ok?
+
+    # test shorthand
+    assert_equal true, conn.commit
+  end
+
+  def test_invalid_commit
+    xml = '<foo>bar</foo>'
+    conn = Solr::Connection.new('http://localhost:9999/solr')
+    set_post_return(xml)
+    response = conn.send(Solr::Request::Commit.new)
+    assert_kind_of Solr::Response::Commit, response
+    assert_equal false, response.ok?
+
+    # test shorthand
+    assert_equal false, conn.commit
+   end
+
+end

data/test/unit/connection_test.rb

@@ -0,0 +1,55 @@
+# 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 ConnectionTest < SolrMockBaseTestCase
+  def test_mock
+    connection = Connection.new("http://localhost:9999")
+    set_post_return("foo")
+    assert_equal "foo", connection.post(Solr::Request::AddDocument.new)
+  end
+  
+  def test_bad_url
+    assert_raise(RuntimeError) do
+      Connection.new("ftp://localhost:9999")
+    end
+  end
+
+  def test_connection_initialize
+    connection = Solr::Connection.new("http://localhost:8983/solr")
+    assert_equal 'localhost', connection.url.host
+    assert_equal 8983, connection.url.port
+    assert_equal '/solr', connection.url.path
+  end
+
+  def test_non_standard_context
+    connection = Solr::Connection.new("http://localhost:8983/index")
+    assert_equal '/index', connection.url.path
+  end
+
+  def test_xml_response
+    connection = Connection.new("http://localhost:9999")
+    set_post_return "<bogus/>"
+    response = connection.send(Solr::Request::Ping.new)
+    assert_equal "<bogus/>", response.raw_response
+  end
+
+  def test_ruby_response
+    connection = Connection.new("http://localhost:9999")
+    set_post_return "{'responseHeader' => {}, 'response' => {}}"
+    response = connection.send(Solr::Request::Standard.new(:query => 'foo'))
+    assert_equal({'responseHeader' => {}, 'response' => {}}, response.data)
+  end
+end

data/test/unit/delete_test.rb

@@ -0,0 +1,56 @@
+# 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 DeleteTest <  SolrMockBaseTestCase
+
+  def test_delete_request
+    request = Solr::Request::Delete.new(:id => '123')
+    assert_match(/<delete>[\s]*<id>123<\/id>[\s]*<\/delete>/m, request.to_s)
+  end
+
+  def test_delete_by_query_request
+    request = Solr::Request::Delete.new(:query => 'name:summers')
+    assert_match(/<delete>[\s]*<query>name:summers<\/query>[\s]*<\/delete>/m, request.to_s)
+  end
+
+  def test_delete_response
+    conn = Solr::Connection.new 'http://localhost:9999/solr'
+    set_post_return('<result status="0"></result>')
+    response = conn.send(Solr::Request::Delete.new(:id => 123))
+    assert_equal true, response.ok? 
+  end
+  
+  def test_bad_delete_request
+    assert_raise(Solr::Exception) do
+      Solr::Request::Delete.new(:bogus => :param)
+    end
+
+    assert_raise(Solr::Exception) do
+      Solr::Request::Delete.new(:id => 529, :query => "id:529")
+    end
+  end
+
+  def test_bad_delete_response
+    conn = Solr::Connection.new 'http://localhost:9999/solr'
+    set_post_return('<result status="400">uhoh</result>')
+    response = conn.send(Solr::Request::Delete.new(:id => 123))
+    assert_equal false, response.ok? 
+  end
+
+  def test_delete_by_i18n_query_request
+    request = Solr::Request::Delete.new(:query => 'ëäïöü')
+    assert_match(/<delete>[\s]*<query>ëäïöü<\/query>[\s]*<\/delete>/m, request.to_s)
+  end
+
+end