hydra-remote_identifier 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bfdfcaee94b94b71118befacfc086df017d23cf
-  data.tar.gz: 3e99f645cbd73f4217d5bd9ae50a4ef60a9ff254
+  metadata.gz: 6dd65def0770c56f479dbc71aaa0dc462603f1ad
+  data.tar.gz: d79fbb1d6ce12a804369a4ef441598c1effa2fbb
 SHA512:
-  metadata.gz: 236c6a8e16274abb3cd508b717a38f46b998ccc7c7c4d712f1d89ff846373ae82b8809f53b6628a0880f9bb0e77a48c34b75ececb9edaafb24b38c08defb6932
-  data.tar.gz: 529388f0a159d7eb9c6f3fee8ff9ded2468f7318ac858cddea6a2fdbc0aac0f6ee71af76647befd5f58a0861529dece024f8bd5e689ebb2bb7c7681247f037c3
+  metadata.gz: 29daa6481feda3dd6225bc112b38d6117c717ca50eac693bbe7a5f665c5958a8659fa400cb49f0e2e1bc0fff3da210d05b2358715bd932af99584e031142af7b
+  data.tar.gz: 72ccf7cd67fa4cca2dc617858a760530f2c06537a0e79efc9d2ef9ce62f798d91e84b5a2b378730c05ce4af1fcb0b547ecdb544f90824023aa846151992a14ae

data/README.md

@@ -28,7 +28,7 @@ Configure your remote identifiers with credentials and what have you:
       config.remote_service(:doi, doi_credentials) do |doi|
         doi.register(Book, Page) do |map|
           map.target :url
-          map.creator :creator
+          map.creator {|obj| obj.person_name }
           map.title :title
           map.publisher :publisher
           map.publicationyear :publicationyear
@@ -37,6 +37,9 @@ Configure your remote identifiers with credentials and what have you:
       end
     end
 
+If you are using Rails, you can run `rails generate hydra:remote_identifier:install` to
+create a Rails initializer with the above stub file.
+
 In your views allow users to request that a remote identifier be assigned:
 
     <%= form_for book do |f| %>
@@ -55,3 +58,25 @@ Where your asynchronouse worker does its work request the minting:
 
     # Instantiate target from input
     Hydra::RemoteIdentifier.mint(remote_service_name, target)
+
+## Extending Hydra::RemoteIdentifier with alternate remote identifiers
+
+If you are interested in creating a new Hydra::RemoteIdentifier::RemoteService,
+this can be done by creating a class in the Hydra::RemoteIdentifier::RemoteServices
+namespace. See below:
+
+    module Hydra::RemoteIdentifier::RemoteServices
+      class MyRemoteService < Hydra::RemoteIdentifier::RemoteService
+        # your code here
+      end
+    end
+
+Then configure your RemoteService for your persisted targets. See below:
+
+    Hydra::RemoteIdentifier.configure do |config|
+      config.remote_service(:my_remote_service, credentials) do |mine|
+        mine.register(Book, Page) do |map|
+          # map fields of Book, Page to the required payload for MyRemoteService
+        end
+      end
+    end

data/lib/generators/hydra/remote_identifier/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+
+class Hydra::RemoteIdentifier::InstallGenerator < Rails::Generators::Base
+  def create_config
+    initializer('hydra-remote_identifier_config.rb') do
+      data = []
+
+      data << '# Register and configure remote identifiers for persisted objects'
+      data << 'Hydra::RemoteIdentifier.configure do |config|'
+      data << ''
+      data << '#   doi_credentials = Psych.load("/path/to/doi_credentials.yml")'
+      data << '#   config.remote_service(:doi, doi_credentials) do |doi|'
+      data << '#     doi.register(PersistedObject) do |map|'
+      data << '#       map.target :url'
+      data << '#       map.creator {|obj| obj.person_name }'
+      data << '#       map.title :title'
+      data << '#       map.publisher :publisher'
+      data << '#       map.publicationyear :publicationyear'
+      data << '#       map.set_identifier :set_doi_identifier='
+      data << '#     end'
+      data << '#   end'
+      data << ''
+      data << 'end'
+
+      data.join("\n")
+    end
+  end
+end

data/lib/hydra/remote_identifier.rb

@@ -2,6 +2,7 @@ require "hydra/remote_identifier/version"
 require 'hydra/remote_identifier/configuration'
 require 'hydra/remote_identifier/registration'
 require 'hydra/remote_identifier/remote_service'
+require 'hydra/remote_identifier/railtie' if defined?(Rails)
 
 module Hydra::RemoteIdentifier
 
@@ -42,6 +43,7 @@ module Hydra::RemoteIdentifier
     # @param remote_service_name [#to_s]
     # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
     def with_registered_remote_service(remote_service_name, target)
+      return false unless target.respond_to?(:registered_remote_identifier_minters)
       # @TODO - the registered remote identifier is more than a bit off;
       # but it continues to work
       target.registered_remote_identifier_minters.each {|coordinator|
@@ -62,6 +64,7 @@ module Hydra::RemoteIdentifier
     # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
     # @yield_param remote_service_name [#to_s]
     def requested_remote_identifiers_for(target)
+      return false unless target.respond_to?(:registered_remote_identifier_minters)
       target.registered_remote_identifier_minters.each do |coordinator|
         remote_service = coordinator.remote_service
         if target.public_send(remote_service.accessor_name).to_i != 0
@@ -80,6 +83,8 @@ module Hydra::RemoteIdentifier
     # @param remote_service_name [#to_s]
     # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
     def mint(remote_service_name, target)
+      return false unless target.respond_to?(:registered_remote_identifier_minters)
+
       # @TODO - there is a better way to do this but this is "complete/correct"
       remote_service = configuration.find_remote_service(remote_service_name)
       target.registered_remote_identifier_minters.each do |coordinator|

data/lib/hydra/remote_identifier/railtie.rb

@@ -0,0 +1,7 @@
+module Hydra::RemoteIdentifier
+  class Railtie < Rails::Railtie
+    generators do
+      require 'generators/hydra/remote_identifier/install_generator'
+    end
+  end
+end

data/lib/hydra/remote_identifier/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module RemoteIdentifier
-    VERSION = "0.4.1"
+    VERSION = "0.4.2"
   end
 end

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -53,12 +53,19 @@ module Hydra::RemoteIdentifier
         }.to yield_with_args(RemoteServices::Doi)
       end
 
-      it 'should not yield the service if non is registered' do
+      it 'should not yield the service is not registered' do
         expect {|block|
           Hydra::RemoteIdentifier.with_registered_remote_service(:alternate, target, &block)
         }.to_not yield_control
       end
 
+      it 'should not yield the service if the target is not registered' do
+        target = double
+        expect {|block|
+          Hydra::RemoteIdentifier.with_registered_remote_service(:doi, target, &block)
+        }.to_not yield_control
+      end
+
     end
 
     describe '.mint' do
@@ -69,6 +76,10 @@ module Hydra::RemoteIdentifier
         }.to change(target, :set_identifier).from(nil).to(expected_doi)
       end
 
+      it 'returns false if the target is not configured for identifiers' do
+        expect(Hydra::RemoteIdentifier.mint(:doi, double)).to eq(false)
+      end
+
     end
 
     describe '.requested_remote_identifiers_for' do
@@ -87,6 +98,13 @@ module Hydra::RemoteIdentifier
         }.to_not yield_control
       end
 
+      it 'should not yield when the remote identifier if target is not configured' do
+        target = double
+        expect { |block|
+          Hydra::RemoteIdentifier.requested_remote_identifiers_for(target, &block)
+        }.to_not yield_control
+      end
+
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -103,12 +103,14 @@ files:
 - README.md
 - Rakefile
 - hydra-remote_identifier.gemspec
+- lib/generators/hydra/remote_identifier/install_generator.rb
 - lib/hydra/remote_identifier.rb
 - lib/hydra/remote_identifier/configuration.rb
 - lib/hydra/remote_identifier/exceptions.rb
 - lib/hydra/remote_identifier/mapper.rb
 - lib/hydra/remote_identifier/minter.rb
 - lib/hydra/remote_identifier/minting_coordinator.rb
+- lib/hydra/remote_identifier/railtie.rb
 - lib/hydra/remote_identifier/registration.rb
 - lib/hydra/remote_identifier/remote_service.rb
 - lib/hydra/remote_identifier/remote_services.rb