hydra-remote_identifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dd002275201924c8933a9a7ea1f2fe473cce6a2
+  data.tar.gz: 310d16e3d0e2366617298b8ecb44da409ae31d09
+SHA512:
+  metadata.gz: 0dc6ea4fc96e29934469d96b08eb4c3a2c8d0ca2fafde6f3d4af8152a167f9e4797573b769a54c503d8245919ca1c1a5466e032f78a8dc138f018041e6603472
+  data.tar.gz: 02d9d09d76c421039fb6f06bd1a56a2926eafac20f56adc35aba9b1ce2330ef677b940ed87050fe812db6e7d6b581f791b9128fe599f1375e739fd4b5cf55af4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hydra-remote_identifier.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,16 @@
+##########################################################################
+#
+# Copyright 2013 Notre Dame
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,29 @@
+# Hydra::RemoteIdentifier
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hydra-remote_identifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hydra-remote_identifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hydra-remote_identifier.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hydra/remote_identifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hydra-remote_identifier"
+  spec.version       = Hydra::RemoteIdentifier::VERSION
+  spec.authors       = ["Jeremy Friesen"]
+  spec.email         = ["jeremy.n.friesen@gmail.com"]
+  spec.description   = %q{Handles the registration and minting of remote identifiers (i.e. DOI, ARK, ORCID)}
+  spec.summary       = %q{Handles the registration and minting of remote identifiers (i.e. DOI, ARK, ORCID)}
+  spec.homepage      = "https://github.com/jeremyf/hydra-remote_identifier"
+  spec.license       = "APACHE2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 3.2.13', '< 5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+end

data/lib/hydra/remote_identifier/mapper.rb

@@ -0,0 +1,93 @@
+module Hydra::RemoteIdentifier
+  class InvalidServiceMapping < RuntimeError
+    def initialize(errors)
+      super(errors.join(". ") << '.')
+    end
+  end
+  class Mapper
+
+    class Wrapper
+      attr_reader :map, :target
+      def initialize(map, target)
+        @map, @target = map, target
+      end
+
+      def extract_payload
+        map._getters.each_with_object({}) do |(key, getter), mem|
+          mem[key] = extract_attribute_for(target, getter, key)
+          mem
+        end
+      end
+
+      def set_identifier(identifier)
+        update_target(map._setter, target, identifier)
+      end
+
+      private
+
+      def update_target(setter, target, value)
+        if setter.respond_to?(:call)
+          setter.call(target, value)
+        elsif setter.is_a?(Symbol) || setter.is_a?(String)
+          target.send(setter, value)
+        elsif setter.is_a?(Hash)
+          datastream = setter.fetch(:at)
+          field = setter.fetch(:in, scheme)
+          target.datastreams["#{datastream}"].send("#{field}=", value)
+        end
+      end
+
+      def extract_attribute_for(target, getter, field_name)
+        if getter.respond_to?(:call)
+          getter.call(target)
+        elsif getter.is_a?(::Symbol) || getter.is_a?(::String)
+          target.send(getter)
+        elsif getter.is_a?(::Hash)
+          datastream = getter.fetch(:at)
+          field = getter.fetch(:in, field_name)
+          target.datastreams["#{datastream}"].send("#{field}")
+        end
+      end
+    end
+
+    class Map < BasicObject
+      attr_reader :service_class, :_getters, :_setter
+      def initialize(service_class, &config)
+        @service_class = service_class
+        @_setter = nil
+        @_getters = {}
+        @errors = []
+        config.call(self)
+        if @_setter.nil?
+          @errors << "Missing :set_identifier"
+        end
+        ::Kernel.raise ::Hydra::RemoteIdentifier::InvalidServiceMapping.new(@errors) if @errors.any?
+      end
+
+      def inspect
+        "#<Hydra::RemoteIdentifier::Mapper::Map for #{service_class} (#{__FILE__})>"
+      end
+
+      def method_missing(method_name, *args, &block)
+        if method_name == :set_identifier
+          @_setter = args.first || block
+        elsif service_class.valid_attribute?(method_name)
+          @_getters[method_name] = args.first || block
+        else
+          @errors << "Invalid mapping #{method_name}"
+        end
+      end
+    end
+
+    attr_reader :map
+    def initialize(service_class, map_builder = Map, &mapping_block)
+      @map = map_builder.new(service_class, &mapping_block)
+    end
+
+    def call(target, wrapper_builder = Wrapper)
+      wrapper_builder.new(map, target)
+    end
+
+  end
+
+end

