solr_wrapper 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f599156c301d05423f3d0bbb82f15bdcdc177c5
-  data.tar.gz: 91fbd6a8b261caa96a9d13d95529f8df4edd8264
+  metadata.gz: f210f3f4d7beb5a3ac5ec90b1f52b79bc7f4f89f
+  data.tar.gz: 3f4ed6125f50d9401313f250c370f216581d2957
 SHA512:
-  metadata.gz: 752c5a759af88d84475784ad50501e5b24f9873d3f7ab8230042a66134f5650b3bafafc6a1b417f99780613f3c5e01824e3fac25b7de717d186b8c04bcf13571
-  data.tar.gz: 2daa20c6613fc167f64de77d6e245d1373924f9b0b1646543fe6e76d41f29846784c0c47849da0cc2c7c36a2005e8b3e3e0d6645bb80f24fa4800acef329caab
+  metadata.gz: 266ae3d05b9b04a5aeb7254e711bd403d76c940fbbfc19fc384851099864f244fda62f19b1ea29d0e4bcd301363330b2837dbc87508f736b64bf7dd1e13769bc
+  data.tar.gz: dad3bfc9e031cfd66535617ec19463c780fe7b5c77fd21e20c6aa2280ad87d1258a858d3eae563a54c1fb96a01264f0be513a7615d3b164577229d209bbc95b6

data/.travis.yml

@@ -2,3 +2,7 @@ language: ruby
 sudo: false
 rvm:
   - 2.2.0
+  - jruby
+cache:
+  directories:
+  - /tmp/solr-5.0.0

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in solr_wrapper.gemspec
-gemspec
-
-gem 'byebug'
+gemspec

data/lib/solr_wrapper.rb

@@ -10,6 +10,8 @@ module SolrWrapper
     @default_instance ||= SolrWrapper::Instance.new options
   end
 
+  ##
+  # Ensures a Solr service is running before executing the block
   def self.wrap options = {}, &block
     default_instance(options).wrap &block
   end

data/lib/solr_wrapper/instance.rb

@@ -12,6 +12,18 @@ module SolrWrapper
   class Instance
     attr_reader :options
 
+    ##
+    # @param [Hash] options
+    # @option options [String] :url
+    # @option options [String] :version
+    # @option options [String] :port
+    # @option options [String] :version_file
+    # @option options [String] :instance_dir
+    # @option options [String] :download_path
+    # @option options [String] :md5sum
+    # @option options [Boolean] :verbose
+    # @option options [Boolean] :managed
+    # @option options [Boolean] :ignore_md5sum
     def initialize options = {}
       @options = options
     end
@@ -23,78 +35,100 @@ module SolrWrapper
       stop
     end
 
+    ##
+    # Start Solr and wait for it to become available
     def start
       extract
-      IO.popen([solr_binary, "start", "-p", port, err: [:child, :out]]) do |io|
-        stringio = StringIO.new
-        if verbose?
-          IO.copy_stream(io,$stderr)
-        else
-          IO.copy_stream(io, stringio)
-        end
-        _, exit_status = Process.wait2(io.pid)
-        if exit_status != 0
-          stringio.rewind
-          raise "Unable to start solr: #{stringio.read}"
-        end
-      end if managed?
+      if managed?
+        exec('start', p: port)
 
-      # Wait for solr to start
-      unless status
-        sleep 1
+        # Wait for solr to start
+        unless status
+          sleep 1
+        end
       end
-      started!
     end
 
+    ##
+    # Stop Solr and wait for it to finish exiting
     def stop
-      return unless started?
-
-      IO.popen([solr_binary, "stop", "-p", port, err: [:child, :out]]) do |io|
-        stringio = StringIO.new
-        if verbose?
-          IO.copy_stream(io,$stderr)
-        else
-          IO.copy_stream(io, stringio)
-        end
-        _, exit_status = Process.wait2(io.pid)
-
-        if exit_status != 0
-          stringio.rewind
-          raise "Unable to start solr: #{stringio.read}"
-        end
+      if managed? and started?
 
+        exec('stop', p: port)
         # Wait for solr to stop
         while status
           sleep 1
         end
-      end if managed?
+      end
     end
 
+    ##
+    # Check the status of a managed Solr service
     def status
       return true unless managed?
 
-      stringio = StringIO.new
+      out = exec('status', output: true).read
+      out =~ /running on port #{port}/
+    end
 
-      IO.popen([solr_binary, "status", "-p", port, err: [:child, :out]]) do |io|
-        IO.copy_stream(io, stringio)
+    ##
+    # Is Solr running?
+    def started?
+      !!status
+    end
 
