hydra-remote_identifier 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ad9b2a31edae34b37fafca1d7cef7292ff37bab
-  data.tar.gz: 65e362d4c8eec8f4c1ecc20bcdf7fb75f5bb0c4c
+  metadata.gz: 99922dd154a6430c8dd64418d60db843a3f1082a
+  data.tar.gz: 0e6d029a6ae54490e3d5b6270469eb6a4ee57932
 SHA512:
-  metadata.gz: aeb034f74327c96718859cea5ce998b7ec6f2c01bb4174c625067b44e68120a7e4cb25f4604043d8ce7dac19b03dd8499ece4183909b5f6dc77cf5385c2dc61f
-  data.tar.gz: aa4f0b58c3c76c41222c6485dedc778551401ffbc6a8c06a80b68816af85138e5b1aaafcb7e04cab9a30ce41f6ed2b9992d04eaef9d35a0bec71618680d03825
+  metadata.gz: f22cacf89302908db05f330156f84f9a4145881b113ae1571e3e92338d3e8456e91b550af7860a53a74e39e9ab13f45ce7c05ad6ca3d02d11f968e405fcfd47f
+  data.tar.gz: 234cbd5325b35472d2d003f22bf5bc6ed3527b397548777cc643a5baaf7f29465962eab419dc808f1189fa09015cb88964829245af6c9ea875da4ad49e8c5e29

data/README.md

@@ -48,7 +48,7 @@ In your views allow users to request that a remote identifier be created/assigne
 
 ```ruby
 <%= form_for book do |f| %>
-  <% Hydra::RemoteIdentifier.with_registered_remote_service(:doi, f.object) do |remote_service| %>
+  <% Hydra::RemoteIdentifier.registered?(:doi, f.object) do |remote_service| %>
     <%= f.input remote_service.accessor_name %>
   <% end %>
 <% end %>

data/lib/hydra/remote_identifier.rb

@@ -45,27 +45,50 @@ module Hydra::RemoteIdentifier
     end
     private :configure!
 
+    # Retrieve a valid RemoteService by name
+    # @example
+    #     doi_remote_service = Hydra::RemoteIdentifier.remote_service(:doi)
+    #
+    # @param remote_service_name [#to_s]
+    # @returns [RemoteService]
+    def remote_service(remote_service_name)
+      configuration.find_remote_service(remote_service_name)
+    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.registered?(:doi, book) do |remote_service| %>
     #       <%= f.input remote_service.accessor_name %>
     #     <% end %>
     #
     # @param remote_service_name [#to_s]
     # @param target [#registered_remote_identifier_minters]
-    def with_registered_remote_service(remote_service_name, target)
+    #
+    # @yieldparam @required first [RemoteService]
+    # @yieldparam @optional second [MintingCoordinator]
+    #
+    # @returns [Boolean]
+    def registered?(remote_service_name, target, &block)
       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|
-        if coordinator.remote_service.name.to_s == remote_service_name.to_s
-          yield(coordinator.remote_service)
+      !!target.registered_remote_identifier_minters.detect do |coordinator|
+        # require 'debugger'; debugger; true;
+        if coordinator.remote_service.to_s == remote_service_name.to_s
+          if block_given?
+            if block.arity == 2
+              block.call(coordinator.remote_service, coordinator)
+            else
+              block.call(coordinator.remote_service)
+            end
+          end
+          true
         end
-      }
+      end
     end
 
+    alias_method :with_registered_remote_service, :registered?
+
     # @example
     #    <%= link_to(object.doi, Hydra::RemoteIdentifier.remote_uri_for(:doi, object.doi)) %>
     #
@@ -107,14 +130,11 @@ module Hydra::RemoteIdentifier
     # @param remote_service_name [#to_s]
     # @param target [#registered_remote_identifier_minters]
     def mint(remote_service_name, target)
-      return false unless target.respond_to?(:registered_remote_identifier_minters)
-      remote_service = configuration.find_remote_service(remote_service_name)
-      coordinator = target.registered_remote_identifier_minters.detect do |c|
-        c.remote_service.name == remote_service.name
+      registered?(remote_service_name, target) do |remote_service, coordinator|
+        coordinator.call(target)
       end
-      coordinator.call(target) if coordinator
     end
 
   end
 
-end
+end

data/lib/hydra/remote_identifier/remote_service.rb

@@ -16,6 +16,14 @@ module Hydra::RemoteIdentifier
       name.to_s
     end
 
+    def registered?(target)
+      Hydra::RemoteIdentifier.registered?(self, target)
+    end
+
+    def mint(target)
+      Hydra::RemoteIdentifier.mint(self, target)
+    end
+
     # @param identifier[#to_s] - An identifier that was created by this remote
     #   service
     # @returns [URI] - The URI for that identifier

data/lib/hydra/remote_identifier/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module RemoteIdentifier
-    VERSION = "0.5.3"
+    VERSION = "0.6.0"
   end
 end

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

@@ -5,6 +5,7 @@ module Hydra::RemoteIdentifier
   describe RemoteService do
 
     let(:payload) { 'abc' }
+    let(:target) { double }
     subject { RemoteService.new }
 
     its(:name) { should eq :remote_service }
@@ -16,13 +17,25 @@ module Hydra::RemoteIdentifier
     end
 
     context '#remote_uri_for' do
-      it { expect { subject.remote_uri_for(double) }.to raise_error NotImplementedError }
+      it { expect { subject.remote_uri_for(target) }.to raise_error NotImplementedError }
     end
 
     context '#valid_attribute?' do
       it { expect { subject.valid_attribute?(:attribute_name) }.to raise_error NotImplementedError }
     end
 
+    context '#mint' do
+      it 'should forward delegate to Hydra::RemoteService' do
+        Hydra::RemoteIdentifier.should_receive(:mint).with(subject, target)
+        subject.mint(target)
+      end
+    end
+    context '#registered?' do
+      it 'should forward delegate to Hydra::RemoteService' do
+        Hydra::RemoteIdentifier.should_receive(:registered?).with(subject, target).and_return(:returning_value)
+        expect(subject.registered?(target)).to eq(:returning_value)
+      end
+    end
   end
 
 end

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -35,11 +35,26 @@ module Hydra::RemoteIdentifier
       end
     end
 
+    context '.remote_service' do
+      it 'should return an instance of the request service' do
+        expect(Hydra::RemoteIdentifier.remote_service(:doi)).
+          to be_kind_of(RemoteServices::Doi)
+      end
+
+      it 'should raise exception if it is not a valid remote service' do
+        expect{
+          Hydra::RemoteIdentifier.remote_service(:alternate)
+        }.to raise_error(KeyError)
+      end
+    end
+
+
     context '.with_registered_remote_service' do
       it 'should yield the service if one is registered' do
-        expect {|block|
-          Hydra::RemoteIdentifier.with_registered_remote_service(:doi, target, &block)
-        }.to yield_with_args(RemoteServices::Doi)
+        Hydra::RemoteIdentifier.with_registered_remote_service(:doi, target) do |arg1|
+          @arg1 = arg1
+        end
+        expect(@arg1).to be_instance_of(RemoteServices::Doi)
       end
 
       it 'should not yield the service is not registered' do
@@ -56,6 +71,41 @@ module Hydra::RemoteIdentifier
       end
     end
 
+    context '.registered?' do
+      it 'should return true when registered' do
+        expect(Hydra::RemoteIdentifier.registered?(:doi, target)).to eq(true)
+      end
+
+      it 'should yield true when registered' do
+        expect { |b| Hydra::RemoteIdentifier.registered?(:doi, target, &b) }.to yield_control
+      end
+
+      it 'should yield a remote_service with one arg on the block' do
+        Hydra::RemoteIdentifier.registered?(:doi, target) do |arg1|
+          @arg1 = arg1
+        end
+        expect(@arg1).to be_instance_of(RemoteServices::Doi)
+      end
+
+      it 'should yield a remote_service and minting coordinator with two args' do
+        Hydra::RemoteIdentifier.registered?(:doi, target) do |arg1, arg2|
+          @arg1 = arg1
+          @arg2 = arg2
+        end
+        expect(@arg1).to be_instance_of(RemoteServices::Doi)
+        expect(@arg2).to be_instance_of(MintingCoordinator)
+      end
+
+      it 'should return false when not registered' do
+        expect(Hydra::RemoteIdentifier.registered?(:doi, double)).to eq(false)
+      end
+
+      it 'should return false when service does not exist' do
+        expect(Hydra::RemoteIdentifier.registered?(:alternate, double)).to eq(false)
+      end
+
+    end
+
     context '.remote_uri_for' do
       it {
         expect(Hydra::RemoteIdentifier.remote_uri_for(:doi, expected_doi)).
@@ -93,8 +143,8 @@ module Hydra::RemoteIdentifier
         }.to change(target, :set_identifier).from(nil).to(expected_doi)
       end
 
-      it 'returns the newly minted identifier', VCR::SpecSupport(record: :new_episodes, cassette_name: 'doi-integration') do
-        expect(Hydra::RemoteIdentifier.mint(:doi, target)).to eq(expected_doi)
+      it 'returns true minting occurred', VCR::SpecSupport(record: :new_episodes, cassette_name: 'doi-integration') do
+        expect(Hydra::RemoteIdentifier.mint(:doi, target)).to eq(true)
       end
 
       it 'returns false if the target is not configured for identifiers' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport