fcrepo_wrapper 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32ab8e3c5f45580a33497d826bf7b1b709b51780
-  data.tar.gz: 40bf4c99f37dfb5dd1e0a3c669e656d4a7757831
+  metadata.gz: c13336376dbcb9d568acba19a92fd5555595af05
+  data.tar.gz: 597e66ac22ce559f7a028a54e9c74f6f0a247a2d
 SHA512:
-  metadata.gz: 7bb4083970b80e8c68b3421d93b2af097d77d2629fcbcfa1ea655f0a537d42242705e347b83893550fdba64380f6c858c09ac5827c21b93b1a6ad68dc673e9f9
-  data.tar.gz: 4140735815d94087e4f7b93adbe981fdbb99e33ed7e7fe75720db8c173e64be028dd5927615d4badef76e5816207f204e1561c559a1b35fedffdaee34c6cc16c
+  metadata.gz: 2bbdc8828cdf9b44c4d32fc026c1e8b99a1cb86373b61a885aa1e6cf4a34127c27c0422f0b2c9a177449ee10054b19dfe5b2aab902075e56dce45a48503d3a15
+  data.tar.gz: 52a8673487e434d352d70a6b7b6244eb63bfd6416b27f536fd12b57e2594539412f3306c0f700533054c0ef357b1225fa80e34433a3dd5207bf838fa18bc1ad7

data/README.md

@@ -8,8 +8,43 @@ FcrepoWrapper.wrap do |solr|
 end
 ```
 
-## Basic Options
+## Configuration Options
 
+### Command Line
+To see a list of valid options when using fcrepo_wrapper to launch an Fcrepo instance from the command line:
+```
+$ fcrepo_wrapper -h
+```
+
+### Ruby
 ```ruby
-FcrepoWrapper.wrap port: 8983, verbose: true, managed: true
+FcrepoWrapper.wrap( port: 8983, verbose: true, managed: true )
+```
+
+### Configuration file
+FcrepoWrapper can read configuration options from a YAML configuration file.
+By default, it looks for configuration files at `.fcrepo_wrapper` and `~/.fcrepo_wrapper`.
+
+You can also specify a configuration file when launching from the command line as follows:
+```
+$ fcrepo_wrapper -config <path_to_config_file>
 ```
+
+### Valid ruby and YAML options
+|Option           | Description                             |
+|-----------------|-----------------------------------------|
+| download_dir    | Local path for storing the downloaded jar & md5 file |
+| env             | *(Hash)* |
+| fcrepo_home_dir | Directory to store fedora repoistory data files |
+| fedora_options  | *(Hash)* |
+| ignore_md5sum   | *(Boolean)* suppress checksum error messages |
+| instance_dir    | Directory to store the fedora jar file |
+| md5sum          | Path/URL to MD5 checksum |
+| port            | Port to run Fedora on |
+| url             | URL of the jar file to download |
+| validate        | *(Boolean)* download a new md5 and (re-)validate the jar file? (default: true) |
+| verbose         | *(Boolean)* return verbose info when running fcrepo commands (default: false) |
+| version         | Fedora version to download and install |
+| version_file    | Local path to store the currently installed version number |
+
+

data/exe/fcrepo_wrapper

@@ -5,10 +5,10 @@ require 'optparse'
 
 options = {}
 
-OptionParser.new do |opts|
+args = OptionParser.new do |opts|
   opts.banner = "Usage: fcrepo_wrapper [options]"
 
-  opts.on("--config", "Load configuration from a file") do |v|
+  opts.on("--config FILE", "Load configuration from a file") do |v|
     options[:config] = v
   end
 
@@ -16,7 +16,7 @@ OptionParser.new do |opts|
     options[:verbose] = v
   end
 
-  opts.on("--[no-]jms", "Run without JMS") do |v|
+  opts.on("--[no-]jms", "Run with[or witout] JMS") do |v|
     options[:enable_jms] = v
   end
 
@@ -24,7 +24,7 @@ OptionParser.new do |opts|
     options[:version] = v
   end
 
-  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: 8080)") do |p|
+  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: #{FcrepoWrapper.default_fcrepo_port})") do |p|
     if p == 'random'
       options[:port] = nil
     else
@@ -39,7 +39,20 @@ OptionParser.new do |opts|
   opts.on("-dDIR", "--fcrepo_home DIR", "Store fcrepo at the given directory") do |d|
     options[:fcrepo_home_dir] = d
   end
-end.parse!
+
+  opts.on("-h", "--help", "Show these usage options") do
+    puts opts
+    exit
+  end
+end
+
+begin
+  args.parse!
+rescue => error
+  $stderr.puts "ERROR: #{error}\n"
+  $stderr.puts "#{args.help}\n"
+  exit 1
+end
 
 # default to verbose
 options[:verbose] = true if options[:verbose].nil?

data/lib/fcrepo_wrapper/configuration.rb

@@ -1,3 +1,7 @@
+require 'yaml'
+require 'erb'
+require 'socket'
+
 module FcrepoWrapper
   class Configuration
     attr_reader :options
@@ -22,6 +26,10 @@ module FcrepoWrapper
       @download_path ||= options.fetch(:download_path, default_download_path)
     end
 
+    def ignore_md5sum
+      options.fetch(:ignore_md5sum, false)
+    end
+
     def md5sum_path
       File.join(download_dir, File.basename(md5url))
     end
@@ -87,7 +95,15 @@ module FcrepoWrapper
       # 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]
+      options[:port] || FcrepoWrapper.default_fcrepo_port
+    end
+
+    def validate
+      options.fetch(:validate, true)
+    end
+
+    def md5sum
+      options.fetch(:md5sum, nil)
     end
 
     private
@@ -116,8 +132,16 @@ module FcrepoWrapper
         ['.fcrepo_wrapper', '~/.fcrepo_wrapper']
       end
 
+      def default_download_dir
+        if defined? Rails
+          File.join(Rails.root, 'tmp')
+        else
+          Dir.tmpdir
+        end
+      end
+
       def download_dir
-        @download_dir ||= options.fetch(:download_dir, Dir.tmpdir)
+        @download_dir ||= options.fetch(:download_dir, default_download_dir)
         FileUtils.mkdir_p @download_dir
         @download_dir
       end

data/lib/fcrepo_wrapper/instance.rb

@@ -22,7 +22,7 @@ module FcrepoWrapper
     # @option options [String] :version_file Local path to store the currently installed version
     # @option options [String] :download_dir Local directory to store the downloaded fcrepo jar and its md5 file in (overridden by :download_path)
     # @option options [String] :download_path Local path for storing the downloaded fcrepo jar file
-    # @option options [Boolean] :validate Should fcrepo_wrapper download a new md5 and (re-)validate the zip file? (default: trueF)
+    # @option options [Boolean] :validate Should fcrepo_wrapper download a new md5 and (re-)false the zip file? (default: trueF)
     # @option options [String] :md5sum Path/URL to MD5 checksum
     # @option options [Boolean] :verbose return verbose info when running fcrepo commands
     # @option options [Boolean] :ignore_md5sum
@@ -141,6 +141,14 @@ module FcrepoWrapper
       config.version
     end
 
+    def instance_dir
+      config.instance_dir
+    end
+
+    def options
+      config.options
+    end
+
     ##
     # Clean up any files fcrepo_wrapper may have downloaded
     def clean!
@@ -191,9 +199,9 @@ module FcrepoWrapper
     end
 
     def download
-      unless File.exists?(config.download_path) && validate?(config.download_path)
+      unless File.exists?(config.download_path) && md5.validate?(config.download_path)
         Downloader.fetch_with_progressbar config.download_url, config.download_path
-        validate! config.download_path
+        md5.validate! config.download_path
       end
       config.download_path
     end

data/lib/fcrepo_wrapper/settings.rb

@@ -1,3 +1,4 @@
+require 'delegate'
 module FcrepoWrapper
   # Configuraton that comes from static and dynamic sources.
   class Settings < Delegator

data/lib/fcrepo_wrapper/tasks/fcrepo_wrapper.rake

@@ -4,7 +4,6 @@ require 'fcrepo_wrapper'
 namespace :fcrepo do
   desc "Load the fcrepo options and fcrepo instance"
   task :environment do
-    FcrepoWrapper.default_instance_options[:download_dir] ||= Rails.root.to_s + '/tmp' if defined? Rails
     @fcrepo_instance = FcrepoWrapper.default_instance
   end
 

data/lib/fcrepo_wrapper/version.rb

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

data/lib/fcrepo_wrapper.rb

@@ -10,19 +10,12 @@ module FcrepoWrapper
     '4.5.0'
   end
 
-  def self.default_instance_options
-    @default_instance_options ||= {
-      port: '8080',
-      version: FcrepoWrapper.default_fcrepo_version
-    }
-  end
-
-  def self.default_instance_options=(options)
-    @default_instance_options = options
+  def self.default_fcrepo_port
+    '8080'
   end
 
   def self.default_instance(options = {})
-    @default_instance ||= FcrepoWrapper::Instance.new default_instance_options.merge(options)
+    @default_instance ||= FcrepoWrapper::Instance.new options
   end
 
   ##

data/spec/lib/fcrepo_wrapper/configuration_spec.rb

@@ -30,7 +30,23 @@ describe FcrepoWrapper::Configuration do
     it "uses values from the config file" do
       expect(config.port).to eq '9999'
     end
+  end
 
+  describe "#validate" do
+    let(:options) { {} }
+    subject { config.validate }
+    it { is_expected.to eq true }
+  end
+
+  describe "#md5sum" do
+    let(:options) { {} }
+    subject { config.md5sum }
+    it { is_expected.to be nil }
   end
-end
 
+  describe "#ignore_md5sum" do
+    let(:options) { {} }
+    subject { config.ignore_md5sum }
+    it { is_expected.to be false }
+  end
+end

data/spec/lib/fcrepo_wrapper/instance_spec.rb

@@ -27,5 +27,14 @@ describe FcrepoWrapper::Instance do
     subject { wrapper.md5 }
     it { is_expected.to be_instance_of FcrepoWrapper::MD5 }
   end
-end
 
+  describe "#instance_dir" do
+    subject { File.exists?(wrapper.instance_dir) }
+    it { is_expected.to be true }
+  end
+
+  describe "#options" do
+    subject { wrapper.options }
+    it { is_expected.to eq({}) }
+  end 
+end

data/spec/lib/fcrepo_wrapper/md5_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe FcrepoWrapper::MD5 do
+  let(:options) { {} }
+  let(:config) { FcrepoWrapper::Configuration.new options }
+  let(:md5) { described_class.new(config) }
+  let(:file) { 'spec/fixtures/sample_config.yml' }
+
+  describe "#validate!" do
+    subject { md5.validate!(file) }
+    context "with a checksum mismatch" do
+      it "raises an error" do
+        expect { subject }.to raise_error "MD5 mismatch"
+      end
+    end
+
+    context "with a correct checksum" do
+      let(:options) { { md5sum: 'de0b8ccf94db635e149b4c01027b34c1' } }
+      it "doesn't raise an error" do
+        expect { subject }.not_to raise_error
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -127,6 +127,7 @@ files:
 - spec/fixtures/sample_config.yml
 - spec/lib/fcrepo_wrapper/configuration_spec.rb
 - spec/lib/fcrepo_wrapper/instance_spec.rb
+- spec/lib/fcrepo_wrapper/md5_spec.rb
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cbeer/fcrepo_wrapper
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Solr 5 service wrapper
@@ -157,6 +158,6 @@ 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/md5_spec.rb
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: