orcid 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdbf8eaf74801c8b3c9d2325d362d14e7f7e3c8b
-  data.tar.gz: dc2b890ba3958416489f364983885bf6a08a0f85
+  metadata.gz: e325b389824d646a737db51751aea1ffe7bc2869
+  data.tar.gz: 336b4bd518961b2f784f948f47bf70afcd252baa
 SHA512:
-  metadata.gz: 18825277ac23c713d06fad1ead3df6565bf1273fcb77cb53e01839cd7a5e443c7fad3f17cc4eefa1c70a73d4a69d7a03e5c1b5999d187a421a40c2ed0f8fd7ed
-  data.tar.gz: 3737282f7a406c4ca10cae3f2d51b315d512278c834680c20c57821f140864d2e0188a888a6a89eb0ff1a6f3f5df9ec0cf93cb9354d493121f19683062a6aa3e
+  metadata.gz: f7f07ca24430ed0063f5cfb9bb4dc615263f5c401fc2a406f246f996444f737e31a9ac17960ec11a603be0a9322cb8ec33b873f67f9d1215d3461d123eebffc1
+  data.tar.gz: e22ac42cc8be96e67a0e720b6388c54ceb9d79c8e9dbe4ac24b1dac17773383f7d057a681ff598475179654694e3169a0a1119ddbebd9aaf119177d6c879c6a0

data/.hound.yml

@@ -396,6 +396,16 @@ ParenthesesAroundCondition:
 
 PercentLiteralDelimiters:
   Description: 'Use `%`-literal delimiters consistently'
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
   Enabled: true
 
 PerlBackrefs:

data/.mailmap

@@ -0,0 +1,3 @@
+Dan Brubaker Horst <dan@brubakerhorst.com> <dan.brubaker.horst@gmail.com>
+Glen Horton <hortongn@ucmail.uc.edu> <glen.horton@gmail.com>
+Carolyn Cole <cam156@psu.edu> cam156

data/.travis.yml

@@ -6,7 +6,7 @@ env:
   global:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 
-script: 'rake spec:travis'
+script: 'COVERAGE=true rake spec:travis'
 
 bundler_args: --without headless debug
 

data/Gemfile

@@ -12,3 +12,4 @@ gemspec
 
 # To use debugger
 # gem 'debugger'
+gem 'coveralls', require: false

data/README.md

@@ -1,6 +1,38 @@
-# Orcid [![Version](https://badge.fury.io/rb/orcid.png)](http://badge.fury.io/rb/orcid) [![Build Status](https://travis-ci.org/projecthydra-labs/orcid.png?branch=master)](https://travis-ci.org/projecthydra-labs/orcid)
+# Orcid
 
