hydra-remote_identifier 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f98bb8113e7148bed0364b4a49a438d70a21ed83
-  data.tar.gz: ae8a740d87e58916eb53df0a5bf3897ade3dd7bc
+  metadata.gz: 9bfdfcaee94b94b71118befacfc086df017d23cf
+  data.tar.gz: 3e99f645cbd73f4217d5bd9ae50a4ef60a9ff254
 SHA512:
-  metadata.gz: 8c2e8a60049fddab49d180ee6e9f142553f0b113b0669dae6acc9e84ba0e6ae8f9c8427d8840cab30bf08496efe77cb4de0bf169a0b240151c30e5372530e4c7
-  data.tar.gz: 1a354e9bd6b9d793b621c607bf9f0d2eb1c045a94f3cd534f1bd369beb4c19d69a0093047ea279bec8a61afce4c7351280cfbb6502ab4e32d6d81a0b2fb55ffb
+  metadata.gz: 236c6a8e16274abb3cd508b717a38f46b998ccc7c7c4d712f1d89ff846373ae82b8809f53b6628a0880f9bb0e77a48c34b75ececb9edaafb24b38c08defb6932
+  data.tar.gz: 529388f0a159d7eb9c6f3fee8ff9ded2468f7318ac858cddea6a2fdbc0aac0f6ee71af76647befd5f58a0861529dece024f8bd5e689ebb2bb7c7681247f037c3

data/README.md

@@ -36,3 +36,22 @@ Configure your remote identifiers with credentials and what have you:
         end
       end
     end
+
+In your views allow users to request that a remote identifier be assigned:
+
+    <%= form_for book do |f| %>
+      <% Hydra::RemoteIdentifier.with_registered_remote_service(:doi, f.object) do |remote_service| %>
+        <%= f.input remote_service.accessor_name %>
+      <% end %>
+    <% end %>
+
+Where you enqueue an asynchronous worker iterate over the requested identifiers:
+
+    Hydra::RemoteIdentifier.applicable_remote_service_names_for(book) do |remote_service|
+      MintRemoteIdentifierWorker.enqueue(book.to_param, remote_service.name)
+    end
+
+Where your asynchronouse worker does its work request the minting:
+
+    # Instantiate target from input
+    Hydra::RemoteIdentifier.mint(remote_service_name, target)

data/lib/hydra/remote_identifier.rb

@@ -31,10 +31,16 @@ module Hydra::RemoteIdentifier
       yield(configuration)
     end
 
+    # Yields the specified RemoteService if it _could_ be requested for the
+    # Target.
+    #
     # @example
-    #     Hydra::RemoteIdentifier.with_registered_remote_service(:doi, book) do |remote_service|
-    #       Hydra::RemoteIdentifier.mint(:doi, book)
-    #     end
+    #     <% Hydra::RemoteIdentifier.with_registered_remote_service(:doi, book) do |remote_service| %>
+    #       <%= f.input remote_service.accessor_name %>
+    #     <% end %>
+    #
+    # @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)
       # @TODO - the registered remote identifier is more than a bit off;
       # but it continues to work
@@ -45,11 +51,21 @@ module Hydra::RemoteIdentifier
       }
     end
 
+
+    # Yields each RemoteService#name that _is_ requested for the Target.
+    #
+    # @example
+    #     Hydra::RemoteIdentifier.requested_remote_identifiers_for(book) do |remote_service_name|
+    #       Hydra::RemoteIdentifier.mint(remote_service_name, book)
+    #     end
+    #
+    # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
+    # @yield_param remote_service_name [#to_s]
     def requested_remote_identifiers_for(target)
       target.registered_remote_identifier_minters.each do |coordinator|
         remote_service = coordinator.remote_service
         if target.public_send(remote_service.accessor_name).to_i != 0
-          yield(remote_service.name)
+          yield(remote_service)
         end
       end
     end
@@ -58,12 +74,11 @@ module Hydra::RemoteIdentifier
     # the target. You must first configure the RemoteService and target's class
     # to define the attribute map. See Hydra::RemoteIdentifier.configure
     #
-    #
     # @example
     #     Hydra::RemoteIdentifier.mint(:doi, book)
     #
     # @param remote_service_name [#to_s]
-    # @param target [#registered_remote_identifier_minters]
+    # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
     def mint(remote_service_name, target)
       # @TODO - there is a better way to do this but this is "complete/correct"
       remote_service = configuration.find_remote_service(remote_service_name)

data/lib/hydra/remote_identifier/remote_service.rb

@@ -12,6 +12,10 @@ module Hydra::RemoteIdentifier
       self.class.to_s.demodulize.underscore.to_sym
     end
 
+    def to_s
+      name.to_s
+    end
+
     def accessor_name
       "mint_#{name}".to_sym
     end

data/lib/hydra/remote_identifier/version.rb

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

data/spec/lib/hydra/remote_identifier/remote_service_spec.rb

@@ -9,6 +9,7 @@ module Hydra::RemoteIdentifier
 
     its(:name) { should eq :remote_service }
     its(:accessor_name) { should eq :mint_remote_service }
+    its(:to_s) { should eq 'remote_service' }
 
     context '#call' do
       it { expect { subject.call(payload) }.to raise_error NotImplementedError }

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -77,7 +77,7 @@ module Hydra::RemoteIdentifier
         target.mint_doi = '1'
         expect { |block|
           Hydra::RemoteIdentifier.requested_remote_identifiers_for(target, &block)
-        }.to yield_with_args(:doi)
+        }.to yield_with_args(instance_of(RemoteServices::Doi))
       end
 
       it 'should not yield when the remote identifier was not requested' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jeremy Friesen