orcid 0.0.4 → 0.1.0

data/app/models/orcid/profile_request.rb

@@ -4,7 +4,6 @@ module Orcid
   # * submitting a request for an ORCID Profile
   # * handling the response for the ORCID Profile creation
   class ProfileRequest < ActiveRecord::Base
-
     def self.find_by_user(user)
       where(user: user).first
     end
@@ -20,39 +19,60 @@ 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.
+      # 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) { method(:xml_payload) }
-      profile_creation_service = options.fetch(:profile_creation_service) { default_profile_creation_service }
+      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 ||= Orcid::Remote::ProfileCreationService.new do |on|
-        on.success {|orcid_profile_id| handle_profile_creation_response(orcid_profile_id) }
+      @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
 
-      if context.orcid_profile_id?
-        context.errors.add(:base, "#{context.class} ID=#{context.to_param} already has an assigned :orcid_profile_id #{context.orcid_profile_id.inspect}")
-        return false
-      end
-
-      if user_orcid_profile = Orcid.profile_for(context.user)
-        context.errors.add(:base, "#{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}")
-        return false
-      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
 
-      true
+    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
+    # 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
@@ -83,6 +103,5 @@ module Orcid
         Orcid.connect_user_and_orcid_profile(user, orcid_profile_id)
       end
     end
-
   end
 end

data/app/models/orcid/work.rb

@@ -2,9 +2,28 @@ module Orcid
   # A well-defined data structure that coordinates with its :template in order
   # to generate XML that can be POSTed/PUT as an Orcid Work.
   class Work
-    VALID_WORK_TYPES = [
-      "artistic-performance","book-chapter","book-review","book","conference-abstract","conference-paper","conference-poster","data-set","dictionary-entry","disclosure","dissertation","edited-book","encyclopedia-entry","invention","journal-article","journal-issue","lecture-speech","license","magazine-article","manual","newsletter-article","newspaper-article","online-resource","other","patent","registered-copyright","report","research-technique","research-tool","spin-off-company","standards-and-policy","supervised-student-publication","technical-standard","test","translation","trademark","website","working-paper",
-    ].freeze
+    VALID_WORK_TYPES =
+    %w(artistic-performance book-chapter book-review book
+       conference-abstract conference-paper conference-poster
+       data-set dictionary-entry disclosure dissertation
+       edited-book encyclopedia-entry invention journal-article
+       journal-issue lecture-speech license magazine-article
+       manual newsletter-article newspaper-article online-resource
+       other patent registered-copyright report research-technique
+       research-tool spin-off-company standards-and-policy
+       supervised-student-publication technical-standard test
+       translation trademark website working-paper
+       ).freeze
+
+    # An Orcid Work's external identifier is not represented in a single
+    # attribute.
+    class ExternalIdentifier
+      include Virtus.value_object
+      values do
+        attribute :type,  String
+        attribute :identifier, String
+      end
+    end
 
     include Virtus.model
     include ActiveModel::Validations
@@ -16,16 +35,36 @@ module Orcid
     attribute :work_type, String
     validates :work_type, presence: true, inclusion: { in: VALID_WORK_TYPES }
 
+    attribute :subtitle, String
+    attribute :journal_title, String
+    attribute :short_description, String
+    attribute :citation_type, String
+    attribute :citation, String
+    attribute :publication_year, Integer
+    attribute :publication_month, Integer
+    attribute :url, String
+    attribute :language_code, String
+    attribute :country, String
     attribute :put_code, String
+    attribute :external_identifiers, Array[ExternalIdentifier]
+
+    def work_citation?
+      citation_type.present? || citation.present?
+    end
+
+    def publication_date?
+      publication_year.present? || publication_month.present?
+    end
 
     def to_xml
       XmlRenderer.call(self)
     end
 
-    def ==(comparison_object)
-      super || comparison_object.instance_of?(self.class) &&
+    def ==(other)
+      super ||
+        other.instance_of?(self.class) &&
         id.present? &&
-        comparison_object.id == id
+        other.id == id
     end
 
     def id
@@ -37,54 +76,5 @@ module Orcid
         nil
       end
     end
-
-    class XmlRenderer
-      def self.call(works, options = {})
-        new(works, options).call
-      end
-
-      attr_reader :works, :template
-      def initialize(works, options = {})
-        self.works = works
-        @template = options.fetch(:template_path) { Orcid::Engine.root.join('app/templates/orcid/work.template.v1.1.xml.erb').read }
-      end
-
-      def call
-        ERB.new(template).result(binding)
-      end
-
-      protected
-      def works=(thing)
-        @works = Array(thing)
-      end
-
-    end
-
-    class XmlParser
-      def self.call(xml)
-        new(xml).call
-      end
-
-      attr_reader :xml
-      def initialize(xml)
-        @xml = xml
-      end
-
-      def call
-        document = Nokogiri::XML.parse(xml)
-        document.css('orcid-works orcid-work').collect do |node|
-          transform(node)
-        end
-      end
-
-      private
-      def transform(node)
-        Orcid::Work.new.tap do |work|
-          work.put_code = node.attributes.fetch("put-code").value
-          work.title = node.css('work-title title').text
-          work.work_type = node.css('work-type').text
-        end
-      end
-    end
   end
 end

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

@@ -0,0 +1,45 @@
+module Orcid
+  class Work
+    # Responsible for taking an Orcid Work and extracting the value/text from
+    # the document and reifying an Orcid::Work object.
+    class XmlParser
+      def self.call(xml)
+        new(xml).call
+      end
+
+      attr_reader :xml
+      def initialize(xml)
+        @xml = xml
+      end
+
+      def call
+        document.css('orcid-works orcid-work').map do |node|
+          transform(node)
+        end
+      end
+
+      private
+
+      def document
+        @document ||= Nokogiri::XML.parse(xml)
+      end
+
+      def transform(node)
+        Work.new.tap do |work|
+          work.put_code = node.attributes.fetch('put-code').value
+          work.title = node.css('work-title title').text
+          work.work_type = node.css('work-type').text
+          work.journal_title = node.css('journal-title').text
+          work.short_description = node.css('short-description').text
+          work.citation_type = node.css('work-citation work-citation-type').text
+          work.citation = node.css('work-citation citation').text
+          work.publication_year = node.css('publication-date year').text
+          work.publication_month = node.css('publication-date month').text
+          work.url = node.css('url').text
+          work.language_code = node.css('language_code').text
+          work.country = node.css('country').text
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Orcid
+  class Work
+    # Responsible for transforming a Work into an Orcid Work XML document
+    class XmlRenderer
+      def self.call(works, options = {})
+        new(works, options).call
+      end
+
+      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
+      end
+
+      def call
+        ERB.new(template).result(binding)
+      end
+
+      protected
+
+      def works=(thing)
+        @works = Array.wrap(thing)
+      end
+    end
+  end
+end

data/app/services/orcid/remote/profile_creation_service.rb

@@ -1,43 +1,51 @@
 require 'orcid/remote/service'
-module Orcid::Remote
-  # Responsible for minting a new ORCID for the given payload.
-  class ProfileCreationService < Orcid::Remote::Service
+module Orcid
+  module Remote
+    # Responsible for minting a new ORCID for the given payload.
+    class ProfileCreationService < Orcid::Remote::Service
+      def self.call(payload, config = {}, &callback_config)
+        new(config, &callback_config).call(payload)
+      end
 
-    def self.call(payload, config = {}, &callback_config)
-      new(config, &callback_config).call(payload)
-    end
+      attr_reader :token, :path, :headers
+      def initialize(config = {}, &callback_config)
+        super(&callback_config)
+        @token = config.fetch(:token) do
+          Orcid.client_credentials_token('/orcid-profile/create')
+        end
+        @path = config.fetch(:path) { 'v1.1/orcid-profile' }
+        @headers = config.fetch(:headers) { default_headers }
+      end
 
-    attr_reader :token, :path, :headers
-    def initialize(config = {}, &callback_config)
-      super(&callback_config)
-      @token = config.fetch(:token) { Orcid.client_credentials_token('/orcid-profile/create') }
-      @path = config.fetch(:path) { "v1.1/orcid-profile" }
-      @headers = config.fetch(:headers) { default_headers }
-    end
+      def call(payload)
+        response = deliver(payload)
+        parse(response)
+      end
 
-    def call(payload)
-      response = deliver(payload)
-      parse(response)
-    end
+      protected
 
-    protected
-    def deliver(body)
-      token.post(path, body: body, headers: headers)
-    end
+      def deliver(body)
+        token.post(path, body: body, headers: headers)
+      end
 
-    def parse(response)
-      uri = URI.parse(response.headers.fetch(:location))
-      if orcid_profile_id = uri.path.sub(/\A\//, "").split("/").first
-        callback(:success, orcid_profile_id)
-        orcid_profile_id
-      else
-        callback(:failure)
-        false
+      def parse(response)
+        uri = URI.parse(response.headers.fetch(:location))
+        orcid_profile_id = uri.path.sub(/\A\//, '').split('/').first
+        if orcid_profile_id
+          callback(:success, orcid_profile_id)
+          orcid_profile_id
+        else
+          callback(:failure)
+          false
+        end
       end
-    end
 
-    def default_headers
-      { "Accept" => 'application/xml', 'Content-Type'=>'application/vdn.orcid+xml' }
+      def default_headers
+        {
+          'Accept' => 'application/xml',
+          'Content-Type' => 'application/vdn.orcid+xml'
+        }
+      end
     end
   end
 end

data/app/services/orcid/remote/profile_query_service.rb

@@ -0,0 +1,82 @@
+require_dependency 'json'
+require 'orcid/remote/service'
+module Orcid
+  module Remote
+    # Responsible for querying Orcid to find various ORCiDs
+    class ProfileQueryService < Orcid::Remote::Service
+      def self.call(query, config = {}, &callbacks)
+        new(config, &callbacks).call(query)
+      end
+
+      attr_reader :token, :path, :headers, :response_builder, :query_builder
+      def initialize(config = {}, &callbacks)
+        super(&callbacks)
+        @query_builder = config.fetch(:query_parameter_builder) { QueryParameterBuilder }
+        @token = config.fetch(:token) { default_token }
+        @response_builder = config.fetch(:response_builder) { SearchResponse }
+        @path = config.fetch(:path) { 'v1.1/search/orcid-bio/' }
+        @headers = config.fetch(:headers) { default_headers }
+      end
+
+      def call(input)
+        parameters = query_builder.call(input)
+        response = deliver(parameters)
+        parsed_response = parse(response.body)
+        issue_callbacks(parsed_response)
+        parsed_response
+      end
+      alias_method :search, :call
+
+      protected
+
+      def default_token
+        Orcid.client_credentials_token('/read-public')
+      end
+
+      def default_headers
+        {
+          :accept => 'application/orcid+json',
+          'Content-Type' => 'application/orcid+xml'
+        }
+      end
+
+      def issue_callbacks(search_results)
+        if search_results.any?
+          callback(:found, search_results)
+        else
+          callback(:not_found)
+        end
+      end
+
+      attr_reader :host, :access_token
+      def deliver(parameters)
+        token.get(path, headers: headers, params: parameters)
+      end
+
+      def parse(document)
+        json = JSON.parse(document)
+
+        json.fetch('orcid-search-results').fetch('orcid-search-result')
+        .each_with_object([]) do |result, returning_value|
+          profile = result.fetch('orcid-profile')
+          identifier = profile.fetch('orcid-identifier').fetch('path')
+          orcid_bio = profile.fetch('orcid-bio')
+          given_names = orcid_bio.fetch('personal-details').fetch('given-names').fetch('value')
+          family_name = orcid_bio.fetch('personal-details').fetch('family-name').fetch('value')
+          emails = []
+          contact_details = orcid_bio['contact-details']
+          if contact_details
+            emails = (contact_details['email'] || []).map {|email| email.fetch('value') }
+          end
+          label = "#{given_names} #{family_name}"
+          label << ' (' << emails.join(', ') << ')' if emails.any?
+          label << " [ORCID: #{identifier}]"
+          biography = ''
+          biography = orcid_bio['biography']['value'] if orcid_bio['biography']
+          returning_value << response_builder.new('id' => identifier, 'label' => label, 'biography' => biography)
+        end
+      end
+
+    end
+  end
+end