solr_wrapper 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8990953af5f4056ffa716a2d1187995684efdbeb41e3c54e7c1f6056d5875c9d
-  data.tar.gz: 80c77a4af17402b1a5743b263bd6ffeeaddb366d13723b64071e50035a313d16
+  metadata.gz: dea9ffb20f5c86f84c5f55ac9ccd393ebdb4ac3eccc321bec26327727626b882
+  data.tar.gz: d9f85c0414b81491599cc76ba88540e8ba894c47205debb0b6699ccec00b5905
 SHA512:
-  metadata.gz: 4f8e1736239ffdd87d5327743cc5baab237f56e4b90264ed87b18272a6be225e55f04bfa29fe2fd757f9be32f12a437dbed127b9ed6341fba4100ba03c30cc51
-  data.tar.gz: ef4b72a613031cd55d745cb57c76b26f3331e6d877e36133dd72bd859129578dbbbdce07ac05dc5415fac3e5667a73f9ad1d720c1721fda2a1ef1f1956275ac8
+  metadata.gz: 86d8223ecd9df368ede9c624f3d150f65f06e6644b060ad3c2628b3338145aeaf1c82c72818b9867ff7b428480663a3da65694185641998f5d5cfade3830b2ef
+  data.tar.gz: '08585c280ca1884815c42d4d585eef463bb3cc878376a6fbb33a77e4e1add615e5effc72d76d6ac4b0a7eee8b36719f8c34b930277956e179f07660912b99bbe'

data/.github/workflows/ci.yml

@@ -12,11 +12,19 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.7
-          - 3.0
-          - jruby-9.2.20.0
+          - '3.2.5'
+          - '3.3.4'
+          - jruby-9.4.8.0
+        solr_version: ['']
+        include:
+          - ruby: '3.3.4'
+            solr_version: '8.11.4'
+          - ruby: '3.3.4'
+            solr_version: '9.6.1'
+    env:
+      SOLR_WRAPPER_SOLR_VERSION: ${{ matrix.solr_version }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/lib/solr_wrapper/checksum_validator.rb

@@ -13,13 +13,16 @@ module SolrWrapper
 
     def validate?(file)
       return true if config.validate == false
-      Digest.const_get(algorithm.upcase).file(file).hexdigest == expected_sum(algorithm)
+
+      actual_sum(file) == expected_sum
     end
 
     def validate!(file)
-      unless validate? file
-        raise "Checksum mismatch" unless config.ignore_checksum
-      end
+      return if validate?(file)
+
+      return if config.ignore_checksum || defined?(JRUBY_VERSION)
+
+      raise "Checksum mismatch: #{file} (expected(#{expected_sum}) != actual(#{actual_sum(file)})"
     end
 
     private
@@ -36,8 +39,12 @@ module SolrWrapper
         File.join(config.download_dir, File.basename(checksumurl(suffix)))
       end
 
-      def expected_sum(alg)
-        config.checksum || read_file(alg)
+      def actual_sum(file)
+        Digest.const_get(algorithm.upcase).file(file).hexdigest
+      end
+
+      def expected_sum
+        config.checksum || read_file(algorithm)
       end
 
       def read_file(alg)

data/lib/solr_wrapper/client.rb

@@ -1,4 +1,4 @@
-require 'http'
+require 'faraday'
 require 'json'
 
 module SolrWrapper
@@ -18,7 +18,7 @@ module SolrWrapper
     private
 
     def collection?(name)
-      response = HTTP.get("#{url}admin/collections?action=LIST&wt=json")
+      response = Faraday.get("#{url}admin/collections?action=LIST&wt=json")
       data = JSON.parse(response.body)
       return if data['error'] && data['error']['msg'] == 'Solr instance is not running in SolrCloud mode.'
 
@@ -26,7 +26,7 @@ module SolrWrapper
     end
 
     def core?(name)
-      response = HTTP.get("#{url}admin/cores?action=STATUS&wt=json&core=#{name}")
+      response = Faraday.get("#{url}admin/cores?action=STATUS&wt=json&core=#{name}")
       !JSON.parse(response.body)['status'][name].empty?
     end
   end

data/lib/solr_wrapper/configuration.rb

@@ -1,4 +1,5 @@
-require 'http'
+require 'faraday'
+require 'faraday/follow_redirects'
 
 module SolrWrapper
   class Configuration
@@ -9,6 +10,7 @@ module SolrWrapper
       @verbose = options[:verbose]
 
       @options = load_configs(Array(options[:config])).merge(options)
+      @options[:env] ||= ENV
     end
 
     def solr_xml
@@ -84,7 +86,12 @@ module SolrWrapper
 
     def version
       @version ||= begin
-        config_version = options.fetch(:version, SolrWrapper.default_instance_options[:version])
+        config_version = if env_options[:version].nil? || env_options[:version].empty?
+          options.fetch(:version, SolrWrapper.default_instance_options[:version])
+        else
+          env_options[:version]
+        end
+
         if config_version == 'latest'
           fetch_latest_version
         else
@@ -110,18 +117,23 @@ module SolrWrapper
         options[:mirror_url] + mirror_artifact_path
       else
         begin
-          json = HTTP.follow.get(closest_mirror_url).body
+          client = Faraday.new(closest_mirror_url) do |faraday|
+            faraday.use Faraday::FollowRedirects::Middleware
+            faraday.adapter Faraday.default_adapter
+          end
+
+          json = client.get.body
           doc = JSON.parse(json)
           url = doc['preferred'] + doc['path_info']
 
-          response = HTTP.head(url)
+          response = Faraday.head(url)
 
-          if response.status.success?
+          if response.success?
             url
           else
             archive_download_url
           end
-        rescue Errno::ECONNRESET, SocketError, HTTP::Error
+        rescue Errno::ECONNRESET, SocketError, Faraday::Error
           archive_download_url
         end
       end
@@ -186,7 +198,8 @@ module SolrWrapper
           $stderr.puts "Unable to parse config #{config_file}" if verbose?
           return {}
         end
-        config.transform_keys(&:to_sym)
+
+        config.transform_keys!(&:to_sym)
         absoluteize_paths(config, root: File.dirname(config_file))
       end
 
@@ -209,8 +222,24 @@ module SolrWrapper
       end
 
       def fetch_latest_version
-        response = HTTP.follow.get(options.fetch(:latest_version_url, 'https://solr.apache.org/downloads.html'))
+        url = options.fetch(:latest_version_url, 'https://solr.apache.org/downloads.html')
+
+        client = Faraday.new(url) do |faraday|
+          faraday.use Faraday::FollowRedirects::Middleware
+          faraday.adapter Faraday.default_adapter
+        end
+
+        response = client.get
         response.body.to_s[/Solr \d+\.\d+\.\d+/][/\d+\.\d+\.\d+/]
       end
+
+      def env_options
+        @env_options ||= begin
+          env = options.fetch(:env, {})
+          {
+            version: env['SOLR_WRAPPER_SOLR_VERSION']
+          }
+        end
+      end
   end
 end

data/lib/solr_wrapper/downloader.rb

@@ -1,23 +1,29 @@
 require 'ruby-progressbar'
-require 'http'
+require 'faraday'
+require 'faraday/follow_redirects'
 
 module SolrWrapper
   class Downloader
     def self.fetch_with_progressbar(url, output)
       pbar = SafeProgressBar.new(title: File.basename(url), total: nil, format: '%t: |%B| %p%% (%e )')
 
-      response = HTTP.follow.get(url)
-      pbar.total = response.headers['content-length'].to_i
+      client = Faraday.new(url) do |faraday|
+        faraday.use Faraday::FollowRedirects::Middleware
+        faraday.adapter Faraday.default_adapter
+      end
 
       File.open(output, 'wb') do |f|
-        response.body.each do |chunk|
-          f.write(chunk)
-          pbar.progress += chunk.length
+        client.get do |req|
+          req.options.on_data = Proc.new do |chunk, overall_received_bytes, env|
+            pbar.total = env.response_headers['content-length'].to_i
+            pbar.progress = overall_received_bytes
+            f.write(chunk)
+          end
         end
-
-        nil
       end
-    rescue HTTP::Error => e
+
+      true
+    rescue Faraday::Error => e
       raise SolrWrapperError, "Unable to download solr from #{url}\n#{e}"
     end
 

data/lib/solr_wrapper/instance.rb

@@ -144,23 +144,52 @@ module SolrWrapper
     # @option options [String] :name
     # @option options [String] :dir
     def create(options = {})
-      options[:name] ||= SecureRandom.hex
+      tmpdir = nil
 
-      create_options = { p: port }
-      create_options[:c] = options[:name] if options[:name]
-      create_options[:n] = options[:config_name] if options[:config_name]
-      create_options[:d] = options[:dir] if options[:dir]
+      begin
+        options[:name] ||= SecureRandom.hex
 
-      Retriable.retriable do
-        raise "Not started yet" unless started?
-      end
+        create_options = {}
+        if version >= '9.7'
+          create_options[:url] = config.base_url
+        else
+          create_options[:p] = port
+        end
+        create_options[:c] = options[:name] if options[:name]
+        create_options[:n] = options[:config_name] if options[:config_name]
+
+        if options[:dir]
+          # Solr 9.7 required that the dir argument contain a `conf` directory that
+          # contains the actual configuration files.
+          if version >= '9.7' && !File.exist?(File.join(options[:dir], 'conf'))
+
+            if options[:dir].match?(/conf\/$/)
+              create_options[:d] = File.expand_path(options[:dir], '..')
+            else
+              tmpdir = Dir.mktmpdir
+
+              FileUtils.mkdir("#{tmpdir}/conf")
+              FileUtils.cp_r("#{options[:dir]}/.", "#{tmpdir}/conf")
+              create_options[:d] = tmpdir
+            end
+          else
+            create_options[:d] = options[:dir]
+          end
+        end
+
+        Retriable.retriable do
+          raise "Not started yet" unless started?
+        end
 
-      # short-circuit if we're using persisted data with an existing core/collection
-      return if options[:persist] && create_options[:c] && client.exists?(create_options[:c])
+        # short-circuit if we're using persisted data with an existing core/collection
+        return if options[:persist] && create_options[:c] && client.exists?(create_options[:c])
 
-      exec("create", create_options)
+        exec("create", create_options)
 
-      options[:name]
+        options[:name]
+      ensure
+        FileUtils.remove_entry tmpdir if tmpdir
+      end
     end
 
     ##
@@ -203,7 +232,15 @@ module SolrWrapper
     # Create a new collection in solr
     # @param [String] name collection name
     def delete(name, _options = {})
-      exec("delete", c: name, p: port)
+      delete_options = { c: name }
+
+      if version >= '9.7'
+        delete_options[:url] = config.base_url
+      else
+        delete_options[:p] = port
+      end
+
+      exec("delete", delete_options)
     end
 
     ##

data/lib/solr_wrapper/settings.rb

@@ -42,10 +42,14 @@ module SolrWrapper
       @zookeeper_port ||= "#{port.to_i + 1000}"
     end
 
+    def base_url
+      "http://#{host}:#{port}/"
+    end
+
     ##
     # Get a (likely) URL to the solr instance
     def url
-      "http://#{host}:#{port}/solr/"
+      "#{base_url}solr/"
     end
 
     def instance_dir

data/lib/solr_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SolrWrapper
-  VERSION = '4.0.1'
+  VERSION = '4.1.0'
 end

data/solr_wrapper.gemspec

@@ -18,16 +18,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "http"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday-follow_redirects"
   spec.add_dependency "minitar"
   spec.add_dependency "ruby-progressbar"
   spec.add_dependency "retriable"
+  spec.add_dependency "ostruct"
 
   spec.add_development_dependency "bundler", ">= 1.7", "< 3"
-  spec.add_development_dependency "rake", "~> 10.0", "< 13"
+  spec.add_development_dependency "rake", ">= 12.2", "< 14"
 
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simple_solr_client", "= 0.2.0" # 0.2.1 removed support for schema retrieval
-  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "webmock"
 end

data/spec/fixtures/basic_configs/solrconfig.xml

@@ -240,7 +240,7 @@
            autowarmCount - the number of entries to prepopulate from
                and old cache.  
       -->
-    <filterCache class="solr.FastLRUCache"
+    <filterCache class="solr.CaffeineCache"
                  size="512"
                  initialSize="512"
                  autowarmCount="0"/>
@@ -250,7 +250,7 @@
          Caches results of searches - ordered lists of document ids
          (DocList) based on a query, a sort, and the range of documents requested.  
       -->
-    <queryResultCache class="solr.LRUCache"
+    <queryResultCache class="solr.CaffeineCache"
                      size="512"
                      initialSize="512"
                      autowarmCount="0"/>
@@ -261,14 +261,14 @@
          document).  Since Lucene internal document ids are transient,
          this cache will not be autowarmed.  
       -->
-    <documentCache class="solr.LRUCache"
+    <documentCache class="solr.CaffeineCache"
                    size="512"
                    initialSize="512"
                    autowarmCount="0"/>
     
     <!-- custom cache currently used by block join --> 
     <cache name="perSegFilter"
-      class="solr.search.LRUCache"
+      class="solr.CaffeineCache"
       size="10"
       initialSize="0"
       autowarmCount="10"

data/spec/lib/solr_wrapper/configuration_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe SolrWrapper::Configuration do
-  let(:config) { described_class.new options }
+  let(:config) { described_class.new default_options.merge(options) }
+  let(:default_options) { { env: {} } }
 
   describe "#port" do
     subject { config.port }

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require 'coveralls'
-Coveralls.wear!
-
 require 'solr_wrapper'
 require 'simple_solr_client'
 

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: solr_wrapper
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: http
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,22 +118,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -134,20 +162,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -230,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Solr service wrapper