rsolr 0.9.7.1 → 0.9.7.2

data/CHANGES.txt

@@ -1,3 +1,6 @@
+0.9.7.2 - November 6, 2009
+  fixed gem spec, added client.rb
+
 0.9.7.1 - November 5, 2009
   added support for multibyte url characters in RSolr::Connection::Utils
     - this is because Ruby 1.9's String size method is different than 1.8

data/lib/rsolr.rb

@@ -8,7 +8,7 @@ require 'xout'
 
 module RSolr
   
-  VERSION = '0.9.7'
+  VERSION = '0.9.7.2'
   
   autoload :Message, 'rsolr/message'
   autoload :Client, 'rsolr/client'

data/lib/rsolr/client.rb

@@ -0,0 +1,113 @@
+class RSolr::Client
+  
+  attr_reader :adapter
+  
+  # "adapter" is instance of:
+  #   RSolr::Adapter::HTTP
+  #   RSolr::Adapter::Direct (jRuby only)
+  # or any other class that uses the connection "interface"
+  def initialize(adapter)
+    @adapter = adapter
+  end
+
+  # Send a request to a request handler using the method name.
+  def method_missing(method_name, *args, &blk)
+    request("/#{method_name}", *args, &blk)
+  end
+  
+  # sends data to the update handler
+  # data can be a string of xml, or an object that returns xml from its #to_xml method
+  def update(data, params={})
+    request '/update', params, data
+  end
+  
+  # send request solr
+  # params is hash with valid solr request params (:q, :fl, :qf etc..)
+  #   if params[:wt] is not set, the default is :ruby
+  #   if :wt is something other than :ruby, the raw response body is used
+  #   otherwise, a simple Hash is returned
+  #   NOTE: to get raw ruby, use :wt=>'ruby' <- a string, not a symbol like :ruby  
+  #
+  #
+  def request(path, params={}, *extra)
+    response = @adapter.request(path, map_params(params), *extra)
+    adapt_response(response)
+  end
+  
+  # 
+  # single record:
+  # solr.update(:id=>1, :name=>'one')
+  #
+  # update using an array
+  # solr.update([{:id=>1, :name=>'one'}, {:id=>2, :name=>'two'}])
+  #
+  def add(doc, &block)
+    update message.add(doc, &block)
+  end
+
+  # send </commit>
+  def commit
+    update message.commit
+  end
+
+  # send </optimize>
+  def optimize
+    update message.optimize
+  end
+
+  # send </rollback>
+  # NOTE: solr 1.4 only
+  def rollback
+    update message.rollback
+  end
+
+  # Delete one or many documents by id
+  #   solr.delete_by_id 10
+  #   solr.delete_by_id([12, 41, 199])
+  def delete_by_id(id)
+    update message.delete_by_id(id)
+  end
+
+  # delete one or many documents by query
+  #   solr.delete_by_query 'available:0'
+  #   solr.delete_by_query ['quantity:0', 'manu:"FQ"']
+  def delete_by_query(query)
+    update message.delete_by_query(query)
+  end
+  
+  # shortcut to RSolr::Message::Builder
+  def message
+    @message ||= RSolr::Message::Builder.new
+  end
+  
+  protected
+  
+  # sets default params etc.. - could be used as a mapping hook
+  # type of request should be passed in here? -> map_params(:query, {})
+  def map_params(params)
+    params||={}
+    {:wt=>:ruby}.merge(params)
+  end
+
+  # "adapter_response" must be a hash with the following keys:
+  #   :params - a sub hash of standard solr params
+  #   : body - the raw response body from the solr server
+  # This method will evaluate the :body value if the params[:wt] == :ruby
+  # otherwise, the body is returned
+  # The return object has a special method attached called #adapter_response
+  # This method gives you access to the original response from the adapter,
+  # so you can access things like the actual :url sent to solr,
+  # the raw :body, original :params and original :data
+  def adapt_response(adapter_response)
+    data = adapter_response[:body]
+    # if the wt is :ruby, evaluate the ruby string response
+    if adapter_response[:params][:wt] == :ruby
+      data = Kernel.eval(data)
+    end
+    # attach a method called #adapter_response that returns the original adapter response value
+    def data.raw; @raw end
+    data.send(:instance_variable_set, '@raw', adapter_response)
+    data
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.9.7.1
+  version: 0.9.7.2
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-05 00:00:00 -05:00
+date: 2009-11-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +27,7 @@ extra_rdoc_files:
 files: 
 - examples/direct.rb
 - examples/http.rb
+- lib/rsolr/client.rb
 - lib/rsolr/connection/direct.rb
 - lib/rsolr/connection/net_http.rb
 - lib/rsolr/connection.rb