rsolr 0.9.6

data/lib/rsolr/http_client/adapter/curb.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'curb'
+
+class RSolr::HTTPClient::Adapter::Curb
+  
+  include RSolr::HTTPClient::Util
+  
+  attr :uri
+  attr :connection
+  
+  def initialize(opts={})
+    @uri = URI.parse(opts[:url])
+    @connection = ::Curl::Easy.new
+  end
+  
+  def get(path, params={})
+    @connection.url = _build_url(path, params)
+    @connection.multipart_form_post = false
+    @connection.perform
+    create_http_context(path, params)
+  end
+  
+  def post(path, data, params={}, headers={})
+    @connection.url = _build_url(path, params)
+    @connection.headers = headers
+    @connection.http_post(data)
+    create_http_context(path, params, data, headers)
+  end
+  
+  protected
+  
+  def create_http_context(path, params, data=nil, headers={})
+    {
+      :status_code=>@connection.response_code.to_i,
+      :url=>@connection.url,
+      :body=>@connection.body_str,
+      :path=>path,
+      :params=>params,
+      :data=>data,
+      :headers=>headers
+    }
+  end
+  
+  def _build_url(path, params={})
+    url = @uri.scheme + '://' + @uri.host
+    url += ':' + @uri.port.to_s if @uri.port
+    url += @uri.path + path
+    build_url(url, params, @uri.query) # build_url is coming from RSolr::HTTPClient::Util
+  end
+  
+end

data/lib/rsolr/http_client/adapter/net_http.rb

@@ -0,0 +1,48 @@
+require 'net/http'
+
+class RSolr::HTTPClient::Adapter::NetHTTP
+  
+  include RSolr::HTTPClient::Util
+  
+  attr :uri
+  attr :connection
+  
+  def initialize(opts={})
+    @uri = URI.parse(opts[:url])
+    @connection = Net::HTTP.new(@uri.host, @uri.port)
+  end
+  
+  def get(path, params={})
+    url = _build_url(path, params)
+    net_http_response = @connection.get(url)
+    create_http_context(net_http_response, url, path, params)
+  end
+  
+  def post(path, data, params={}, headers={})
+    url = _build_url(path, params)
+    net_http_response = @connection.post(url, data, headers)
+    create_http_context(net_http_response, url, path, params, data, headers)
+  end
+  
+  protected
+  
+  def create_http_context(net_http_response, url, path, params, data=nil, headers={})
+    full_url = "#{@uri.scheme}://#{@uri.host}"
+    full_url += @uri.port ? ":#{@uri.port}" : ''
+    full_url += url
+    {
+      :status_code=>net_http_response.code.to_i,
+      :url=>full_url,
+      :body=>net_http_response.body,
+      :path=>path,
+      :params=>params,
+      :data=>data,
+      :headers=>headers
+    }
+  end
+  
+  def _build_url(path, params={})
+    build_url(@uri.path + path, params, @uri.query) # build_url is coming from RSolr::HTTPClient::Util
+  end
+  
+end

data/lib/rsolr/message.rb