-        _, exit_status = Process.wait2(io.pid)
+    ##
+    # Create a new collection in solr
+    # @param [Hash] options
+    # @option options [String] :name
+    # @option options [String] :dir
+    def create options = {}
+      options[:name] ||= SecureRandom.hex
 
-        stringio.rewind
+      exec("create", c: options[:name], d: options[:dir], p: port)
 
-        if exit_status != 0
-          raise "Unable to query solr status: #{stringio.read}"
-        end
+      options[:name]
+    end
+    
+    ##
+    # Create a new collection in solr
+    # @param [String] name collection name
+    def delete name, options = {}
+      exec("delete", c: name, p: port)
+    end
+
+    ##
+    # Create a new collection, run the block, and then clean up the collection
+    # @param [Hash] options
+    # @option options [String] :name
+    # @option options [String] :dir
+    def with_collection options = {}
+      name = create(options)
+      begin
+        yield name
+      ensure
+        delete name
       end
+    end
 
-      out = stringio.read
-      out =~ /running on port #{port}/
+    ##
+    # Get the port this Solr instance is running at 
+    def port
+      options.fetch(:port, "8983").to_s
     end
 
-    def started?
-      !!status
+    ##
+    # Clean up any files solr_wrapper may have downloaded
+    def clean!
+      stop
+      FileUtils.remove_entry(download_path) if File.exists? download_path
+      FileUtils.remove_entry(tmp_save_dir, true) if File.exists? tmp_save_dir
+      FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
+      FileUtils.remove_entry(md5sum_path) if File.exists? md5sum_path
+      FileUtils.remove_entry(version_file) if File.exists? version_file
     end
 
+    protected
     def extract
       return solr_dir if File.exists?(solr_binary) and extracted_version == version
 
@@ -129,95 +163,76 @@ module SolrWrapper
     end
 
     def download
-      unless File.exists? download_path and md5sum(download_path) == expected_md5sum
-        pbar = ProgressBar.create(title: File.basename(url), total: nil, format: "%t: |%B| %p%% (%e )")
-        open(url, content_length_proc: lambda {|t|
-          if t && 0 < t
-            pbar.total = t
-          end
-          },
-          progress_proc: lambda {|s|
-            pbar.progress = s
-          }) do |io|
-          IO.copy_stream(io,download_path)
-        end
-
-        unless md5sum(download_path) == expected_md5sum
-          raise "MD5 mismatch" unless options[:ignore_md5sum]
-        end
+      unless File.exists? download_path and validate? download_path
+        fetch_with_progressbar url, download_path
+        validate!
       end
 
       download_path
     end
 
-    def port
-      options.fetch(:port, "8983")
+    def validate? file
+      Digest::MD5.file(file).hexdigest == expected_md5sum
     end
 
-    def create options = {}
-      options[:name] ||= SecureRandom.hex
-
-      IO.popen([solr_binary, "create", "-c", options[:name], "-d", options[:dir], "-p", port, err: [:child, :out]]) do |io|
-        if verbose?
-          IO.copy_stream(io,$stderr)
-        end
+    def validate! file
+      unless validate? download_path
+        raise "MD5 mismatch" unless options[:ignore_md5sum]
       end
-
-      options[:name]
     end
-    
-    def delete name, options = {}
-      IO.popen([solr_binary, "delete", "-c", name, "-p", port, err: [:child, :out]]) do |io|
-        if verbose?
-          IO.copy_stream(io,$stderr)
+
+    ##
+    # Run a bin/solr command
+    # @see https://github.com/apache/lucene-solr/blob/trunk/solr/bin/solr
+    def exec cmd, options = {}
+      output = !!options.delete(:output)
+      args = [solr_binary, cmd] + options.map { |k,v| ["-#{k}", "#{v}"] }.flatten
+
+      if IO.respond_to? :popen4
+        # JRuby
+        pid, input, output, error = IO.popen4(args.join(" "))
+        
+        stringio = StringIO.new
+        if verbose? and !output
+          IO.copy_stream(output,$stderr)
+          IO.copy_stream(error,$stderr)
+        else
+          IO.copy_stream(output, stringio)
+          IO.copy_stream(error, stringio)
         end
-      end
-    end
+        input.close
+        output.close
+        error.close
+        
+        stringio.rewind
 
-    def with_collection options = {}
-      name = create(options)
-      begin
-        yield name
-      ensure
-        delete name
-      end
-    end
+        if $? != 0
+          raise "Failed to execute solr #{cmd}: #{stringio.read}"
+        end
 
-    private
-    def expected_md5sum
-      @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
-    end
+        stringio
+      else
+        IO.popen(args + [err: [:child, :out]]) do |io|
+          stringio = StringIO.new
+          if verbose? and !output
+            IO.copy_stream(io,$stderr)
+          else
+            IO.copy_stream(io, stringio)
+          end
+          _, exit_status = Process.wait2(io.pid)
 
-    def md5sum file
-      Digest::MD5.file(file).hexdigest
-    end
+          stringio.rewind
 
-    def md5file
-      unless File.exists? md5sum_path
-        pbar = ProgressBar.create(title: File.basename(md5url), total: nil, format: "%t: |%B| %p%% (%e )")
-        open(md5url, content_length_proc: lambda {|t|
-          if t && 0 < t
-            pbar.total = t
+          if exit_status != 0
+            raise "Failed to execute solr #{cmd}: #{stringio.read}"
           end
-        },
-        progress_proc: lambda {|s|
-          pbar.progress = s
-        }) do |io|
-          IO.copy_stream(io, md5sum_path)
+
+          stringio
         end
       end
-
-      md5sum_path
-    end
-
-    def md5url
-      "http://www.us.apache.org/dist/lucene/solr/#{version}/solr-#{version}.zip.md5"
-    end
-
-    def md5sum_path
-      File.join(Dir.tmpdir, File.basename(md5url))
     end
 
+    private  
     def url
       @download_url ||= options.fetch(:url, default_url)
     end
@@ -231,8 +246,16 @@ module SolrWrapper
       end
     end
 
+    def md5url
+      "http://www.us.apache.org/dist/lucene/solr/#{version}/solr-#{version}.zip.md5"
+    end
+
     def version
-      @version ||= options.fetch(:version, SolrWrapper.default_solr_version)
+      @version ||= options.fetch(:version, default_solr_version)
+    end
+
+    def default_solr_version
+      SolrWrapper.default_solr_version
     end
 
     def download_path
@@ -247,28 +270,54 @@ module SolrWrapper
       @solr_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(default_url, ".zip")))
     end
 
-    def tmp_save_dir
-      @tmp_save_dir ||= Dir.mktmpdir
+    def verbose?
+      !!options.fetch(:verbose, false)
     end
 
+    def managed?
+      !!options.fetch(:managed, true)
+    end
+
+    def version_file
+      options.fetch(:version_file, File.join(solr_dir, "VERSION"))
+    end
+
+    def expected_md5sum
+      @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
+    end
+    
     def solr_binary
       File.join(solr_dir, "bin", "solr")
     end
-    
-    def started! status = true
-      @started = status
+
+    def md5sum_path
+      File.join(Dir.tmpdir, File.basename(md5url))
     end
 
-    def verbose?
-      !!options.fetch(:verbose, false)
+    def tmp_save_dir
+      @tmp_save_dir ||= Dir.mktmpdir
     end
 
-    def managed?
-      !!options.fetch(:managed, true)
+    def fetch_with_progressbar url, output
+      pbar = ProgressBar.create(title: File.basename(url), total: nil, format: "%t: |%B| %p%% (%e )")
+      open(url, content_length_proc: lambda {|t|
+        if t && 0 < t
+          pbar.total = t
+        end
+        },
+        progress_proc: lambda {|s|
+          pbar.progress = s
+        }) do |io|
+        IO.copy_stream(io,output)
+      end
     end
 
-    def version_file
-      options.fetch(:version_file, File.join(solr_dir, "VERSION"))
+    def md5file
+      unless File.exists? md5sum_path
+        fetch_with_progressbar md5url, md5sum_path
+      end
+
+      md5sum_path
     end
 
     def extracted_version

data/lib/solr_wrapper/version.rb

@@ -1,3 +1,3 @@
 module SolrWrapper
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/solr_wrapper.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chris Beer"]
   spec.email         = ["chris@cbeer.info"]
   spec.summary       = %q{Solr 5 service wrapper}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/cbeer/solr_wrapper"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/lib/solr_wrapper/instance_spec.rb

@@ -8,8 +8,10 @@ describe SolrWrapper::Instance do
       subject.wrap do |solr|
         solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
           core = client.core(collection_name)
-          expect(core.schema.field('id').name).to eq 'id'
-          expect(core.schema.field('id').stored).to eq true
+          unless defined? JRUBY_VERSION
+            expect(core.schema.field('id').name).to eq 'id'
+            expect(core.schema.field('id').stored).to eq true
+          end
         end
       end
     end

metadata

@@ -1,122 +1,122 @@
 --- !ruby/object:Gem::Specification
 name: solr_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: rubyzip
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: ruby-progressbar
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_solr_client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: simple_solr_client
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: coveralls
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - chris@cbeer.info
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -137,28 +137,28 @@ files:
 - spec/lib/solr_wrapper/instance_spec.rb
 - spec/lib/solr_wrapper_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/cbeer/solr_wrapper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Solr 5 service wrapper
 test_files: