fcrepo_wrapper 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27b5f9a48873be7d333a9a7e0046bbe6996aeb23
-  data.tar.gz: 4026d1885222e7b1ce2e9d875b7bde905e81d8d9
+  metadata.gz: 32ab8e3c5f45580a33497d826bf7b1b709b51780
+  data.tar.gz: 40bf4c99f37dfb5dd1e0a3c669e656d4a7757831
 SHA512:
-  metadata.gz: 31439fadf4af4ab257100f6f049d9428746928cffa0e91f85cb6b63e7dc4ed086aad442db88a6cf19fef87bf9919c5f5875e4ee36bcd2682323d7b48a7b6cb77
-  data.tar.gz: e0fcc2b9177deffb03201ad694a45ce972512124ec414d7fcddd71a9afd3f817ff0dc4ebab2e57444aab3325f4acf93df2a2f0dfa1954dc9bbb3289cc7f24230
+  metadata.gz: 7bb4083970b80e8c68b3421d93b2af097d77d2629fcbcfa1ea655f0a537d42242705e347b83893550fdba64380f6c858c09ac5827c21b93b1a6ad68dc673e9f9
+  data.tar.gz: 4140735815d94087e4f7b93adbe981fdbb99e33ed7e7fe75720db8c173e64be028dd5927615d4badef76e5816207f204e1561c559a1b35fedffdaee34c6cc16c

data/.gitignore

@@ -33,3 +33,5 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+/fcrepo4-data

data/README.md

@@ -11,5 +11,5 @@ end
 ## Basic Options
 
 ```ruby
-FcrepoWrapper.wrap port: 8983, verbose: true, managed: true 
+FcrepoWrapper.wrap port: 8983, verbose: true, managed: true
 ```

data/exe/fcrepo_wrapper

@@ -8,6 +8,10 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: fcrepo_wrapper [options]"
 
+  opts.on("--config", "Load configuration from a file") do |v|
+    options[:config] = v
+  end
+
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     options[:verbose] = v
   end
@@ -20,7 +24,7 @@ OptionParser.new do |opts|
     options[:version] = v
   end
 
-  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: 8983)") do |p|
+  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: 8080)") do |p|
     if p == 'random'
       options[:port] = nil
     else

data/lib/fcrepo_wrapper.rb

@@ -1,4 +1,8 @@
 require 'fcrepo_wrapper/version'
+require 'fcrepo_wrapper/configuration'
+require 'fcrepo_wrapper/settings'
+require 'fcrepo_wrapper/downloader'
+require 'fcrepo_wrapper/md5'
 require 'fcrepo_wrapper/instance'
 
 module FcrepoWrapper

data/lib/fcrepo_wrapper/configuration.rb

