mdwan-rsolr 0.8.2

data/CHANGES.txt

@@ -0,0 +1,157 @@
+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
+  Updated tests, examples and README.rdoc to reflect this change
+  Bumped the version up in gemspec and the RSolr module
+
+0.8.1 - March 12, 2009
+  Added RSolr.escape and RSolr::Connection.new.escape
+    - tests in rsolr_test
+  Added ability to set doc and field attributes when adding documents via Message.add
+
+0.8.0 - March 6, 2009
+  Removed all response wrapper classes (now returning a simple hash for ruby responses)
+  Removed RSolr::Query - this library needs an external partner lib, RSolrExt etc..
+  changed query method to select
+  added send_request method to Connection for custom requests:
+    send_request '/my-handler', {:start=>0}, post_data=nil
+  moved Connection::Base to Connection
+  moved Connection::Adapter::* to Adapter::*
+  
+0.7.1 - February 27, 2009
+  Added simple query helper module -> RSolr::Query
+  Added tests for RSolr::Query
+  Modified Test::Unit::TestCase in test/test_helpers.rb
+
+0.7.0 - February 20, 2009
+  Removed all param mapping behavior, code and tests
+   - this stuff just gunks up rsolr and should be in an extension of some sort
+  Can now specify the request handler in all RSolr::Connection::Base methods as the first argument:
+    - solr.query 'select', :q=>'ipod'
+    - solr.query 'catalog', :q=>'humphry'
+    - solr.query :q=>'big' # defaults to the /select handler
+
+0.6.9 - January 29, 2009
+	Simplified facet response methods
+	Main facet method is called #facets
+	  - returns an array of Response::Facet instances
+	  - each Facet instance has field and values attributes
+	  -- the values attribute is an array with FacetValue instances which have @value and @hits
+	Added ability to set Connection::Base @param_adapters using :dismax or :standard
+	  instead of full class constant
+	  updated comments for #search method
+	Updated tests
+	Bumped up version
+
+0.6.8 - January 28, 2009
+	New method added to RSolr::Connection::Base - #find_values_for_facet
+	This method searches for facet values only, and sets the :rows param to 0
+	- returns an RSolr::Response::Query::Base instance
+	Example:
+		search_params[:facets][:offset]=0
+		search_params[:facets][:limit]=5
+		response = solr.search_facet_by_name(:language_facet, search_params)
+
+0.6.7 - January 27, 2009
+	The Symbol extension in core_ext.rb was cause for some REALLY painful debuging - so I removed it :(
+	This means no more :q.alt or :facet.field until RSolr gets a really nice query-builder module happening.
+
+0.6.6 - January 26, 2009
+	Added #get method helper to RSolr::Response::Query::DocExt
+	# doc.get(key, opts)
+	# key is the name of the field
+	# opts is a hash with the following valid keys:
+	#  - :sep - a string used for joining multivalued field values
+	#  - :default - a value to return when the key doesn't exist
+	# if :sep is nil and the field is a multivalued field, the array is returned
+
+0.6.5 - January 26, 2009
+	Removed to_mash everywhere, except for usage in RSolr::Response
+	Added a #close method to the Direct adapter
+		- this closes the connection and sets the @connection variable to nil
+	Removed to_mash in RSolr::Connection::Base
+	Changed RSolr::Response::Query::Doc to DocExt
+		- this no longer extends Mash
+		- each doc in the response now uses the #extend method to mixin the new DocExt module
+	Added #teardown method in direct connection test, this method closes the connection
+	Updated the connection test methods a bit
+
+0.6.4 - January 26, 2009
+	Updated the mapping output for the :filters and :phrase_filters (when using the #search method)
+		- now sending multiple fq's instead of one
+	Updated mapping tests
+
+0.6.3 - January 21, 2009
+	Added a new param mapping module: RSolr::Connection::ParamMapping
+	Mapping only for fields that need conversion/escaping or nested (facet.*) etc.
+	This new module can be activated by using the #search method
+	New tests for ParamMapping
+
+0.6.2 - January 14, 2009
+	Removed mapping and indexer modules -- seems to me that a general purpose mapping library
+	would be more valuable than an embedded module in RSolr ( RMapper ?)
+	This helps lighten RSolr a bit too
+	
+0.6.1 - January 13, 2009
+	Removed SearchExt and mapping until this library gets some real use
+	The only param mapping now is for :page and :per_page via the #search method
+	The Connection::Base #query method does NO mapping now
+	
+0.6.0 - January 9, 2009
+	Removed first argument from RSolr.connect, the "adapter_name"
+		The adapter is now set using the :adapter key when passing in options to RSolr.connect:
+		s = RSolr.connect(:adapter=>:direct)
+	
+0.5.9 - January 7, 2009
+	Finally brought in the ExtLib Mash classes for incoming params and response hashes from solr
+	  - this gives the ability to access/set values for hashes using strings OR symbols (HashWithIndifferentAccess)
+	Organized response tests
+	Added more response tests
+	Simplified the RSolr::Response::Base class by supporting only raw/string ruby input
+	Added method to Response::IndexInfo for grabbing a Solr field list
+	
+0.5.7 - January 5, 2009
+	Changed name from Solr to RSolr, changed all references to Solr to RSolr
+	Added new tests for RSolr::Mapper and RSolr::Message
+	
+0.5.6 - December 30, 2008
+	solr.gemspec cleanedup thanks to shairontoledo on github! :)
+	Added Solr::Response::Query::Facet module with helpers from the delsolr project
+		Also added test stub in test/connection/search_ext_test_methods.rb
+	Fixed pagination math errors
+	Added new SearchExt helper field: :phrase_filters
+		This will add quoted values to the :filters (fq solr param) hash for doing easier facet requests
+	
+	Be sure to check out the new demo app: http://github.com/mwmitchell/consuminator/tree/master
+	
+0.5.5 - December 29, 2008
+	Fixed bug where accessing a field by method name failed:
+		docs.each do |doc|
+			doc.timestamp
+		end
+	Fixed bug where using the #has? method on a doc failed:
+		docs.each do |doc|
+			doc.has?('timestamp')
+		end
+	Removed invalid autoload in Solr module
+	Fixed spelling error in Solr::Connection::SearchExt (thanks to matthewrudy)
+	
+0.5.4 - December 29, 2008
+	Re-organized the main Solr adapters, they're now in Solr::Connection::Adapter instead of Solr::Adapter
+	All responses from HTTPClient and Connection::Adapter::Direct return a hash with the following keys:
+		:status_code
+		:body
+		:params
+		:url
+		:path
+		:headers
+		:data
+	This hash is now available in the solr response objects as #source - this will be useful in testing and debugging by allowing you to see the generated params and queries... example:
+		response = Solr.query(:q=>'*:*')
+		response.source[:params]
+		response.source[:body]
+		response.source[:url]
+	Added MultiValue field support in Solr::Message, thanks to Fouad Mardini
+	Bug in Solr::Connection::SearchExt where the :q params was not getting generated - fixed by Fouad Mardini
+	Organized tests a bit, moved connection tests into test/connection
+	Fixed a bug in Solr::Connection::Adapter::HTTP where invalid HTTP POST headers were being generated

data/LICENSE

@@ -0,0 +1,67 @@
+Copyright 2008-2009 Matt Mitchell
+
+Licensed 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.
+
+========================================================================
+
+For use of the lib/Mash/extlib code:
+
+========================================================================
+
+Copyright (c) 2008 Sam Smoot.
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 
+---
+---
+ 
+Some portions of blank.rb and mash.rb are verbatim copies of software
+licensed under the MIT license. That license is included below:
+ 
+Copyright (c) 2005-2008 David Heinemeier Hansson
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,126 @@
+=RSolr
+
+A Ruby client for Apache Solr. Has transparent JRuby support by using "org.apache.solr.servlet.DirectSolrConnection" as a connection adapter.
+
+==Installation:
+  gem sources -a http://gems.github.com
+  sudo gem install mwmitchell-rsolr
+
+==Community
+http://groups.google.com/group/rsolr
+
+==Simple usage:
+  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=*:*
+
+To run tests:
+  
+  Copy an Apache Solr 1.3.0/or later (http://apache.seekmeup.com/lucene/solr/1.3.0/) distribution into this directory and rename to "apache-solr"
+  Start Solr HTTP:    rake rsolr:start_test_server
+  MRI Ruby:           rake
+  JRuby:              jruby -S rake
+
+To get a connection in MRI/standard Ruby:
+  
+  solr = RSolr.connect
+
+To change the Solr HTTP host:
+  
+  solr = RSolr.connect(:url=>'http://solrserver.com')
+
+To get a direct connection (no http) in jRuby using DirectSolrConnection:
+  
+  solr = RSolr.connect({
+    :adapter=>:direct,
+    :home_dir=>'/path/to/solr/home',
+    :dist_dir=>'/path/to/solr/distribution'
+  )
+
+== Requests
+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)
+
+
+=== 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".
+
+Single document
+  response = solr.add(:id=>1, :price=>1.00)
+
+Multiple documents
+  documents = [{:id=>1, :price=>1.00}, {:id=>2, :price=>10.50}]
+  response = solr.add(documents)
+
+When adding, you can also supply "add" xml element attributes and/or a block for manipulating other "add" related elements:
+  
+  doc = {:id=>1, :price=>1.00}
+  add_attributes = {:allowDups=>false, :commitWithin=>10.0}
+  solr.add(doc, add_attributes) do |doc|
+    # boost each document
+    doc.attrs[:boost] = 1.5
+    # boost the price field:
+    doc.field_by_name(:price).attrs[:boost] = 2.0
+  end
+
+Delete by id
+  response = solr.delete_by_id(1)
+or an array of ids
+  response = solr.delete_by_id([1, 2, 3, 4])
+
+Delete by query:
+  response = solr.delete_by_query('price:1.00')
+Delete by array of queries
+  response = solr.delete_by_query(['price:1.00', 'price:10.00'])
+
+
+Commit & Optimize
+  solr.commit
+  solr.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..
+
+===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
+
+The adapter_response is a hash that contains the generated params, url, path, post data, headers etc., very useful for debugging and testing.
+
+
+== HTTP Client Adapter
+You can specify the http client adapter to use by setting solr.adapter.connector.adapter_name to one of:
+  :net_http     uses the standard Net::HTTP library
+  :curb         uses the Ruby "curl" bindings
+
+Example:
+	
+  solr.adapter.connector.adapter_name = :curb
+
+Example of using the HTTP client only:
+  
+  hclient = RSolr::HTTPClient::Connector.new(:curb).connect(url)
+  hclient = RSolr::HTTPClient::Connector.new(:net_http).connect(url)
+  hclient.get('/')
+
+After reading this http://apocryph.org/2008/11/09/more_indepth_analysis_ruby_http_client_performance - I would recommend using the :curb adapter. NOTE: You can't use the :curb adapter under jRuby. To install curb:
+
+  sudo gem install curb

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+namespace :rsolr do
+  
+  desc "Starts the HTTP server used for running HTTP connection tests"
+  task :start_test_server do
+    system "cd apache-solr/example; java -jar start.jar"
+  end
+  
+end
+
+task :default => [:test_units]
+
+desc "Run basic tests"
+Rake::TestTask.new("test_units") { |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = true
+  t.libs << "test"
+}
+
+# Clean house
+desc 'Clean up tmp files.'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "pkg"
+end
+
+# Rdoc
+desc 'Generate documentation for the rsolr gem.'
+Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = 'Solr-Ruby'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/examples/direct.rb

@@ -0,0 +1,27 @@
+# Must be executed using jruby
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rsolr')
+
+base = File.expand_path( File.dirname(__FILE__) )
+dist = File.join(base, '..', 'apache-solr')
+home = File.join(dist, 'example', 'solr')
+
+solr = RSolr.connect(:adapter=>:direct, :home_dir=>home, :dist_dir=>dist)
+
+Dir['../apache-solr/example/exampledocs/*.xml'].each do |xml_file|
+  puts "Updating with #{xml_file}"
+  solr.update File.read(xml_file)
+end
+
+puts
+
+response = solr.select :q=>'ipod', :fq=>'price:[0 TO 50]', :rows=>2, :start=>0
+
+docs = response[:response][:docs]
+
+docs.each do |doc|
+  puts doc[:timestamp]
+end
+
+solr.delete_by_query('*:*') and solr.commit
+
+solr.adapter.close

data/examples/http.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rsolr')
+
+solr = RSolr.connect
+
+# switch out the http adapter from curb to net_http (just for an example)
+solr.adapter.connector.adapter_name = :curb
+
+Dir['../apache-solr/example/exampledocs/*.xml'].each do |xml_file|
+  puts "Updating with #{xml_file}"
+  solr.update File.read(xml_file)
+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
+end
+
+solr.delete_by_query('*:*') and solr.commit

data/lib/core_ext.rb

@@ -0,0 +1,25 @@
+#class Symbol
+  
+  # allow symbol chaining: :one.two.three
+  # This breaks Rails, probably lots of other things too :(
+  #def method_missing(m)
+  #  [self.to_s, m.to_s].join('.').to_sym
+  #end
+  
+#end
+
+class Hash
+  
+  def to_mash
+    self.is_a?(Mash) ? self : Mash.new(self)
+  end
+  
+end
+
+unless Array.respond_to?(:extract_options!)
+  class Array
+    def extract_options!
+      last.is_a?(::Hash) ? pop : {}
+    end
+  end
+end