mwmitchell-rsolr 0.8.2 → 0.8.3

data/CHANGES.txt

@@ -1,3 +1,12 @@
+0.8.3 - April 3, 2009
+  RSolr::Connection
+    - removed the block functionality of send_request and related methods
+      - this was used to gain access to the raw adapter response
+    - added #adapter_response method to all response objects
+      - this is used to get access to the original adapter response:
+        response = rsolr.select(:q=>'test')
+        response.adapter_response[:status_code]
+
 0.8.2 - March 24, 2009
   Changed RSolr.connect method to accept one options hash argument
     - This hash gets passed to the Connection object and the adapter

data/README.rdoc

@@ -13,10 +13,12 @@ http://groups.google.com/group/rsolr
   require 'rubygems'
   require 'rsolr'
   rsolr = RSolr.connect
-  response = rsolr.select(:q=>'*:*') # sends a request to /solr/select?q=*:*
   
-  # can also set the request handler path like:
-  response = rsolr.send_request('/catalog', :q=>'*:*') # sends a request to /solr/catalog?q=*:*
+  # sends a request to /select
+  response = rsolr.select(:q=>'*:*')
+  
+  # send a request to a custom request handler; /catalog
+  response = rsolr.send_request('/catalog', :q=>'*:*')
 
 To run tests:
   
@@ -46,12 +48,23 @@ Once you have a connection, you can execute queries, updates etc..
 
 === Querying
 Use the #select method to send requests to the /select handler:
-  response = solr.select(:q=>'washington', :facet=>true, 'facet.limit'=>-1, 'facet.field'=>'cat', 'facet.field'=>'inStock', :start=>0, :rows=>10)
+  response = solr.select({
+    :q=>'washington',
+    :facet=>true,
+    'facet.limit'=>-1,
+    'facet.field'=>'cat',
+    'facet.field'=>'inStock',
+    :start=>0,
+    :rows=>10
+  })
 
 
 === Updating Solr
 Updating is done using native Ruby structures. Hashes are used for single documents and arrays are used for a collection of documents (hashes). These structures get turned into simple XML "messages".
 
+Raw XML
+  response = solr.update('</optimize>')
+
 Single document
   response = solr.add(:id=>1, :price=>1.00)
 
@@ -81,7 +94,7 @@ Delete by array of queries
   response = solr.delete_by_query(['price:1.00', 'price:10.00'])
 
 
-Commit & Optimize
+Commit & optimize shortcuts
   solr.commit
   solr.optimize
 
@@ -89,19 +102,21 @@ Commit & Optimize
 == Response Formats
 The default response format is Ruby. When the :wt param is set to :ruby, the response is eval'd and wrapped up in a nice Mash (Hash) class. You can get a raw response by setting the :wt to "ruby" - notice, the string -- not a symbol. All other response formats are available as expected, :wt=>'xml' etc..
 
+===Evaluated Ruby (default)
+  solr.select(:wt=>:ruby) # notice :ruby is a Symbol
+===Raw Ruby
+  solr.select(:wt=>'ruby') # notice 'ruby' is a String
+
 ===XML:
   solr.select(:wt=>:xml)
 ===JSON:
   solr.select(:wt=>:json)
-===Raw Ruby
-  solr.select(:wt=>'ruby')
 
-You can access the original request context (path, params, url etc.) by using a block:
-  solr.select(:q=>'*:*') do |solr_response, adapter_response|
-    adapter_response[:status_code]
-    adapter_response[:body]
-    adapter_response[:url]
-  end
+You can access the original request context (path, params, url etc.) by calling the #adapter_response method:
+  response = solr.select(:q=>'*:*')
+  response.adapter_response[:status_code]
+  response.adapter_response[:body]
+  response.adapter_response[:url]
 
 The adapter_response is a hash that contains the generated params, url, path, post data, headers etc., very useful for debugging and testing.
 

data/Rakefile

@@ -21,6 +21,26 @@ Rake::TestTask.new("test_units") { |t|
   t.libs << "test"
 }
 
+
+desc 'Run specs' # this task runs each test in its own process
+task :specs do
+  require 'rubygems'
+  require 'facets/more/filelist' unless defined?(FileList)
+  files = FileList["**/*_spec.rb"]
+  p files.to_a
+  files.each do |filename|
+    system "cd #{File.dirname(filename)} && ruby #{File.basename(filename)}"
+  end
+end
+
+#desc "Run specs"
+#Rake::TestTask.new("specs") { |t|
+#  t.pattern = 'spec/**/*_spec.rb'
+#  t.verbose = true
+#  t.warning = true
+#  t.libs += ["lib", "spec"]
+#}
+
 # Clean house
 desc 'Clean up tmp files.'
 task :clean do |t|

data/lib/rsolr/connection.rb

@@ -16,9 +16,9 @@ class RSolr::Connection
   end
   
   # sends data to the update handler
-  # data can be a string of xml, or an object that returns xml from its #to_s method
-  def update(data, params={}, &blk)
-    send_request('/update', map_params(params), data, &blk)
+  # data can be a string of xml, or an object that returns xml from its #to_xml method
+  def update(data, params={})
+    send_request('/update', map_params(params), data)
   end
   
   # send request solr
@@ -27,16 +27,11 @@ class RSolr::Connection
   #   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  
-  # 
-  # use a block to get access to the adapter response:
-  # solr.send_request('/select', :q=>'blue') do |solr_response, adapter_response|
-  #   raise 'Woops!' if adapter_response[:status] != 200
-  #   solr_response[:response][:docs].each {|doc|}
-  # end
   #
-  def send_request(path, params={}, data=nil, &blk)
+  #
+  def send_request(path, params={}, data=nil)
     response = @adapter.send_request(path, map_params(params), data)
-    adapt_response(response, &blk)
+    adapt_response(response)
   end
   
   # 
@@ -94,14 +89,27 @@ class RSolr::Connection
     {: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(adapter_response[:body]).to_mash
-    else
-      data = adapter_response[:body]
+      data = Kernel.eval(data).to_mash
+    end
+    # attach a method called #adapter_response that returns the original adapter response value
+    def data.adapter_response
+      @adapter_response
     end
-    block_given? ? yield(data, adapter_response) : data
+    data.send(:instance_variable_set, '@adapter_response', adapter_response)
+    data
   end
   
 end

data/lib/rsolr.rb

@@ -1,13 +1,15 @@
 # add this directory to the load path if it hasn't already been added
-# load xout and rfuzz libs
-proc {|base, files|
-  $: << base unless $:.include?(base) || $:.include?(File.expand_path(base))
-  files.each {|f| require f}
-}.call(File.dirname(__FILE__), ['core_ext', 'mash'])
+
+if ! $:.include? File.dirname(__FILE__) or ! $:.include? File.expand_path(File.dirname(__FILE__))
+  $: << File.dirname(__FILE__)
+end
+
+require 'core_ext'
+require 'mash'
 
 module RSolr
   
-  VERSION = '0.8.2'
+  VERSION = '0.8.3'
   
   autoload :Message, 'rsolr/message'
   autoload :Connection, 'rsolr/connection'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors: 
 - Matt Mitchell