@@ -0,0 +1,147 @@
+module FcrepoWrapper
+  class Configuration
+    attr_reader :options
+    def initialize(options)
+      @options = read_config(options[:config], options[:verbose])
+                   .merge options
+    end
+
+    def instance_dir
+      @instance_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".jar")))
+    end
+
+    def download_url
+      @download_url ||= options.fetch(:url, default_download_url)
+    end
+
+    def default_download_path
+      File.join(download_dir, File.basename(download_url))
+    end
+
+    def download_path
+      @download_path ||= options.fetch(:download_path, default_download_path)
+    end
+
+    def md5sum_path
+      File.join(download_dir, File.basename(md5url))
+    end
+
+    def tmp_save_dir
+      @tmp_save_dir ||= Dir.mktmpdir
+    end
+
+    def version
+      @version ||= options.fetch(:version, FcrepoWrapper.default_fcrepo_version)
+    end
+
+    def version_file
+      options.fetch(:version_file, File.join(instance_dir, "VERSION"))
+    end
+
+    def binary_path
+      File.join(instance_dir, "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 fcrepo_options
+      options.fetch(:fcrepo_options, headless: nil)
+    end
+
+    def env
+      options.fetch(:env, {})
+    end
+
+    def verbose?
+      !!options.fetch(:verbose, false)
+    end
+
+    def managed?
+      File.exists?(instance_dir)
+    end
+
+    # @return a list of arguments to pass to the JVM
+    def java_options
+      options.fetch(:java_options, default_java_options) + ['-jar', binary_path]
+    end
+
+    def default_java_options
+      ['-Dfcrepo.log.http.api=WARN',
+      # To avoid "WARN: The namespace of predicate:
+      # info:fedora/fedora-system:def/relations-external#isPartOf
+      # was possibly misinterpreted as:
+      # info:fedora/fedora-system:def/relations-external#."
+      '-Dfcrepo.log.kernel=ERROR',
+      ("-Dfcrepo.home=#{fcrepo_home_dir}" if fcrepo_home_dir),
+      ("-Dfcrepo.spring.jms.configuration=#{spring_noop_file}" unless jms_enabled?),
+      '-Xmx512m'].compact
+    end
+
+    def fcrepo_home_dir
+      options[:fcrepo_home_dir]
+    end
+
+    def port
+      # Check if the port option has been explicitly set to nil.
+      # this means to start fcrepo_wrapper on a random open port
+      return nil if options.key?(:port) && !options[:port]
+      options[:port] || FcrepoWrapper.default_instance_options[:port]
+    end
+
+    private
+
+      def read_config(config_file, verbose)
+        default_configuration_paths.each do |p|
+          path = File.expand_path(p)
+          config_file ||= path if File.exist? path
+        end
+
+        unless config_file
+          $stdout.puts "No config specified" if verbose
+          return {}
+        end
+
+        $stdout.puts "Loading configuration from #{config_file}" if verbose
+        config = YAML.load(ERB.new(IO.read(config_file)).result(binding))
+        unless config
+          $stderr.puts "Unable to parse config #{config_file}" if verbose
+          return {}
+        end
+        config.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_s }
+      end
+
+      def default_configuration_paths
+        ['.fcrepo_wrapper', '~/.fcrepo_wrapper']
+      end
+
+      def download_dir
+        @download_dir ||= options.fetch(:download_dir, Dir.tmpdir)
+        FileUtils.mkdir_p @download_dir
+        @download_dir
+      end
+
+      def default_download_url
+        @default_url ||= "https://github.com/fcrepo4/fcrepo4/releases/download/fcrepo-#{version}/fcrepo-webapp-#{version}-jetty-console.jar"
+      end
+
+      def random_open_port
+        socket = Socket.new(:INET, :STREAM, 0)
+        begin
+          socket.bind(Addrinfo.tcp('127.0.0.1', 0))
+          socket.local_address.ip_port
+        ensure
+          socket.close
+        end
+      end
+
+      def spring_noop_file
+        'file://' + File.expand_path('../../../data/spring-noop.xml', __FILE__)
+      end
+
+      def jms_enabled?
+        options.fetch(:enable_jms, true)
+      end
+  end
+end

data/lib/fcrepo_wrapper/downloader.rb

@@ -0,0 +1,18 @@
+module FcrepoWrapper
+  class Downloader
+    def self.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
+  end
+end
+

data/lib/fcrepo_wrapper/instance.rb

@@ -11,7 +11,7 @@ require 'tmpdir'
 
 module FcrepoWrapper
   class Instance
-    attr_reader :options, :pid
+    attr_reader :config, :pid
 
     ##
     # @param [Hash] options
@@ -29,7 +29,11 @@ module FcrepoWrapper
     # @option options [Hash] :fcrepo_options
     # @option options [Hash] :env
     def initialize(options = {})
-      @options = options
+      @config = Settings.new(Configuration.new(options))
+    end
+
+    def md5
+      @md5 ||= MD5.new(config)
     end
 
     def wrap(&_block)
@@ -40,30 +44,9 @@ module FcrepoWrapper
       stop
     end
 
-    # @return a list of arguments to pass to the JVM
-    def java_options
-      options.fetch(:java_options, default_java_options) + ['-jar', binary_path]
-    end
-
-    def default_java_options
-      ['-Dfcrepo.log.http.api=WARN',
-      # To avoid "WARN: The namespace of predicate:
-      # info:fedora/fedora-system:def/relations-external#isPartOf
-      # was possibly misinterpreted as:
-      # info:fedora/fedora-system:def/relations-external#."
-      '-Dfcrepo.log.kernel=ERROR',
-      ("-Dfcrepo.home=#{fcrepo_home_dir}" if fcrepo_home_dir),
-      ("-Dfcrepo.spring.jms.configuration=#{spring_noop_file}" unless jms_enabled?),
-      '-Xmx512m'].compact
-    end
-
-    def fcrepo_home_dir
-      options[:fcrepo_home_dir]
-    end
-
     def process_arguments
-      ["java"] + java_options +
-        fcrepo_options.merge(port: port)
+      ["java"] + config.java_options +
+        config.fcrepo_options.merge(port: port)
           .map { |k, v| ["--#{k}", "#{v}"].reject(&:empty?) }.flatten
     end
 
@@ -71,8 +54,8 @@ module FcrepoWrapper
     # Start fcrepo and wait for it to become available
     def start
       extract_and_configure
-      if managed?
-        @pid = spawn(env, *process_arguments)
+      if config.managed?
+        @pid = spawn(config.env, *process_arguments)
 
         # Wait for fcrepo to start
         while !status
@@ -84,7 +67,7 @@ module FcrepoWrapper
     ##
     # Stop fcrepo and wait for it to finish exiting
     def stop
-      if managed? && started?
+      if config.managed? && started?
         Process.kill 'HUP', pid
 
         # Wait for fcrepo to stop
@@ -101,7 +84,7 @@ module FcrepoWrapper
     ##
     # Stop fcrepo and wait for it to finish exiting
     def restart
-      if managed? && started?
+      if config.managed? && started?
         stop
         start
       end
@@ -110,12 +93,16 @@ module FcrepoWrapper
     ##
     # Check the status of a managed fcrepo service
     def status
-      return true unless managed?
+      return true unless config.managed?
       return false if pid.nil?
 
       begin
         Process.getpgid(pid)
+      rescue Errno::ESRCH
+        return false
+      end
 
+      begin
         TCPSocket.new(host, port).close
 
         Net::HTTP.start(host, port) do |http|
@@ -123,7 +110,7 @@ module FcrepoWrapper
         end
 
         true
-      rescue Errno::ESRCH, Errno::ECONNREFUSED
+      rescue Errno::ECONNREFUSED, Errno::EINVAL
         false
       end
     end
@@ -140,11 +127,18 @@ module FcrepoWrapper
       '127.0.0.1'
     end
 
-    ##
-    # Get the port this fcrepo instance is running at
     def port
-      @port ||= options[:port]
-      @port ||= random_open_port.to_s
+      config.port
+    end
+
+    ##
+    # Get a (likely) URL to the fcrepo instance
+    def url
+      "http://#{host}:#{port}/"
+    end
+
+    def version
+      config.version
     end
 
     ##
@@ -152,32 +146,22 @@ module FcrepoWrapper
     def clean!
       stop
       remove_instance_dir!
-      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(md5sum_path) if File.exists? md5sum_path
-      FileUtils.remove_entry(version_file) if File.exists? version_file
+      FileUtils.remove_entry(config.download_path) if File.exists?(config.download_path)
+      FileUtils.remove_entry(config.tmp_save_dir, true) if File.exists? config.tmp_save_dir
+      md5.clean!
+      FileUtils.remove_entry(config.version_file) if File.exists? config.version_file
     end
 
     ##
     # Clean up any files in the fcrepo instance dir
     def remove_instance_dir!
-      FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
-    end
-
-    ##
-    # Get a (likely) URL to the fcrepo instance
-    def url
-      "http://#{host}:#{port}/"
+      FileUtils.remove_entry(config.instance_dir, true) if File.exists? config.instance_dir
     end
 
     def configure
       raise_error_unless_extracted
     end
 
-    def instance_dir
-      @instance_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".jar")))
-    end
-
     def extract_and_configure
       instance_dir = extract
       configure
@@ -188,164 +172,46 @@ module FcrepoWrapper
     # Does noting if fcrepo already exists at instance_dir
     # @return [String] instance_dir Directory where fcrepo has been installed
     def extract
-      return instance_dir if extracted?
+      return config.instance_dir if extracted?
 
       jar_file = download
 
-      FileUtils.mkdir_p instance_dir
-      FileUtils.cp jar_file, binary_path
-      self.extracted_version = version
+      FileUtils.mkdir_p config.instance_dir
+      FileUtils.cp jar_file, config.binary_path
+      self.extracted_version = config.version
 
-      instance_dir
+      config.instance_dir
     end
     # rubocop:enable Lint/RescueException
 
-    def version
-      @version ||= options.fetch(:version, FcrepoWrapper.default_fcrepo_version)
-    end
-
     protected
 
     def extracted?
-      File.exists?(binary_path) && extracted_version == version
+      File.exists?(config.binary_path) && extracted_version == config.version
     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)
-      return true if options[:validate] == false
-
-      Digest::MD5.file(file).hexdigest == expected_md5sum
-    end
-
-    def validate!(file)
-      unless validate? file
-        raise "MD5 mismatch" unless options[:ignore_md5sum]
+      unless File.exists?(config.download_path) && validate?(config.download_path)
+        Downloader.fetch_with_progressbar config.download_url, config.download_path
+        validate! config.download_path
       end
+      config.download_path
     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 fcrepo_options
-      options.fetch(:fcrepo_options, headless: nil)
-    end
-
-    def env
-      options.fetch(:env, {})
-    end
-
-    def download_path
-      @download_path ||= options.fetch(:download_path, default_download_path)
-    end
-
-    def default_download_path
-      File.join(download_dir, File.basename(download_url))
-    end
-
-    def download_dir
-      @download_dir ||= options.fetch(:download_dir, Dir.tmpdir)
-      FileUtils.mkdir_p @download_dir
-      @download_dir
-    end
-
-    def verbose?
-      !!options.fetch(:verbose, false)
-    end
-
-    def managed?
-      File.exists?(instance_dir)
-    end
-
-    def version_file
-      options.fetch(:version_file, File.join(instance_dir, "VERSION"))
-    end
-
-    def expected_md5sum
-      @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
-    end
-
-    def binary_path
-      File.join(instance_dir, "fcrepo-webapp-#{version}-jetty-console.jar")
-    end
-
-    def md5sum_path
-      File.join(download_dir, 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
+      File.read(config.version_file).strip if File.exists? config.version_file
     end
 
     def extracted_version=(version)
-      File.open(version_file, "w") do |f|
+      File.open(config.version_file, "w") do |f|
         f.puts version
       end
     end
 
-    def random_open_port
-      socket = Socket.new(:INET, :STREAM, 0)
-      begin
-        socket.bind(Addrinfo.tcp('127.0.0.1', 0))
-        socket.local_address.ip_port
-      ensure
-        socket.close
-      end
-    end
-
     def raise_error_unless_extracted
-      raise RuntimeError, "there is no fcrepo instance at #{instance_dir}.  Run FcrepoWrapper.extract first." unless extracted?
-    end
-
-    def spring_noop_file
-      'file://' + File.expand_path('../../../data/spring-noop.xml', __FILE__)
-    end
-
-    def jms_enabled?
-      options.fetch(:enable_jms, true)
+      raise RuntimeError, "there is no fcrepo instance at #{config.instance_dir}.  Run FcrepoWrapper.extract first." unless extracted?
     end
   end
 end

data/lib/fcrepo_wrapper/md5.rb

@@ -0,0 +1,44 @@
+module FcrepoWrapper
+  class MD5
+    attr_reader :config
+    def initialize(config)
+      @config = config
+    end
+
+    def clean!
+      FileUtils.remove_entry(config.md5sum_path) if File.exists? 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.exists? config.md5sum_path
+          Downloader.fetch_with_progressbar config.md5url, config.md5sum_path
+        end
+
+        config.md5sum_path
+      end
+  end
+end
+

data/lib/fcrepo_wrapper/settings.rb

@@ -0,0 +1,39 @@
+module FcrepoWrapper
+  # Configuraton that comes from static and dynamic sources.
+  class Settings < Delegator
+    def __getobj__
+      @static_config # return object we are delegating to, required
+    end
+
+    alias static_config __getobj__
+
+    def __setobj__(obj)
+      @static_config = obj
+    end
+
+    def initialize(static_config)
+      super
+      @static_config = static_config
+    end
+
+    ##
+    # Get the port this fcrepo instance is running at
+    def port
+      @port ||= static_config.port
+      @port ||= random_open_port.to_s
+    end
+
+    private
+
+      def random_open_port
+        socket = Socket.new(:INET, :STREAM, 0)
+        begin
+          socket.bind(Addrinfo.tcp('127.0.0.1', 0))
+          socket.local_address.ip_port
+        ensure
+          socket.close
+        end
+      end
+  end
+end
+

data/lib/fcrepo_wrapper/version.rb

@@ -1,3 +1,3 @@
 module FcrepoWrapper
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/fixtures/sample_config.yml

@@ -0,0 +1 @@
+port: 9999

data/spec/lib/fcrepo_wrapper/configuration_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe FcrepoWrapper::Configuration do
+  let(:config) { described_class.new options }
+
+  describe "#port" do
+    subject { config.port }
+
+    context "when port is set to nil" do
+      let(:options) { { port: nil } }
+      it { is_expected.to eq nil }
+    end
+
+    context "when port is not set" do
+      let(:options) { {} }
+      it { is_expected.to eq '8080' }
+    end
+
+    context "when a port is provided" do
+      let(:options) { { port: '8888' } }
+      it { is_expected.to eq '8888' }
+    end
+  end
+
+  describe "#read_config" do
+    before do
+      allow(config).to receive(:default_configuration_paths).and_return([])
+    end
+    let(:options) { { config: 'spec/fixtures/sample_config.yml' } }
+    it "uses values from the config file" do
+      expect(config.port).to eq '9999'
+    end
+
+  end
+end
+

data/spec/lib/fcrepo_wrapper/instance_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe FcrepoWrapper::Instance do
+  let(:wrapper) { described_class.new }
+
+  describe "#host" do
+    subject { wrapper.host }
+    it { is_expected.to eq '127.0.0.1' }
+  end
+
+  describe "#port" do
+    subject { wrapper.port }
+    it { is_expected.to eq '8080' }
+  end
+
+  describe "#url" do
+    subject { wrapper.url }
+    it { is_expected.to eq 'http://127.0.0.1:8080/' }
+  end
+
+  describe "#version" do
+    subject { wrapper.version }
+    it { is_expected.to eq '4.5.0' }
+  end
+
+  describe "#md5" do
+    subject { wrapper.md5 }
+    it { is_expected.to be_instance_of FcrepoWrapper::MD5 }
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -116,10 +116,17 @@ files:
 - exe/fcrepo_wrapper
 - fcrepo_wrapper.gemspec
 - lib/fcrepo_wrapper.rb
+- lib/fcrepo_wrapper/configuration.rb
+- lib/fcrepo_wrapper/downloader.rb
 - lib/fcrepo_wrapper/instance.rb
+- lib/fcrepo_wrapper/md5.rb
 - lib/fcrepo_wrapper/rake_task.rb
+- lib/fcrepo_wrapper/settings.rb
 - lib/fcrepo_wrapper/tasks/fcrepo_wrapper.rake
 - lib/fcrepo_wrapper/version.rb
+- spec/fixtures/sample_config.yml
+- spec/lib/fcrepo_wrapper/configuration_spec.rb
+- spec/lib/fcrepo_wrapper/instance_spec.rb
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cbeer/fcrepo_wrapper
@@ -142,10 +149,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Solr 5 service wrapper
 test_files:
+- spec/fixtures/sample_config.yml
+- spec/lib/fcrepo_wrapper/configuration_spec.rb
+- spec/lib/fcrepo_wrapper/instance_spec.rb
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
+has_rdoc: