rsolr 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def877722611e3004a0264d334d6807aade91d4af710c3b0846a9023cf44e620
-  data.tar.gz: 9a5b3e5c1252fe6cb78669286f0a90449fbe923b9a6385a211f70ff6462b2a43
+  metadata.gz: 2b7e170dd7fcd0bfd504562297b93a6fb504da5e95df0d356cd0d1c70a7515c8
+  data.tar.gz: b4d04a24455588c421f72d29b8e9e7ab255fb4bfde9457bc6ab5f64bb64c76a4
 SHA512:
-  metadata.gz: a7d50dddb8b4408965f3c09b16a05f3306de7cde2f89f668a3e847f1e842b44f4e6372f43e7c2fa26ab4287d64c183a969721701ea54ce51716f8afc71126755
-  data.tar.gz: 0137a6861afffa2cdd51effc56805997641943037bc65ef9170a9feef35c1675d14f80d318fb97b3b9e1c45971b71b69ebdc2ced1976c000296829580b9642f8
+  metadata.gz: cd27dcd3369b5d1e4cd99604426927bf83a3a4c3ef7d8a06fb3cfc45676b33c920ce256ecb7fc577dedbbe910b6d50a45fdaa7dd0324516529c5705df8698385
+  data.tar.gz: 5a488c3aa5e5ca93e8fe2647baf313d8b5a94229e99d6a49820a3bf80b65fe9c19fd8ab05678ee402d3674d7a043ded6110acdf4ada5a2a1752b96f4080ceec1

data/.github/workflows/ruby.yml

@@ -11,7 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [jruby-9.2.20.0, 2.4, 2.5, 2.6, 2.7, 3.0]
+        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
@@ -20,5 +21,9 @@ jobs:
         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,15 @@
+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

data/Gemfile

@@ -4,6 +4,10 @@ gemspec
 
 gem "builder", ">= 2.1.2"
 
-# 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
+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/lib/rsolr/client.rb

@@ -215,7 +215,7 @@ class RSolr::Client
     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, request_context.inspect
+      raise RSolr::Error::ConnectionRefused.new(request_context)
     rescue Faraday::Error => e
       raise RSolr::Error::Http.new(request_context, e.response)
     end
@@ -314,12 +314,22 @@ class RSolr::Client
       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/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.4.0"
+  VERSION = "2.6.0"
 
   def self.version
     VERSION

data/rsolr.gemspec

@@ -27,13 +27,13 @@ Gem::Specification.new do |s|
   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

@@ -77,6 +77,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

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,13 @@ 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://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/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 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsolr
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Antoine Latter
@@ -29,7 +29,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-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
@@ -225,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Apache Solr
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Ruby client for Apache Solr