fcrepo_wrapper 0.0.1

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.0
+  - jruby
+cache:
+  directories:
+  - /tmp/solr-5.1.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Beer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,28 @@
+# FcrepoWrapper
+
+Wrap any task with a Solr instance:
+
+```ruby
+FcrepoWrapper.wrap do |solr|
+  # Something that requires Solr
+end
+```
+
+Or with Solr and a solr collection:
+
+```ruby
+  subject.wrap do |solr|
+    solr.with_collection(dir: File.join(FIXTURES_DIR, "basic_configs")) do |collection_name|
+    end
+  end
+```
+
+## Basic Options
+
+```ruby
+FcrepoWrapper.wrap port: 8983, verbose: true, managed: true 
+```
+
+```ruby
+solr.with_collection(name: 'collection_name', dir: 'path_to_solr_confiigs')
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: ['spec']

data/coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/exe/fcrepo_wrapper

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'fcrepo_wrapper'
+require 'optparse'
+
+options = {}
+collection_options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: fcrepo_wrapper [options]"
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on("--version VERSION", "Specify a fcrepo version to download (default: #{FcrepoWrapper.default_solr_version})") do |v|
+    options[:version] = v
+  end
+
+  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: 8080)") do |p|
+    options[:port] = p
+  end
+end.parse!
+
+# default to verbose
+options[:verbose] = true if options[:verbose].nil?
+
+FcrepoWrapper.wrap(options) do |conn|
+  with_collection(collection_options)
+  while conn.status
+    sleep 1
+  end
+end

data/fcrepo_wrapper.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fcrepo_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fcrepo_wrapper"
+  spec.version       = FcrepoWrapper::VERSION
+  spec.authors       = ["Chris Beer"]
+  spec.email         = ["chris@cbeer.info"]
+  spec.summary       = %q{Solr 5 service wrapper}
+  spec.homepage      = "https://github.com/cbeer/fcrepo_wrapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-progressbar"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simple_solr_client"
+  spec.add_development_dependency "coveralls"
+end

data/lib/fcrepo_wrapper/instance.rb

@@ -0,0 +1,258 @@
+require 'digest'
+require 'fileutils'
+require 'open-uri'
+require 'ruby-progressbar'
+require 'securerandom'
+require 'stringio'
+require 'tmpdir'
+require 'byebug'
+
+module FcrepoWrapper
+  class Instance
+    attr_reader :options, :pid
+
+    ##
+    # @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 [String] :xml
+    # @option options [Boolean] :verbose
+    # @option options [Boolean] :managed
+    # @option options [Boolean] :ignore_md5sum
+    # @option options [Hash] :fcrepo_options
+    # @option options [Hash] :env
+    def initialize(options = {})
+      @options = options
+    end
+
+    def wrap(&_block)
+      start
+      yield self
+    ensure
+      stop
+    end
+
+    ##
+    # Start Solr and wait for it to become available
+    def start
+      extract
+      if managed?
+        args = ["java", "-jar", fcrepo_binary] + fcrepo_options.merge(port: port).map { |k, v| ["--#{k}", "#{v}"].reject(&:empty?) }.flatten
+
+        @pid = spawn(env, *args)
+
+        # Wait for fcrepo to start
+        until status
+          sleep 1
+        end
+      end
+    end
+
+    ##
+    # Stop fcrepo and wait for it to finish exiting
+    def stop
+      if managed? && started?
+        Process.kill 'HUP', pid
+
+        # Wait for fcrepo to stop
+        while status
+          sleep 1
+        end
+
+        Process.waitpid(pid)
+      end
+
+      @pid = nil
+    end
+
+    ##
+    # Check the status of a managed fcrepo service
+    def status
+      return true unless managed?
+      return false if pid.nil?
+
+      begin
+        Process.getpgid(pid)
+
+        TCPSocket.new('127.0.0.1', port).close
+        true
+      rescue Errno::ESRCH, Errno::ECONNREFUSED
+        false
+      end
+    end
+
+    ##
+    # Is Solr running?
+    def started?
+      !!status
+    end
+
+    ##
+    # Get the port this fcrepo instance is running at
+    def port
+      options.fetch(:port, "8080").to_s
+    end
+
+    ##
+    # Clean up any files fcrepo_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
+
+    ##
+    # Get a (likely) URL to the fcrepo instance
+    def url
+      "http://127.0.0.1:#{port}/fcrepo/"
+    end
+
+    protected
+
+    def extract
+      return fcrepo_dir if File.exists?(fcrepo_binary) && extracted_version == version
+
+      jar_path = download
+
+      FileUtils.mkdir_p fcrepo_path
+      FileUtils.cp jar_path, fcrepo_binary
+      self.extracted_version = version
+
+      configure
+
+      fcrepo_dir
+    end
+
+    def download
+      unless File.exists?(download_path) && validate?(download_path)
+        fetch_with_progressbar download_url, download_path
+        validate! download_path
+      end
+
+      download_path
+    end
+
+    def validate?(file)
+      Digest::MD5.file(file).hexdigest == expected_md5sum
+    end
+
+    def validate!(file)
+      unless validate? file
+        raise "MD5 mismatch" unless options[:ignore_md5sum]
+      end
+    end
+
+    private
+
+    def download_url
+      @download_url ||= options.fetch(:url, default_download_url)
+    end
+
+    def default_download_url
+      @default_url ||= "https://github.com/fcrepo4/fcrepo4/releases/download/fcrepo-#{version}/fcrepo-webapp-#{version}-jetty-console.jar"
+    end
+
+    def md5url
+      "https://github.com/fcrepo4/fcrepo4/releases/download/fcrepo-#{version}/fcrepo-webapp-#{version}-jetty-console.jar.md5"
+    end
+
+    def version
+      @version ||= options.fetch(:version, default_fcrepo_version)
+    end
+
+    def fcrepo_options
+      options.fetch(:fcrepo_options, headless: nil)
+    end
+
+    def env
+      options.fetch(:env, {})
+    end
+
+    def default_fcrepo_version
+      FcrepoWrapper.default_fcrepo_version
+    end
+
+    def download_path
+      @download_path ||= options.fetch(:download_path, default_download_path)
+    end
+
+    def default_download_path
+      File.join(Dir.tmpdir, File.basename(download_url))
+    end
+
+    def fcrepo_dir
+      @fcrepo_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".jar")))
+    end
+
+    def verbose?
+      !!options.fetch(:verbose, false)
+    end
+
+    def managed?
+      !!options.fetch(:managed, true)
+    end
+
+    def version_file
+      options.fetch(:version_file, File.join(fcrepo_dir, "VERSION"))
+    end
+
+    def expected_md5sum
+      @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
+    end
+
+    def fcrepo_binary
+      File.join(fcrepo_dir, "fcrepo-webapp-#{version}-jetty-console.jar")
+    end
+
+    def md5sum_path
+      File.join(Dir.tmpdir, File.basename(md5url))
+    end
+
+    def tmp_save_dir
+      @tmp_save_dir ||= Dir.mktmpdir
+    end
+
+    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 do|t|
+        if t && 0 < t
+          pbar.total = t
+        end
+      end,
+                progress_proc: lambda do|s|
+                  pbar.progress = s
+                end) do |io|
+        IO.copy_stream(io, output)
+      end
+    end
+
+    def md5file
+      unless File.exists? md5sum_path
+        fetch_with_progressbar md5url, md5sum_path
+      end
+
+      md5sum_path
+    end
+
+    def extracted_version
+      File.read(version_file).strip if File.exists? version_file
+    end
+
+    def extracted_version=(version)
+      File.open(version_file, "w") do |f|
+        f.puts version
+      end
+    end
+
+    def configure
+    end
+  end
+end

data/lib/fcrepo_wrapper/version.rb

@@ -0,0 +1,3 @@
+module FcrepoWrapper
+  VERSION = '0.0.1'
+end

data/lib/fcrepo_wrapper.rb

@@ -0,0 +1,18 @@
+require 'fcrepo_wrapper/version'
+require 'fcrepo_wrapper/instance'
+
+module FcrepoWrapper
+  def self.default_fcrepo_version
+    '4.3.0'
+  end
+
+  def self.default_instance(options = {})
+    @default_instance ||= FcrepoWrapper::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
+end

data/spec/lib/fcrepo_wrapper_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe FcrepoWrapper do
+  describe ".wrap" do
+    it "should launch fcrepo" do
+      FcrepoWrapper.wrap do |fcrepo|
+        expect do
+          Timeout::timeout(15) do
+            TCPSocket.new('127.0.0.1', fcrepo.port).close
+          end
+        end.not_to raise_exception
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'fcrepo_wrapper'
+require 'simple_solr_client'
+
+require 'rspec'
+
+FIXTURES_DIR = File.expand_path("fixtures", File.dirname(__FILE__))
+
+RSpec.configure do |_config|
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fcrepo_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- chris@cbeer.info
+executables:
+- fcrepo_wrapper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_hound.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- coveralls.yml
+- exe/fcrepo_wrapper
+- fcrepo_wrapper.gemspec
+- lib/fcrepo_wrapper.rb
+- lib/fcrepo_wrapper/instance.rb
+- lib/fcrepo_wrapper/version.rb
+- spec/lib/fcrepo_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cbeer/fcrepo_wrapper
+licenses:
+- MIT
+metadata: {}
+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.8
+signing_key: 
+specification_version: 4
+summary: Solr 5 service wrapper
+test_files:
+- spec/lib/fcrepo_wrapper_spec.rb
+- spec/spec_helper.rb