rsolr 2.1.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a439e2ad6e60a3ca89ef3423cd44d860222beec9
-  data.tar.gz: d713c30d050a5e71e7e14a0707fa348ca6509325
+SHA256:
+  metadata.gz: 2b7e170dd7fcd0bfd504562297b93a6fb504da5e95df0d356cd0d1c70a7515c8
+  data.tar.gz: b4d04a24455588c421f72d29b8e9e7ab255fb4bfde9457bc6ab5f64bb64c76a4
 SHA512:
-  metadata.gz: 6730fd4ba6f8f1ed97c4bfa95b6ba0984a46da482a3aeebd4ce6a683e01cc669038319d8aba520bcd88d2c347fc4fe09d2209479b4499e94ba9aafa2d9700808
-  data.tar.gz: 21cf5078ab027b7acd3852b7e118d532829910e844f882660e2860ed241032c75d239153d1bfcb511d0b275ca96b761d0f34eaaf5579027de47f48a93baeb81b
+  metadata.gz: cd27dcd3369b5d1e4cd99604426927bf83a3a4c3ef7d8a06fb3cfc45676b33c920ce256ecb7fc577dedbbe910b6d50a45fdaa7dd0324516529c5705df8698385
+  data.tar.gz: 5a488c3aa5e5ca93e8fe2647baf313d8b5a94229e99d6a49820a3bf80b65fe9c19fd8ab05678ee402d3674d7a043ded6110acdf4ada5a2a1752b96f4080ceec1

data/.github/workflows/ruby.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [jruby-9.3.3.0, '3.0', '3.1', '3.2', '3.3']
+        faraday: ['~> 0.17', '~> 1', '~>2']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+      env:
+        FARADAY_VERSION: ${{ matrix.faraday}}
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        FARADAY_VERSION: ${{ matrix.faraday}}

data/CHANGES.txt

@@ -1,3 +1,41 @@
+2.6.0
+
+- Stop testing on Ruby 2. https://github.com/rsolr/rsolr/pull/237
+- Set solr version to 8.11.3. https://github.com/rsolr/rsolr/pull/238
+- Add newer rubies to the test matrix. https://github.com/rsolr/rsolr/pull/239
+- Sanitizing URIs displayed in error messages. https://github.com/rsolr/rsolr/pull/236
+
+2.5.0
+
+- Sorry, not human-edited: https://github.com/rsolr/rsolr/compare/v2.4.0...v2.5.0
+
+
+2.4.0
+
+- Raise specific timeout error for solr timeouts. https://github.com/rsolr/rsolr/pull/214
+- Pass `timeout` RSolr configuration through to Faraday, deprecate `read_timeout` Rsolr configuration. https://github.com/rsolr/rsolr/pull/215
+- Better visibility of Solr error message in `RSolr::Error`. https://github.com/rsolr/rsolr/pull/222
+- Add soft-commit function https://github.com/rsolr/rsolr/pull/210 (thanks @giteshnandre)
+- Avoid encoding exception in error message display https://github.com/rsolr/rsolr/pull/208 (thanks @expajp)
+- Fix JSON generator for atomic updates of array fields https://github.com/rsolr/rsolr/pull/201 (thanks @serggl)
+
+
+2.3.0
+
+- Sorry, not human-edited: https://github.com/rsolr/rsolr/compare/v2.2.0...v2.3.0
+
+2.2.0
+
+- Sorry, not human-edited: https://github.com/rsolr/rsolr/compare/v2.1.0...v2.2.0
+
+2.1.0
+
+- Sorry, not human-edited: https://github.com/rsolr/rsolr/compare/v2.0.0...v2.1.0
+
+2.0.0
+
+- Sorry, not human-edited: https://github.com/rsolr/rsolr/compare/v2.0.0.pre1...v2.0.0
+
 2.0.0.pre1
 
 In this release, we've added many new features, including:

data/Gemfile

