hydra-remote_identifier 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06bf8800b2023776c3dcaf064c25de6a3e01778b
-  data.tar.gz: 4619ca2b0114d02524d7045f5ecc07cf33791255
+  metadata.gz: 87813006e82d12d459d9ac9f003a9872092492cf
+  data.tar.gz: 16fe3b7b203515ef37e87fa1a11a21d6610600ab
 SHA512:
-  metadata.gz: f7d15a5ddb6d06010753e69b532676790b699f2609ad202c054ba9736f3addf204e8cd7d4494d390b88251739e80467e467581ec56a0feec8ecd88a6599ecc85
-  data.tar.gz: 094898fa1278674a3257aae36458879ae97fa1a22a0bb1bfa1440daf6370179675236b97d1962ae6ca72df1b8c00168ad056b0142798c1955d568319bd7c135a
+  metadata.gz: 6edb49259d5997f2e0b16939fb8c1424a544c1ed80e5b521681163a30a3295c442b9d00b12cfd20ecd52fd499dde059c6ec14dc18382300ff9051853e3aaaa95
+  data.tar.gz: 36a347aae24e33b6c93e9fb0355624e580cffe81dc8f16f6850746f64eee253055548016da9f067ccf215a4ea3cbeaea0fb530ccf7230c85116f15625ea330a2

