solr_wrapper 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69b59fa99bc915577bf48a1ccf9a82fbe1a03abf
-  data.tar.gz: cd5fe1e6bf5d3e16d784606a52f56dd6e57c56fc
+  metadata.gz: 3991dd503c5902e6012328a4663edff78f669fbf
+  data.tar.gz: 7d17c2fcc21fa1e370a4903c393de8b3ae207f76
 SHA512:
-  metadata.gz: 70f274a2cc52e3221338eae2833185f21a0ab295b813b917feaae5e190e684a28ca38846efdef148b1747dba58557be677105a499d1443c3fb8a7bfd3233c79c
-  data.tar.gz: '08b924bbe6bd57633f53865bd893e9e6a486d9821baccb0d1234011f8648ccc223326f065b5acb64ed8809babbe3daf563d992b2318c7ed3915bf86e10f4b3f3'
+  metadata.gz: 650abf178f6f41be0f6a96c01699edbdee09a82d6bcca41223ce0c185524bc0d59ec549c669232abab75e85ce187bdb03acf759f94033b0fb2cdd2071b0e1a99
+  data.tar.gz: 29f4b23edfee5ee869b1626c0f88775468106dff2ae5a2059ef1d805cc3d7f03e76d9c285f9e0822583026190160db0d1ae8a361745b8b45a599e70d01f35e1a

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.4.1
-  - 2.3.4
-  - jruby-9.1.8.0
+  - 2.5.0
+  - 2.4.2
+  - 2.3.6
+  - jruby-9.1.16.0
 
 jdk:
   - oraclejdk8

data/README.md

@@ -32,16 +32,17 @@ SolrWrapper.wrap port: 8983,
 |---------------|-----------------------------------------|
 | instance_dir  | Directory to store the solr index files |
 | url           | URL of the Zip file to download |
