hydra-remote_identifier 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+
+script: "rspec"
+
+notifications:
+  irc: "irc.freenode.org#ndlib"
+
+before_install:
+  - gem install bundler

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hydra-remote_identifier.gemspec
 gemspec
+
+group :test do
+  gem 'guard-rspec'
+  gem 'ruby_gntp'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,6 +1,7 @@
 # Hydra::RemoteIdentifier
 
-TODO: Write a gem description
+Coordinate the registration and minting of remote identifiers for persisted
+objects.
 
 ## Installation
 
@@ -18,12 +19,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your `./config/initializers` add a file that registers remote identification
+services for a list of models.
 
-## 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
+    Hydra::RemoteIdentifier.register(:doi, Book) do |map|
+      map.what  {|book| book.title + ": " book.subtitle }
+      map.who   :author_name
+      map.set_identifier {|book, value| book.set_doi!(value)}
+    end

data/hydra-remote_identifier.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
 end

data/lib/hydra/remote_identifier.rb

@@ -1,11 +1,52 @@
 require "hydra/remote_identifier/version"
 require 'hydra/remote_identifier/registration'
+require 'hydra/remote_identifier/remote_service'
+require 'hydra/remote_identifier/remote_services'
 
 module Hydra::RemoteIdentifier
 
-  def register(remote_service, target_class, &block)
-    Registration.new(remote_service, target_class, &block)
+  class << self
+
+    # For the given :remote_service_name and :target_classes register the Map
+    # to use for minting a remote identifier for instances of the
+    # :target_classes
+    #
+    # @example
+    #     Hydra::RemoteIdentifier.register(:doi, Book) do |map|
+    #       map.what  {|book| book.title + ": " book.subtitle }
+    #       map.who   :author_name
+    #       map.set_identifier {|book, value| book.set_doi!(value)}
+    #     end
+    #
+    # @param remote_service_name [#to_s] the name of a remote service we will
+    #   use to mint the corresponding remote identifier
+    # @param target_classes [Array<Class>] a collection of classes who's
+    #   instances to which we will assign a remote identifier
+    # @yieldparam map [Map] defines what attributes are required by the
+    #   :remote_service as well as what the callback for what the
+    #   :remote_resource should do (see Mapper::Wrapper)
+    def register(remote_service_name, *target_classes, &map)
+      Array(target_classes).flatten.compact.each do |target_class|
+        Registration.new(remote_service(remote_service_name), target_class, &map)
+      end
+    end
+
+
+    # Given a string retrieve an instance of the corresponding RemoteService.
+    # @param string [#to_s]
+    # @return [RemoteService]
+    def remote_service(string)
+      namespace_for_lookup = RemoteServices
+      remote_service_class_name = string.to_s.gsub(/(?:^|_)([a-z])/) { $1.upcase }
+      if namespace_for_lookup.const_defined?(remote_service_class_name)
+        namespace_for_lookup.const_get(remote_service_class_name).new
+      else
+        raise NotImplementedError.new(
+          "Unable to find #{self} remote_service '#{string}'. Consider creating #{namespace_for_lookup}::#{remote_service_class_name}"
+        )
+      end
+    end
+
   end
-  module_function :register
 
 end

data/lib/hydra/remote_identifier/minting_coordinator.rb

@@ -1,18 +1,21 @@
+require File.expand_path('../mapper', __FILE__)
+require File.expand_path('../minter', __FILE__)
+
 module Hydra::RemoteIdentifier
 
   # The Minting
   class MintingCoordinator
-    attr_reader :service_class, :mapper
-    def initialize(service_class, mapper_builder = Mapper, &map_config)
-      @service_class = service_class
-      @mapper = mapper_builder.new(service_class, &map_config)
+    attr_reader :remote_service, :mapper
+    def initialize(remote_service, mapper_builder = Mapper, &map_config)
+      @remote_service = remote_service
+      @mapper = mapper_builder.new(remote_service, &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))
+      minter.call(remote_service, wrap(target))
     end
 
     private

data/lib/hydra/remote_identifier/registration.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/class/attribute'
+require File.expand_path('../minting_coordinator', __FILE__)
 
 module Hydra::RemoteIdentifier
 

data/lib/hydra/remote_identifier/remote_service.rb

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

data/lib/hydra/remote_identifier/remote_services.rb

@@ -0,0 +1,5 @@
+module Hydra::RemoteIdentifier
+  module RemoteServices
+    # For namespace
+  end
+end

data/lib/hydra/remote_identifier/version.rb

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

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

@@ -2,14 +2,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(:remote_service) { Class.new { def self.valid_attribute?(*); true; end } }
     let(:mapper_builder) { double(new: double(call: :wrapped_target)) }
     let(:target) { double }
     let(:map) { lambda {|*|} }
-    subject { MintingCoordinator.new(service_class, mapper_builder, &map) }
+    subject { MintingCoordinator.new(remote_service, mapper_builder, &map) }
     it 'forward delegates call to the minter' do
       minter = double
-      minter.should_receive(:call).with(kind_of(service_class), :wrapped_target)
+      minter.should_receive(:call).with(remote_service, :wrapped_target)
       subject.call(target, minter)
     end
   end

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

@@ -3,24 +3,23 @@ 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)
+      expect { Registration.new(:my_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)
+        Registration.new(:my_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)
+      Registration.new(:my_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)
+      Registration.new(:my_remote_service, target_class, minting_coordinator, &map)
     end
   end
 end

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

@@ -7,6 +7,7 @@ module Hydra::RemoteIdentifier
     subject { RemoteService.new }
 
     it { expect { subject.call(payload) }.to raise_error NotImplementedError }
+    it { expect { subject.valid_attribute?(:attribute_name) }.to raise_error NotImplementedError }
 
   end
 

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -1,39 +1,63 @@
 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
+  describe 'with custom remote service' do
+    around do |example|
+      module RemoteServices
+        class MyRemoteService < ::Hydra::RemoteIdentifier::RemoteService
+          def valid_attribute?(*)
+            true
+          end
+          def call(payload)
+            :remote_service_response
+          end
         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
+      end
+      example.run
+      RemoteServices.send(:remove_const, :MyRemoteService)
+    end
+
+    describe '.register' do
+
+      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 }
+      let(:target) { target_class.new }
+
+      it 'should update the registered identifier based on the registered attributes' do
+        Hydra::RemoteIdentifier.register(:my_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)
 
-    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
+    end
 
-      expect {
-        target_class.registered_remote_identifier_minters.each do |minter|
-          minter.call(target)
+    describe '.remote_service' do
+      context 'with valid remote service' do
+        subject { Hydra::RemoteIdentifier.remote_service(:my_remote_service) }
+        it 'should return an instance of that service' do
+          expect(subject).to be_instance_of RemoteServices::MyRemoteService
         end
-      }.to change(target, :identifier).from(nil).to(:remote_service_response)
-
+      end
+      context 'with invalid remote service' do
+        subject { Hydra::RemoteIdentifier.remote_service(:undefined_service) }
+        it 'should raise a NotImplementedError' do
+          expect { subject }.to raise_error NotImplementedError
+        end
+      end
     end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+GEM_ROOT = File.expand_path("../../", __FILE__)
+$:.unshift File.join(GEM_ROOT, "lib")
+
 # 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

metadata

@@ -1,20 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
+  prerelease: 
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.13
     - - <
@@ -23,8 +25,9 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.13
     - - <
@@ -33,6 +36,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -40,6 +44,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -47,29 +52,65 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Handles the registration and minting of remote identifiers (i.e. DOI,
@@ -82,7 +123,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -94,6 +137,7 @@ files:
 - lib/hydra/remote_identifier/minting_coordinator.rb
 - lib/hydra/remote_identifier/registration.rb
 - lib/hydra/remote_identifier/remote_service.rb
+- lib/hydra/remote_identifier/remote_services.rb
 - lib/hydra/remote_identifier/version.rb
 - spec/lib/hydra/remote_identifier/mapper_spec.rb
 - spec/lib/hydra/remote_identifier/minter_spec.rb
@@ -105,26 +149,33 @@ files:
 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
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1218886598798334275
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1218886598798334275
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Handles the registration and minting of remote identifiers (i.e. DOI, ARK,
   ORCID)
 test_files:
@@ -135,3 +186,4 @@ test_files:
 - spec/lib/hydra/remote_identifier/remote_service_spec.rb
 - spec/lib/hydra/remote_identifier_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: c212f0c8fbb12faf3510a14674d470e79475cc28
-  data.tar.gz: 28b81cd39c16f2c191c79ce226bfc7f333718c82
-SHA512:
-  metadata.gz: ef7b1d1f3f40c22b6169a456814ae2dce2925a1f66fba6fb51a7ae0ad92891a8ad3cb212db376312420ea9209b34663210a6f224d2041d1a07df2cd8e944b4c0
-  data.tar.gz: 38c365ad04bea7a1452900aea09090441bb309757254b5024a223533302ce473766911be6d41e15e7ec07a012768f4095ed4dcdc496172618c1abc1c7b925490