mwmitchell-rsolr 0.8.4 → 0.8.5

data/CHANGES.txt

@@ -1,3 +1,11 @@
+0.8.5 - April 7, 2009
+  The RSolr::Message #add method now accepts a single Message::Document or an array of Message::Document objects
+  The Message::Document class has a new method: #add_field
+  Tests added for both changes
+  Permissions of files changed to non-executable
+  -- the above changes were made by Mat Brown, thank you Mat!
+  Added CannedSolrResponse module for mocks in the specs... not used yet
+
 0.8.4 - April 3, 2009
   New test suite using RSpec and mocks coming. Run "rake spec"
     - added specs for RSolr and RSolr::Connection

data/examples/http.rb

@@ -12,11 +12,12 @@ end
 
 puts
 
-solr.select(:q=>'ipod', :fq=>'price:[0 TO 50]', :rows=>2, :start=>0) do |solr_response,adapter_response|
-  puts "URL : #{adapter_response[:url]}"
-  solr_response[:response][:docs].each do |doc|
-    puts doc[:timestamp]
-  end
+response = solr.select(:q=>'ipod', :fq=>'price:[0 TO 50]', :rows=>2, :start=>0)
+
+puts "URL : #{response.adapter_response[:url]} -> #{response.adapter_response[:status_code]}"
+
+solr_response[:response][:docs].each do |doc|
+  puts doc[:timestamp]
 end
 
 solr.delete_by_query('*:*') and solr.commit

data/lib/rsolr/adapter/direct.rb

@@ -57,13 +57,11 @@ class RSolr::Adapter::Direct
       raise RSolr::RequestError.new($!.message)
     end
     {
-      :status_code=>nil,
       :body=>body,
       :url=>url,
       :path=>path,
       :params=>params,
       :data=>data,
-      :headers=>nil
     }
   end
   

data/lib/rsolr/adapter/http.rb

@@ -7,10 +7,6 @@ class RSolr::Adapter::HTTP
   
   # opts can have:
   #   :url => 'http://localhost:8080/solr'
-  #   :select_path => '/the/url/path/to/the/select/handler'
-  #   :update_path => '/the/url/path/to/the/update/handler'
-  #   :luke_path => '/admin/luke'
-  #
   def initialize(opts={}, &block)
     opts[:url]||='http://127.0.0.1:8983/solr'
     @opts = opts
@@ -36,7 +32,7 @@ class RSolr::Adapter::HTTP
   
   protected
   
-  # The standard post headers
+  # The standard POST headers
   def post_headers
     {"Content-Type" => 'text/xml; charset=utf-8'}
   end

data/lib/rsolr/http_client.rb

@@ -1,9 +1,8 @@
 # A simple wrapper for different http client implementations.
 # Supports #get and #post
 # This was motivated by: http://apocryph.org/2008/11/09/more_indepth_analysis_ruby_http_client_performance/
-# Curb is the default adapter
 
-# Each adapters response should be a hash with the following keys:
+# Each adapters' response should be a hash with the following keys:
 #   :status_code
 #   :url
 #   :body
@@ -36,6 +35,13 @@ module RSolr::HTTPClient
       @adapter_name = adapter_name
     end
     
+    # Creates and returns an instance of RSolr::HTTPClient::Adapter::*
+    # The "url" is a full/valid url.
+    # Example:
+    # connector = RSolr::HTTPClient::Connector.new
+    # client = connector.connect('http://google.com')
+    #
+    # TODO: this should be less verbose... something like RSolr:HTTPClient.connect(url, adapter=:curb)
     def connect(url)
       case adapter_name
       when :curb
@@ -54,14 +60,19 @@ module RSolr::HTTPClient
     
   end
   
+  # The base class for interacting with one of the HTTP client adapters
   class Base
     
     attr_reader :adapter
     
+    # requires an instace of RSolr::HTTPClient::*
     def initialize(adapter)
       @adapter = adapter
     end
     