@@ -0,0 +1,153 @@
+# The Solr::Message class is the XML generation module for sending updates to Solr.
+
+module RSolr::Message
+  
+  module Adapter
+    autoload :Builder, 'rsolr/message/adapter/builder'
+    autoload :Libxml, 'rsolr/message/adapter/libxml'
+  end
+  
+  # A class that represents a "doc" xml element for a solr update
+  class Document
+    
+    # "attrs" is a hash for setting the "doc" xml attributes
+    # "fields" is an array of Field objects
+    attr_accessor :attrs, :fields
+    
+    # "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 = {})
+      @fields = []
+      doc_hash.each_pair do |field,values|
+        # create a new field for each value (multi-valued)
+        # put non-array values into an array
+        values = [values] unless values.is_a?(Array)
+        values.each do |v|
+          next if v.to_s.empty?
+          @fields << Field.new({:name=>field}, v)
+        end
+      end
+      @attrs={}
+    end
+    
+    # returns an array of fields that match the "name" arg
+    def fields_by_name(name)
+      @fields.select{|f|f.name==name}
+    end
+    
+    # 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
+  class Field
+    
+    # "attrs" is a hash for setting the "doc" xml attributes
+    # "value" is the text value for the node
+    attr_accessor :attrs, :value
+    
+    # "attrs" must be a hash
+    # "value" should be something that responds to #_to_s
+    def initialize(attrs, value)
+      @attrs = attrs
+      @value = value
+    end
+    
+    # the value of the "name" attribute
+    def name
+      @attrs[:name]
+    end
+    
+  end
+  
+  class Builder
+    
+    attr_writer :adapter
+    
+    # b = Builder.new
+    # b.adapter = RSolr::Message::Adapter::LibXML.new
+    # b.optimize == '<optimize/>'
+    def adapter
+      @adapter ||= RSolr::Message::Adapter::Builder.new
+    end
+    
+    # generates "add" xml for updating solr
+    # "data" can be a hash or an array of hashes.
+    # - each hash should be a simple key=>value pair representing a solr doc.
+    # If a value is an array, multiple fields will be created.
+    #
+    # "add_attrs" can be a hash for setting the add xml element attributes.
+    # 
+    # This method can also accept a block.
+    # The value yielded to the block is a Message::Document; for each solr doc in "data".
+    # You can set xml element attributes for each "doc" element or individual "field" elements.
+    #
+    # For example:
+    #
+    # solr.add({:id=>1, :nickname=>'Tim'}, {:boost=>5.0, :commitWithin=>1.0}) do |doc_msg|
+    #   doc_msg.attrs[:boost] = 10.00 # boost the document
+    #   nickname = doc_msg.field_by_name(:nickname)
+    #   nickname.attrs[:boost] = 20 if nickname.value=='Tim' # boost a field
+    # end
+    #
+    # would result in an add element having the attributes boost="10.0"
+    # and a commitWithin="1.0".
+    # Each doc element would have a boost="10.0".
+    # The "nickname" field would have a boost="20.0"
+    # if the doc had a "nickname" field with the value of "Tim".
+    #
+    def add(data, add_attrs={})
+      data = [data] unless data.is_a?(Array)
+      documents = data.map do |doc|
+        doc = Document.new(doc) if doc.respond_to?(:each_pair)
+        yield doc if block_given?
+        doc
+      end
+      adapter.add(documents, add_attrs)
+    end
+    
+    # generates a <commit/> message
+    def commit(opts={})
+      adapter.commit(opts)
+    end
+    
+    # generates a <optimize/> message
+    def optimize(opts={})
+      adapter.optimize(opts)
+    end
+    
+    # generates a <rollback/> message
+    def rollback
+      adapter.rollback
+    end
+    
+    # generates a <delete><id>ID</id></delete> message
+    # "ids" can be a single value or array of values
+    def delete_by_id(ids)
+      adapter.delete_by_id(ids)
+    end
+    
+    # generates a <delete><query>ID</query></delete> message
+    # "queries" can be a single value or an array of values
+    def delete_by_query(queries)
+      adapter.delete_by_query(queries)
+    end
+  end
+end

data/lib/rsolr/message/adapter/builder.rb

@@ -0,0 +1,85 @@
+require 'builder'
+
+class RSolr::Message::Adapter::Builder
+  
+  # shortcut method -> xml = RSolr::Message.xml
+  def xml
+    ::Builder::XmlMarkup.new
+  end
+
+  # generates "add" xml for updating solr
+  # "data" can be a hash or an array of hashes.
+  # - each hash should be a simple key=>value pair representing a solr doc.
+  # If a value is an array, multiple fields will be created.
+  #
+  # "add_attrs" can be a hash for setting the add xml element attributes.
+  # 
+  # This method can also accept a block.
+  # The value yielded to the block is a Message::Document; for each solr doc in "data".
+  # You can set xml element attributes for each "doc" element or individual "field" elements.
+  #
+  # For example:
+  #
+  # solr.add({:id=>1, :nickname=>'Tim'}, {:boost=>5.0, :commitWithin=>1.0}) do |doc_msg|
+  #   doc_msg.attrs[:boost] = 10.00 # boost the document
+  #   nickname = doc_msg.field_by_name(:nickname)
+  #   nickname.attrs[:boost] = 20 if nickname.value=='Tim' # boost a field
+  # end
+  #
+  # would result in an add element having the attributes boost="10.0"
+  # and a commitWithin="1.0".
+  # Each doc element would have a boost="10.0".
+  # The "nickname" field would have a boost="20.0"
+  # if the doc had a "nickname" field with the value of "Tim".
+  #
+  def add(documents, add_attrs={})
+    xml.add(add_attrs) do |add_node|
+      documents.each do |doc|
+        # create doc, passing in fields
+        add_node.doc(doc.attrs) do |doc_node|
+          doc.fields.each do |field_obj|
+            doc_node.field(field_obj.value, field_obj.attrs)
+          end
+        end
+      end
+    end
+  end
+
+  # generates a <commit/> message
+  def commit(opts={})
+    xml.commit(opts)
+  end
+
+  # generates a <optimize/> message
+  def optimize(opts={})
+    xml.optimize(opts)
+  end
+
+  # generates a <rollback/> message
+  def rollback
+    xml.rollback
+  end
+
+  # generates a <delete><id>ID</id></delete> message
+  # "ids" can be a single value or array of values
+  def delete_by_id(ids)
+    ids = [ids] unless ids.is_a?(Array)
+    xml.delete do |xml|
+      ids.each do |id|
+        xml.id(id)
+      end
+    end
+  end
+
+  # generates a <delete><query>ID</query></delete> message
+  # "queries" can be a single value or an array of values
+  def delete_by_query(queries)
+    queries = [queries] unless queries.is_a?(Array)
+    xml.delete do |xml|
+      queries.each do |query|
+        xml.query(query)
+      end
+    end
+  end
+
+end