data/lib/hydra/remote_identifier/minter.rb

@@ -0,0 +1,31 @@
+module Hydra::RemoteIdentifier
+
+  class Minter
+
+    def self.call(coordinator, target)
+      new(coordinator, target).call
+    end
+
+    attr_reader :service, :target
+
+    def initialize(service, target)
+      @service, @target = service, target
+    end
+
+    def call
+      update_target(service.call(payload))
+    end
+
+    private
+
+    def payload
+      target.extract_payload
+    end
+
+    def update_target(identifier)
+      target.set_identifier(identifier)
+    end
+
+  end
+
+end

data/lib/hydra/remote_identifier/minting_coordinator.rb

@@ -0,0 +1,37 @@
+module Hydra::RemoteIdentifier
+
+  class MintingCoordinator
+    attr_reader :service_class, :target_class, :mapper
+    def initialize(service_class, target_class, mapper_builder = Mapper, &map_config)
+      @service_class = service_class
+      @target_class = target_class
+      @mapper = mapper_builder.new(service_class, &map_config)
+    end
+
+    # Responsible for passing attributes from the target, as per the map, to
+    # the service and assigning the result of the service to the target, as per
+    # the map.
+    def call(target, minter = Minter)
+      minter.call(service_class.new, wrap(target))
+    end
+
+    private
+    def wrap(target)
+      mapper.call(target)
+    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

data/lib/hydra/remote_identifier/registration.rb

@@ -0,0 +1,44 @@
+require 'active_support/core_ext/class/attribute'
+
+module Hydra::RemoteIdentifier
+
+  class Registration
+    def initialize(service_class, target_class, minting_coordinator = MintingCoordinator, &map)
+      if map.nil?
+        raise RuntimeError, "You attempted to register the remote service #{service_class} for #{target_class} without a map"
+      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)]
+    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

@@ -0,0 +1,16 @@
+module Hydra::RemoteIdentifier
+
+  class RemoteService
+
+    def self.valid_attribute?(attribute_name)
+      true
+    end
+
+    def call(payload)
+      raise NotImplementedError,
+        "You must implement #{self.class}#call"
+    end
+
+  end
+
+end

data/lib/hydra/remote_identifier/version.rb

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

data/lib/hydra/remote_identifier.rb

@@ -0,0 +1,11 @@
+require "hydra/remote_identifier/version"
+require 'hydra/remote_identifier/registration'
+
+module Hydra::RemoteIdentifier
+
+  def register(remote_service, target_class, &block)
+    Registration.new(remote_service, target_class, &block)
+  end
+  module_function :register
+
+end

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

@@ -0,0 +1,51 @@
+require File.expand_path('../../../../../lib/hydra/remote_identifier/mapper', __FILE__)
+module Hydra::RemoteIdentifier
+  describe Mapper do
+
+    let(:service_class) { double }
+
+    describe 'with valid mapping block' do
+      before(:each) do
+        service_class.should_receive(:valid_attribute?).with(:title).and_return(true)
+      end
+      subject {
+        Mapper.new(service_class) { |map|
+          map.title :title
+          map.set_identifier :foo=
+        }
+      }
+      let(:my_title) { 'abc' }
+      let(:target) { double(title: my_title)}
+      let(:identifier) { '123' }
+
+      it { expect(subject.call(target)).to be_kind_of Mapper::Wrapper }
+
+      it { expect(subject.call(target).extract_payload).to eq({ title: my_title }) }
+      it {
+        target.should_receive(:foo=).with(identifier)
+        subject.call(target).set_identifier(identifier)
+      }
+    end
+
+    describe 'with invalid mapping block' do
+      it 'chokes on invalid attribute' do
+        service_class.should_receive(:valid_attribute?).with(:title).and_return(false)
+        expect {
+          Mapper.new(service_class) { |map|
+            map.title :title
+            map.set_identifier :foo=
+          }
+        }.to raise_error(InvalidServiceMapping)
+      end
+
+      it 'chokes when set_identifier is not specified' do
+        service_class.should_receive(:valid_attribute?).with(:title).and_return(true)
+        expect {
+          Mapper.new(service_class) { |map|
+            map.title :title
+          }
+        }.to raise_error(InvalidServiceMapping)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require File.expand_path('../../../../../lib/hydra/remote_identifier/minter', __FILE__)
+
+module Hydra::RemoteIdentifier
+
+  describe Minter do
+    let(:payload) { 'abc' }
+    let(:identifier) { '123' }
+    let(:target) { double(extract_payload: payload) }
+    let(:service) { double }
+    describe '.call' do
+      it 'initializes the minter and calls it' do
+
+      end
+    end
+    describe '#call' do
+      subject { Minter.new(service, target) }
+      it "extracts the target's payload to send to the remote service then updates the target's identifier" do
+        service.should_receive(:call).with(payload).and_return(identifier)
+        target.should_receive(:set_identifier).with(identifier)
+        subject.call
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,17 @@
+require File.expand_path('../../../../../lib/hydra/remote_identifier/minting_coordinator', __FILE__)
+
+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(: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

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

@@ -0,0 +1,26 @@
+require File.expand_path('../../../../../lib/hydra/remote_identifier/registration', __FILE__)
+module Hydra::RemoteIdentifier
+
+  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/spec/lib/hydra/remote_identifier/remote_service_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../../../../../lib/hydra/remote_identifier/remote_service', __FILE__)
+
+module Hydra::RemoteIdentifier
+
+  describe RemoteService do
+    let(:payload) { 'abc' }
+    subject { RemoteService.new }
+
+    it { expect { subject.call(payload) }.to raise_error NotImplementedError }
+
+  end
+
+end

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../../../../lib/hydra/remote_identifier', __FILE__)
+module Hydra::RemoteIdentifier
+
+  describe '.register' do
+    let(:remote_service) {
+      Class.new(RemoteService) {
+        def self.valid_attribute?(*)
+          true
+        end
+        def call(payload)
+          :remote_service_response
+        end
+      }
+    }
+    let(:target_class) {
+      Class.new {
+        attr_reader :identifier
+        def title; 'a special title'; end
+        def update_identifier(value); @identifier = value; end
+      }
+    }
+    let(:target) { target_class.new }
+
+    it 'should update the registered identifier based on the registered attributes' do
+      Hydra::RemoteIdentifier.register(remote_service, target_class) do |config|
+        config.title :title
+        config.set_identifier :update_identifier
+      end
+
+      expect {
+        target_class.registered_remote_identifier_minters.each do |minter|
+          minter.call(target)
+        end
+      }.to change(target, :identifier).from(nil).to(:remote_service_response)
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: hydra-remote_identifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Handles the registration and minting of remote identifiers (i.e. DOI,
+  ARK, ORCID)
+email:
+- jeremy.n.friesen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hydra-remote_identifier.gemspec
+- lib/hydra/remote_identifier.rb
+- lib/hydra/remote_identifier/mapper.rb
+- lib/hydra/remote_identifier/minter.rb
+- lib/hydra/remote_identifier/minting_coordinator.rb
+- lib/hydra/remote_identifier/registration.rb
+- lib/hydra/remote_identifier/remote_service.rb
+- lib/hydra/remote_identifier/version.rb
+- spec/lib/hydra/remote_identifier/mapper_spec.rb
+- spec/lib/hydra/remote_identifier/minter_spec.rb
+- spec/lib/hydra/remote_identifier/minting_coordinator_spec.rb
+- spec/lib/hydra/remote_identifier/registration_spec.rb
+- spec/lib/hydra/remote_identifier/remote_service_spec.rb
+- spec/lib/hydra/remote_identifier_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jeremyf/hydra-remote_identifier
+licenses:
+- APACHE2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Handles the registration and minting of remote identifiers (i.e. DOI, ARK,
+  ORCID)
+test_files:
+- spec/lib/hydra/remote_identifier/mapper_spec.rb
+- spec/lib/hydra/remote_identifier/minter_spec.rb
+- spec/lib/hydra/remote_identifier/minting_coordinator_spec.rb
+- spec/lib/hydra/remote_identifier/registration_spec.rb
+- spec/lib/hydra/remote_identifier/remote_service_spec.rb
+- spec/lib/hydra/remote_identifier_spec.rb
+- spec/spec_helper.rb