+    # sends a GET reqest to the "path" variable
+    # an optional hash of "params" can be used,
+    # which is later transformed into a GET query string
     def get(path, params={})
       begin
         http_context = @adapter.get(path, params)
@@ -71,6 +82,10 @@ module RSolr::HTTPClient
       http_context
     end
     
+    # sends a POST request to the "path" variable
+    # "data" is required, and must be a string
+    # "params" is an optional hash for query string params...
+    # "headers" is a hash for setting request header values.
     def post(path, data, params={}, headers={})
       begin
         http_context = @adapter.post(path, data, params, headers)
@@ -90,14 +105,22 @@ module RSolr::HTTPClient
         '%'+$1.unpack('H2'*$1.size).join('%').upcase
       }.tr(' ', '+') 
     end
-
+    
+    # creates and returns a url as a string
+    # "url" is the base url
+    # "params" is an optional hash of GET style query params
+    # "string_query" is an extra query string that will be appended to the 
+    # result of "url" and "params".
     def build_url(url='', params={}, string_query='')
       queries = [string_query, hash_to_params(params)]
       queries.delete_if{|i| i.to_s.empty?}
       url += "?#{queries.join('&')}" unless queries.empty?
       url
     end
-
+    
+    # converts a key value pair to an escaped string:
+    # Example:
+    # build_param(:id, 1) == "id=1"
     def build_param(k,v)
       "#{escape(k)}=#{escape(v)}"
     end

data/lib/rsolr/message.rb

@@ -16,7 +16,7 @@ class RSolr::Message
     # "doc_hash" must be a Hash/Mash object
     # If a value in the "doc_hash" is an array,
     # a field object is created for each value...
-    def initialize(doc_hash)
+    def initialize(doc_hash = {})
       @fields = []
       doc_hash.each_pair do |field,values|
         # create a new field for each value (multi-valued)
@@ -35,11 +35,24 @@ class RSolr::Message
       @fields.select{|f|f.name==name}
     end
     
-    # returns the first field that matches the "name" arg
+    # returns the *first* field that matches the "name" arg
     def field_by_name(name)
       @fields.detect{|f|f.name==name}
     end
     
+    #
+    # Add a field value to the document. Options map directly to
+    # XML attributes in the Solr <field> node.
+    # See http://wiki.apache.org/solr/UpdateXmlMessages#head-8315b8028923d028950ff750a57ee22cbf7977c6
+    #
+    # === Example:
+    #
+    #   document.add_field('title', 'A Title', :boost => 2.0)
+    #
+    def add_field(name, value, options = {})
+      @fields << Field.new(options.merge({:name=>name}), value)
+    end
+    
   end
   
   # A class that represents a "doc"/"field" xml element for a solr update
@@ -96,11 +109,11 @@ class RSolr::Message
     # if the doc had a "nickname" field with the value of "Tim".
     #
     def add(data, add_attrs={}, &blk)
-      data = [data] if data.respond_to?(:each_pair)
+      data = [data] unless data.is_a?(Array)
       xml.add(add_attrs) do |add_node|
-        data.each do |item|
+        data.each do |doc|
           # create doc, passing in fields
-          doc = Document.new(item)
+          doc = Document.new(doc) if doc.respond_to?(:each_pair)
           yield doc if block_given?
           add_node.doc(doc.attrs) do |doc_node|
             doc.fields.each do |field_obj|
@@ -150,4 +163,4 @@ class RSolr::Message
     
   end
   
-end
+end

data/lib/rsolr.rb

@@ -9,7 +9,7 @@ require 'mash'
 
 module RSolr
   
-  VERSION = '0.8.4'
+  VERSION = '0.8.5'
   
   autoload :Message, 'rsolr/message'
   autoload :Connection, 'rsolr/connection'
@@ -30,6 +30,7 @@ module RSolr
     RSolr::Connection.new(adapter, options)
   end
   
+  # A module that contains string related methods
   module Char
     
     # escape - from the solr-ruby library
@@ -49,6 +50,7 @@ module RSolr
   # bring escape into this module (RSolr) -> RSolr.escape('asdf')
   extend Char
   
