hydra-ezid 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37143ff47d5dca9d488f26f82d965ef9238c1aab
-  data.tar.gz: 61b7db89ef84e1d94026e9a21f12cc2f422b8e80
+  metadata.gz: 057f939ebe9d09e72b871c309aaf46069a950b0b
+  data.tar.gz: ff9d5a5c602c89ae7cb1e994b6c40d995411830b
 SHA512:
-  metadata.gz: eb7b59bf87388430f0841a26bde4f77d818e90ad5d5e62430a9de5c68facacce3cf08812fbdd228c0eb4d2b0ccda601e4df694b3f6f5f5e11752ef9760fce055
-  data.tar.gz: d5fa71a928fa97ea1d7744882ec74ea2c3181b508979b3b955ebfdeb01e7582578601eb4c76c3a3986c226afc037a973ea42588936950d00bdb893015486699e
+  metadata.gz: 717e05c76340bccb043baa60b08f462910a8111bd9d4ce7ab4c0ed75431c63316bdf09a5a29871a84308a1253605b4430c89480579fce22fd27b067d46b98adf
+  data.tar.gz: cc82e1054392701c1ca5a77c0fa0f54df9cff16485a6756a3d47dd979d47139586646e6cb175be16ebdc2286cdd5d0a6055c8eb085900762acda86231747561a

data/.gitignore

@@ -1,3 +1,4 @@
+/jetty
 [.]ruby-version
 [.]ruby-gemset
 *.rbc

data/CONTRIBUTORS.md

@@ -1,3 +1,4 @@
 Contributors to this project:
 
 *  Michael J. Giarlo
+*  Tom Johnson

data/Gemfile

@@ -2,16 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hydra-ezid.gemspec
 gemspec
-
-# To use debugger
-# gem 'debugger'
-
-gem 'blacklight'
-
-group :development, :test do
-  gem 'sqlite3'
-  gem "factory_girl_rails", "~> 4.1.0"
-  gem 'devise'
-  gem 'capybara', '~>1.1.3'
-  gem 'jettywrapper'
-end

data/README.md

@@ -1,6 +1,6 @@
 # Hydra::Ezid [![Version](https://badge.fury.io/rb/hydra-ezid.png)](http://badge.fury.io/rb/hydra-ezid) [![Build Status](https://travis-ci.org/psu-stewardship/hydra-ezid.png?branch=master)](https://travis-ci.org/psu-stewardship/hydra-ezid) [![Dependency Status](https://gemnasium.com/psu-stewardship/hydra-ezid.png)](https://gemnasium.com/psu-stewardship/hydra-ezid)
 
-A Rails engine providing EZID services for Hydra applications
+A Ruby gem providing EZID services for Hydra applications
 
 ## Installation
 
@@ -18,35 +18,54 @@ Or install it yourself as:
 
 ## Usage
 
-### Mount the engine to get the routes in config/routes.rb
+### Make your Models Identifiable by EZID
 
-    mount Hydra::Ezid::Engine => '/'
+First, add a config file to your app in `config/ezid.yml` that looks like the following:
 
-### Call button_to_mint_ezid view helper in your search result page template.
+```yaml
+doi:
+  user: "foo"
+  pass: "bar"
+  scheme: "doi"
+  shoulder: "sldr1"
+  naa: "10.1000"
 
-First add `helper :ezid` to your `catalog_controller.rb`
-
-Next, we recommend putting the view helper in catalog/[_sort_and_per_page.html.erb](https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/_sort_and_per_page.html.erb) which you will manually override in your app:
-```erb
-<%= button_to_mint_ezid %>
+ark:
+  user: "foo"
+  pass: "quux"
+  scheme: "ark"
+  shoulder: "sldr2"
+  naa: "98765"
 ```
 
-### Any time you want to refer to the routes from hydra-ezid use ezid.
-
-ezid.new_ezid_path
-
-### Make your Models Ezid-able
-
-Add `include Hydra::Ezid::ModelMethods` to the models for anything that you want to be able to mint EZIDs for.
+Add `include Hydra::Ezid::Identifiable` to the models you want EZIDs for.
 
 Example:
 ```ruby
 class GenericFile < ActiveFedora::Base
-  include Hydra::Ezid::ModelMethods
-    ...
+  include Hydra::Ezid::Identifiable
+  ezid_config do
+    store_doi at: :descMetadata, in: :my_doi
+    store_ark at: :properties, in: :some_ark
+    find_creator at: :descMetadata, in: :author
+    find_title at: :properties
+    find_publisher at: :properties
+    find_publication_year at: :descMetadata, in: :pubYear
+end
+```
+
+And then you can mint EZIDs on your model instances:
+
+```ruby
+gf = GenericFile.find('id:123')
+gf.mint_ezid # will mint both a DOI and an ARK per the snippet above
+gf.mint_ezid(Hydra::Ezid.config(except_keys: :doi)) # will mint only an ARK
+gf.mint_doi # shortcut version of prior method
+gf.mint_ezid(Hydra::Ezid.config(except_keys: :ark)) # will mint only a DOI
+gf.mint_ark # shortcut version of prior method
 ```
 
-### Setup instructions for Contributors
+## Developers
 
 In order to make modifications to the gem code and run the tests, clone the repository then
 

data/Rakefile

@@ -5,12 +5,22 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-Dir.glob('tasks/*.rake').each { |r| import r }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+APP_ROOT="." # for jettywrapper
+require 'jettywrapper'
 
-ENV["RAILS_ROOT"] ||= 'spec/internal'
+RSpec::Core::RakeTask.new(:spec)
 
-desc 'Run CI tests in e.g. Travis environment'
-task :travis => ['clean', 'ci']
+desc 'Spin up jetty and run specs'
+task :ci => ['jetty:unzip'] do
+  puts 'running continuous integration'
+  jetty_params = Jettywrapper.load_config
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
 
 desc 'Default: run CI'
-task :default => [:travis]
+task :default => :ci

data/config/ezid.yml

@@ -0,0 +1,13 @@
+doi:
+  user: ""
+  pass: ""
+  scheme: "doi"
+  shoulder: "sldr1"
+  naa: "10.1000"
+
+ark:
+  user: ""
+  pass: ""
+  scheme: "ark"
+  shoulder: "sldr2"
+  naa: "98765"

data/config/ezid_override.yml

@@ -0,0 +1,6 @@
+mysillything:
+  user: ""
+  pass: ""
+  scheme: "doi"
+  shoulder: "sldr3"
+  naa: "10.2000"

data/config/jetty.yml

@@ -0,0 +1,6 @@
+default:
+  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8983 %>
+  startup_wait: 60
+  java_opts:
+    - "-Xmx256m" 
+    - "-XX:MaxPermSize=128m"

data/hydra-ezid.gemspec

@@ -1,6 +1,5 @@
 lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hydra/ezid/version'
 
 Gem::Specification.new do |s|
@@ -8,8 +7,8 @@ Gem::Specification.new do |s|
   s.version       = Hydra::Ezid::VERSION
   s.authors       = ['Michael J. Giarlo']
   s.email         = ['leftwing@alumni.rutgers.edu']
-  s.summary       = 'A Rails engine providing EZID services for Hydra applications'
-  s.description   = 'A Rails engine providing EZID services for Hydra applications'
+  s.summary       = 'A Ruby gem providing EZID services for Hydra applications'
+  s.description   = 'A Ruby gem providing EZID services for Hydra applications'
   s.homepage      = 'https://github.com/psu-stewardship/hydra-ezid'
   s.license       = 'APACHE2'
 
@@ -18,12 +17,12 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_dependency 'blacklight'
-  s.add_dependency 'hydra-head'
+  s.add_dependency 'activesupport', '>= 3.2.13', '< 5.0'
+  s.add_dependency 'active-fedora'
   s.add_dependency 'ezid'
 
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'sass-rails', '< 5', '>= 3.2'
+  s.add_development_dependency 'jettywrapper'
+  s.add_development_dependency 'rspec'
 end

data/lib/hydra/ezid.rb

@@ -1,11 +1,22 @@
+require 'active_support'
+require 'active-fedora'
+require 'yaml'
 module Hydra
   module Ezid
     extend ActiveSupport::Autoload
     autoload :Version
-    autoload :ControllerBehavior
-    autoload :ModelMethods
-    class Engine < ::Rails::Engine
-      engine_name 'ezid'
+    autoload :MintError
+    autoload :Identifiable
+
+    def self.config(options = {}.with_indifferent_access)
+      from_file = options.fetch(:from_file, default_file)
+      except_keys = Array(options[:except_keys])
+      from_file.to_hash.with_indifferent_access.delete_if { |k, v| except_keys.include? k.to_sym }
+    end
+
+    private
+    def self.default_file
+      YAML::load(ERB.new(IO.read(File.join('config', 'ezid.yml'))).result)
     end
   end
 end

data/lib/hydra/ezid/identifiable.rb

@@ -0,0 +1,75 @@
+module Hydra
+  module Ezid
+    module Identifiable
+      extend ActiveSupport::Concern
+
+      included do
+        def self.ezid_registry
+          @@ezid_registry ||= {}
+        end
+        def self.ezid_config(&block)
+          block.call
+        end
+        def self.store_doi(options)
+          ezid_register(options, :doi)
+        end
+        def self.store_ark(options)
+          ezid_register(options, :ark)
+        end
+        def self.find_creator(options)
+          # TODO: unstub
+        end
+        def self.find_title(options)
+          # TODO: unstub
+        end
+        def self.find_publisher(options)
+          # TODO: unstub
+        end
+        def self.find_publication_year(options)
+          # TODO: unstub
+        end
+
+        # TODO: include stuff such as AF callbacks and validations
+
+        private
+        def self.ezid_register(options, scheme)
+          datastream = options[:at]
+          field = options.fetch(:in, scheme)
+          ezid_registry[scheme] = {datastream: datastream, field: field}
+        end
+      end
+
+      # TODO: This will be done by ezid gem, THROW AWAY
+      def idify(*ary)
+        "#{ary[0]}:/#{ary[1]}/#{ary[2]}#{ary[3]}"
+      end
+
+      def mint_ezid(conf = Hydra::Ezid.config)
+        raise Hydra::Ezid::MintError.new("Cannot mint EZID until object is saved") unless self.persisted?
+        self.class.ezid_registry.each_pair do |scheme, opts|
+          scheme_conf = conf.values.find { |subkeys| subkeys['scheme'] == scheme.to_s }
+          next unless scheme_conf
+          id = idify(scheme_conf['scheme'], scheme_conf['naa'], scheme_conf['shoulder'], self.pid)
+          datastreams["#{opts[:datastream]}"].send("#{opts[:field]}=", id)
+        end
+        # TODO: When generate_ezid is ready, fix me with something like:
+        #   session = ::Ezid::ApiSession.new(
+        #     conf.doi.user,
+        #     conf.doi.pass,
+        #     conf.doi.scheme,
+        #     conf.doi.naa
+        #  )
+        #  @ezid = session.generate_ezid(conf.doi.shoulder + self.pid)
+        nil
+      end
+
+      def mint_doi
+        mint_ezid(Hydra::Ezid.config(except_keys: :ark))
+      end
+
+      def mint_ark
+        mint_ezid(Hydra::Ezid.config(except_keys: :doi))
+      end
+    end
+  end
+end

data/lib/hydra/ezid/mint_error.rb

@@ -0,0 +1,6 @@
+module Hydra
+  module Ezid
+    class MintError < StandardError
+    end
+  end
+end

data/lib/hydra/ezid/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Ezid
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/spec/spec_helper.rb

@@ -1,30 +1,6 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-ENV["RAILS_ENV"] ||= 'test'
-
-require File.expand_path("config/environment", ENV['RAILS_ROOT'] || File.expand_path("../internal", __FILE__))
-require 'rspec/rails'
-require 'hydra-ezid'
-
-FactoryGirl.definition_file_paths = [File.expand_path("../factories", __FILE__)]
-FactoryGirl.find_definitions
-
-module EngineRoutes
-  def self.included(base)
-    base.routes { Hydra::Ezid::Engine.routes }
-  end
-end
+require 'rspec/autorun'
+ENV['environment'] ||= 'test'
+require 'hydra/ezid'
 
 RSpec.configure do |config|
-  config.use_transactional_fixtures = true
-  config.include Devise::TestHelpers, :type => :controller
-  config.before(:each, :type=>"controller") { @routes = Hydra::Ezid::Engine.routes }
-  config.include EngineRoutes, :type => :controller
-end
-
-module FactoryGirl
-  def self.find_or_create(handle, by=:email)
-    tmpl = FactoryGirl.build(handle)
-    tmpl.class.send("find_by_#{by}".to_sym, tmpl.send(by)) || FactoryGirl.create(handle)
-  end
 end

data/spec/units/ezid_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Hydra::Ezid do
+  before(:all) do
+    class FedoraModel < ActiveFedora::Base
+      include Hydra::Ezid::Identifiable
+      has_metadata :name => 'properties', :type => ActiveFedora::SimpleDatastream do |m|
+        m.field 'some_ark',  :string
+      end
+      has_metadata :name => 'descMetadata', :type => ActiveFedora::SimpleDatastream do |m|
+        m.field 'doi',  :string
+      end
+      delegate_to :properties, [:some_ark], unique: true
+      delegate_to :descMetadata, [:doi], unique: true
+      ezid_config do
+        store_doi at: :descMetadata
+        store_ark at: :properties, in: :some_ark
+        find_creator at: :descMetadata, in: :author
+        find_title at: :properties
+        find_publisher at: :properties
+        find_publication_year at: :descMetadata, in: :pubYear
+      end
+    end
+  end
+
+  after(:all) do
+    Object.send(:remove_const, :FedoraModel)
+  end
+
+  subject(:item) { FedoraModel.new }
+
+  describe "#mint_ezid" do
+    before(:each) do
+      item.stub(:persisted? => true)
+      item.stub(:pid => 'sufia:xz67gt83a')
+    end
+
+    it { should respond_to(:mint_ezid) }
+
+    it "mints a valid ezid" do
+      item.mint_ezid.should be_nil
+    end
+
+    it "uses a configurator for account details" do
+      Hydra::Ezid.config['doi']['user'].should == ''
+    end
+
+    it "calls Ezid.generate_ezid" do
+      pending "*** WE NEED TO IMPLEMENT THIS ***"
+      Ezid::ApiSession.any_instance.should_receive(:generate_ezid).once
+      item.mint_ezid
+    end
+
+    it "raises an error when minting against an unsaved object" do
+      item.stub(:persisted? => false)
+      expect { item.mint_ezid }.to raise_error(Hydra::Ezid::MintError)
+    end
+
+    it "respects the configurator when keys are passed in - doi" do
+      item.mint_ezid(Hydra::Ezid.config(except_keys: :doi))
+      item.some_ark.should == "ark:/98765/sldr2sufia:xz67gt83a"
+      item.doi.should be_nil
+    end
+
+    it "respects the configurator when keys are passed in - ark" do
+      item.mint_ezid(Hydra::Ezid.config(except_keys: :ark))
+      item.some_ark.should be_nil
+      item.doi.should == "doi:/10.1000/sldr1sufia:xz67gt83a"
+    end
+
+    it "provides a convenience method for minting only ARKs" do
+      item.mint_ark
+      item.some_ark.should == "ark:/98765/sldr2sufia:xz67gt83a"
+      item.doi.should be_nil
+    end
+
+    it "provides a convenience method for minting only DOIs" do
+      item.mint_doi
+      item.some_ark.should be_nil
+      item.doi.should == "doi:/10.1000/sldr1sufia:xz67gt83a"
+    end
+
+    it "respects a config from a file" do
+      f = YAML::load(ERB.new(IO.read(File.join('config', 'ezid_override.yml'))).result)
+      item.mint_ezid(Hydra::Ezid.config(from_file: f))
+      item.some_ark.should be_nil
+      item.doi.should == "doi:/10.2000/sldr3sufia:xz67gt83a"
+    end
+
+    it "stores an id in a configurable location by scheme" do
+      item.mint_ezid
+      item.some_ark.should == "ark:/98765/sldr2sufia:xz67gt83a"
+      item.doi.should == "doi:/10.1000/sldr1sufia:xz67gt83a"
+    end
+  end
+
+  it "disallows repeat settings of a scheme"
+  it "disallows setting of the ezid manually"
+  it "updates/saves when changed"
+  it "crosswalks metadata"
+  it "sends crosswalked metadata to the ezid service"
+  it "allows specification of DOI or ARK"
+  it "allows multiple accounts"
+  it "allows management of status (public, private, etc.)"
+end