+| mirror_url    | Mirror to download the solr artifacts from (e.g. http://lib-solr-mirror.princeton.edu/dist/)|
 | version       | Solr version to download and install |
 | port          | port to run Solr on |
 | version_file  | Local path to store the currently installed version |
 | download_dir  | Local path for storing the downloaded Solr zip file |
 | solr_zip_path | Local path to the Solr zip file |
-| md5sum        | Path/URL to MD5 checksum |
+| checksum      | Path/URL to checksum |
 | solr_xml      | Path to Solr configuration |
 | verbose       | (Boolean) |
 | managed       | (Boolean) |
-| ignore_md5sum | (Boolean) |
+| ignore_checksum | (Boolean) |
 | solr_options  | (Hash) |
 | env           | (Hash) |
 | persist      | (Boolean) Preserves the data in you collection between startups |

data/exe/solr_wrapper

@@ -64,7 +64,7 @@ args = OptionParser.new do |opts|
   end
 
   opts.on("--no-checksum", "Skip running checksum validation on the downloaded file") do |d|
-    options[:ignore_md5sum] = true
+    options[:ignore_checksum] = true
   end
 
   opts.separator ""

data/lib/solr_wrapper.rb

@@ -1,7 +1,7 @@
 require 'solr_wrapper/version'
 require 'solr_wrapper/configuration'
 require 'solr_wrapper/settings'
-require 'solr_wrapper/md5'
+require 'solr_wrapper/checksum_validator'
 require 'solr_wrapper/downloader'
 require 'solr_wrapper/instance'
 require 'solr_wrapper/client'

data/lib/solr_wrapper/checksum_validator.rb

@@ -0,0 +1,57 @@
+module SolrWrapper
+  class ChecksumValidator
+    attr_reader :config
+
+    ALGORITHM = 'sha1'
+
+    def initialize(config)
+      @config = config
+    end
+
+    def clean!
+      path = checksum_path(ALGORITHM)
+      FileUtils.remove_entry(path) if File.exist? path
+    end
+
+    def validate?(file)
+      return true if config.validate == false
+      Digest.const_get(ALGORITHM.upcase).file(file).hexdigest == expected_sum(ALGORITHM)
+    end
+
+    def validate!(file)
+      unless validate? file
+        raise "Checksum mismatch" unless config.ignore_checksum
+      end
+    end
+
+    private
+
+      def checksumurl(suffix)
+        if config.default_download_url == config.static_config.archive_download_url
+          "#{config.default_download_url}.#{suffix}"
+        else
+          "http://www.us.apache.org/dist/lucene/solr/#{config.static_config.version}/solr-#{config.static_config.version}.zip.#{suffix}"
+        end
+      end
+
+      def checksum_path(suffix)
+        File.join(config.download_dir, File.basename(checksumurl(suffix)))
+      end
+
+      def expected_sum(alg)
+        config.checksum || read_file(alg)
+      end
+
+      def read_file(alg)
+        open(checksumfile(alg)).read.split(" ").first
+      end
+
+      def checksumfile(alg)
+        path = checksum_path(alg)
+        unless File.exist? path
+          Downloader.fetch_with_progressbar checksumurl(alg), path
+        end
+        path
+      end
+  end
+end

data/lib/solr_wrapper/configuration.rb

@@ -23,12 +23,12 @@ module SolrWrapper
       options[:validate]
     end
 
-    def ignore_md5sum
-      options[:ignore_md5sum]
+    def ignore_checksum
+      options[:ignore_checksum]
     end
 
-    def md5sum
-      options[:md5sum]
+    def checksum
+      options[:checksum]
     end
 
     def url
@@ -89,10 +89,37 @@ module SolrWrapper
       end
     end
 
-    def mirror_url
+    def closest_mirror_url
       "http://www.apache.org/dyn/closer.lua/lucene/solr/#{version}/solr-#{version}.zip?asjson=true"
     end
 
+    def mirror_url
+      @mirror_url ||= if options[:mirror_url]
+        options[:mirror_url] + "lucene/solr/#{version}/solr-#{version}.zip"
+      else
+        begin
+          json = open(closest_mirror_url).read
+          doc = JSON.parse(json)
+          url = doc['preferred'] + doc['path_info']
+
+          response = Faraday.head(url)
+
+          if response.success?
+            url
+          else
+            archive_download_url
+          end
+
+        rescue Errno::ECONNRESET, SocketError, Faraday::Error
+          archive_download_url
+        end
+      end
+    end
+
+    def archive_download_url
+      "https://archive.apache.org/dist/lucene/solr/#{version}/solr-#{version}.zip"
+    end
+
     def cloud
       options[:cloud]
     end

data/lib/solr_wrapper/instance.rb

@@ -13,7 +13,7 @@ require 'retriable'
 
 module SolrWrapper
   class Instance
-    attr_reader :config, :md5
+    attr_reader :config
 
     ##
     # @param [Hash] options
@@ -23,20 +23,19 @@ module SolrWrapper
     # @option options [String] :port port to run Solr on
     # @option options [Boolean] :cloud Run solr in cloud mode
     # @option options [String] :version_file Local path to store the currently installed version
-    # @option options [String] :download_dir Local directory to store the downloaded Solr zip and its md5 file in (overridden by :solr_zip_path)
+    # @option options [String] :download_dir Local directory to store the downloaded Solr zip and its checksum file in (overridden by :solr_zip_path)
     # @option options [String] :solr_zip_path Local path for storing the downloaded Solr zip file
-    # @option options [Boolean] :validate Should solr_wrapper download a new md5 and (re-)validate the zip file? (default: trueF)
-    # @option options [String] :md5sum Path/URL to MD5 checksum
+    # @option options [Boolean] :validate Should solr_wrapper download a new checksum and (re-)validate the zip file? (default: trueF)
+    # @option options [String] :checksum Path/URL to checksum
     # @option options [String] :solr_xml Path to Solr configuration
     # @option options [String] :extra_lib_dir Path to directory containing extra libraries to copy into instance_dir/lib
     # @option options [Boolean] :verbose return verbose info when running solr commands
-    # @option options [Boolean] :ignore_md5sum
+    # @option options [Boolean] :ignore_checksum
     # @option options [Hash] :solr_options
     # @option options [Hash] :env
     # @option options [String] :config
     def initialize(options = {})
       @config = Settings.new(Configuration.new(options))
-      @md5 = MD5.new(@config)
     end
 
     def host
@@ -228,7 +227,7 @@ module SolrWrapper
       remove_instance_dir!
       FileUtils.remove_entry(config.download_dir, true) if File.exist?(config.download_dir)
       FileUtils.remove_entry(config.tmp_save_dir, true) if File.exist? config.tmp_save_dir
-      md5.clean!
+      checksum_validator.clean!
       FileUtils.remove_entry(config.version_file) if File.exist? config.version_file
     end
 
@@ -294,9 +293,9 @@ module SolrWrapper
     end
 
     def download
-      unless File.exist?(config.solr_zip_path) && md5.validate?(config.solr_zip_path)
+      unless File.exist?(config.solr_zip_path) && checksum_validator.validate?(config.solr_zip_path)
         Downloader.fetch_with_progressbar config.download_url, config.solr_zip_path
-        md5.validate! config.solr_zip_path
+        checksum_validator.validate! config.solr_zip_path
       end
       config.solr_zip_path
     end
@@ -327,6 +326,10 @@ module SolrWrapper
 
     private
 
+    def checksum_validator
+      @checksum_validator ||= ChecksumValidator.new(config)
+    end
+
     def after_start
       create_configsets if config.cloud
     end

data/lib/solr_wrapper/settings.rb

@@ -43,7 +43,6 @@ module SolrWrapper
       @zookeeper_port ||= "#{port.to_i + 1000}"
     end
 
-
     ##
     # Get a (likely) URL to the solr instance
     def url
@@ -73,18 +72,6 @@ module SolrWrapper
       static_config.version_file || File.join(instance_dir, "VERSION")
     end
 
-    def md5url
-      if default_download_url == archive_download_url
-        "#{archive_download_url}.md5"
-      else
-        "http://www.us.apache.org/dist/lucene/solr/#{static_config.version}/solr-#{static_config.version}.zip.md5"
-      end
-    end
-
-    def md5sum_path
-      File.join(download_dir, File.basename(md5url))
-    end
-
     def solr_binary
       File.join(instance_dir, "bin", "solr")
     end
@@ -93,6 +80,10 @@ module SolrWrapper
       @tmp_save_dir ||= Dir.mktmpdir
     end
 
+    def default_download_url
+      static_config.mirror_url
+    end
+
     private
 
       def tmpdir
@@ -113,28 +104,6 @@ module SolrWrapper
         @download_dir
       end
 
-      def default_download_url
-        @default_url ||= begin
-          json = open(static_config.mirror_url).read
-          doc = JSON.parse(json)
-          url = doc['preferred'] + doc['path_info']
-
-          response = Faraday.head(url)
-
-          if response.success?
-            url
-          else
-            archive_download_url
-          end
-        end
-      rescue Errno::ECONNRESET, SocketError, Faraday::Error
-        archive_download_url
-      end
-
-      def archive_download_url
-        "https://archive.apache.org/dist/lucene/solr/#{static_config.version}/solr-#{static_config.version}.zip"
-      end
-
       def random_open_port
         socket = Socket.new(:INET, :STREAM, 0)
         begin

data/lib/solr_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SolrWrapper
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/spec/lib/solr_wrapper/configuration_spec.rb

@@ -83,4 +83,14 @@ describe SolrWrapper::Configuration do
       end
     end
   end
+
+  describe '#mirror_url' do
+    context 'with a preferred mirror' do
+      let(:options) { { mirror_url: 'http://lib-solr-mirror.princeton.edu/dist/', version: '7.2.1' } }
+
+      it 'is the URL to the artifact on the preferred mirror' do
+        expect(config.mirror_url).to eq 'http://lib-solr-mirror.princeton.edu/dist/lucene/solr/7.2.1/solr-7.2.1.zip'
+      end
+    end
+  end
 end

data/spec/lib/solr_wrapper/instance_spec.rb

@@ -159,8 +159,8 @@ describe SolrWrapper::Instance do
     it { is_expected.to eq 'solr-version-number' }
   end
 
-  describe "#md5" do
-    subject { solr_instance.md5 }
-    it { is_expected.to be_instance_of SolrWrapper::MD5 }
+  describe "#checksum_validator" do
+    subject { solr_instance.send(:checksum_validator) }
+    it { is_expected.to be_instance_of SolrWrapper::ChecksumValidator }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -171,11 +171,11 @@ files:
 - coveralls.yml
 - exe/solr_wrapper
 - lib/solr_wrapper.rb
+- lib/solr_wrapper/checksum_validator.rb
 - lib/solr_wrapper/client.rb
 - lib/solr_wrapper/configuration.rb
 - lib/solr_wrapper/downloader.rb
 - lib/solr_wrapper/instance.rb
-- lib/solr_wrapper/md5.rb
 - lib/solr_wrapper/popen4_runner.rb
 - lib/solr_wrapper/popen_runner.rb
 - lib/solr_wrapper/rake_task.rb

data/lib/solr_wrapper/md5.rb

@@ -1,43 +0,0 @@
-module SolrWrapper
-  class MD5
-    attr_reader :config
-    def initialize(config)
-      @config = config
-    end
-
-    def clean!
-      FileUtils.remove_entry(config.md5sum_path) if File.exist? config.md5sum_path
-    end
-
-    def validate?(file)
-      return true if config.validate == false
-
-      Digest::MD5.file(file).hexdigest == expected_sum
-    end
-
-    def validate!(file)
-      unless validate? file
-        raise "MD5 mismatch" unless config.ignore_md5sum
-      end
-    end
-
-    private
-
-      def expected_sum
-        @md5sum ||= config.md5sum
-        @md5sum ||= read_file
-      end
-
-      def read_file
-        open(md5file).read.split(" ").first
-      end
-
-      def md5file
-        unless File.exist? config.md5sum_path
-          Downloader.fetch_with_progressbar config.md5url, config.md5sum_path
-        end
-
-        config.md5sum_path
-      end
-  end
-end