rsolr 1.0.10 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c51404db922cb38d87d897879b80c175e6999fe
-  data.tar.gz: 3c6ac7bf24da6216b288442fc10fc9e207941c00
+  metadata.gz: d605bb65e2fdbd7e99f9bd1890549408f304016e
+  data.tar.gz: 02b7f7e889860627575f10e55b6fe73c9c73663c
 SHA512:
-  metadata.gz: 3ad642cbdd3f948e7f372dbcc75f0e63ae4b011678f2d2b7730f40f378b4298814dbea5fe5a32044317c6537f4eed07064cc1b0e68e429b21bf720bc4ff15e2f
-  data.tar.gz: a3c3283fb33be2db71b9195d5f177075673b819ea5f20e163d0ae69af8b2b7fcfb66f4411edb245f381f3832c8cd4ab8e692e0c01480cb284b10d411d82eafb6
+  metadata.gz: 656df9328215c9dba8d747baa7faff8b47a7b6a0fb5a8a46cb0246a7967ea7ecee78f5f59076396ddd463fd4413f8d54a7efc914df59c64c614a13fe396f1763
+  data.tar.gz: 8efa618685448b35cc7da82c6ec0576b17838bddc4924fb70ac07529afc2075754f9231697b221c42f0fe418010332ddce050236a4d16d1bf0b994d7855975cb

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 2.2.0
   - 2.1.0
   - 2.0.0
   - 1.9.3

data/CHANGES.txt

@@ -1,3 +1,17 @@
+1.0.11
+   - add RSolr.solr_escape method and add deprecation messages to RSolr.escape (ndushay)
+   - use stdlib URI.escape methods instead of homegrown in RSolr::URI (ndushay)
+   - fix bug with Rsolr::Uri.create adding trailing slash if query params (ndushay)
+   - update rake tasks  (cbeer)
+   - add Ruby 2.2.0 to travis ci build (ndushay)
+   - Housekeeping (badges to README, license in gemspec, correct url in gemspec ...)  (ndushay)
+   - Improve rdoc styling (udaykadaboina)
+   - Support setting default_wt per connection via its options. (jcoleman)
+   - eliminates the usage of per-instance `extend` (jcoleman)
+   - Upgrade to RSpec 3 (blackwinter, adamjonas, cbeer)
+   - Fixed RSolr::Error to_s  (PofMagicfingers)
+1.0.10 xxx
+
 1.0.8
    -  Fix connection refused errors in specs + add basic auth support (Denis Goeury)
    - Ability to set :retry_503, the number of retry attempts for a 503 response

data/Gemfile

@@ -4,16 +4,6 @@ gemspec
 
 gem "builder", ">= 2.1.2"
 
-group :development do
-  gem "rake", ">= 0.9.2"
-  gem "rdoc", ">= 3.9"
-end
-
-group :test do
-  gem "rake", ">= 0.9.2"
-  gem "rspec", "~> 2.6"
-end
-
 if defined? RUBY_VERSION and RUBY_VERSION < "1.9"
   gem 'nokogiri', "< 1.6"
-end
+end

data/README.rdoc

@@ -1,12 +1,14 @@
 =RSolr
+{<img src="https://travis-ci.org/rsolr/rsolr.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/rsolr/rsolr] {<img src="https://badge.fury.io/rb/rsolr.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rsolr]
+
 
 A simple, extensible Ruby client for Apache Solr.
 
 ==Documentation
-The code docs for the last *release* can be viewed here: http://rubydoc.info/gems/rsolr/1.0.6/frames
+The code docs http://www.rubydoc.info/gems/rsolr
 
 == Installation:
-  sudo gem install rsolr
+  gem install rsolr
 
 == Example:
   require 'rubygems'
@@ -24,22 +26,22 @@ The code docs for the last *release* can be viewed here: http://rubydoc.info/gem
   # send a request to /catalog
   response = solr.get 'catalog', :params => {:q => '*:*'}
 
-When the Solr :wt is :ruby, then the response will be a Hash. This Hash is the same object returned by Solr, but evaluated as Ruby. If the :wt is not :ruby, then the response will be a String.
+When the Solr +:wt+ is +:ruby+, then the response will be a Hash. This Hash is the same object returned by Solr, but evaluated as Ruby. If the +:wt+ is not +:ruby+, then the response will be a String.
 
-The response also exposes 2 attribute readers (for any :wt value), :request and :response. Both are Hash objects with symbolized keys.
+The response also exposes 2 attribute readers (for any +:wt+ value), +:request+ and +:response+. Both are Hash objects with symbolized keys.
 
-The :request attribute contains the original request context. You can use this for debugging or logging. Some of the keys this object contains are :uri, :query, :method etc..
+The +:request+ attribute contains the original request context. You can use this for debugging or logging. Some of the keys this object contains are +:uri+, +:query+, +:method+ etc..
 
-The :response attribute contains the original response. This object contains the :status, :body and :headers keys.
+The +:response+ attribute contains the original response. This object contains the +:status+, +:body+ and +:headers+ keys.
 
 == Timeouts
 The read and connect timeout settings can be set when creating a new instance of RSolr:
   solr = RSolr.connect(:read_timeout => 120, :open_timeout => 120)
 
 == Retry 503s
-A 503 is usually a temporary error which RSolr may retry if requested. You may specify the number of retry attempts with the :retry_503 option.
+A 503 is usually a temporary error which RSolr may retry if requested. You may specify the number of retry attempts with the +:retry_503+ option.
 
-Only requests which specify a Retry-After header will be retried, after waiting the indicated retry interval, otherwise RSolr will treat the request as a 500. You may specify a maximum Retry-After interval to wait with the :retry_after_limit option (default: one second).
+Only requests which specify a Retry-After header will be retried, after waiting the indicated retry interval, otherwise RSolr will treat the request as a 500. You may specify a maximum Retry-After interval to wait with the +:retry_after_limit+ option (default: one second).
   solr = RSolr.connect(:retry_503 => 1, :retry_after_limit => 1)
 
 
@@ -52,7 +54,7 @@ Use the #get / #post method to send search requests to the /select handler:
   }
   response["response"]["docs"].each{|doc| puts doc["id"] }
 
-The :params sent into the method are sent to Solr as-is, which is to say they are converted to Solr url style, but no special mapping is used.
+The +:params+ sent into the method are sent to Solr as-is, which is to say they are converted to Solr url style, but no special mapping is used.
 When an array is used, multiple parameters *with the same name* are generated for the Solr query. Example:
   
   solr.get 'select', :params => {:q=>'roses', :fq=>['red', 'violet']}
@@ -71,7 +73,7 @@ The paginate method returns WillPaginate ready "docs" objects, so for example in
   <%= will_paginate @solr_response["response"]["docs"] %>
 
 ===Method Missing
-The RSolr::Client class also uses method_missing for setting the request handler/path:
+The +RSolr::Client+ class also uses +method_missing+ for setting the request handler/path:
   
   solr.paintings :params => {:q=>'roses', :fq=>['red', 'violet']}
   
@@ -86,7 +88,7 @@ This works with pagination as well:
 There may be cases where the query string is too long for a GET request. RSolr solves this issue by converting hash objects into form-encoded strings:
   response = solr.music :data => {:q => "*:*"}
 
-The :data hash is serialized as a form-encoded query string, and the correct content-type headers are sent along to Solr.
+The +:data+ hash is serialized as a form-encoded query string, and the correct content-type headers are sent along to Solr.
 
 ===Sending HEAD Requests
 There may be cases where you'd like to send a HEAD request to Solr:
@@ -94,11 +96,11 @@ There may be cases where you'd like to send a HEAD request to Solr:
 
 ==Sending HTTP Headers
 Solr responds to the request headers listed here: http://wiki.apache.org/solr/SolrAndHTTPCaches
-To send header information to Solr using RSolr, just use the :headers option:
+To send header information to Solr using RSolr, just use the +:headers+ option:
   response = solr.head "admin/ping", :headers => {"Cache-Control" => "If-None-Match"}
 
 ===Building a Request
-RSolr::Client provides a method for building a request context, which can be useful for debugging or logging etc.:
++RSolr::Client+ provides a method for building a request context, which can be useful for debugging or logging etc.:
   request_context = solr.build_request "select", :data => {:q => "*:*"}, :method => :post, :headers => {}
   
 To build a paginated request use build_paginated_request:
@@ -114,7 +116,7 @@ Multiple documents via #add
   documents = [{:id=>1, :price=>1.00}, {:id=>2, :price=>10.50}]
   solr.add documents
 
-The optional :add_attributes hash can also be used to set Solr "add" document attributes:
+The optional +:add_attributes+ hash can also be used to set Solr "add" document attributes:
   solr.add documents, :add_attributes => {:commitWithin => 10}
 
 Raw XML via  #update
@@ -151,7 +153,7 @@ Delete by array of queries
   solr.optimize, :optimize_attributes => {}
 
 == Response Formats
-The default response format is Ruby. When the :wt param is set to :ruby, the response is eval'd resulting in a Hash. You can get a raw response by setting the :wt to "ruby" - notice, the string -- not a symbol. RSolr will eval the Ruby string ONLY if the :wt value is :ruby. All other response formats are available as expected, :wt=>'xml' etc..
+The default response format is Ruby. When the +:wt+ param is set to +:ruby+, the response is eval'd resulting in a Hash. You can get a raw response by setting the +:wt+ to +"ruby"+ - notice, the string -- not a symbol. RSolr will eval the Ruby string ONLY if the :wt value is :ruby. All other response formats are available as expected, +:wt=>'xml'+ etc..
 
 ===Evaluated Ruby (default)
   solr.get 'select', :params => {:wt => :ruby} # notice :ruby is a Symbol
@@ -197,6 +199,7 @@ The default response format is Ruby. When the :wt param is set to :ruby, the res
 * Lucas Souza
 * Dmitry Lihachev
 * Antoine Latter
+* Naomi Dushay
 
 ==Author
 

data/Rakefile

@@ -1,15 +1,6 @@
 require 'rake'
-require 'rake/testtask'
 require 'bundler/gem_tasks'
 
-require 'rubygems/package_task'
-
-ENV['RUBYOPT'] = '-W1'
- 
-task :environment do
-  require File.dirname(__FILE__) + '/lib/rsolr'
-end
- 
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-task :default => ['spec:api']
+task :default => ['spec']

data/lib/rsolr/char.rb

@@ -1,9 +1,12 @@
 # A module that contains (1) string related methods
+# @deprecated remove this module when we remove the method (duh)
 module RSolr::Char
   
   # backslash everything
   # that isn't a word character
+  # @deprecated - this is incorrect Solr escaping
   def escape value
+    warn "[DEPRECATION] `RSolr.escape` is deprecated (and incorrect).  Use `Rsolr.solr_escape` instead."
     value.gsub(/(\W)/, '\\\\\1')
   end
   

data/lib/rsolr/client.rb

@@ -261,12 +261,7 @@ class RSolr::Client
     opts[:params]["rows"] = per_page
     build_request path, opts
   end
-  
-  #  A mixin for used by #adapt_response
-  module Context
-    attr_accessor :request, :response
-  end
-  
+
   # This method will evaluate the :body value
   # if the params[:uri].params[:wt] == :ruby
   # ... otherwise, the body is returned as is.
@@ -288,13 +283,15 @@ class RSolr::Client
       response[:body]
     end
 
-    result.extend Context
-    result.request, result.response = request, response
-    result.is_a?(Hash) ? result.extend(RSolr::Response) : result
+    if result.is_a?(Hash)
+      result = RSolr::HashWithResponse.new(request, response, result)
+    end
+
+    result
   end
-  
+
   protected
-  
+
   # converts the method name for the solr request handler path.
   def method_missing name, *args
     if name.to_s =~ /^paginated?_(.+)$/
@@ -330,6 +327,6 @@ class RSolr::Client
   end
 
   def default_wt
-    self.class.default_wt
+    self.options[:default_wt] || self.class.default_wt
   end
 end

data/lib/rsolr/error.rb

@@ -12,8 +12,8 @@ module RSolr::Error
         m << "\nError: #{details}\n" if details
       end
       p = "\nURI: #{request[:uri].to_s}"
-      p = "\nRequest Headers: #{request[:headers].inspect}" if request[:headers]
-      p = "\nRequest Data: #{request[:data].inspect}" if request[:data]
+      p << "\nRequest Headers: #{request[:headers].inspect}" if request[:headers]
+      p << "\nRequest Data: #{request[:data].inspect}" if request[:data]
       p << "\n"
       p << "\nBacktrace: " + self.backtrace[0..10].join("\n")
       m << p

data/lib/rsolr/response.rb

@@ -1,26 +1,47 @@
 module RSolr::Response
-  
-  def self.extended base
-    if base["response"] && base["response"]["docs"]
-      base["response"]["docs"].tap do |d|
-        d.extend PaginatedDocSet
-        d.per_page = base.request[:params]["rows"]
-        d.page_start = base.request[:params]["start"]
-        d.page_total = base["response"]["numFound"].to_s.to_i
-      end
+
+  def self.included(base)
+    unless base < Hash
+      raise ArgumentError, "RSolr::Response expects to included only in (sub)classes of Hash; got included in '#{base}' instead."
+    end
+    base.send(:attr_reader, :request, :response)
+  end
+
+  def initialize_rsolr_response(request, response, result)
+    @request = request
+    @response = response
+    self.merge!(result)
+    if self["response"] && self["response"]["docs"].is_a?(Array)
+      docs = PaginatedDocSet.new(self["response"]["docs"])
+      docs.per_page = request[:params]["rows"]
+      docs.page_start = request[:params]["start"]
+      docs.page_total = self["response"]["numFound"].to_s.to_i
+      self["response"]["docs"] = docs
     end
   end
-  
+
   def with_indifferent_access
-    if {}.respond_to?(:with_indifferent_access)
-      super.extend RSolr::Response
+    if defined?(::RSolr::HashWithIndifferentAccessWithResponse)
+      ::RSolr::HashWithIndifferentAccessWithResponse.new(request, response, self)
     else
-      raise NoMethodError, "undefined method `with_indifferent_access' for #{self.inspect}:#{self.class.name}"
+      if defined?(ActiveSupport::HashWithIndifferentAccess)
+        RSolr.const_set("HashWithIndifferentAccessWithResponse", Class.new(ActiveSupport::HashWithIndifferentAccess))
+        RSolr::HashWithIndifferentAccessWithResponse.class_eval <<-eos
+          include RSolr::Response
+          def initialize(request, response, result)
+            super()
+            initialize_rsolr_response(request, response, result)
+          end
+        eos
+        ::RSolr::HashWithIndifferentAccessWithResponse.new(request, response, self)
+      else
+        raise RuntimeError, "HashWithIndifferentAccess is not currently defined"
+      end
     end
   end
 
   # A response module which gets mixed into the solr ["response"]["docs"] array.
-  module PaginatedDocSet
+  class PaginatedDocSet < Array
 
     attr_accessor :page_start, :per_page, :page_total
     if not (Object.const_defined?("RUBY_ENGINE") and Object::RUBY_ENGINE=='rbx')
@@ -61,5 +82,14 @@ module RSolr::Response
     end
 
   end
-  
+
+end
+
+class RSolr::HashWithResponse < Hash
+  include RSolr::Response
+
+  def initialize(request, response, result)
+    super()
+    initialize_rsolr_response(request, response, result)
+  end
 end

data/lib/rsolr/uri.rb

@@ -3,56 +3,73 @@ require 'uri'
 module RSolr::Uri
   
   def create url
-    ::URI.parse url[-1] == ?/ ? url : "#{url}/"
+    ::URI.parse (url[-1] == '/' || URI.parse(url).query) ? url : "#{url}/"
   end
   
-  # Returns a query string param pair as a string.
-  # Both key and value are escaped.
-  def build_param(k,v, escape = true)
-    escape ? 
-      "#{escape_query_value(k)}=#{escape_query_value(v)}" :
-      "#{k}=#{v}"
-  end
-
-  # Return the bytesize of String; uses String#size under Ruby 1.8 and
-  # String#bytesize under 1.9.
-  if ''.respond_to?(:bytesize)
-    def bytesize(string)
-      string.bytesize
-    end
-  else
-    def bytesize(string)
-      string.size
-    end
-  end
-
   # Creates a Solr based query string.
   # Keys that have arrays values are set multiple times:
   #   params_to_solr(:q => 'query', :fq => ['a', 'b'])
   # is converted to:
   #   ?q=query&fq=a&fq=b
+  # @param [boolean] escape false if no URI escaping is to be performed.  Default true.
+  # @return [String] Solr query params as a String, suitable for use in a url
   def params_to_solr(params, escape = true)
+    return URI.encode_www_form(params.reject{|k,v| k.to_s.empty? || v.to_s.empty?}) if escape
+
+    # escape = false if we are here
     mapped = params.map do |k, v|
       next if v.to_s.empty?
       if v.class == Array
-        params_to_solr(v.map { |x| [k, x] }, escape)
+        params_to_solr(v.map { |x| [k, x] }, false)
       else
-        build_param k, v, escape
+        "#{k}=#{v}"
       end
     end
     mapped.compact.join("&")
   end
   
+  # Returns a query string param pair as a string.
+  # Both key and value are URI escaped, unless third param is false
+  # @param [boolean] escape false if no URI escaping is to be performed.  Default true.
+  # @deprecated - used to be called from params_to_solr before 2015-02-25
+  def build_param(k, v, escape = true)
+    warn "[DEPRECATION] `RSolr::Uri.build_param` is deprecated.  Use `URI.encode_www_form_component` or k=v instead."
+    escape ? 
+      "#{URI.encode_www_form_component(k)}=#{URI.encode_www_form_component(v)}" :
+      "#{k}=#{v}"
+  end
+
+  # 2015-02  Deprecated: use URI.encode_www_form_component(s)
+  #
   # Performs URI escaping so that you can construct proper
   # query strings faster.  Use this rather than the cgi.rb
   # version since it's faster.
   # (Stolen from Rack).
+  #  http://www.rubydoc.info/github/rack/rack/URI.encode_www_form_component
+  # @deprecated
   def escape_query_value(s)
-    s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/u) {
-      '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
-    }.tr(' ', '+')
+    warn "[DEPRECATION] `RSolr::Uri.escape_query_value` is deprecated.  Use `URI.encode_www_form_component` instead."
+    URI.encode_www_form_component(s)
+#    s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/u) {
+#      '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
+#    }.tr(' ', '+')
   end
-  
+
+  # Return the bytesize of String; uses String#size under Ruby 1.8 and
+  # String#bytesize under 1.9.
+  # @deprecated  as bytesize was only used by escape_query_value which is itself deprecated
+  if ''.respond_to?(:bytesize)
+    def bytesize(string)
+      warn "[DEPRECATION] `RSolr::Uri.bytesize` is deprecated.  Use String.bytesize"
+      string.bytesize
+    end
+  else
+    def bytesize(string)
+      warn "[DEPRECATION] `RSolr::Uri.bytesize` is deprecated.  Use String.size"
+      string.size
+    end
+  end
+
   extend self
   
 end

data/lib/rsolr/version.rb

@@ -1,5 +1,5 @@
 module RSolr
-  VERSION = "1.0.10"
+  VERSION = "1.0.11"
 
   def self.version
     VERSION

data/lib/rsolr.rb

@@ -1,11 +1,6 @@
-$: << "#{File.dirname(__FILE__)}" unless $:.include? File.dirname(__FILE__)
-
-require 'rubygems'
-require 'rsolr/version'
-
 module RSolr
   
-  %W(Response Char Client Error Connection Uri Xml).each{|n|autoload n.to_sym, "rsolr/#{n.downcase}"}
+  Dir.glob(File.expand_path("../rsolr/*.rb", __FILE__)).each{|rb_file| require(rb_file)}
   
   def self.connect *args
     driver = Class === args[0] ? args[0] : RSolr::Connection
@@ -13,7 +8,19 @@ module RSolr
     Client.new driver.new, opts
   end
   
-  # RSolr.escape
+  # RSolr.escape, which is deprecated as of 2015-02
   extend Char
   
-end
+  # backslash escape characters that have special meaning to Solr query parser
+  # per http://lucene.apache.org/core/4_0_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters
+  #  + - & | ! ( ) { } [ ] ^ " ~ * ? : \ /
+  # see also http://svn.apache.org/repos/asf/lucene/dev/tags/lucene_solr_4_9_1/solr/solrj/src/java/org/apache/solr/client/solrj/util/ClientUtils.java
+  #   escapeQueryChars method
+  # @return [String] str with special chars preceded by a backslash
+  def self.solr_escape(str)
+    # note that the gsub will parse the escaped backslashes, as will the ruby code sending the query to Solr 
+    # so the result sent to Solr is ultimately a single backslash in front of the particular character 
+    str.gsub(/([+\-&|!\(\)\{\}\[\]\^"~\*\?:\\\/])/, '\\\\\1')
+  end
+  
+end

data/rsolr.gemspec

@@ -18,9 +18,11 @@ Gem::Specification.new do |s|
                   "Mat Brown", "Shairon Toledo",
                   "Matthew Rudy", "Fouad Mardini",
                   "Jeremy Hinegardner", "Nathan Witmer",
+                  "Naomi Dushay",
                   "\"shima\""]
   s.email       = ["goodieboy@gmail.com"]
-  s.homepage    = "https://github.com/mwmitchell/rsolr"
+  s.license     = 'Apache-2.0'
+  s.homepage    = "https://github.com/rsolr/rsolr"
   s.rubyforge_project = "rsolr"
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
@@ -30,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'builder', '>= 2.1.2'
   s.add_development_dependency 'activesupport'
   s.add_development_dependency 'nokogiri', '>= 1.4.0'
-  s.add_development_dependency 'rake', '~> 0.9.2'
-  s.add_development_dependency 'rdoc', '~> 3.9.4'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rdoc', '~> 4.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
 end

data/spec/api/char_spec.rb

@@ -1,18 +1,23 @@
 require 'spec_helper'
+# @deprecated remove this module's specs when we remove the method (duh)
 describe "RSolr::Char" do
   
   let(:char){Object.new.extend RSolr::Char}
   
+  # deprecated as of 2015-02, as it is incorrect Solr escaping.
+  #  instead, use RSolr.solr_escape
+  #  commented out as it gives a mess of deprecation warnings
+=begin  
   it 'should escape everything that is not a word with \\' do
     (0..255).each do |ascii|
       chr = ascii.chr
       esc = char.escape(chr)
       if chr =~ /\W/
-        esc.to_s.should == "\\#{chr}"
+        expect(esc.to_s).to eq("\\#{chr}")
       else
-        esc.to_s.should == chr
+        expect(esc.to_s).to eq(chr)
       end
     end
   end
-  
+=end  
 end