+  # RequestError is a common/generic exception class used by the adapters
   class RequestError < RuntimeError; end
   
 end

data/test/message_test.rb

@@ -104,4 +104,32 @@ class MessageTest < RSolrBaseTest
     assert result.to_s =~ /<field name="name">matt2<\/field>/
   end
   
-end
+  def test_add_single_document
+    document = RSolr::Message::Document.new
+    document.add_field('id', 1)
+    document.add_field('name', 'matt', :boost => 2.0)
+    result = RSolr::Message.add(document)
+    
+    assert result.to_s =~ /<field name="id">1<\/field>/
+    
+    # depending on which ruby version, the attributes can be out of place
+    # so we need to test both... there's gotta be a better way to do this?
+    assert(
+      result.to_s =~ /<field name="name" boost="2.0">matt<\/field>/ || 
+      result.to_s =~ /<field boost="2.0" name="name">matt<\/field>/
+    )
+  end
+
+  def test_add_multiple_documents
+    documents = (1..2).map do |i|
+      doc = RSolr::Message::Document.new
+      doc.add_field('id', i)
+      doc.add_field('name', "matt#{i}")
+      doc
+    end
+    result = RSolr::Message.add(documents)
+
+    assert result.to_s =~ /<field name="name">matt1<\/field>/
+    assert result.to_s =~ /<field name="name">matt2<\/field>/
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-03 00:00:00 -07:00
+date: 2009-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,6 +91,3 @@ test_files:
 - test/message_test.rb
 - test/rsolr_test
 - test/test_helpers.rb
-- spec/connection_spec.rb
-- spec/helper.rb
-- spec/rsolr_spec.rb

data/spec/connection_spec.rb