@@ -3,3 +3,11 @@ source "https://rubygems.org"
 gemspec
 
 gem "builder", ">= 2.1.2"
+
+if defined? JRUBY_VERSION
+  # HTTP.rb (used by solr_wrapper to download solr for integration testing) fails
+  # to download the full contents of files (under jruby)?
+  gem "http", '< 5', platforms: :jruby
+end
+
+gem 'faraday', ENV['FARADAY_VERSION'] if ENV['FARADAY_VERSION']

data/README.rdoc

@@ -1,6 +1,4 @@
 =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.
 
@@ -12,26 +10,26 @@ The code docs http://www.rubydoc.info/gems/rsolr
 
 == Example:
   require 'rsolr'
-  
+
   # Direct connection
   solr = RSolr.connect :url => 'http://solrserver.com'
-  
+
   # Connecting over a proxy server
   solr = RSolr.connect :url => 'http://solrserver.com', :proxy=>'http://user:pass@proxy.example.com:8080'
 
   # Using an alternate Faraday adapter
   solr = RSolr.connect :url => 'http://solrserver.com', :adapter => :em_http
-  
+
   # Using a custom Faraday connection
   conn = Faraday.new do |faraday|
     faraday.response :logger                  # log requests to STDOUT
     faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
   end
   solr = RSolr.connect conn, :url => 'http://solrserver.com'
-    
+
   # send a request to /select
   response = solr.get 'select', :params => {:q => '*:*'}
-  
+
   # send a request to /catalog
   response = solr.get 'catalog', :params => {:q => '*:*'}
 
@@ -52,8 +50,10 @@ By default, RSolr uses the Solr JSON command format for all requests.
   RSolr.connect :url => 'http://solrserver.com', update_format: :xml
 
 == 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)
