mwmitchell-rsolr 0.5.7

data/CHANGES.txt

@@ -0,0 +1,41 @@
+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,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.rdoc

@@ -0,0 +1,191 @@
+=Solr
+
+A Ruby client for Apache Solr. Has transparent JRuby support by using "org.apache.solr.servlet.DirectSolrConnection" as a connection adapter.
+
+To run tests:
+  
+  Copy a Solr 1.3.0 (or later) distribution into this directory and rename to "apache-solr"
+  Start Solr HTTP:    rake start_test_server
+  MRI Ruby:           rake
+  JRuby:              jruby -S rake
+
+To get a connection in MRI/standard Ruby:
+  
+  solr = Solr.connect(:http)
+
+To get a direct connection in jRuby using DirectSolrConnection:
+  
+  solr = Solr.connect(:direct, :home_dir=>'/path/to/solr/home', :dist_dir=>'/path/to/solr/distribution')
+
+You can set Solr params that will be sent for every request:
+  
+  solr = Solr.connect(:http, :global_params=>{:wt=>:ruby, :echoParams=>'EXPLICIT'})
+
+
+== Requests
+Once you have a connection, you can execute queries, updates etc..
+
+
+=== Querying
+  response = solr.query(:q=>'washington', :facet=>true, :facet.limit=>-1, :facet.field=>'cat', :facet.field=>'inStock')
+  response = solr.find_by_id(1)
+
+* thanks to a little Ruby magic, we can chain symbols to create Solr "dot" syntax: :facet.field=>'cat'
+
+Using the #search method makes building more complex Solr queries easier:
+  
+  response = solr.search 'my search', :filters=>{:price=>(0.00..10.00)}
+  response.docs.each do |doc|
+    doc.price
+  end
+
+====Pagination
+Pagination is simplified by using the :page and :per_page params:
+
+  response = solr.query(:page=>1, :per_page=>10, :q=>'*:*')
+  response.per_page
+  response.total_pages
+  response.current_page
+  response.previous_page
+  response.next_page
+
+If you use WillPaginate, just pass-in the response to the #will_paginate view helper:
+  
+  <%= will_paginate(@response) %>
+
+The #query and #search methods automatically figure out the :start and :rows value, based on the values of :page and :per_page. The will_paginate view helper just needs the right methods (#current_page, #previous_page, #next_page and #total_pages) to create the pagination view widget.
+
+
+=== 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
+  response = solr.add([{:id=>1, :price=>1.00}, {:id=>2, :price=>10.50}])
+
+When adding, you can also supply "add" attributes and/or a block for digging into the Solr "add" params:
+
+  doc = {:id=>1, :price=>1.00}
+  solr.add(doc, {:allowDups=>false, :commitWithin=>10.0}) do |doc_attrs|
+    doc_attrs[:boost] = 10.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 Solr::Response class. You can get an unwrapped response by setting the :wt to "ruby" - notice, the string -- not a symbol. All other response formats are available as expected, :wt=>'xml' etc.. Currently, the only response format that gets eval'd and wrapped is :ruby.
+
+You can access the original request context (path, params, url etc.) from response.source. The response.source is a hash that contains the generated params, url, path, post data, headers etc.. This could be useful for debugging and testing.
+
+==Data Mapping
+The Solr::Mapper::Base class provides some nice ways of mapping data. You provide a hash mapping and a "data source". The keys of the hash mapping become the Solr field names. The values of the hash mapping get processed differently based on the value. The data source must be an Enumerable type object. The hash mapping is processed for each item in the data source.
+
+===Hash Map Processing
+If the value is a string, the value of the String is used as the final Solr field value. If the value is a Symbol, the Symbol is used as a key on the data source. An Enumerable type does the same as the Symbol, but for each item in the set. The most interesting and flexible processing occurs when the value is a Proc. When a Proc is used as a hash mapping value, the mapper executes the Proc's #call method, passing in the current data source item.
+
+===Examples
+
+  mapping = {
+    :id=>:id,
+    :title=>:title,
+    :source=>'Example',
+    :meta=>[:author, :sub_title],
+    :web_id=>proc {|item|
+      WebService.fetch_item_id_by_name(item[:name])
+    }
+  }
+  
+  data_source = [
+    {
+      :id=>100,
+      :title=>'Doc One',
+      :author=>'Mr. X',
+      :sub_title=>'A first class document.',
+      :name=>'doc_1'
+    },
+    {
+      :id=>200,
+      :title=>'Doc Two',
+      :author=>'Mr. XYZ',
+      :sub_title=>'A second class document.',
+      :name=>'doc_2'
+    }
+  ]
+  
+  mapper = Solr::Mapper::Base(mapping)
+  mapped_data = mapper.map(data_source)
+  
+  # the following would be true...
+  mapped_data == [
+    {
+      :id=>100,
+      :title=>'Doc One',
+      :source=>'Example',
+      :meta=>['Mr. X', 'A first class document'],
+      :web_id=>'web_id_for_doc_1_for_example'
+    },
+    {
+      :id=>200,
+      :title=>'Doc Two',
+      :source=>'Example',
+      :meta=>['Mr. XYZ', 'A second class document'],
+      :web_id=>'web_id_for_doc_2_for_example'
+    }
+  ]
+
+===RSS Mapper
+There is currently one built in mapper, Solr::Mapper::RSS. Here's an example usage:
+  
+  mapper = Solr::Mapper::RSS.new
+  mapping = {
+    :channel=>:'channel.title',
+    :url=>:'channel.link',
+    :total=>:'items.size',
+    :title=>proc {|item,m| item.title },
+    :link=>proc {|item,m| item.link },
+    :published=>proc {|item,m| item.date },
+    :description=>proc {|item,m| item.description }
+  }
+  mapped_data = m.map('http://site.com/feed.rss')
+
+==Indexing
+Solr (ruby) comes with a simple indexer that makes use of the Solr mapper. Here's an example, using the "mapping" and "mapped_data" variables above (RSS mapper):
+
+  solr = Solr.connect(:http)
+  i = Solr::Indexer.new(solr, mapping)
+  i.index(mapped_data)
+
+
+==HTTP Client Adapter
+You can specify the Ruby http client to use by setting Solr::Connection::Adapter::HTTP.client_adapter to one of:
+  :net_http     uses the standard Net::HTTP library
+  :curb         uses the Ruby "curl" bindings
+
+Example:
+	
+  Solr::Connection::Adapter::HTTP.client_adapter = :curb
+	
+Example of using the HTTP client only:
+  
+  hclient = Solr::HTTPClient.connect(url, :curb)
+  hclient = Solr::HTTPClient.connect(url, :net_http)
+
+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,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require File.join(File.dirname(__FILE__), 'lib', 'rsolr')
+
+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
+}
+
+# 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