telvue-rsolr 2.2.2

data/lib/rsolr/uri.rb

@@ -0,0 +1,25 @@
+require 'uri'
+
+module RSolr::Uri
+  # 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 self.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] }, false)
+      else
+        "#{k}=#{v}"
+      end
+    end
+    mapped.compact.join("&")
+  end
+end

data/lib/rsolr/version.rb

@@ -0,0 +1,7 @@
+module RSolr
+  VERSION = "2.2.2"
+
+  def self.version
+    VERSION
+  end
+end

data/lib/rsolr/xml.rb

@@ -0,0 +1,150 @@
+module RSolr::Xml
+  Document = RSolr::Document
+  Field = RSolr::Field
+
+  class Generator < RSolr::Generator
+    class << self
+      attr_accessor :use_nokogiri
+
+      def builder_proc
+        if use_nokogiri 
+          require 'nokogiri' unless defined?(::Nokogiri::XML::Builder)
+          :nokogiri_build
+        else
+          require 'builder' unless defined?(::Builder::XmlMarkup)
+          :builder_build
+        end
+      end
+    end
+    self.use_nokogiri = defined?(::Nokogiri::XML::Builder) ? true : false
+
+    CONTENT_TYPE = 'text/xml'.freeze
+
+    def content_type
+      CONTENT_TYPE
+    end
+
+
+    def nokogiri_build &block
+      b = ::Nokogiri::XML::Builder.new do |xml|
+        block_given? ? yield(xml) : xml
+      end
+      '<?xml version="1.0" encoding="UTF-8"?>'+b.to_xml(:indent => 0, :encoding => 'UTF-8', :save_with => ::Nokogiri::XML::Node::SaveOptions::AS_XML | ::Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip
+    end
+    protected :nokogiri_build
+    
+    def builder_build &block
+      b = ::Builder::XmlMarkup.new(:indent => 0, :margin => 0, :encoding => 'UTF-8')
+      b.instruct!
+      block_given? ? yield(b) : b
+    end
+    protected :builder_build
+    
+    def build &block
+      self.send(self.class.builder_proc,&block)
+    end
+    
+    # generates "add" xml for updating solr
+    # "data" can be a hash or an array of hashes.
+    # - each hash should be a simple key=>value pair representing a solr doc.
+    # If a value is an array, multiple fields will be created.
+    #
+    # "add_attrs" can be a hash for setting the add xml element attributes.
+    # 
+    # This method can also accept a block.
+    # The value yielded to the block is a Message::Document; for each solr doc in "data".
+    # You can set xml element attributes for each "doc" element or individual "field" elements.
+    #
+    # For example:
+    #
+    # solr.add({:id=>1, :nickname=>'Tim'}, {:boost=>5.0, :commitWithin=>1.0}) do |doc_msg|
+    #   doc_msg.attrs[:boost] = 10.00 # boost the document
+    #   nickname = doc_msg.field_by_name(:nickname)
+    #   nickname.attrs[:boost] = 20 if nickname.value=='Tim' # boost a field
+    # end
+    #
+    # would result in an add element having the attributes boost="10.0"
+    # and a commitWithin="1.0".
+    # Each doc element would have a boost="10.0".
+    # The "nickname" field would have a boost="20.0"
+    # if the doc had a "nickname" field with the value of "Tim".
+    #
+    def add data, add_attrs = nil, &block
+      add_attrs ||= {}
+      data = RSolr::Array.wrap(data)
+      build do |xml|
+        xml.add(add_attrs) do |add_node|
+          data.each do |doc|
+            doc = RSolr::Document.new(doc) if doc.respond_to?(:each_pair)
+            yield doc if block_given?
+            doc_node_builder = to_xml(doc)
+            self.class.use_nokogiri ? add_node.doc_(doc.attrs,&doc_node_builder) : add_node.doc(doc.attrs,&doc_node_builder)
+          end
+        end
+      end
+    end
+    
+    # generates a <commit/> message
+    def commit opts = nil
+      opts ||= {}
+      build {|xml| xml.commit(opts) }
+    end
+    
+    # generates a <optimize/> message
+    def optimize opts = nil
+      opts ||= {}
+      build {|xml| xml.optimize(opts) }
+    end
+    
+    # generates a <rollback/> message
+    def rollback
+      build {|xml| xml.rollback({}) }
+    end
+
+    # generates a <delete><id>ID</id></delete> message
+    # "ids" can be a single value or array of values
+    def delete_by_id ids
+      ids = RSolr::Array.wrap(ids)
+      build do |xml|
+        xml.delete do |delete_node|
+          ids.each do |id| 
+            self.class.use_nokogiri ? delete_node.id_(id) : delete_node.id(id)
+          end
+        end
+      end
+    end
+
+    # generates a <delete><query>ID</query></delete> message
+    # "queries" can be a single value or an array of values
+    def delete_by_query(queries)
+      queries = RSolr::Array.wrap(queries)
+      build do |xml|
+        xml.delete do |delete_node|
+          queries.each { |query| delete_node.query(query) }
+        end
+      end
+    end
+
+    private
+
+    def to_xml(doc)
+      lambda do |doc_node|
+        doc.fields.each do |field_obj|
+          value = field_obj.value
+
+          if field_obj.name.to_s == RSolr::Document::CHILD_DOCUMENT_KEY
+            child_node_builder = to_xml(field_obj.value)
+            self.class.use_nokogiri ? doc_node.doc_(&child_node_builder) : doc_node.doc(&child_node_builder)
+          elsif value.is_a?(Hash) && value.length == 1 && field_obj.attrs[:update].nil?
+            update_attr, real_value = value.first
+            doc_node.field real_value, field_obj.attrs.merge(update: update_attr)
+          elsif value.nil?
+            doc_node.field field_obj.value, field_obj.attrs.merge(null: true)
+          else
+            doc_node.field field_obj.value, field_obj.attrs
+          end
+        end
+      end
+    end
+  end
+end

data/rsolr.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rsolr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "telvue-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\"", "Ben Liu"]
+  s.email       = ["bliu@telvue.com"]
+  s.license     = 'Apache-2.0'
+  s.homepage    = "https://github.com/telvue/rsolr"
+  s.rubyforge_project = "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.0'
+
+  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,355 @@
+require 'spec_helper'
+
+RSpec.describe RSolr::Client do
+  let(:connection) { nil }
+  let(:url) { "http://localhost:9999/solr" }
+  let(:connection_options) { { url: url, read_timeout: 42, open_timeout: 43, 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 "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", :read_timeout => 42, :open_timeout=>43, :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 "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