@@ -1,151 +0,0 @@
-require 'helper'
-
-describe RSolr::Connection do
-  
-  context 'the initialize method' do
-    
-    it 'should require one argument' do
-      lambda{RSolr::Connection.new}.should raise_error(ArgumentError)
-    end
-    
-  end
-  
-  before(:each) do
-    @adapter = mock('RSolr::Adapter::HTTP')
-    @connection = RSolr::Connection.new(@adapter)
-  end
-  
-  context '#map_params method' do
-    it 'should merge :wt=>:ruby to the incoming params' do
-      result = @connection.send(:map_params, {})
-      result[:wt].should == :ruby
-    end
-    it 'should not overwrite an existing :wt param' do
-      result = @connection.send(:map_params, {:wt=>'xml'})
-      result[:wt].should == 'xml'
-    end
-  end
-  
-  context '#adapt_response method' do
-    it 'should evaluate the :body value if the :wt param IS :ruby' do
-      response_from_adapter = {:body=>'{}', :params=>{:wt=>:ruby}}
-      result = @connection.send(:adapt_response, response_from_adapter)
-      result.should be_a(Hash) 
-    end
-    it 'should not evaluate the :body value if the :wt is NOT :ruby' do
-      response_from_adapter = {:body=>'</xml>', :params=>{:wt=>:xml}}
-      result = @connection.send(:adapt_response, response_from_adapter)
-      result.should be_a(String)
-    end
-    it 'should return an object that will respond_to?(:adapter_response)' do
-      response_from_adapter = {:body=>'</xml>', :params=>{:wt=>:xml}}
-      result = @connection.send(:adapt_response, response_from_adapter)
-      result.should respond_to(:adapter_response)
-    end
-    it 'should return the original adapter response from #adapter_response method' do
-      response_from_adapter = {:body=>'</xml>', :params=>{:wt=>:xml}}
-      result = @connection.send(:adapt_response, response_from_adapter)
-      result.adapter_response.should == response_from_adapter
-    end
-  end
-  
-  it 'should have an adapter' do
-    @connection.adapter.should == @adapter
-  end
-  
-  it 'should send requests to the adapter' do
-    params = {:wt=>:ruby, :q=>'test'}
-    expected_return = {:params=>params, :body=>'{}'}
-    @adapter.should_receive(:send_request).with(
-      '/documents',
-      params,
-      nil
-    ).once.and_return(expected_return)
-    @connection.send_request('/documents', :q=>'test')
-  end
-  
-  context '#select method' do
-    
-    it 'should set the solr request path to /select' do
-      params = {:wt=>:ruby, :q=>'test'}
-      expected_return = {:params=>params, :body=>'{}'}
-      @adapter.should_receive(:send_request).with(
-        '/select',
-        params,
-        nil
-      ).once.and_return(expected_return)
-      @connection.select(:q=>'test')
-    end
-    
-    it 'should add a :qt=>:ruby to the params, then pass the params to the adapter' do
-      input_params = {:q=>'test', :fq=>'filter:one', :fq=>'documents'}
-      expected_modified_params = input_params.merge({:wt=>:ruby})
-      expected_return = {:body=>'{}', :params=>expected_modified_params}
-      @adapter.should_receive(:send_request).with(
-        '/select',
-        hash_including(expected_modified_params),
-        nil
-      ).once.and_return(expected_return)
-      @connection.select(input_params)
-    end
-    
-    it 'should return a hash' do
-      @adapter.should_receive(:send_request).and_return(
-        {:body=>'{}', :params=>{:wt=>:ruby}}
-      )
-      @connection.select(:q=>'test').should be_a(Hash)
-    end
-    
-  end
-  
-  context '#update method' do
-    
-    it 'should set the solr request path to /update' do
-      expected_params = {:name=>'test', :wt=>:ruby}
-      @adapter.should_receive(:send_request).with(
-        '/update',
-        hash_including(expected_params),
-        '</optimize>'
-      ).once.and_return(
-        {:body=>'{}', :params=>expected_params}
-      )
-      @connection.update('</optimize>', :name=>'test')
-    end
-    
-    it 'should accept a solr params hash' do
-      @adapter.should_receive(:send_request).with(
-        '/update',
-        hash_including(:xyz=>123, :wt=>:ruby),
-        '</optimize>'
-      ).once.and_return(
-        {:body=>'{}', :params=>{:xyz=>123, :wt=>:ruby}}
-      )
-      @connection.update('</optimize>', :xyz=>123)
-    end
-    
-  end
-  
-  context '#send_request method' do
-    
-    it 'should send the request path to the adapter' do
-      @adapter.should_receive(:send_request).with(
-        '/documents',
-        hash_including(:q=>'test', :wt=>:ruby),
-        nil
-      ).once.and_return({:body=>'{}', :params=>{:wt=>:ruby, :q=>'test'}})
-      @connection.send_request('/documents', :q=>'test')
-    end
-    
-    it 'should return an object will respond_to :adapter_response' do
-      @adapter.should_receive(:send_request).with(
-        '/select',
-        hash_including(:q=>'test', :wt=>:ruby),
-        nil
-      ).once.and_return({:body=>'{}', :params=>{:q=>'test', :wt=>:ruby}})
-      response = @connection.select(:q=>'test')
-      response.should respond_to(:adapter_response)
-    end
-    
-  end
-  
-end

data/spec/helper.rb

@@ -1,4 +0,0 @@
-require 'rubygems'
-require 'spec'
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'rsolr')

data/spec/rsolr_spec.rb

@@ -1,29 +0,0 @@
-require 'helper'
-
-describe RSolr::Connection do
-  
-  context 'the #connect method' do
-    
-    it 'should exist' do
-      RSolr.should respond_to(:connect)
-    end
-    
-    it 'should return an RSolr::Connection object' do
-      RSolr.connect.should be_a(RSolr::Connection)
-    end
-    
-  end
-  
-  context "the #escape method" do
-    
-    it "should exist" do
-      RSolr.should respond_to(:escape)
-    end
-    
-    it "should escape properly" do
-      RSolr.escape('Trying & % different "characters" here!').should == "Trying\\ \\&\\ \\%\\ different\\ \\\"characters\\\"\\ here\\!"
-    end
-    
-  end
-  
-end