+The read and connect timeout settings can be set when creating a new instance of RSolr, and will
+be passed on to underlying Faraday instance:
+
+  solr = RSolr.connect(: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.
@@ -74,11 +74,11 @@ Use the #get / #post method to send search requests to the /select handler:
 
 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']}
 
 The above statement generates this Solr query:
-  
+
   select?q=roses&fq=red&fq=violet
 
 ===Pagination
@@ -92,14 +92,14 @@ The paginate method returns WillPaginate ready "docs" objects, so for example in
 
 ===Method Missing
 The +RSolr::Client+ class also uses +method_missing+ for setting the request handler/path:
-  
+
   solr.paintings :params => {:q=>'roses', :fq=>['red', 'violet']}
-  
+
 This is sent to Solr as:
   paintings?q=roses&fq=red&fq=violet
 
 This works with pagination as well:
-  
+
   solr.paginate_paintings 1, 10, {:q=>'roses', :fq=>['red', 'violet']}
 
 ===Using POST for Search Queries
@@ -120,10 +120,10 @@ To send header information to Solr using RSolr, just use the +:headers+ option:
 ===Building a Request
 +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:
   request_context = solr.build_paginated_request 1, 10, "select", ...
-  
+
 == Updating Solr
 Updating is done using native Ruby objects. Hashes are used for single documents and arrays are used for a collection of documents (hashes). These objects get turned into simple XML "messages". Raw XML strings can also be used.
 
@@ -142,7 +142,7 @@ Raw commands via  #update
   solr.update data: { optimize: true }.to_json, headers: { 'Content-Type' => 'application/json' }
 
 When adding, you can also supply "add" xml element attributes and/or a block for manipulating other "add" related elements (docs and fields) by calling the +xml+ method directly:
-  
+
   doc = {:id=>1, :price=>1.00}
   add_attributes = {:allowDups=>false, :commitWithin=>10}
   add_xml = solr.xml.add(doc, add_attributes) do |doc|

data/lib/rsolr/client.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'faraday'
 require 'uri'
 
 class RSolr::Client
+  DEFAULT_URL = 'http://127.0.0.1:8983/solr/'
 
   class << self
     def default_wt
@@ -20,9 +23,7 @@ class RSolr::Client
     @proxy = @uri = nil
     @connection = connection
     unless false === options[:url]
-      url = options[:url] ? options[:url].dup : 'http://127.0.0.1:8983/solr/'
-      url << "/" unless url[-1] == ?/
-      @uri = ::URI.parse(url)
+      @uri = extract_url_from_options(options)
       if options[:proxy]
         proxy_url = options[:proxy].dup
         proxy_url << "/" unless proxy_url.nil? or proxy_url[-1] == ?/
@@ -34,6 +35,19 @@ class RSolr::Client
     @update_format = options.delete(:update_format) || RSolr::JSON::Generator
     @update_path = options.fetch(:update_path, 'update')
     @options = options
+
+    if options[:read_timeout]
+      warn "DEPRECATION: Rsolr.new/connect option `read_timeout` is deprecated and will be removed in Rsolr 3. `timeout` is currently a synonym, use that instead."
+    end
+  end
+
+  def extract_url_from_options(options)
+    url = options[:url] ? options[:url].dup : DEFAULT_URL
+    url << "/" unless url[-1] == ?/
+    uri = ::URI.parse(url)
+    # URI::HTTPS is a subclass of URI::HTTP, so this check accepts HTTP(S)
+    raise ArgumentError, "You must provide an HTTP(S) url." unless uri.kind_of?(URI::HTTP)
+    uri
   end
 
   # returns the request uri object.
@@ -112,6 +126,14 @@ class RSolr::Client
     update opts.merge(:data => builder.commit( commit_attrs ))
   end
 
+  # soft commit
+  #
+  # https://lucene.apache.org/solr/guide/updatehandlers-in-solrconfig.html#commit-and-softcommit
+  #
+  def soft_commit opts = {}
+    commit(opts.merge params: { softCommit: true })
+  end
+
   # send "optimize" xml with opts.
   #
   # http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22
@@ -190,8 +212,10 @@ class RSolr::Client
       end
 
       { status: response.status.to_i, headers: response.headers, body: response.body.force_encoding('utf-8') }
-    rescue Errno::ECONNREFUSED, Faraday::Error::ConnectionFailed
-      raise RSolr::Error::ConnectionRefused, request_context.inspect
+    rescue Faraday::TimeoutError => e
+      raise RSolr::Error::Timeout.new(request_context, e.response)
+    rescue Errno::ECONNREFUSED, defined?(Faraday::ConnectionFailed) ? Faraday::ConnectionFailed : Faraday::Error::ConnectionFailed
+      raise RSolr::Error::ConnectionRefused.new(request_context)
     rescue Faraday::Error => e
       raise RSolr::Error::Http.new(request_context, e.response)
     end
@@ -273,23 +297,39 @@ class RSolr::Client
 
     result
   end
-  
+
   def connection
     @connection ||= begin
       conn_opts = { request: {} }
       conn_opts[:url] = uri.to_s
       conn_opts[:proxy] = proxy if proxy
       conn_opts[:request][:open_timeout] = options[:open_timeout] if options[:open_timeout]
-      conn_opts[:request][:timeout] = options[:read_timeout] if options[:read_timeout]
+
+      if options[:read_timeout] || options[:timeout]
+        # read_timeout was being passed to faraday as timeout since Rsolr 2.0,
+        # it's now deprecated, just use `timeout` directly.
+        conn_opts[:request][:timeout] = options[:timeout] || options[:read_timeout]
+      end
+
       conn_opts[:request][:params_encoder] = Faraday::FlatParamsEncoder
 
       Faraday.new(conn_opts) do |conn|
-        conn.basic_auth(uri.user, uri.password) if uri.user && uri.password
+        if uri.user && uri.password
+          case Faraday::VERSION
+          when /^0/
+            conn.basic_auth uri.user, uri.password
+          when /^1/
+            conn.request :basic_auth, uri.user, uri.password
+          else
+            conn.request :authorization, :basic_auth, uri.user, uri.password
+          end
+        end
+
         conn.response :raise_error
         conn.request :retry, max: options[:retry_after_limit], interval: 0.05,
                              interval_randomness: 0.5, backoff_factor: 2,
                              exceptions: ['Faraday::Error', 'Timeout::Error'] if options[:retry_503]
-        conn.adapter options[:adapter] || Faraday.default_adapter
+        conn.adapter options[:adapter] || Faraday.default_adapter || :net_http
       end
     end
   end

data/lib/rsolr/document.rb

@@ -1,6 +1,7 @@
 module RSolr
   class Document
     CHILD_DOCUMENT_KEY = '_childDocuments_'.freeze
+    ATOMIC_MULTI_VALUE_OPERATIONS = %i[set add add-distinct remove]
 
     # "attrs" is a hash for setting the "doc" xml attributes
     # "fields" is an array of Field objects
@@ -48,6 +49,15 @@ module RSolr
     def as_json
       @fields.group_by(&:name).each_with_object({}) do |(field, values), result|
         v = values.map(&:as_json)
+        if v.length > 1 && v.first.is_a?(Hash)
+          if v.first.key?(:value)
+            v = v.first.merge(value: v.map { |single| single[:value] })
+          else
+            (v.first.keys & ATOMIC_MULTI_VALUE_OPERATIONS).each do |op|
+              v = [{ op => v.map { |single| single[op] } }]
+            end
+          end
+        end
         v = v.first if v.length == 1 && field.to_s != CHILD_DOCUMENT_KEY
         result[field] = v
       end

data/lib/rsolr/error.rb

@@ -1,6 +1,19 @@
+require 'json'
+
 module RSolr::Error
 
+  module URICleanup
+    # Removes username and password from URI object.
+    def clean_uri(uri)
+      uri = uri.dup
+      uri.password = "REDACTED" if uri.password
+      uri.user = "REDACTED" if uri.user
+      uri
+    end
+  end
+
   module SolrContext
+    include URICleanup
 
     attr_accessor :request, :response
 
@@ -11,7 +24,7 @@ module RSolr::Error
         details = parse_solr_error_response response[:body]
         m << "\nError: #{details}\n" if details
       end
-      p = "\nURI: #{request[:uri].to_s}"
+      p = "\nURI: #{clean_uri(request[:uri]).to_s}"
       p << "\nRequest Headers: #{request[:headers].inspect}" if request[:headers]
       p << "\nRequest Data: #{request[:data].inspect}" if request[:data]
       p << "\n"
@@ -24,6 +37,18 @@ module RSolr::Error
 
     def parse_solr_error_response body
       begin
+        # Default JSON response, try to parse and retrieve error message
+        if response[:headers] && response[:headers]["content-type"].start_with?("application/json")
+          begin
+            parsed_body = JSON.parse(body)
+            info = parsed_body && parsed_body["error"] && parsed_body["error"]["msg"]
+          rescue JSON::ParserError
+          end
+        end
+        return info if info
+
+        # legacy analysis, I think trying to handle wt=ruby responses without
+        # a full parse?
         if body =~ /<pre>/
           info = body.scan(/<pre>(.*)<\/pre>/mi)[0]
         elsif body =~ /'msg'=>/
@@ -38,11 +63,16 @@ module RSolr::Error
         nil
       end
     end
-
-
   end
 
   class ConnectionRefused < ::Errno::ECONNREFUSED
+    include URICleanup
+
+    def initialize(request)
+      request[:uri] = clean_uri(request[:uri])
+
+      super(request.inspect)
+    end
   end
 
   class Http < RuntimeError
@@ -110,9 +140,16 @@ module RSolr::Error
     }
 
     def initialize request, response