data/lib/rsolr/message/adapter/libxml.rb

@@ -0,0 +1,59 @@
+require 'libxml'
+
+class RSolr::Message::Adapter::Libxml
+  
+  def add(documents, attributes = {})
+    add_node = new_node('add', attributes)
+    for document in documents
+      add_node << doc_node = new_node('doc', document.attrs)
+      for field in document.fields
+        doc_node << field_node = new_node('field', field.attrs)
+        field_node << field.value
+      end
+    end
+    add_node.to_s(:indent => false)
+  end
+
+  def delete_by_id(ids)
+    delete = new_node('delete')
+    for id in Array(ids)
+      id_node = new_node('id')
+      id_node << id
+      delete << id_node
+    end
+    delete.to_s(:indent => false)
+  end
+
+  def delete_by_query(queries)
+    delete = new_node('delete')
+    for query in Array(queries)
+      query_node = new_node('query')
+      query_node << query
+      delete << query_node
+    end
+    delete.to_s(:indent => false)
+  end
+
+  def optimize(opts)
+    new_node('optimize', opts).to_s
+  end
+
+  def rollback
+    new_node('rollback').to_s
+  end
+
+  def commit(opts = {})
+    new_node('commit', opts).to_s
+  end
+
+  private
+
+  def new_node(name, opts = {})
+    node = LibXML::XML::Node.new(name)
+    opts.each_pair do |attr, value|
+      node[attr.to_s] = value.to_s
+    end
+    node
+  end
+  
+end

data/rsolr.gemspec

@@ -0,0 +1,46 @@
+Gem::Specification.new do |s|
+  s.name = "rsolr"
+  s.version = "0.9.6"
+  s.date = "2009-09-12"
+  s.summary = "A Ruby client for Apache Solr"
+  s.email = "goodieboy@gmail.com"
+  s.homepage = "http://github.com/mwmitchell/rsolr"
+  s.description = "RSolr is a Ruby gem for working with Apache Solr!"
+  s.has_rdoc = true
+  s.authors = ["Matt Mitchell"]
+  
+  s.files = [
+    "examples/http.rb",
+    "examples/direct.rb",
+    "lib/rsolr.rb",
+    "lib/rsolr/connection/adapter/direct.rb",
+    "lib/rsolr/connection/adapter/http.rb",
+    "lib/rsolr/connection.rb",
+    "lib/rsolr/http_client/adapter/curb.rb",
+    "lib/rsolr/http_client/adapter/net_http.rb",
+    "lib/rsolr/http_client.rb",
+    "lib/rsolr/message/adapter/builder.rb",
+    "lib/rsolr/message/adapter/libxml.rb",
+    "lib/rsolr/message.rb",
+    "LICENSE",
+    "Rakefile",
+    "README.rdoc",
+    "rsolr.gemspec",
+    "CHANGES.txt"
+  ]
+  s.test_files = [
+    "test/connection/direct_test.rb",
+    "test/connection/http_test.rb",
+    "test/connection/test_methods.rb",
+    "test/helper.rb",
+    "test/http_client/curb_test.rb",
+    "test/http_client/net_http_test.rb",
+    "test/http_client/test_methods.rb",
+    "test/http_client/util_test.rb",
+    "test/message_test.rb",
+    "test/rsolr_test.rb"
+  ]
+  #s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = %w(LICENSE Rakefile README.rdoc CHANGES.txt)
+  s.add_dependency("builder", [">= 2.1.2"])
+end