data/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# How to Contribute
+
+We want your help to make Project Hydra great.
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+## Hydra Project Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./issues) by:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
+  * Please avoid working directly on the `master` branch.
+  * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
+* Make commits of logical units.
+  * Your commit should include a high level description of your work in HISTORY.textile 
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
+### Submitting Changes
+
+[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+
+* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* Squash the commits for your branch into one commit
+  * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
+  * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" to merge your own request.
+* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  * Does the commit message explain what is going on?
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  * Did the Travis tests complete successfully?
+* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
+* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/README.md

@@ -1,6 +1,8 @@
 # Hydra::RemoteIdentifier
 
 [![Gem Version](https://badge.fury.io/rb/hydra-remote_identifier.png)](http://badge.fury.io/rb/hydra-remote_identifier)
+[![Build Status](https://travis-ci.org/jeremyf/hydra-remote_identifier.png)](https://travis-ci.org/jeremyf/hydra-remote_identifier)
+
 
 Coordinate the registration and minting of remote identifiers for persisted
 objects.
@@ -54,11 +56,16 @@ Where you enqueue an asynchronous worker iterate over the requested identifiers:
       MintRemoteIdentifierWorker.enqueue(book.to_param, remote_service.name)
     end
 
-Where your asynchronouse worker does its work request the minting:
+Where your asynchronous worker does its work request the minting:
 
     # Instantiate target from input
     Hydra::RemoteIdentifier.mint(remote_service_name, target)
 
+In your show views you can provide a link to the remote identifier via
+Hydra::RemoteIdentifier.remote_uri_for:
+
+    <%= link_to(object.doi, Hydra::RemoteIdentifier.remote_uri_for(:doi, object.doi)) %>
+
 ## Extending Hydra::RemoteIdentifier with alternate remote identifiers
 
 If you are interested in creating a new Hydra::RemoteIdentifier::RemoteService,

data/lib/hydra/remote_identifier.rb

@@ -26,8 +26,13 @@ module Hydra::RemoteIdentifier
     #     end
     #
     # @yieldparam config [Configuration]
+    # @see Hydra::RemoteIdentifier::Railtie
     def configure(&block)
       @configuration_block = block
+
+      # The Rails load sequence means that some of the configured Targets may
+      # not be loaded; As such I am not calling configure! instead relying on
+      # Hydra::RemoteIdentifier::Railtie to handle the configure! call
       configure! unless defined?(Rails)
     end
     attr_accessor :configuration
@@ -49,7 +54,7 @@ module Hydra::RemoteIdentifier
     #     <% end %>
     #
     # @param remote_service_name [#to_s]
-    # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
+    # @param target [#registered_remote_identifier_minters]
     def with_registered_remote_service(remote_service_name, target)
       return false unless target.respond_to?(:registered_remote_identifier_minters)
       # @TODO - the registered remote identifier is more than a bit off;
@@ -61,6 +66,17 @@ module Hydra::RemoteIdentifier
       }
     end
 
+    # @example
+    #    <%= link_to(object.doi, Hydra::RemoteIdentifier.remote_uri_for(:doi, object.doi)) %>
+    #
+    # @param remote_service_name [#to_s]
+    # @param identifier[#to_s] - An identifier that was created by the
+    #   RemoteService derived from the given remote_service_name
+    # @returns [URI] - The URI for that identifier
+    def remote_uri_for(remote_service_name, identifier)
+      remote_service = configuration.find_remote_service(remote_service_name)
+      remote_service.remote_uri_for(identifier)
+    end
 
     # Yields each RemoteService#name that _is_ requested for the Target.
     #
@@ -69,7 +85,7 @@ module Hydra::RemoteIdentifier
     #       Hydra::RemoteIdentifier.mint(remote_service_name, book)
     #     end
     #
-    # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
+    # @param target [#registered_remote_identifier_minters]
     # @yield_param remote_service_name [#to_s]
     def requested_remote_identifiers_for(target)
       return false unless target.respond_to?(:registered_remote_identifier_minters)
@@ -89,7 +105,7 @@ module Hydra::RemoteIdentifier
     #     Hydra::RemoteIdentifier.mint(:doi, book)
     #
     # @param remote_service_name [#to_s]
-    # @param target [#registered_remote_identifier_minters] (see Hydra::RemoteIdentifier.configure)
+    # @param target [#registered_remote_identifier_minters]
     def mint(remote_service_name, target)
       return false unless target.respond_to?(:registered_remote_identifier_minters)
 

data/lib/hydra/remote_identifier/configuration.rb

@@ -20,6 +20,10 @@ module Hydra::RemoteIdentifier
       remote_services.fetch(service_name)
     end
 
+    # @param service_name [#to_s]
+    # @param args - passed through to RemoteService initializer
+    #
+    # @yieldparam [Registration]
     def remote_service(service_name, *args)
       remote_service = remote_service_class_lookup(service_name).new(*args)
       remote_services[service_name] = remote_service

data/lib/hydra/remote_identifier/registration.rb

@@ -12,6 +12,8 @@ module Hydra::RemoteIdentifier
       @minting_coordinator = minting_coordinator
     end
 
+    # @param target_classes [Array]
+    # @yieldparam map [Map]
     def register(*target_classes, &map)
       if map.nil?
         raise RuntimeError, "You attempted to register the remote service #{remote_service} for #{target_classes} without a map"

data/lib/hydra/remote_identifier/remote_service.rb

@@ -16,15 +16,38 @@ module Hydra::RemoteIdentifier
       name.to_s
     end
 
+    # @param identifier[#to_s] - An identifier that was created by this remote
+    #   service
+    # @returns [URI] - The URI for that identifier
+    def remote_uri_for(identifier)
+      raise NotImplementedError,
+        "You must implement #{self.class}#remote_uri_for(identifier)"
+    end
+
+    # When mapping a Target to a RemoteService, this is the name of the
+    # :attr_accessor that will be created on the Target; Helpful for form
+    # construction.
+    #
+    # @returns [Symbol]
     def accessor_name
       "mint_#{name}".to_sym
     end
 
+    # @param identifier[#to_s] - The name of an attribute that is
+    #
+    # @returns [boolean] - Is this a valid attribute to send as part of the
+    #   payload for RemoteService#call
     def valid_attribute?(attribute_name)
       raise NotImplementedError,
         "You must implement #{self.class}#valid_attribute?"
     end
 
+    # @param payload[Hash] - A map with key/value pairs of valid attribute names
+    #   and corresponding values that will be used to create the remote
+    #   identifier
+    # @return - The remote identifier that was created
+    #
+    # @see RemoteService#valid_attribute?
     def call(payload)
       raise NotImplementedError,
         "You must implement #{self.class}#call"

data/lib/hydra/remote_identifier/remote_services/doi.rb

@@ -14,17 +14,16 @@ module Hydra::RemoteIdentifier
         url: "https://n2t.net/ezid/"
       }
 
-      attr_reader :uri
+      attr_reader :username, :password, :shoulder, :url
       def initialize(configuration = {})
-        username = configuration.fetch(:username)
-        password = configuration.fetch(:password)
-        shoulder = configuration.fetch(:shoulder)
-        url = configuration.fetch(:url)
-
-        # This is specific for the creation of DOIs
-        @uri = URI.parse(File.join(url, 'shoulder', shoulder))
-        @uri.user = username
-        @uri.password = password
+        @username = configuration.fetch(:username)
+        @password = configuration.fetch(:password)
+        @shoulder = configuration.fetch(:shoulder)
+        @url = configuration.fetch(:url)
+      end
+
+      def remote_uri_for(identifier)
+        URI.parse(File.join(url, identifier))
       end
 
       REQUIRED_ATTRIBUTES = ['target', 'creator', 'title', 'publisher', 'publicationyear' ].freeze
@@ -38,8 +37,15 @@ module Hydra::RemoteIdentifier
 
       private
 
+      def uri_for_create
+        uri_for_create = URI.parse(File.join(url, 'shoulder', shoulder))
+        uri_for_create.user = username
+        uri_for_create.password = password
+        uri_for_create
+      end
+
       def request(data)
-        response = RestClient.post(uri.to_s, data, content_type: 'text/plain')
+        response = RestClient.post(uri_for_create.to_s, data, content_type: 'text/plain')
         matched_data = /\Asuccess:(.*)(?<doi>doi:[^\|]*)(.*)\Z/.match(response.body)
         matched_data[:doi].strip
       end

data/lib/hydra/remote_identifier/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module RemoteIdentifier
-    VERSION = "0.4.4"
+    VERSION = "0.5.0"
   end
 end

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

@@ -15,6 +15,10 @@ module Hydra::RemoteIdentifier
       it { expect { subject.call(payload) }.to raise_error NotImplementedError }
     end
 
+    context '#remote_uri_for' do
+      it { expect { subject.remote_uri_for(double) }.to raise_error NotImplementedError }
+    end
+
     context '#valid_attribute?' do
       it { expect { subject.valid_attribute?(:attribute_name) }.to raise_error NotImplementedError }
     end

data/spec/lib/hydra/remote_identifier/remote_services/doi_spec.rb

@@ -26,6 +26,13 @@ module Hydra::RemoteIdentifier
           expect(subject.call(payload)).to eq(expected_doi)
         end
       end
+
+      context '.remote_uri_for' do
+        let(:expected_uri) { URI.parse(File.join(subject.url, expected_doi))}
+        it 'should be based on configuration' do
+          expect(subject.remote_uri_for(expected_doi)).to eq(expected_uri)
+        end
+      end
     end
   end
 end

data/spec/lib/hydra/remote_identifier_spec.rb

@@ -3,21 +3,6 @@ require File.expand_path('../../../../lib/hydra/remote_identifier', __FILE__)
 module Hydra::RemoteIdentifier
 
   describe 'public API' do
-    before(:each) do
-      Hydra::RemoteIdentifier.configure do |config|
-        config.remote_service(:doi, doi_options) do |doi|
-          doi.register(target_class) do |map|
-            map.target :url
-            map.creator :creator
-            map.title :title
-            map.publisher :publisher
-            map.publicationyear :publicationyear
-            map.set_identifier(:set_identifier=)
-          end
-        end
-      end
-    end
-
     let(:target_class) {
       Class.new {
         def url; 'http://google.com'; end
@@ -30,23 +15,27 @@ module Hydra::RemoteIdentifier
     }
 
     let(:target) { target_class.new }
-
     let(:expected_doi) {
-      # From the doi-create cassette
-      'doi:10.5072/FK2FT8XZZ'
-    }
-
-    let(:doi_options) {
-      {
-        username: 'apitest',
-        password: 'apitest',
-        shoulder: 'doi:10.5072/FK2',
-        url: "https://n2t.net/ezid/"
-      }
+      'doi:10.5072/FK2FT8XZZ' # From the doi-create cassette
     }
+    let(:doi_options) { RemoteServices::Doi::TEST_CONFIGURATION }
 
-    describe '.with_remote_service' do
+    before(:each) do
+      Hydra::RemoteIdentifier.configure do |config|
+        config.remote_service(:doi, doi_options) do |doi|
+          doi.register(target_class) do |map|
+            map.target :url
+            map.creator :creator
+            map.title :title
+            map.publisher :publisher
+            map.publicationyear :publicationyear
+            map.set_identifier(:set_identifier=)
+          end
+        end
+      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)
@@ -65,25 +54,16 @@ module Hydra::RemoteIdentifier
           Hydra::RemoteIdentifier.with_registered_remote_service(:doi, target, &block)
         }.to_not yield_control
       end
-
     end
 
-    describe '.mint' do
-
-      it 'works!', VCR::SpecSupport(record: :new_episodes, cassette_name: 'doi-integration') do
-        expect {
-          Hydra::RemoteIdentifier.mint(:doi, target)
-        }.to change(target, :set_identifier).from(nil).to(expected_doi)
-      end
-
-      it 'returns false if the target is not configured for identifiers' do
-        expect(Hydra::RemoteIdentifier.mint(:doi, double)).to eq(false)
-      end
-
+    context '.remote_uri_for' do
+      it {
+        expect(Hydra::RemoteIdentifier.remote_uri_for(:doi, expected_doi)).
+        to eq(URI.parse(File.join(doi_options.fetch(:url), expected_doi)))
+      }
     end
 
-    describe '.requested_remote_identifiers_for' do
-
+    context '.requested_remote_identifiers_for' do
       it 'should yield when the remote identifier was requested' do
         target.mint_doi = '1'
         expect { |block|
@@ -104,9 +84,20 @@ module Hydra::RemoteIdentifier
           Hydra::RemoteIdentifier.requested_remote_identifiers_for(target, &block)
         }.to_not yield_control
       end
+    end
+
+    context '.mint' do
+      it 'works!', VCR::SpecSupport(record: :new_episodes, cassette_name: 'doi-integration') do
+        expect {
+          Hydra::RemoteIdentifier.mint(:doi, target)
+        }.to change(target, :set_identifier).from(nil).to(expected_doi)
+      end
 
+      it 'returns false if the target is not configured for identifiers' do
+        expect(Hydra::RemoteIdentifier.mint(:doi, double)).to eq(false)
+      end
     end
 
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-remote_identifier
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -97,6 +97,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE