mwmitchell-rsolr-ext 0.9.5 → 0.9.6

data/README.rdoc

@@ -1,6 +1,9 @@
 =RSolr::Ext
 A set of helper methods/modules to assist in building Solr queries and handling responses when using the RSolr library.
 
+==Related Resources & Projects
+* {RSolr}[http://github.com/mwmitchell/rsolr]
+
 ==Requests
 To use the RSolr::Ext connection instead of the normal RSolr connection:
   solr = RSolr::Ext.connect
@@ -9,57 +12,61 @@ RSolr::Ext adds a #find and a #luke_admin method to the connection object.
 
 ===#luke
 The #luke method returns a Hash/Mash result of a /admin/luke?numTerms=0 request:
-  solr.luke['index']
-  solr.luke['fields']
-  solr.luke['info']
+  luke_response = solr.luke
+  luke_response['index']
+  luke_response['fields']
+  luke_response['info']
+
 
 ===#find
 The #find method listens for certain keys. All other keys are ignored, allowing the ability to mix-and-match special keys with normal Solr param keys. The recognized keys are describe below.
 
-====:page
-This maps to the Solr "start" param. The current "page" in the results set. RSolr::Ext handles the page-to-rows math for you.
 
-====:per_page
-This maps to the Solr "rows" param. How many "pages" in the result.
+:page - This maps to the Solr "start" param. The current "page" in the results set. RSolr::Ext handles the page-to-rows math for you.
+
+
+:per_page - This maps to the Solr "rows" param. How many "pages" in the result.
+
+
+:queries - This key maps to the Solr "q" param. Accepts a string, array or hash. When an array is used, each value is joined by a space. When a hash is used, the keys are used as Solr fields.
 
-====:queries
-This key maps to the Solr "q" param. Accepts a string, array or hash. When an array is used, each value is joined by a space. When a hash is used, the keys are used as Solr fields.
-=====Examples
 * :queries => 'normal' BECOMES ?q=normal
 * :queries => ['one', 'two'] BECOMES ?q=one two
 * :queries => {:title=>'one'} BECOMES ?q=title:(one)
 * :queries => ['red', {:title=>'one'}] BECOMES ?q=red title:(one)
 
-====:phrases
-This value is mapped to the Solr "q" param. When this key is used, the value will become double-quoted, creating a Solr "phrase" based query.
-=====Examples
+
+:phrases - This value is mapped to the Solr "q" param. When this key is used, the value will become double-quoted, creating a Solr "phrase" based query.
+
 * :phrases => 'normal' BECOMES ?q="normal"
 * :phrases => ['one', 'two'] BECOMES ?q="one" "two"
 * :phrases => {:title=>'one'} BECOMES ?q=title:("one")
-* :phrases => ['red', {:title=>'one'}] BECOMES ?q="red" title:("one")
+* :phrases => ['red', {:title=>'one'}] BECOMES ?q="red" title:("one") 
+
+
+:filters - The :filters key maps to the Solr :fq param. This has the same behavior as the :queries key, except it's for the :fq param.
 
-====:filters
-The :filters key maps to the Solr :fq param. This has the same behavior as the :queries key, except it's for the :fq param.
-=====Examples
 * :filters => 'normal' BECOMES ?fq=normal
 * :filters => ['one', 'two'] BECOMES ?fq=one two
 * :filters => {:title=>'one'} BECOMES ?fq=title:(one)
 * :filters => ['red', {:title=>'one'}] BECOMES ?fq=red title:(one)
+ 
+
+:phrase_filters - The :phrase_filters key maps to the Solr :fq param. This has the same behavior as the :phrases key, except it's for the :fq param.
 
-====:phrase_filters
-The :phrase_filters key maps to the Solr :fq param. This has the same behavior as the :phrases key, except it's for the :fq param.
-=====Examples
 * :phrase_filters => 'normal' BECOMES ?fq="normal"
 * :phrase_filters => ['one', 'two'] BECOMES ?fq="one" "two"
 * :phrase_filters => {:title=>'one'} BECOMES ?fq=title:("one")
 * :phrase_filters => ['red', {:title=>'one'}] BECOMES ?fq="red" title:("one")
+ 
+
+:facets - The :facets does a few different things. First, it sets the Solr param facet=true. It accepts a hash with a single key called :fields. This should be an array of field names to facet on.
 
-====:facets
-The :facets does a few different things. First, it sets the Solr param facet=true. It accepts a hash with a single key called :fields. This should be an array of field names to facet on.
-=====Examples
 * :facets=>{:fields=>['cat', 'blah']} BECOMES ?facet=true&facet.field=cat&facet.field=blah
 
-====Request Example
+
+
+==Request Example
   solr = RSolr::Ext.connect
   solr_params = {
     :page=>2,
@@ -68,15 +75,14 @@ The :facets does a few different things. First, it sets the Solr param facet=tru
     :filters=>['test', {:price=>(1..10)}],
     :phrase_filters=>{:manu=>['Apple']},
     :queries=>'ipod',
-    :facets=>{:fields=>['cat', 'blah']}
+    :facets=>{:fields=>['cat', 'blah']},
+    :echoParams => 'EXPLICIT'
   }
-  
-  response = rsolr.find(solr_params)
+  response = rsolr.find solr_params
 
 ==Responses
 RSolr::Ext decorates the normal output hash from RSolr and adds some helpful methods.
-
-===Examples
+  
   solr = RSolr::Ext.connect
   
   response = solr.find :q=>'*:*'

data/lib/rsolr-ext/connection.rb

@@ -12,9 +12,12 @@ module RSolr::Ext::Connection
   # mappings are available (everything else gets passed to solr).
   # Returns a new RSolr::Ext::Response::Base object.
   def find *args
+    # remove the handler arg - the first, if it is a string OR set default
     path = args.first.is_a?(String) ? args.shift : '/select'
-    params = args.pop || {}
-    response = self.request path, RSolr::Ext::Request.map(params)
+    # remove the params - the first, if it is a Hash OR set default
+    params = args.first.kind_of?(Hash) ? args.shift : {}
+    # send path, map params and send the rest of the args along
+    response = self.request path, RSolr::Ext::Request.map(params), *args
     RSolr::Ext::Response::Base.new(response)
   end
   

data/rsolr-ext.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "rsolr-ext"
-  s.version = "0.9.5"
-  s.date = "2009-09-04"
+  s.version = "0.9.6"
+  s.date = "2009-09-12"
   s.summary = "An extension lib for RSolr"
   s.email = "goodieboy@gmail.com"
   s.homepage = "http://github.com/mwmitchell/rsolr_ext"
@@ -9,25 +9,16 @@ Gem::Specification.new do |s|
   s.has_rdoc = true
   s.authors = ["Matt Mitchell"]
   s.files = [
-  
     "lib/mash.rb",
-  
     "lib/rsolr-ext/connection.rb",
-  
     "lib/rsolr-ext/doc.rb",
-  
     "lib/rsolr-ext/model.rb",
-  
     "lib/rsolr-ext/request.rb",
-  
     "lib/rsolr-ext/response/docs.rb",
     "lib/rsolr-ext/response/facets.rb",
     "lib/rsolr-ext/response/spelling.rb",
-  
     "lib/rsolr-ext/response.rb",
-  
     "lib/rsolr-ext.rb",
-  
     "LICENSE",
     "README.rdoc",
     "rsolr-ext.gemspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-04 00:00:00 -07:00
+date: 2009-09-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,6 @@ files:
 - rsolr-ext.gemspec
 has_rdoc: true
 homepage: http://github.com/mwmitchell/rsolr_ext
-licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -68,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: An extension lib for RSolr