hydra-remote_identifier 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dd002275201924c8933a9a7ea1f2fe473cce6a2
-  data.tar.gz: 310d16e3d0e2366617298b8ecb44da409ae31d09
+  metadata.gz: c212f0c8fbb12faf3510a14674d470e79475cc28
+  data.tar.gz: 28b81cd39c16f2c191c79ce226bfc7f333718c82
 SHA512:
-  metadata.gz: 0dc6ea4fc96e29934469d96b08eb4c3a2c8d0ca2fafde6f3d4af8152a167f9e4797573b769a54c503d8245919ca1c1a5466e032f78a8dc138f018041e6603472
-  data.tar.gz: 02d9d09d76c421039fb6f06bd1a56a2926eafac20f56adc35aba9b1ce2330ef677b940ed87050fe812db6e7d6b581f791b9128fe599f1375e739fd4b5cf55af4
+  metadata.gz: ef7b1d1f3f40c22b6169a456814ae2dce2925a1f66fba6fb51a7ae0ad92891a8ad3cb212db376312420ea9209b34663210a6f224d2041d1a07df2cd8e944b4c0
+  data.tar.gz: 38c365ad04bea7a1452900aea09090441bb309757254b5024a223533302ce473766911be6d41e15e7ec07a012768f4095ed4dcdc496172618c1abc1c7b925490

data/lib/hydra/remote_identifier/exceptions.rb

@@ -0,0 +1,7 @@
+module Hydra::RemoteIdentifier
+  class InvalidServiceMapping < RuntimeError
+    def initialize(errors)
+      super(errors.join(". ") << '.')
+    end
+  end
+end

data/lib/hydra/remote_identifier/mapper.rb

@@ -1,11 +1,12 @@
+require File.expand_path('../exceptions', __FILE__)
+
 module Hydra::RemoteIdentifier
-  class InvalidServiceMapping < RuntimeError
-    def initialize(errors)
-      super(errors.join(". ") << '.')
-    end
-  end
+
+  # Registry is responsible for associating a model with a set of remote services and defining the attribute map
+  # The Mapper is responsible for transforming a target, via a Map, into an acceptable format for a Minter
   class Mapper
 
+    # The Wrapper provides the getting and setting behavior for a target based on a Map
     class Wrapper
       attr_reader :map, :target
       def initialize(map, target)
@@ -50,6 +51,9 @@ module Hydra::RemoteIdentifier
       end
     end
 
+    # The Map is responsible for defining which attributes on the target map
+    # to the attributes expected in the RemoteService as well as defining
+    # how the RemoteService can update the target
     class Map < BasicObject
       attr_reader :service_class, :_getters, :_setter
       def initialize(service_class, &config)

data/lib/hydra/remote_identifier/minter.rb

@@ -1,5 +1,8 @@
 module Hydra::RemoteIdentifier
 
+  # The Minter is responsible for passing the target's payload to the
+  # RemoteService then setting the target's identifier based on the response
+  # from the remote_service
   class Minter
 
     def self.call(coordinator, target)

data/lib/hydra/remote_identifier/minting_coordinator.rb

@@ -1,10 +1,10 @@
 module Hydra::RemoteIdentifier
 
+  # The Minting
   class MintingCoordinator
-    attr_reader :service_class, :target_class, :mapper
-    def initialize(service_class, target_class, mapper_builder = Mapper, &map_config)
+    attr_reader :service_class, :mapper
+    def initialize(service_class, mapper_builder = Mapper, &map_config)
       @service_class = service_class
-      @target_class = target_class
       @mapper = mapper_builder.new(service_class, &map_config)
     end
 
@@ -21,17 +21,4 @@ module Hydra::RemoteIdentifier
     end
   end
 
-  describe MintingCoordinator do
-    let(:service_class) { Class.new { def self.valid_attribute?(*); true; end } }
-    let(:target_class) { Class.new }
-    let(:mapper_builder) { double(new: double(call: :wrapped_target)) }
-    let(:target) { target_class.new }
-    let(:map) { lambda {|*|} }
-    subject { MintingCoordinator.new(service_class, target_class, mapper_builder, &map) }
-    it 'forward delegates call to the minter' do
-      minter = double
-      minter.should_receive(:call).with(kind_of(service_class), :wrapped_target)
-      subject.call(target, minter)
-    end
-  end
-end
+end

data/lib/hydra/remote_identifier/registration.rb

@@ -2,6 +2,8 @@ require 'active_support/core_ext/class/attribute'
 
 module Hydra::RemoteIdentifier
 
+  # The Registration is responsible for connecting a RemoteService, a Target
+  # to a particular Map
   class Registration
     def initialize(service_class, target_class, minting_coordinator = MintingCoordinator, &map)
       if map.nil?
@@ -9,36 +11,8 @@ module Hydra::RemoteIdentifier
       end
       target_class.class_attribute :registered_remote_identifier_minters unless target_class.respond_to?(:registered_remote_identifier_minters)
       target_class.registered_remote_identifier_minters ||= []
-      target_class.registered_remote_identifier_minters += [minting_coordinator.new(service_class, target_class, &map)]
+      target_class.registered_remote_identifier_minters += [minting_coordinator.new(service_class, &map)]
     end
   end
 
-  describe Registration do
-
-    let(:minting_coordinator) { double(new: :minting_coordinator) }
-    let(:remote_service) { RemoteService }
-    let(:target_class) { Class.new }
-    let(:map) { lambda {|m| m.title :title } }
-
-    it 'requires a map' do
-      expect { Registration.new(remote_service, target_class, minting_coordinator) }.to raise_error(RuntimeError)
-    end
-
-    it 'adds a .registered_remote_identifier_minters method' do
-      expect {
-        Registration.new(remote_service, target_class, minting_coordinator, &map)
-      }.to change{ target_class.respond_to?(:registered_remote_identifier_minters) }.from(false).to(true)
-    end
-
-    it 'adds a .registered_remote_identifier_minters method' do
-      Registration.new(remote_service, target_class, minting_coordinator, &map)
-      expect(target_class.registered_remote_identifier_minters).to eq [:minting_coordinator]
-    end
-
-    it 'should yield a map' do
-      Registration.new(remote_service, target_class, minting_coordinator, &map)
-    end
-
-  end
-
 end

data/lib/hydra/remote_identifier/remote_service.rb

@@ -1,5 +1,10 @@
 module Hydra::RemoteIdentifier
 
+  # The RemoteService is responsible for delivering a payload to a remote
+  # identification minting service and returning an identifier.
+  #
+  # It is responsible for assisting the construction and validation of a remote
+  # payload.
   class RemoteService
 
     def self.valid_attribute?(attribute_name)

data/lib/hydra/remote_identifier/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module RemoteIdentifier
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

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

@@ -3,15 +3,14 @@ require File.expand_path('../../../../../lib/hydra/remote_identifier/minting_coo
 module Hydra::RemoteIdentifier
   describe MintingCoordinator do
     let(:service_class) { Class.new { def self.valid_attribute?(*); true; end } }
-    let(:target_class) { Class.new }
     let(:mapper_builder) { double(new: double(call: :wrapped_target)) }
-    let(:target) { target_class.new }
+    let(:target) { double }
     let(:map) { lambda {|*|} }
-    subject { MintingCoordinator.new(service_class, target_class, mapper_builder, &map) }
+    subject { MintingCoordinator.new(service_class, mapper_builder, &map) }
     it 'forward delegates call to the minter' do
       minter = double
       minter.should_receive(:call).with(kind_of(service_class), :wrapped_target)
       subject.call(target, minter)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -88,6 +88,7 @@ files:
 - Rakefile
 - hydra-remote_identifier.gemspec
 - lib/hydra/remote_identifier.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