+      response = response_with_force_encoded_body(response)
       @request, @response = request, response
     end
 
+    private
+
+    def response_with_force_encoded_body(response)
+      response[:body] = response[:body].force_encoding('UTF-8') if response
+      response
+    end
   end
 
   # Thrown if the :wt is :ruby
@@ -121,6 +158,15 @@ module RSolr::Error
 
   end
 
+  # Subclasses Rsolr::Error::Http for legacy backwards compatibility
+  # purposes, because earlier RSolr 2 didn't distinguish these
+  # from Http errors.
+  #
+  # In RSolr 3, it could make sense to `< Timeout::Error` instead,
+  # analagous to ConnectionRefused above
+  class Timeout < Http
+  end
+
   # Thrown if the :wt is :ruby
   # but the body wasn't succesfully parsed/evaluated
   class InvalidJsonResponse < InvalidResponse

data/lib/rsolr/version.rb

@@ -1,5 +1,5 @@
 module RSolr
-  VERSION = "2.1.0"
+  VERSION = "2.6.0"
 
   def self.version
     VERSION

data/rsolr.gemspec

@@ -23,18 +23,17 @@ Gem::Specification.new do |s|
   s.email       = ["goodieboy@gmail.com"]
   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")
   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_dependency 'faraday', '>= 0.9', '!= 2.0.0', '< 3'
 
   s.add_development_dependency 'activesupport'
   s.add_development_dependency 'nokogiri', '>= 1.4.0'

data/spec/api/client_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 
 RSpec.describe RSolr::Client do
   let(:connection) { nil }
-  let(:connection_options) { { url: "http://localhost:9999/solr", read_timeout: 42, open_timeout: 43, update_format: :xml } }
+  let(:url) { "http://localhost:9999/solr" }
+  let(:connection_options) { { url: url, update_format: :xml } }
 
   let(:client) do
     RSolr::Client.new connection, connection_options
@@ -41,6 +42,23 @@ RSpec.describe RSolr::Client 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
@@ -53,6 +71,32 @@ RSpec.describe RSolr::Client do
     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"}}
@@ -91,7 +135,7 @@ RSpec.describe RSolr::Client do
 
     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
+        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).
@@ -261,6 +305,48 @@ RSpec.describe RSolr::Client do
 
   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")
@@ -324,7 +410,7 @@ RSpec.describe RSolr::Client do
         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/spec/api/error_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe RSolr::Error do
     exception
   end
   let (:response_lines) { (1..15).to_a.map { |i| "line #{i}" } }
-  let(:request)  { double :[] => "mocked" }
+  let(:request) { { uri: URI.parse('http://hostname.local:8983/solr/admin/update?wt=json&q=test') } }
   let(:response_body) { response_lines.join("\n") }
   let(:response) {{
     :body   => response_body,
@@ -43,5 +43,116 @@ RSpec.describe RSolr::Error do
       let(:response_body) { (response_lines << "'error'=>{'msg'=> #{msg}").join("\n") }
       it { should include msg }
     end
+
+    context "when the response body is made of multi-byte chars and encoded by ASCII-8bit" do
+      let (:response_lines) { (1..15).to_a.map { |i| "レスポンス #{i}".b } }
+
+      it "encodes errorlogs by UTF-8" do
+        expect(subject.encoding.to_s).to eq 'UTF-8'
+      end
+    end
+  end
+
+  context "when response is JSON" do
+    let(:response) {{
+      :body   => response_body,
+      :status => 500,
+      :headers => {
+        "content-type" => "application/json;charset=utf-8"
+      }
+
+    }}
+
+    context "and contains a msg key" do
+      let(:msg) { "field 'description_text4_tesim' was indexed without offsets, cannot highlight" }
+      let(:response_body) {<<~EOS
+        {
+          "responseHeader":{
+            "status":500,
+            "QTime":11,
+            "params":{
+              "q":"supercali",
+              "hl":"true",
+              "hl:fl":"description_text4_tesim",
+              "hl.method":"unified",
+              "hl.offsetSource":"postings"
+            }
+          },
+          "response":{"numFound":0,"start":0,"maxScore":127.32743,"numFoundExact":true,"docs":[]},
+          "facet_counts":{
+            "facet_queries":{},
+            "facet_fields":{}
+          },
+          "error":{
+            "msg":"#{msg}",
+            "trace":"java.lang.IllegalArgumentException: field 'description_text4_tesim' was indexed without offsets, cannot highlight\\n\\tat org.apache.lucene.search.uhighlight.FieldHighlighter.highlightOffsetsEnums(FieldHighlighter.java:149)\\n\\tat org.apache.lucene.search.uhighlight.FieldHighlighter.highlightFieldForDoc(FieldHighlighter.java:79)\\n\\tat org.apache.lucene.search.uhighlight.UnifiedHighlighter.highlightFieldsAsObjects(UnifiedHighlighter.java:641)\\n\\tat org.apache.lucene.search.uhighlight.UnifiedHighlighter.highlightFields(UnifiedHighlighter.java:510)\\n\\tat org.apache.solr.highlight.UnifiedSolrHighlighter.doHighlighting(UnifiedSolrHighlighter.java:149)\\n\\tat org.apache.solr.handler.component.HighlightComponent.process(HighlightComponent.java:172)\\n\\tat org.apache.solr.handler.component.SearchHandler.handleRequestBody(SearchHandler.java:331)\\n\\tat org.apache.solr.handler.RequestHandlerBase.handleRequest(RequestHandlerBase.java:214)\\n\\tat org.apache.solr.core.SolrCore.execute(SolrCore.java:2606)\\n\\tat org.apache.solr.servlet.HttpSolrCall.execute(HttpSolrCall.java:815)\\n\\tat org.apache.solr.servlet.HttpSolrCall.call(HttpSolrCall.java:588)\\n\\tat org.apache.solr.servlet.SolrDispatchFilter.doFilter(SolrDispatchFilter.java:415)\\n\\tat org.apache.solr.servlet.SolrDispatchFilter.doFilter(SolrDispatchFilter.java:345)\\n\\tat org.eclipse.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1596)\\n\\tat org.eclipse.jetty.servlet.ServletHandler.doHandle(ServletHandler.java:545)\\n\\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:143)\\n\\tat org.eclipse.jetty.security.SecurityHandler.handle(SecurityHandler.java:590)\\n\\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\\n\\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:235)\\n\\tat org.eclipse.jetty.server.session.SessionHandler.doHandle(SessionHandler.java:1610)\\n\\tat org.eclipse.jetty.server.handler.ScopedHandler.nextHandle(ScopedHandler.java:233)\\n\\tat org.eclipse.jetty.server.handler.ContextHandler.doHandle(ContextHandler.java:1300)\\n\\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:188)\\n\\tat org.eclipse.jetty.servlet.ServletHandler.doScope(ServletHandler.java:485)\\n\\tat org.eclipse.jetty.server.session.SessionHandler.doScope(SessionHandler.java:1580)\\n\\tat org.eclipse.jetty.server.handler.ScopedHandler.nextScope(ScopedHandler.java:186)\\n\\tat org.eclipse.jetty.server.handler.ContextHandler.doScope(ContextHandler.java:1215)\\n\\tat org.eclipse.jetty.server.handler.ScopedHandler.handle(ScopedHandler.java:141)\\n\\tat org.eclipse.jetty.server.handler.ContextHandlerCollection.handle(ContextHandlerCollection.java:221)\\n\\tat org.eclipse.jetty.server.handler.InetAccessHandler.handle(InetAccessHandler.java:177)\\n\\tat org.eclipse.jetty.server.handler.HandlerCollection.handle(HandlerCollection.java:146)\\n\\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\\n\\tat org.eclipse.jetty.rewrite.handler.RewriteHandler.handle(RewriteHandler.java:322)\\n\\tat org.eclipse.jetty.server.handler.HandlerWrapper.handle(HandlerWrapper.java:127)\\n\\tat org.eclipse.jetty.server.Server.handle(Server.java:500)\\n\\tat org.eclipse.jetty.server.HttpChannel.lambda$handle$1(HttpChannel.java:383)\\n\\tat org.eclipse.jetty.server.HttpChannel.dispatch(HttpChannel.java:547)\\n\\tat org.eclipse.jetty.server.HttpChannel.handle(HttpChannel.java:375)\\n\\tat org.eclipse.jetty.server.HttpConnection.onFillable(HttpConnection.java:273)\\n\\tat org.eclipse.jetty.io.AbstractConnection$ReadCallback.succeeded(AbstractConnection.java:311)\\n\\tat org.eclipse.jetty.io.FillInterest.fillable(FillInterest.java:103)\\n\\tat org.eclipse.jetty.io.ChannelEndPoint$2.run(ChannelEndPoint.java:117)\\n\\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.runTask(EatWhatYouKill.java:336)\\n\\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.doProduce(EatWhatYouKill.java:313)\\n\\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.tryProduce(EatWhatYouKill.java:171)\\n\\tat org.eclipse.jetty.util.thread.strategy.EatWhatYouKill.run(EatWhatYouKill.java:129)\\n\\tat org.eclipse.jetty.util.thread.ReservedThreadExecutor$ReservedThread.run(ReservedThreadExecutor.java:375)\\n\\tat org.eclipse.jetty.util.thread.QueuedThreadPool.runJob(QueuedThreadPool.java:806)\\n\\tat org.eclipse.jetty.util.thread.QueuedThreadPool$Runner.run(QueuedThreadPool.java:938)\\n\\tat java.base/java.lang.Thread.run(Thread.java:834)\\n",
+            "code":500
+          }
+        }
+      EOS
+      }
+      it {
+        should include msg
+      }
+    end
+
+    context "and does not contain a msg key" do
+      let(:response_body) {<<~EOS
+        {
+          "responseHeader":{
+            "status":500,
+            "QTime":11,
+            "params":{
+              "q":"supercali",
+              "hl":"true",
+              "hl:fl":"description_text4_tesim",
+              "hl.method":"unified",
+              "hl.offsetSource":"postings"
+            }
+          },
+          "response":{"numFound":0,"start":0,"maxScore":127.32743,"numFoundExact":true,"docs":[]},
+          "facet_counts":{
+            "facet_queries":{},
+            "facet_fields":{}
+          },
+        }
+      EOS
+      }
+      it "shows the first eleven lines of the response" do
+        expect(subject).to include(response_body.split("\n")[0..10].join("\n"))
+        expect(subject).not_to include(response_body.split("\n")[11])
+      end
+    end
+
+    context "and is not parseable json" do
+      let(:response_body) {<<~EOS
+        one
+        two
+        three
+        four
+        five
+        six
+        seven
+        eight
+        nine
+        ten
+        eleven
+        twelve
+      EOS
+      }
+    end
+    it "shows the first eleven lines of the response" do
+      expect(subject).to include(response_body.split("\n")[0..10].join("\n"))
+      expect(subject).not_to include(response_body.split("\n")[11])
+    end
+  end
+
+  context "when request uri contains credentials" do
+    let(:request) { { uri: URI.parse('http://admin:admin@hostname.local:8983/solr/admin/update?wt=json&q=test') } }
+
+
+    it 'includes redacted url' do
+      expect(subject).to include 'http://REDACTED:REDACTED@hostname.local:8983/solr/admin/update?wt=json&q=test'
+    end
   end
 end

data/spec/api/json_spec.rb

@@ -149,6 +149,65 @@ RSpec.describe RSolr::JSON do
     expect(message.first).to eq data
   end
 
+  it 'should create multiple fields from array values with options' do
+    test_values = [nil, 'matt1', 'matt2']
+    message = JSON.parse(
+      generator.add(id: '1') { |doc| doc.add_field(:name, test_values, boost: 3) },
+      symbolize_names: true
+    )
+    expect(message).to eq [{ id: '1', name: { boost: 3, value: test_values } }]
+  end
+
+  context 'for atomic updates with arrays' do
+    let(:test_values) { %w[value1 value2] }
+
+    it 'creates single field from array values on SET' do
+      expect(
+        JSON.parse(
+          generator.add(id: 'set-id') { |doc| doc.add_field(:name, test_values, update: :set) },
+          symbolize_names: true
+        )
+      ).to eq [{ id: 'set-id', name: { set: test_values } }]
+    end
+
+    it 'creates single field from array values on ADD' do
+      expect(
+        JSON.parse(
+          generator.add(id: 'add-id') { |doc| doc.add_field(:name, test_values, update: :add) },
+          symbolize_names: true
+        )
+      ).to eq [{ id: 'add-id', name: { add: test_values } }]
+    end
+
+    it 'creates single field from array values on ADD-DISTINCT' do
+      expect(
+        JSON.parse(
+          generator.add(id: 'add-distinct-id') { |doc| doc.add_field(:name, test_values, update: :'add-distinct') },
+          symbolize_names: true
+        )
+      ).to eq [{ id: 'add-distinct-id', name: { 'add-distinct': test_values } }]
+    end
+
+    it 'creates single field from array values on REMOVE' do
+      expect(
+        JSON.parse(
+          generator.add(id: 'remove-id') { |doc| doc.add_field(:name, test_values, update: :remove) },
+          symbolize_names: true
+        )
+      ).to eq [{ id: 'remove-id', name: { remove: test_values } }]
+    end
+
+    it 'creates single field from array values for child document update' do
+      test_nested_values = [{id: 1, name: 'value1'}, {id: 1, name: 'value2'}]
+      expect(
+        JSON.parse(
+          generator.add(id: 'set-id') { |doc| doc.add_field(:child_documents, test_nested_values, update: :set) },
+          symbolize_names: true
+        )
+      ).to eq [{ id: 'set-id', child_documents: { set: test_nested_values } }]
+    end
+  end
+
   describe '#commit' do
     it 'generates a commit command' do
       expect(JSON.parse(generator.commit, symbolize_names: true)).to eq(commit: {})

data/spec/integration/solr5_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 require 'solr_wrapper'
 
 RSpec.describe "Solr basic_configs" do
+  SolrWrapper.default_instance_options = {
+    port: SolrWrapper.default_solr_port,
+    version: '8.11.3'
+  } 
   SOLR_INSTANCE =  SolrWrapper.default_instance({})
   before(:all) { SOLR_INSTANCE.start }
   after(:all) { SOLR_INSTANCE.stop }

data/spec/lib/rsolr/client_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe RSolr::Client do
+  describe "#connection" do
+    it "accepts a timeout parameter it passes to Faraday" do
+      client = described_class.new(nil, timeout: 1000)
+
+      expect(client.connection.options[:timeout]).to eq 1000
+    end
+    it "accepts a deprecated read_timeout" do
+      client = nil
+      expect do
+        client = described_class.new(nil, read_timeout: 1000)
+      end.to output(/`read_timeout` is deprecated/).to_stderr
+
+      expect(client.connection.options[:timeout]).to eq 1000
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsolr
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Antoine Latter
@@ -26,10 +26,10 @@ authors:
 - Nathan Witmer
 - Naomi Dushay
 - '"shima"'
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -51,14 +51,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -165,9 +177,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGES.txt
 - Gemfile
 - LICENSE
@@ -203,12 +215,13 @@ files:
 - spec/fixtures/basic_configs/stopwords.txt
 - spec/fixtures/basic_configs/synonyms.txt
 - spec/integration/solr5_spec.rb
+- spec/lib/rsolr/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rsolr/rsolr
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -224,9 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Apache Solr
-rubyforge_project: rsolr
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A Ruby client for Apache Solr
 test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
-  - jruby-9.1.7.0
-
-env:
-  global:
-    - JRUBY_OPTS="-J-Xms512m -J-Xmx1024m"
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-
-jdk: oraclejdk8