rsolr 2.5.0 → 3.0.0

data/lib/rsolr/error.rb

@@ -2,7 +2,18 @@ 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
 
@@ -13,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"
@@ -52,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

data/lib/rsolr/version.rb

@@ -1,5 +1,5 @@
 module RSolr
-  VERSION = "2.5.0"
+  VERSION = "3.0.0"
 
   def self.version
     VERSION

data/rsolr.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.requirements << 'Apache Solr'
 
   s.add_dependency 'builder', '>= 2.1.2'
-  s.add_dependency 'faraday', '>= 0.9', '!= 2.0.0', '< 3'
+  s.add_dependency 'faraday', '>= 1.0', '< 3'
 
   s.add_development_dependency 'activesupport'
   s.add_development_dependency 'nokogiri', '>= 1.4.0'
@@ -41,5 +41,4 @@ Gem::Specification.new do |s|
   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

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'base64'
 
 RSpec.describe RSolr::Client do
   let(:connection) { nil }
@@ -13,6 +14,106 @@ RSpec.describe RSolr::Client do
     RSolr::Client.new connection, connection_options.merge(proxy: 'http://localhost:8080')
   end
 
+  context "basic auth" do
+    let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+
+    def authorization_header_for(url:, **client_opts)
+      seen_header = nil
+      stubs.get('/solr/admin/ping') do |env|
+        seen_header = env.request_headers['Authorization']
+        [200, {}, '']
+      end
+
+      RSolr::Client.new(nil, { url: url, adapter: [:test, stubs] }.merge(client_opts)).get('admin/ping')
+      stubs.verify_stubbed_calls
+      seen_header
+    end
+
+    it "sends credentials embedded in the URL as a Basic Authorization header" do
+      header = authorization_header_for(url: "http://someuser:somepass@localhost:9999/solr")
+      expect(header).to eq("Basic #{Base64.strict_encode64('someuser:somepass')}")
+    end
+
+    it "sends no Authorization header when the URL has no credentials" do
+      header = authorization_header_for(url: "http://localhost:9999/solr")
+      expect(header).to be_nil
+    end
+
+    it "sends credentials given via the basic_auth: option" do
+      header = authorization_header_for(
+        url: "http://localhost:9999/solr",
+        basic_auth: { user: 'optuser', password: 'optpass' }
+      )
+      expect(header).to eq("Basic #{Base64.strict_encode64('optuser:optpass')}")
+    end
+
+    it "prefers the basic_auth: option over credentials embedded in the URL" do
+      header = authorization_header_for(
+        url: "http://urluser:urlpass@localhost:9999/solr",
+        basic_auth: { user: 'optuser', password: 'optpass' }
+      )
+      expect(header).to eq("Basic #{Base64.strict_encode64('optuser:optpass')}")
+    end
+
+    it "accepts a basic_auth: option with string keys, as loaded from YAML" do
+      header = authorization_header_for(
+        url: "http://localhost:9999/solr",
+        basic_auth: { 'user' => 'optuser', 'password' => 'optpass' }
+      )
+      expect(header).to eq("Basic #{Base64.strict_encode64('optuser:optpass')}")
+    end
+
+    context 'when a connection error is raised' do
+      def error_raised_for(url:, **client_opts)
+        stubs.get('/solr/admin/ping') { |_env| [500, {}, 'boom'] }
+        RSolr::Client.new(nil, { url: url, adapter: [:test, stubs] }.merge(client_opts)).get('admin/ping')
+        nil
+      rescue RSolr::Error::Http => e
+        e
+      end
+
+      context 'with credentials in url' do
+        it 'already redacts the url in RSolr::Error::Http#message' do
+          error = error_raised_for(url: "http://someuser:somepass@localhost:9999/solr")
+
+          expect(error.message).not_to include('somepass')
+          expect(error.message).to include('REDACTED')
+        end
+
+        it 'does not leak basic auth info' do
+          error = error_raised_for(url: "http://someuser:somepass@localhost:9999/solr")
+
+          expect(error.cause.message).not_to include('somepass')
+          expect(error.cause.inspect).not_to include('somepass')
+          expect(error.cause.inspect).to include('REDACTED')
+        end
+      end
+
+      context 'with credentials in header' do
+        it 'already omits credentials from RSolr::Error::Http#message' do
+          error = error_raised_for(
+            url: "http://localhost:9999/solr",
+            basic_auth: { user: 'optuser', password: 'optpass' }
+          )
+          encoded_credentials = Base64.strict_encode64('optuser:optpass')
+
+          expect(error.message).not_to include(encoded_credentials)
+        end
+
+        it 'does not leak basic auth info' do
+          error = error_raised_for(
+            url: "http://localhost:9999/solr",
+            basic_auth: { user: 'optuser', password: 'optpass' }
+          )
+          encoded_credentials = Base64.strict_encode64('optuser:optpass')
+
+          expect(error.cause.inspect).not_to include(encoded_credentials)
+          expect(error.cause.inspect).to include('REDACTED')
+        end
+      end
+    end
+  end
+
   context "initialize" do
     it "should accept whatevs and set it as the @connection" do
       expect(RSolr::Client.new(:whatevs).connection).to eq(:whatevs)
@@ -77,6 +178,24 @@ RSpec.describe RSolr::Client do
 
       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
@@ -393,6 +512,18 @@ RSpec.describe RSolr::Client do
       end
     end
 
+    context "when post but no hash is passed in as data" do
+      let(:data) { nil }
+
+      it "sets the Content-Type header to application/x-www-form-urlencoded; charset=UTF-8" do
+        expect(subject[:query]).to be_nil
+        [/fq=0/, /fq=1/, /q=test/, /wt=json/].each do |pattern|
+          expect(subject[:data]).to match pattern
+        end
+        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,
@@ -401,5 +532,24 @@ RSpec.describe RSolr::Client do
       )
       expect(result[:uri].to_s).to match %r{^http://localhost:9999/solr/}
     end
+
+    context "http method" do
+      it "uses get by default" do
+        expect(client.build_request('select', { params: params })[:method]).to eq :get
+      end
+      it "uses the instance default if set" do
+        client = RSolr::Client.new connection, connection_options.merge(default_http_method: :post)
+        expect(client.build_request('select', { data: params })[:method]).to eq :post
+      end
+      it "uses the class default if set" do
+        RSolr::Client.default_http_method = :post
+        expect(client.build_request('select', { data: params })[:method]).to eq :post
+        RSolr::Client.default_http_method = nil
+      end
+      it "uses the method passed in opts" do
+        expect(client.build_request('select', { params: params, method: :get })[:method]).to eq :get
+        expect(client.build_request('select', { data: params, method: :post })[:method]).to eq :post
+      end
+    end
   end
 end

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,
@@ -89,7 +89,7 @@ RSpec.describe RSolr::Error do
             "code":500
           }
         }
-        EOS
+      EOS
       }
       it {
         should include msg
@@ -116,7 +116,7 @@ RSpec.describe RSolr::Error do
             "facet_fields":{}
           },
         }
-        EOS
+      EOS
       }
       it "shows the first eleven lines of the response" do
         expect(subject).to include(response_body.split("\n")[0..10].join("\n"))
@@ -146,4 +146,15 @@ RSpec.describe RSolr::Error do
       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://user:pass@hostname.local:8983/solr/admin/update?wt=json&q=test') } }
+
+
+    it 'includes redacted url' do
+      expect(subject).to include 'REDACTED@hostname.local:8983/solr/admin/update?wt=json&q=test'
+      expect(subject).not_to include 'user'
+      expect(subject).not_to include 'pass'
+    end
+  end
 end

data/spec/api/json_spec.rb

@@ -68,32 +68,10 @@ RSpec.describe RSolr::JSON do
           },
         ]
 
-        # custom JSON object class to handle Solr's non-standard JSON command format
-        tmp = Class.new do
-          def initialize
-            @source ||= {}
-          end
-
-          def []=(k, v)
-            if k == :add
-              @source[k] ||= []
-              @source[k] << v.to_h
-            elsif v.class == self.class
-              @source[k] = v.to_h
-            else
-              @source[k] = v
-            end
-          end
-
-          def to_h
-            @source
-          end
-        end
-
         request = generator.add(data, boost: 1)
-        message = JSON.parse(request, object_class: tmp, symbolize_names: true).to_h
-        expect(message[:add].length).to eq 2
-        expect(message[:add].map { |x| x[:doc] }).to eq data
+
+        expect(request).to match(/"add":{"boost":1,"doc":{"id":"1","name":"matt"}}/)
+        expect(request).to match(/"add":{"boost":1,"doc":{"id":"2","name":"sam"}}/)
       end
     end
 

data/spec/fixtures/basic_configs/schema.xml

@@ -498,7 +498,7 @@
     <fieldType name="point" class="solr.PointType" dimension="2" subFieldSuffix="_d"/>
 
     <!-- A specialized field for geospatial search. If indexed, this fieldType must not be multivalued. -->
-    <fieldType name="location" class="solr.LatLonType" subFieldSuffix="_coordinate"/>
+    <fieldType name="location" class="solr.LatLonPointSpatialField"/> 
 
     <!-- An alternative geospatial field type new to Solr 4.  It supports multiValued and polygon shapes.
       For more information about this and other Spatial fields new to Solr 4, see:

data/spec/fixtures/basic_configs/solrconfig.xml

@@ -315,8 +315,8 @@
          background concurrently.  An error is returned if this limit
          is exceeded.
 
-         Recommend values of 1-2 for read-only slaves, higher for
-         masters w/o cache warming.
+         Recommend values of 1-2 for read-only followers, higher for
+         leaders w/o cache warming.
       -->
     <maxWarmingSearchers>2</maxWarmingSearchers>
 

data/spec/fixtures/security/security.json

@@ -0,0 +1,16 @@
+{
+  "authentication": {
+    "blockUnknown": true,
+    "class": "solr.BasicAuthPlugin",
+    "credentials": {
+      "rsolr": "yBxMT8Js4iwRuqWHqW7eQcF1iNDaSbI8ZQtQc5nZyYg= 57WDp52Vgp2LrB9BT5/iFnGY7txUMdTlyM9rVT9XwcA="
+    },
+    "realm": "rsolr test",
+    "forwardCredentials": false
+  },
+  "authorization": {
+    "class": "solr.RuleBasedAuthorizationPlugin",
+    "permissions": [{ "name": "security-edit", "role": "admin" }],
+    "user-role": { "rsolr": "admin" }
+  }
+}

data/spec/integration/basic_auth_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe "Solr basic auth" do
+  let(:port) { ENV.fetch('SOLR_AUTH_TEST_PORT', 8984) }
+  let(:base_url) { "http://localhost:#{port}/solr/basic_configs/" }
+  let(:user) { 'rsolr' }
+  let(:password) { 'RSolrTest123' }
+
+  it "succeeds using the basic_auth: option" do
+    solr = RSolr.connect(url: base_url, basic_auth: { user: user, password: password })
+    expect { solr.head('admin/ping') }.not_to raise_error
+  end
+
+  it "succeeds using credentials embedded in the URL" do
+    url = "http://#{user}:#{password}@localhost:#{port}/solr/basic_configs/"
+    solr = RSolr.connect(url: url)
+    expect { solr.head('admin/ping') }.not_to raise_error
+  end
+
+  it "raises RSolr::Error::Http with no credentials" do
+    solr = RSolr.connect(url: base_url)
+    expect { solr.head('admin/ping') }.to raise_error(RSolr::Error::Http, /401/)
+  end
+
+  it "raises RSolr::Error::Http with the wrong credentials" do
+    solr = RSolr.connect(url: base_url, basic_auth: { user: user, password: 'wrong' })
+    expect { solr.head('admin/ping') }.to raise_error(RSolr::Error::Http, /401/)
+  end
+end

data/spec/integration/solr5_spec.rb

@@ -1,18 +1,9 @@
 require 'spec_helper'
-require 'solr_wrapper'
 
 RSpec.describe "Solr basic_configs" do
-  SOLR_INSTANCE =  SolrWrapper.default_instance({})
-  before(:all) { SOLR_INSTANCE.start }
-  after(:all) { SOLR_INSTANCE.stop }
-
   context "basic configs" do
-    subject { RSolr.connect url: "http://localhost:#{SOLR_INSTANCE.port}/solr/basic_configs/"}
-    around(:each) do |example|
-      SOLR_INSTANCE.with_collection(name: "basic_configs", dir: File.join(FIXTURES_DIR, "basic_configs")) do |coll|
-        example.run
-      end
-    end
+    subject { RSolr.connect url: "http://localhost:#{ENV.fetch('SOLR_TEST_PORT', 8983)}/solr/basic_configs/" }
+
     describe "HEAD admin/ping" do
       it "should not raise an exception" do
         expect { subject.head('admin/ping') }.not_to raise_error

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'simplecov'
 SimpleCov.start do
-  add_filter "/spec/"
+  skip "/spec/"
 end
 
 require 'rsolr'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsolr
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Antoine Latter
@@ -26,10 +26,9 @@ authors:
 - Nathan Witmer
 - Naomi Dushay
 - '"shima"'
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -51,10 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -64,10 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -155,20 +148,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: solr_wrapper
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: RSolr aims to provide a simple and extensible library for working with
   Solr
 email:
@@ -183,8 +162,9 @@ files:
 - CHANGES.txt
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
+- docker-compose.yaml
 - lib/rsolr.rb
 - lib/rsolr/char.rb
 - lib/rsolr/client.rb
@@ -214,6 +194,8 @@ files:
 - spec/fixtures/basic_configs/solrconfig.xml
 - spec/fixtures/basic_configs/stopwords.txt
 - spec/fixtures/basic_configs/synonyms.txt
+- spec/fixtures/security/security.json
+- spec/integration/basic_auth_spec.rb
 - spec/integration/solr5_spec.rb
 - spec/lib/rsolr/client_spec.rb
 - spec/spec_helper.rb
@@ -221,7 +203,6 @@ homepage: https://github.com/rsolr/rsolr
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -237,8 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Apache Solr
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 4.0.18
 specification_version: 4
 summary: A Ruby client for Apache Solr
 test_files: []