-A [Rails Engine](https://guides.rubyonrails.org/engines.html) for integrating with [Orcid](https://orcid.org).
+[![Version](https://badge.fury.io/rb/orcid.png)](http://badge.fury.io/rb/orcid)
+[![Build Status](https://travis-ci.org/projecthydra-labs/orcid.png?branch=master)](https://travis-ci.org/projecthydra-labs/orcid)
+[![Coverage Status](https://img.shields.io/coveralls/projecthydra-labs/orcid.svg)](https://coveralls.io/r/projecthydra-labs/orcid)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/orcid/0.8.0/frames)
+[![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+[![Contributing Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+
+A [Rails Engine](https://guides.rubyonrails.org/engines.html) for integrating with [Orcid](https://orcid.org). It leverages the [Devise MultiAuth plugin](https://rubygems.org/gems/devise-multi_auth) for negotiating the interaction with [orcid.org](https://orcid.org).
+
+**Note: While this is part of ProjectHydra, this gem is not dependent on any of the Hydra components.**
+
+## Features
+
+Associate ORCID with your user account for the application by:
+
+* Creating an ORCID
+* Looking up and associating with an existing ORCID
+* Providing an ORCID to directly associate with your account
+
+Authentication
+
+* Using OAuth2, you can use orcid.org as one of your authentication mechanisms
+
+Interacting with ORCID Profile Works:
+
+**The functionality exists, but it will be a bit bumpy to implement.**
+**Plans are to improve the integration with Version 1.0.0 of the Orcid gem.**
+
+* Query for your Orcid Profile's works
+* Append one or more works to your Orcid Profile
+* Replace your Orcid Profile works with one or more works
+
+## Getting Started with the Orcid gem
 
 To fully interact with the Orcid remote services, you will need to [register your ORCID application profile](#registering-for-an-orcid-application-profile).
 
@@ -9,6 +41,7 @@ To fully interact with the Orcid remote services, you will need to [register you
 * [Registering for an ORCID application profile](#registering-for-an-orcid-application-profile)
 * [Setting up your own ORCIDs in the ORCID Development Sandbox](#setting-up-your-own-orcids-in-the-orcid-development-sandbox)
 * [Running the tests](#running-the-tests)
+* [Versioning](#versioning)
 * [Contributing to this gem](./CONTRIBUTING.md)
 
 ## Installation
@@ -121,3 +154,7 @@ Run the online tests with
 ```console
 $ rake spec:online
 ```
+
+## Versioning
+
+**Orcid** uses [Semantic Versioning 2.0.0](http://semver.org/)

data/app/controllers/orcid/profile_connections_controller.rb

@@ -1,5 +1,9 @@
 module Orcid
   # Responsible for negotiating a user request Profile Creation.
+  #
+  # @TODO - Leverage the Orcid::ProfileStatus object instead of the really
+  # chatty method names. The method names are fine, but the knowledge of
+  # Orcid::ProfileStatus is encapsulated in that class.
   class ProfileConnectionsController < Orcid::ApplicationController
     respond_to :html
     before_filter :authenticate_user!

data/app/controllers/orcid/profile_requests_controller.rb

@@ -1,5 +1,9 @@
 module Orcid
   # Responsible for helping a user request a new Orcid Profile.
+  #
+  # @TODO - Leverage the Orcid::ProfileStatus object instead of the really
+  # chatty method names. The method names are fine, but the knowledge of
+  # Orcid::ProfileStatus is encapsulated in that class.
   class ProfileRequestsController < Orcid::ApplicationController
     respond_to :html
     before_filter :authenticate_user!
@@ -67,7 +71,7 @@ module Orcid
     end
 
     def create_profile_request(profile_request)
-      profile_request.save && Orcid.enqueue(profile_request)
+      profile_request.save && Orcid::ProfileRequestCoordinator.call(profile_request)
     end
 
     def profile_request_params

data/app/models/orcid/profile.rb

@@ -2,22 +2,21 @@ module Orcid
   # Provides a container around an Orcid Profile and its relation to the Orcid
   # Works.
   class Profile
-    attr_reader(
-      :orcid_profile_id, :mapper, :remote_service, :xml_renderer, :xml_parser
-    )
-    private :mapper
-    def initialize(orcid_profile_id, config = {})
+    attr_reader :orcid_profile_id, :mapper, :remote_service, :xml_renderer, :xml_parser
+    private :mapper, :remote_service, :xml_renderer, :xml_parser
+    def initialize(orcid_profile_id, collaborators = {})
       @orcid_profile_id = orcid_profile_id
-      @mapper = config.fetch(:mapper) { Orcid.mapper }
-      @remote_service = config.fetch(:remote_service) do
-        Orcid::Remote::WorkService
-      end
-      @xml_renderer = config.fetch(:xml_renderer) { Orcid::Work::XmlRenderer }
-      @xml_parser = config.fetch(:xml_parser) { Orcid::Work::XmlParser }
+      @mapper = collaborators.fetch(:mapper) { default_mapper }
+      @remote_service = collaborators.fetch(:remote_service) { default_remote_service }
+      @xml_renderer = collaborators.fetch(:xml_renderer) { default_xml_renderer }
+      @xml_parser = collaborators.fetch(:xml_parser) { default_xml_parser }
     end
 
     # Answers the question: Has the user been authenticated via the ORCID
     # system.
+    #
+    # @TODO - Extract this to the Orcid::ProfileStatus object. As the method
+    # is referenced via a controller, this can easily be moved.
     def verified_authentication?
       Orcid.authenticated_orcid?(orcid_profile_id)
     end
@@ -44,6 +43,22 @@ module Orcid
 
     protected
 
+    def default_mapper
+      Orcid.mapper
+    end
+
+    def default_remote_service
+      Orcid::Remote::WorkService
+    end
+
+    def default_xml_renderer
+      Orcid::Work::XmlRenderer
+    end
+
+    def default_xml_parser
+      Orcid::Work::XmlParser
+    end
+
     # Note: We can handle
     def normalize_work(*works)
       Array.wrap(works).map do |work|

data/app/models/orcid/profile_connection.rb

@@ -1,3 +1,5 @@
+require 'virtus'
+require 'active_model'
 module Orcid
   # Responsible for connecting an authenticated user to the ORCID profile that
   # the user searched for and selected.
@@ -21,10 +23,7 @@ module Orcid
     validates :user, presence: true
     validates :orcid_profile_id, presence: true
 
-    def save(collaborators = {})
-      persister = collaborators.fetch(:persister) do
-        Orcid.method(:connect_user_and_orcid_profile)
-      end
+    def save
       valid? ? persister.call(user, orcid_profile_id) : false
     end
 
@@ -32,6 +31,17 @@ module Orcid
       false
     end
 
+    attr_writer :persister
+    def persister
+      @persister ||= default_persister
+    end
+    private :persister
+
+    def default_persister
+      require 'orcid'
+      Orcid.method(:connect_user_and_orcid_profile)
+    end
+
     attr_writer :profile_query_service
     def profile_query_service
       @profile_query_service ||= default_profile_query_service

data/app/models/orcid/profile_request.rb

@@ -18,90 +18,16 @@ module Orcid
 
     belongs_to :user
 
-    def run(options = {})
-      # Why dependency injection? Because this is going to be a plugin, and
-      # things can't possibly be simple. I also found it easier to test the
-      # #run method with these injected dependencies
-      validator = options.fetch(:validator) { method(:validate_before_run) }
-      return false unless validator.call(self)
-
-      payload_xml_builder = options.fetch(:payload_xml_builder) do
-        method(:xml_payload)
-      end
-      profile_creation_service = options.fetch(:profile_creation_service) do
-        default_profile_creation_service
-      end
-      profile_creation_service.call(payload_xml_builder.call(attributes))
-    end
-
-    def default_profile_creation_service
-      @default_profile_creation_service ||= begin
-        Orcid::Remote::ProfileCreationService.new do |on|
-          on.success do |orcid_profile_id|
-            handle_profile_creation_response(orcid_profile_id)
-          end
-        end
-      end
-    end
-
-    def validate_before_run(context = self)
-      validate_profile_id_is_unassigned(context) &&
-        validate_user_does_not_have_profile(context)
-    end
-
-    def validate_user_does_not_have_profile(context)
-      user_orcid_profile = Orcid.profile_for(context.user)
-      return true unless user_orcid_profile
-      message = "#{context.class} ID=#{context.to_param}'s associated user" \
-       " #{context.user.to_param} already has an assigned :orcid_profile_id" \
-       " #{user_orcid_profile.to_param}"
-      context.errors.add(:base, message)
-      false
-    end
-    private :validate_user_does_not_have_profile
-
-    def validate_profile_id_is_unassigned(context)
-      return true unless context.orcid_profile_id?
-      message = "#{context.class} ID=#{context.to_param} already has an" \
-        " assigned :orcid_profile_id #{context.orcid_profile_id.inspect}"
-      context.errors.add(:base, message)
-      false
-    end
-    private :validate_profile_id_is_unassigned
-
-    # NOTE: This one lies ->
-    #   http://support.orcid.org/knowledgebase/articles/177522-create-an-id-technical-developer
-    # NOTE: This one was true at 2014-02-06:14:55 ->
-    #   http://support.orcid.org/knowledgebase/articles/162412-tutorial-create-a-new-record-using-curl
-    def xml_payload(input = attributes)
-      attrs = input.with_indifferent_access
-      returning_value = <<-XML_TEMPLATE
-      <?xml version="1.0" encoding="UTF-8"?>
-      <orcid-message
-      xmlns:xsi="http://www.orcid.org/ns/orcid https://raw.github.com/ORCID/ORCID-Source/master/orcid-model/src/main/resources/orcid-message-1.1.xsd"
-      xmlns="http://www.orcid.org/ns/orcid">
-      <message-version>1.1</message-version>
-      <orcid-profile>
-      <orcid-bio>
-      <personal-details>
-      <given-names>#{attrs.fetch('given_names')}</given-names>
-      <family-name>#{attrs.fetch('family_name')}</family-name>
-      </personal-details>
-      <contact-details>
-      <email primary="true">#{attrs.fetch('primary_email')}</email>
-      </contact-details>
-      </orcid-bio>
-      </orcid-profile>
-      </orcid-message>
-      XML_TEMPLATE
-      returning_value.strip
-    end
-
-    def handle_profile_creation_response(orcid_profile_id)
+    def successful_profile_creation(orcid_profile_id)
       self.class.transaction do
         update_column(:orcid_profile_id, orcid_profile_id)
         Orcid.connect_user_and_orcid_profile(user, orcid_profile_id)
       end
     end
+
+    def validation_error_on_profile_creation(error_message)
+      update_column(:response_text, error_message)
+    end
+
   end
 end

data/app/models/orcid/profile_status.rb

@@ -1,4 +1,11 @@
 module Orcid
+  # Responsible for determining a given user's orcid profile state as it
+  # pertains to the parent application.
+  #
+  # @TODO - There are quite a few locations where the state related behavior
+  # has leaked out (i.e. the Orcid::ProfileConnectionsController and Orcid::
+  # ProfileRequestsController)
+  #
   # ProfileStatus.status
   # **:authenticated_connection** - User has authenticated against the Orcid
   #   remote system
@@ -39,7 +46,6 @@ module Orcid
           return callback(:unknown)
         end
       end
-      return callback(:unknown)
     end
 
     private

data/app/models/orcid/work/xml_renderer.rb

@@ -9,10 +9,7 @@ module Orcid
       attr_reader :works, :template
       def initialize(works, options = {})
         self.works = works
-        @template = options.fetch(:template_path) do
-          template_name = 'app/templates/orcid/work.template.v1.1.xml.erb'
-          Orcid::Engine.root.join(template_name).read
-        end
+        @template = options.fetch(:template) { default_template }
       end
 
       def call
@@ -24,6 +21,11 @@ module Orcid
       def works=(thing)
         @works = Array.wrap(thing)
       end
+
+      def default_template
+        template_name = 'app/templates/orcid/work.template.v1.1.xml.erb'
+        Orcid::Engine.root.join(template_name).read
+      end
     end
   end
 end

data/app/services/orcid/profile_request_coordinator.rb

@@ -0,0 +1,112 @@
+require 'orcid/exceptions'
+
+module Orcid
+  # Responsible for converting an Orcid::ProfileRequest into an Orcid::Profile.
+  class ProfileRequestCoordinator
+
+    def self.call(profile_request, collaborators = {})
+      new(profile_request, collaborators).call
+    end
+
+    def initialize(profile_request, collaborators = {})
+      self.profile_request = profile_request
+      @remote_service = collaborators.fetch(:remote_service) { default_remote_service }
+      @profile_state_finder = collaborators.fetch(:profile_state_finder) { default_profile_state_finder }
+      @logger = collaborators.fetch(:logger) { default_logger }
+    end
+
+    attr_reader :profile_request, :remote_service, :profile_state_finder, :logger
+    private :remote_service, :profile_state_finder, :logger
+
+    def call
+      profile_state_finder.call(user) do |on|
+        on.unknown { handle_unknown_profile_state }
+        on.profile_request_pending { |request| handle_profile_request }
+        on.pending_connection { |profile| handle_pending_connection_for(profile) }
+        on.authenticated_connection { |profile| handle_authenticated_connection_for(profile) }
+      end
+      true
+    end
+
+    private
+
+    def handle_profile_request
+      payload = xml_payload(profile_request)
+      remote_service.call(payload) do |on|
+        on.success { |orcid_profile_id| profile_request.successful_profile_creation(orcid_profile_id) }
+        on.failure { }
+        on.orcid_validation_error { |error_message| profile_request.validation_error_on_profile_creation(error_message) }
+      end
+    end
+
+    protected
+
+    def profile_request=(request)
+      if !request.respond_to?(:user) || !request.user.present?
+        fail MissingUserForProfileRequest, request
+      end
+      if !request.respond_to?(:validation_error_on_profile_creation)
+        raise ProfileRequestMethodExpectedError.new(request, :validation_error_on_profile_creation)
+      end
+      if !request.respond_to?(:successful_profile_creation)
+        raise ProfileRequestMethodExpectedError.new(request, :successful_profile_creation)
+      end
+      @profile_request = request
+    end
+
+    def user
+      profile_request.user
+    end
+
+    private
+
+    def default_logger
+      Rails.logger
+    end
+
+    def default_remote_service
+      require 'orcid/remote/profile_creation_service'
+      Orcid::Remote::ProfileCreationService
+    end
+
+    def default_profile_state_finder
+      require 'orcid/profile_status'
+      Orcid::ProfileStatus.method(:for)
+    end
+
+    def handle_unknown_profile_state
+      require 'orcid/exceptions'
+      fail Orcid::ProfileRequestStateError, user
+    end
+
+    def handle_pending_connection_for(profile)
+      message = "Attempted to request ORCID for #{profile_request.class} ID=#{profile_request.to_param}."
+      message << " There is a pending connection for #{user.class} ID=#{user.to_param}."
+      logger.notice(message)
+    end
+
+    def handle_authenticated_connection_for(profile)
+      message = "Attempted to request ORCID for #{profile_request.class} ID=#{profile_request.to_param}."
+      message << " There is an authenticated connection for  #{user.class} ID=#{user.to_param}."
+      logger.notice(message)
+    end
+
+    def xml_payload(request)
+      attrs = request.attributes.with_indifferent_access
+      returning_value = <<-XML_TEMPLATE
+      <?xml version="1.0" encoding="UTF-8"?>
+      <orcid-message
+      xmlns:xsi="http://www.orcid.org/ns/orcid https://raw.github.com/ORCID/ORCID-Source/master/orcid-model/src/main/resources/orcid-message-1.1.xsd"
+      xmlns="http://www.orcid.org/ns/orcid">
+      <message-version>1.1</message-version>
+      <orcid-profile>\n<orcid-bio>\n<personal-details>
+      <given-names>#{attrs.fetch('given_names')}</given-names>
+      <family-name>#{attrs.fetch('family_name')}</family-name>
+      </personal-details>\n<contact-details>
+      <email primary="true">#{attrs.fetch('primary_email')}</email>
+      </contact-details>\n</orcid-bio>\n</orcid-profile>\n</orcid-message>
+      XML_TEMPLATE
+      returning_value.strip
+    end
+  end
+end