fcrepo_wrapper 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87b62fa9edf42b7de6f796431bed9e3734fb912f
-  data.tar.gz: 20371b68990e12b86bca4c7e635a2df482078b10
+  metadata.gz: d0f8e9988b5ee44ce1a0e23953a2f123905ca46c
+  data.tar.gz: e58c9f5a366d73a997892a8fcecd1748b68ea136
 SHA512:
-  metadata.gz: 83b7907e5b591fc8a6942c0b417894bea81eb6cde9dc23e929cd2cc361a8be3b392da25685306e229cb0bba18252e28e8ee9cbe6c7208446ec0c4636aac86168
-  data.tar.gz: 6c23eede5efdb846bb783e6265138e257772d3377a80f4468f8dd964d9bdd81fbe7b6422672b3f9a1379915d335e488bd4aacd1b545edf9abbe1a166bd24f1d1
+  metadata.gz: 1cae3f84d9feb62d4addf0469e5aed08a7251a595e0d45f1124ee1cb5ebc2779d7d659935d09aa7973f77550cf9567eb8a1bb78854bd5a452eb748e7ff0bb3fd
+  data.tar.gz: c1d6ce5f75551a6d5ffa00f78e6dc26f4b9cefb53766c2e5a8e1db9ca475ee86ed817580a18180b7d6cb768747af6674bd6c6a4155bb2960e7595e8c91137233

data/README.md

@@ -1,28 +1,15 @@
 # FcrepoWrapper
 
-Wrap any task with a Solr instance:
+Wrap any task with a Fcrepo instance:
 
 ```ruby
 FcrepoWrapper.wrap do |solr|
-  # Something that requires Solr
+  # Something that requires Fcrepo
 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/exe/fcrepo_wrapper

@@ -12,7 +12,7 @@ OptionParser.new do |opts|
     options[:verbose] = v
   end
 
-  opts.on("--version VERSION", "Specify a fcrepo version to download (default: #{FcrepoWrapper.default_solr_version})") do |v|
+  opts.on("--version VERSION", "Specify a fcrepo version to download (default: #{FcrepoWrapper.default_fcrepo_version})") do |v|
     options[:version] = v
   end
 
@@ -25,7 +25,6 @@ end.parse!
 options[:verbose] = true if options[:verbose].nil?
 
 FcrepoWrapper.wrap(options) do |conn|
-  with_collection(collection_options)
   while conn.status
     sleep 1
   end

data/lib/fcrepo_wrapper/instance.rb

@@ -6,9 +6,11 @@ require 'securerandom'
 require 'stringio'
 require 'tmpdir'
 require 'byebug'
+require 'service_instance'
 
 module FcrepoWrapper
   class Instance
+    include ServiceInstance
     attr_reader :options, :pid
 
     ##
@@ -24,6 +26,7 @@ module FcrepoWrapper
     # @option options [Boolean] :verbose
     # @option options [Boolean] :managed
     # @option options [Boolean] :ignore_md5sum
+    # @option options [Array<String>] :java_options a list of options to pass to the JVM
     # @option options [Hash] :fcrepo_options
     # @option options [Hash] :env
     def initialize(options = {})
@@ -37,14 +40,33 @@ 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']
+    end
+
+    def process_arguments
+      ["java"] + java_options +
+        fcrepo_options.merge(port: port)
+          .map { |k, v| ["--#{k}", "#{v}"].reject(&:empty?) }.flatten
+    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)
+        @pid = spawn(env, *process_arguments)
 
         # Wait for fcrepo to start
         until status
@@ -86,76 +108,20 @@ module FcrepoWrapper
       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
+      "http://127.0.0.1:#{port}/rest/"
     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
@@ -172,87 +138,36 @@ module FcrepoWrapper
       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)
+    def default_instance_dir
+      File.join(Dir.tmpdir, File.basename(download_url, ".jar"))
     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
+    def binary_path
+      File.join(instance_dir, "fcrepo-webapp-#{version}-jetty-console.jar")
     end
 
-    def md5file
-      unless File.exists? md5sum_path
-        fetch_with_progressbar md5url, md5sum_path
-      end
-
-      md5sum_path
-    end
+    # extract a copy of fcrepo to instance_dir
+    # Does noting if fcrepo already exists at instance_dir
+    # @return [String] instance_dir Directory where solr has been installed
+    def extract
+      return instance_dir if extracted?
 
-    def extracted_version
-      File.read(version_file).strip if File.exists? version_file
-    end
+      jar_file = download
 
-    def extracted_version=(version)
-      File.open(version_file, "w") do |f|
-        f.puts version
-      end
-    end
+      byebug
+      FileUtils.mkdir_p instance_dir
+      FileUtils.cp jar_file, binary_path
+      self.extracted_version = version
 
-    def configure
+      instance_dir
     end
   end
 end

data/lib/fcrepo_wrapper/version.rb

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

data/lib/fcrepo_wrapper.rb

@@ -3,7 +3,7 @@ require 'fcrepo_wrapper/instance'
 
 module FcrepoWrapper
   def self.default_fcrepo_version
-    '4.3.0'
+    '4.5.0'
   end
 
   def self.default_instance(options = {})

data/lib/service_instance.rb

@@ -0,0 +1,134 @@
+# This module is intended to be mixed into SolrWrapper::Instance and FcrepoWrapper::Instance
+module ServiceInstance
+  def env
+    options.fetch(:env, {})
+  end
+
+  def binary_path
+    raise NotImplementedError, "Implement binary_path in a subclass"
+  end
+
+  def default_download_url
+    raise NotImplementedError, "Implement default_download_url in a subclass"
+  end
+
+  def default_instance_dir
+    raise NotImplementedError, "Implement default_instance_dir in a subclass"
+  end
+
+  def md5url
+    raise NotImplementedError, "Implement md5url in a subclass"
+  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 download_url
+    @download_url ||= options.fetch(:url, default_download_url)
+  end
+
+
+  def verbose?
+    !!options.fetch(:verbose, false)
+  end
+
+  def instance_dir
+    @instance_dir ||= options.fetch(:instance_dir, default_instance_dir)
+  end
+
+  def extracted?
+    File.exists?(binary_path) && extracted_version == version
+  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 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
+
+  ##
+  # Is the service running?
+  def started?
+    !!status
+  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]
+    end
+  end
+
+  ##
+  # Clean up any files fcrepo_wrapper may have downloaded
+  # TODO: if this is used for solr_wrapper, we also need to remove tmp_save_dir
+  def clean!
+    stop
+    remove_instance_dir!
+    FileUtils.remove_entry(download_path) if File.exists? download_path
+    FileUtils.remove_entry(md5sum_path) if File.exists? md5sum_path
+    FileUtils.remove_entry(version_file) if File.exists? version_file
+  end
+
+  ##
+  # Clean up any files in the Solr instance dir
+  def remove_instance_dir!
+    FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
+  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 md5sum_path
+    File.join(Dir.tmpdir, File.basename(md5url))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -117,6 +117,7 @@ files:
 - lib/fcrepo_wrapper.rb
 - lib/fcrepo_wrapper/instance.rb
 - lib/fcrepo_wrapper/version.rb
+- lib/service_instance.rb
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cbeer/fcrepo_wrapper
@@ -139,10 +140,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Solr 5 service wrapper
 test_files:
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
+has_rdoc: