rsolr 0.12.0 → 2.6.0

data/lib/rsolr.rb

@@ -1,40 +1,52 @@
-
-require 'rubygems'
-$:.unshift File.dirname(__FILE__) unless $:.include?(File.dirname(__FILE__))
-
 module RSolr
-  
-  VERSION = '0.12.0'
-  
-  autoload :Message, 'rsolr/message'
+  require 'rsolr/version'
+
+  autoload :Char, 'rsolr/char'
   autoload :Client, 'rsolr/client'
-  autoload :Connection, 'rsolr/connection'
-  
-  def self.connect opts={}
-    Client.new Connection::NetHttp.new(opts)
+  autoload :Document, 'rsolr/document'
+  autoload :Error, 'rsolr/error'
+  autoload :Field, 'rsolr/field'
+  autoload :Generator, 'rsolr/generator'
+  autoload :HashWithResponse, 'rsolr/response'
+  autoload :JSON, 'rsolr/json'
+  autoload :Response, 'rsolr/response'
+  autoload :Uri, 'rsolr/uri'
+  autoload :Xml, 'rsolr/xml'
+
+  def self.connect *args
+    opts = args.pop if args.last.is_a?(::Hash)
+    opts ||= {}
+
+    connection = args.first
+
+    Client.new connection, opts
+  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
-  
-  # A module that contains string related methods
-  module Char
-    
-    # escape - from the solr-ruby library
-    # RSolr.escape('asdf')
-    # backslash everything that isn't a word character
-    def escape(value)
-      value.gsub(/(\W)/, '\\\\\1')
+
+  module Array
+    def self.wrap(object)
+      if object.nil?
+        [nil]
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      elsif object.is_a? Hash
+        [object]
+      elsif object.is_a? Enumerable
+        object
+      else
+        [object]
+      end
     end
-    
   end
-  
-  # send the escape method into the Connection class ->
-  # solr = RSolr.connect
-  # solr.escape('asdf')
-  RSolr::Client.send(:include, Char)
-  
-  # bring escape into this module (RSolr) -> RSolr.escape('asdf')
-  extend Char
-  
-  # RequestError is a common/generic exception class used by the adapters
-  class RequestError < RuntimeError; end
-  
-end
+end

data/rsolr.gemspec

@@ -1,32 +1,45 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rsolr/version"
+
 Gem::Specification.new do |s|
-  
-  s.name = "rsolr"
-  s.version = "0.12.0"
-  s.date = "2010-02-03"
-  s.summary = "A Ruby client for Apache Solr"
-  s.email = "goodieboy@gmail.com"
-  s.homepage = "http://github.com/mwmitchell/rsolr"
-  s.description = "RSolr is a Ruby gem for working with Apache Solr!"
-  s.has_rdoc = true
-  s.authors = ["Matt Mitchell"]
-  
-  s.files = [
-    "CHANGES.txt",
-    "lib/rsolr/client.rb",
-    "lib/rsolr/connection/net_http.rb",
-    "lib/rsolr/connection/requestable.rb",
-    "lib/rsolr/connection/utils.rb",
-    "lib/rsolr/connection.rb",
-    "lib/rsolr/message/document.rb",
-    "lib/rsolr/message/field.rb",
-    "lib/rsolr/message/generator.rb",
-    "lib/rsolr/message.rb",
-    "lib/rsolr.rb",
-    "LICENSE",
-    "README.rdoc",
-    "rsolr.gemspec"
-  ]
-  
-  #s.rdoc_options = ["--main", "README.rdoc"]
-  s.extra_rdoc_files = %w(LICENSE README.rdoc CHANGES.txt)
-end
+  s.name        = "rsolr"
+  s.summary     = "A Ruby client for Apache Solr"
+  s.description = %q{RSolr aims to provide a simple and extensible library for working with Solr}
+  s.version     = RSolr::VERSION
+  s.authors     = ["Antoine Latter", "Dmitry Lihachev",
+                  "Lucas Souza", "Peter Kieltyka",
+                  "Rob Di Marco", "Magnus Bergmark",
+                  "Jonathan Rochkind", "Chris Beer",
+                  "Craig Smith", "Randy Souza",
+                  "Colin Steele", "Peter Kieltyka",
+                  "Lorenzo Riccucci", "Mike Perham",
+                  "Mat Brown", "Shairon Toledo",
+                  "Matthew Rudy", "Fouad Mardini",
+                  "Jeremy Hinegardner", "Nathan Witmer",
+                  "Naomi Dushay",
+                  "\"shima\""]
+  s.email       = ["goodieboy@gmail.com"]
+  s.license     = 'Apache-2.0'
+  s.homepage    = "https://github.com/rsolr/rsolr"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version      = '>= 1.9.3'
+
+  s.requirements << 'Apache Solr'
+
+  s.add_dependency 'builder', '>= 2.1.2'
+  s.add_dependency 'faraday', '>= 0.9', '!= 2.0.0', '< 3'
+
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'nokogiri', '>= 1.4.0'
+  s.add_development_dependency 'rake', '>= 10.0'
+  s.add_development_dependency 'rdoc', '>= 4.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'solr_wrapper'
+end

data/spec/api/client_spec.rb

@@ -0,0 +1,423 @@
+require 'spec_helper'
+
+RSpec.describe RSolr::Client do
+  let(:connection) { nil }
+  let(:url) { "http://localhost:9999/solr" }
+  let(:connection_options) { { url: url, update_format: :xml } }
+
+  let(:client) do
+    RSolr::Client.new connection, connection_options
+  end
+
+  let(:client_with_proxy) do
+    RSolr::Client.new connection, connection_options.merge(proxy: 'http://localhost:8080')
+  end
+
+  context "initialize" do
+    it "should accept whatevs and set it as the @connection" do
+      expect(RSolr::Client.new(:whatevs).connection).to eq(:whatevs)
+    end
+
+    it "should use :update_path from options" do
+      client = RSolr::Client.new(:whatevs, { update_path: 'update_test' })
+      expect(client.update_path).to eql('update_test')
+    end
+
+    it "should use 'update' for update_path by default" do
+      client = RSolr::Client.new(:whatevs)
+      expect(client.update_path).to eql('update')
+    end
+
+    it "should use :proxy from options" do
+      client = RSolr::Client.new(:whatevs, { proxy: 'http://my.proxy/' })
+      expect(client.proxy.to_s).to eql('http://my.proxy/')
+    end
+
+    it "should use 'nil' for proxy by default" do
+      client = RSolr::Client.new(:whatevs)
+      expect(client.proxy).to be_nil
+    end
+
+    it "should use 'false' for proxy if passed 'false'" do
+      client = RSolr::Client.new(:whatevs, { proxy: false })
+      expect(client.proxy).to eq(false)
+    end
+
+    context "with an non-HTTP url" do
+      let(:url) { "fake://localhost:9999/solr" }
+
+      it "raises an argument error" do
+        expect { client }.to raise_error ArgumentError, "You must provide an HTTP(S) url."
+      end
+    end
+
+    context "with an HTTPS url" do
+      let(:url) { "https://localhost:9999/solr" }
+
+      it "creates a connection" do
+        expect(client.uri).to be_kind_of URI::HTTPS
+      end
+    end
+
+  end
+
+  context "send_and_receive" do
+    it "should forward these method calls the #connection object" do
+      [:get, :post, :head].each do |meth|
+        expect(client).to receive(:execute).
+          and_return({:status => 200, :body => "{}", :headers => {}})
+        client.send_and_receive '', :method => meth, :params => {}, :data => nil, :headers => {}
+      end
+    end
+  end
+
+  context "execute" do
+    it "maps Faraday::TimeoutError to an RSolr::Error::Timeout" do
+      allow(client.connection).to receive(:send).and_raise(Faraday::TimeoutError)
+
+      expect{ client.execute({}) }.to raise_error RSolr::Error::Timeout
+    end
+
+    context 'when an Errno::ECONNREFUSED error is raised' do
+      let(:uri) { URI.parse('http://admin:secret@hostname.local:8983/solr/admin/update?wt=json&q=test') }
+
+      before do
+        allow(client.connection).to receive(:send).and_raise(Errno::ECONNREFUSED)
+      end
+
+      it "maps error to RSolr::Error:ConnectionRefused" do
+        expect { client.execute({ uri: uri }) }.to raise_error RSolr::Error::ConnectionRefused
+      end
+
+      it "removes credentials from uri" do
+        expect {
+          client.execute({ uri: uri })
+        }.to raise_error(RSolr::Error::ConnectionRefused, /http:\/\/REDACTED:REDACTED@hostname\.local:8983/)
+      end
+    end
+  end
+
+  context "post" do
+    it "should pass the expected params to the connection's #execute method" do
+      request_opts = {:data => "the data", :method=>:post, :headers => {"Content-Type" => "text/plain"}}
+      expect(client).to receive(:execute).
+        with(hash_including(request_opts)).
+        and_return(
+          :body => "",
+          :status => 200,
+          :headers => {"Content-Type"=>"text/plain"}
+        )
+        client.post "update", request_opts
+    end
+  end
+
+  context "add" do
+    it "should send xml to the connection's #post method" do
+      expect(client).to receive(:execute).
+        with(
+          hash_including({
+            :path => "update",
+            :headers => {"Content-Type"=>"text/xml"},
+            :method => :post,
+            :data => "<xml/>"
+          })
+      ).
+      and_return(
+        :body => "",
+        :status => 200,
+        :headers => {"Content-Type"=>"text/xml"}
+      )
+      expect(client.builder).to receive(:add).
+        with({:id=>1}, {:commitWith=>10}).
+        and_return("<xml/>")
+      client.add({:id=>1}, :add_attributes => {:commitWith=>10})
+    end
+
+    context 'when the client is configured for json updates' do
+      let(:client) do
+        RSolr::Client.new nil, :url => "http://localhost:9999/solr", :update_format => :json
+      end
+      it "should send json to the connection's #post method" do
+        expect(client).to receive(:execute).
+          with(hash_including({
+              :path => 'update',
+              :headers => {"Content-Type" => 'application/json'},
+              :method => :post,
+              :data => '{"hello":"this is json"}'
+            })
+          ).
+            and_return(
+              :body => "",
+              :status => 200,
+              :headers => {"Content-Type"=>"text/xml"}
+            )
+        expect(client.builder).to receive(:add).
+          with({:id => 1}, {:commitWith=>10}).
+            and_return('{"hello":"this is json"}')
+        client.add({:id=>1}, :add_attributes => {:commitWith=>10})
+      end
+
+      it "should send json to the connection's #post method" do
+        expect(client).to receive(:execute).
+          with(hash_including({
+              :path => 'update',
+              :headers => {'Content-Type'=>'application/json'},
+              :method => :post,
+              :data => '{"optimise" : {}}'
+            })
+          ).
+            and_return(
+              :body => "",
+              :status => 200,
+              :headers => {"Content-Type"=>"text/xml"}
+          )
+        client.update(:data => '{"optimise" : {}}')
+      end
+    end
+  end
+
+  context "update" do
+    it "should send data to the connection's #post method" do
+      expect(client).to receive(:execute).
+        with(hash_including({
+            :path => "update",
+            :headers => {"Content-Type"=>"text/xml"},
+            :method => :post,
+            :data => "<optimize/>"
+          })
+      ).
+      and_return(
+        :body => "",
+        :status => 200,
+        :headers => {"Content-Type"=>"text/xml"}
+      )
+      client.update(:data => "<optimize/>")
+    end
+
+    it "should use #update_path" do
+      expect(client).to receive(:post).with('update_test', any_args)
+      expect(client).to receive(:update_path).and_return('update_test')
+      client.update({})
+    end
+
+    it "should use path from opts" do
+      expect(client).to receive(:post).with('update_opts', any_args)
+      allow(client).to receive(:update_path).and_return('update_test')
+      client.update({path: 'update_opts'})
+    end
+  end
+
+  context "post based helper methods:" do
+    [:commit, :optimize, :rollback].each do |meth|
+      it "should send a #{meth} message to the connection's #post method" do
+        expect(client).to receive(:execute).
+          with(hash_including({
+              :path => "update",
+              :headers => {"Content-Type"=>"text/xml"},
+              :method => :post,
+              :data => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><#{meth}/>"
+            })
+        ).
+        and_return(
+          :body => "",
+          :status => 200,
+          :headers => {"Content-Type"=>"text/xml"}
+        )
+        client.send meth
+      end
+    end
+  end
+
+  context "delete_by_id" do
+    it "should send data to the connection's #post method" do
+      expect(client).to receive(:execute).
+        with(
+          hash_including({
+            :path => "update",
+            :headers => {"Content-Type"=>"text/xml"},
+            :method => :post,
+            :data => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><delete><id>1</id></delete>"
+          })
+      ).
+      and_return(
+        :body => "",
+        :status => 200,
+        :headers => {"Content-Type"=>"text/xml"}
+      )
+      client.delete_by_id 1
+    end
+  end
+
+  context "delete_by_query" do
+    it "should send data to the connection's #post method" do
+      expect(client).to receive(:execute).
+        with(
+          hash_including({
+            :path => "update",
+            :headers => {"Content-Type"=>"text/xml"},
+            :method => :post,
+            :data => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><delete><query fq=\"category:&quot;trash&quot;\"/></delete>"
+          })
+      ).
+      and_return(
+        :body => "",
+        :status => 200,
+        :headers => {"Content-Type"=>"text/xml"}
+      )
+      client.delete_by_query :fq => "category:\"trash\""
+    end
+  end
+
+  context "adapt_response" do
+    it 'should not try to evaluate ruby when the :qt is not :ruby' do
+      body = '{"time"=>"NOW"}'
+      result = client.adapt_response({:params=>{}}, {:status => 200, :body => body, :headers => {}})
+      expect(result).to eq(body)
+    end
+
+    it 'should evaluate ruby responses when the :wt is :ruby' do
+      body = '{"time"=>"NOW"}'
+      result = client.adapt_response({:params=>{:wt=>:ruby}}, {:status => 200, :body => body, :headers => {}})
+      expect(result).to eq({"time"=>"NOW"})
+    end
+
+    it 'should evaluate json responses when the :wt is :json' do
+      body = '{"time": "NOW"}'
+      result = client.adapt_response({:params=>{:wt=>:json}}, {:status => 200, :body => body, :headers => {}})
+      if defined? JSON
+        expect(result).to eq({"time"=>"NOW"})
+      else
+        # ruby 1.8 without the JSON gem
+        expect(result).to eq('{"time": "NOW"}')
+      end
+    end
+
+    it 'should return a response for a head request' do
+      result = client.adapt_response({:method=>:head,:params=>{}}, {:status => 200, :body => nil, :headers => {}})
+      expect(result.response[:status]).to eq 200
+    end
+
+    it "ought raise a RSolr::Error::InvalidRubyResponse when the ruby is indeed frugged, or even fruggified" do
+      expect {
+        client.adapt_response({:params=>{:wt => :ruby}}, {:status => 200, :body => "<woops/>", :headers => {}})
+      }.to raise_error RSolr::Error::InvalidRubyResponse
+    end
+
+  end
+
+  context "commit" do
+    it "should add hard commit params for hard commit request" do
+      expect(client).to receive(:execute).
+        with(
+          hash_including({
+            :path => "update",
+            :headers => {"Content-Type"=>"text/xml"},
+            :method => :post,
+            :data => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><commit/>",
+            :params => {:wt=>:json},
+            :query => "wt=json"
+          })
+      ).
+      and_return(
+        :body => "",
+        :status => 200,
+        :headers => {"Content-Type"=>"text/xml"}
+      )
+      client.commit
+    end
+
+    it "should add soft commit params for soft commit request" do
+      expect(client).to receive(:execute).
+        with(
+          hash_including({
+            :path => "update",
+            :headers => {"Content-Type"=>"text/xml"},
+            :method => :post,
+            :data => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><commit/>",
+            :params => {:softCommit=>true, :wt=>:json},
+            :query => "wt=json&softCommit=true"
+          })
+      ).
+      and_return(
+        :body => "",
+        :status => 200,
+        :headers => {"Content-Type"=>"text/xml"}
+      )
+      client.soft_commit
+    end
+  end
+
+  context "indifferent access" do
+    it "should raise a RuntimeError if the #with_indifferent_access extension isn't loaded" do
+      hide_const("::RSolr::HashWithIndifferentAccessWithResponse")
+      hide_const("ActiveSupport::HashWithIndifferentAccess")
+      body = "{'foo'=>'bar'}"
+      result = client.adapt_response({:params=>{:wt=>:ruby}}, {:status => 200, :body => body, :headers => {}})
+      expect { result.with_indifferent_access }.to raise_error RuntimeError
+    end
+
+    it "should provide indifferent access" do
+      require 'active_support/core_ext/hash/indifferent_access'
+      body = "{'foo'=>'bar'}"
+      result = client.adapt_response({:params=>{:wt=>:ruby}}, {:status => 200, :body => body, :headers => {}})
+      indifferent_result = result.with_indifferent_access
+
+      expect(result).to be_a(RSolr::Response)
+      expect(result['foo']).to eq('bar')
+      expect(result[:foo]).to be_nil
+
+      expect(indifferent_result).to be_a(RSolr::Response)
+      expect(indifferent_result['foo']).to eq('bar')
+      expect(indifferent_result[:foo]).to eq('bar')
+    end
+  end
+
+  context "build_request" do
+    let(:data) { 'data' }
+    let(:params) { { q: 'test', fq: [0,1] } }
+    let(:options) { { method: :post, params: params, data: data, headers: {} } }
+    subject { client.build_request('select', options) }
+
+    context "when params are symbols" do
+      it 'should return a request context array' do
+        [/fq=0/, /fq=1/, /q=test/, /wt=json/].each do |pattern|
+          expect(subject[:query]).to match pattern
+        end
+        expect(subject[:data]).to eq("data")
+        expect(subject[:headers]).to eq({})
+      end
+    end
+
+    context "when params are strings" do
+      let(:params) { { 'q' => 'test', 'wt' => 'json' } }
+      it 'should return a request context array' do
+        expect(subject[:query]).to eq 'q=test&wt=json'
+        expect(subject[:data]).to eq("data")
+        expect(subject[:headers]).to eq({})
+      end
+    end
+
+    context "when a Hash is passed in as data" do
+      let(:data) { { q: 'test', fq: [0,1] } }
+      let(:options) { { method: :post, data: data, headers: {} } }
+
+      it "sets the Content-Type header to application/x-www-form-urlencoded; charset=UTF-8" do
+        expect(subject[:query]).to eq("wt=json")
+        [/fq=0/, /fq=1/, /q=test/].each do |pattern|
+          expect(subject[:data]).to match pattern
+        end
+        expect(subject[:data]).not_to match(/wt=json/)
+        expect(subject[:headers]).to eq({"Content-Type" => "application/x-www-form-urlencoded; charset=UTF-8"})
+      end
+    end
+
+    it "should properly handle proxy configuration" do
+      result = client_with_proxy.build_request('select',
+        :method => :post,
+        :data => {:q=>'test', :fq=>[0,1]},
+        :headers => {}
+      )
+      expect(result[:uri].to_s).to match %r{^http://localhost:9999/solr/}
+    end
+  end
+end

data/spec/api/document_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe RSolr::Document do
+  describe RSolr::Field do
+    describe ".instance" do
+      subject { RSolr::Field }
+
+      it "uses the class name of the field value" do
+        expect(subject.instance({}, Time.new)).to be_a_kind_of(RSolr::TimeField)
+      end
+
+      it "uses the provided type option when it is a class" do
+        expect(subject.instance({:type => RSolr::TimeField}, nil)).to be_a_kind_of(RSolr::TimeField)
+      end
+
+      it "uses the provided type option when it is a string" do
+        expect(subject.instance({:type => 'Time'}, nil)).to be_a_kind_of(RSolr::TimeField)
+      end
+
+      it "falls back to the base Field class" do
+        expect(subject.instance({:type => 'UndefinedType'}, nil)).to be_a_kind_of(RSolr::Field)
+      end
+
+      it "defaults to the base Field class" do
+        expect(subject.instance({}, nil)).to be_a_kind_of(RSolr::Field)
+      end
+    end
+  end
+
+  describe RSolr::TimeField do
+    it "convert value to string" do
+      time_value = Time.utc(2013, 9, 11, 18, 10, 0)
+      expect(RSolr::Field.instance({}, time_value).value).to eq '2013-09-11T18:10:00Z'
+    end
+
+    it "convert time to UTC" do
+      time_value = Time.new(2013, 9, 11, 18, 10, 0, '+02:00')
+      expect(RSolr::Field.instance({}, time_value).value).to eq '2013-09-11T16:10:00Z'
+    end
+  end
+
+  describe RSolr::DateField do
+    it "convert value to string" do
+      date_value = Date.new(2013, 9, 11)
+      expect(RSolr::Field.instance({}, date_value).value).to eq '2013-09-11T00:00:00Z'
+    end
+  end
+end