orcid 0.0.4 → 0.1.0

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

@@ -0,0 +1,43 @@
+require_dependency 'orcid/remote/profile_query_service'
+module Orcid
+  module Remote
+    class ProfileQueryService
+      # http://support.orcid.org/knowledgebase/articles/132354-searching-with-the-public-api
+      module QueryParameterBuilder
+
+        module_function
+        # Responsible for converting an arbitrary query string to the acceptable
+        # Orcid query format.
+        #
+        # @TODO - Note this is likely not correct, but is providing the singular
+        # point of entry
+        def call(input = {})
+          params = {}
+          q_params = []
+          text_params = []
+          input.each do |key, value|
+            next if value.nil? || value.to_s.strip == ''
+            case key.to_s
+            when 'start', 'row'
+              params[key] = value
+            when 'q', 'text'
+              text_params << "#{value}"
+            else
+              q_params << "#{key.to_s.gsub('_', '-')}:#{value}"
+            end
+          end
+
+          case text_params.size
+          when 0; then nil
+          when 1
+            q_params << "text:#{text_params.first}"
+          else
+            q_params << "text:((#{text_params.join(') AND (')}))"
+          end
+          params[:q] = q_params.join(' AND ')
+          params
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require_dependency 'orcid/remote/profile_query_service'
+module Orcid
+  module Remote
+    class ProfileQueryService
+      # A search response against Orcid. This should implement the Questioning
+      # Authority query response object interface.
+      class SearchResponse
+        delegate :[], :has_key?, :key?, :fetch, to: :@records
+        def initialize(attributes = {})
+          @attributes = attributes.with_indifferent_access
+        end
+
+        def id
+          @attributes.fetch(:id)
+        end
+
+        def orcid_profile_id
+          @attributes.fetch(:id)
+        end
+
+        def label
+          @attributes.fetch(:label)
+        end
+
+        def biography
+          @attributes.fetch(:biography)
+        end
+      end
+    end
+  end
+end

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

@@ -1,19 +1,22 @@
 require 'orcid/named_callbacks'
-module Orcid::Remote
-  class Service
-    def initialize
-      @callbacks = Orcid::NamedCallbacks.new
-      yield(@callbacks) if block_given?
-    end
+module Orcid
+  module Remote
+    # An abstract service class, responsible for making remote calls and
+    # issuing a callback.
+    class Service
+      def initialize
+        @callbacks = Orcid::NamedCallbacks.new
+        yield(@callbacks) if block_given?
+      end
 
-    def call
-      raise NotImplementedError.new("Define #{self.class}#call")
-    end
+      def call
+        fail NotImplementedError, ("Define #{self.class}#call")
+      end
 
-    def callback(name, *args)
-      @callbacks.call(name, *args)
-      args
+      def callback(name, *args)
+        @callbacks.call(name, *args)
+        args
+      end
     end
-
   end
 end

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

@@ -1,52 +1,67 @@
 require 'orcid/exceptions'
-module Orcid::Remote
-  class WorkService
-    def self.call(orcid_profile_id, options = {})
-      new(orcid_profile_id, options).call
-    end
+module Orcid
+  module Remote
+    # Responsible for interacting with the Orcid works endpoint
+    class WorkService
+      def self.call(orcid_profile_id, options = {})
+        new(orcid_profile_id, options).call
+      end
 
-    attr_reader :headers, :token, :orcid_profile_id, :body, :request_method, :path
-    def initialize(orcid_profile_id, options = {})
-      @orcid_profile_id = orcid_profile_id
-      @request_method = options.fetch(:request_method) { :get }
-      @body = options.fetch(:body) { "" }
-      @token = options.fetch(:token) { Orcid.access_token_for(orcid_profile_id) }
-      @headers = options.fetch(:headers) { default_headers }
-      @path = options.fetch(:path) { default_path }
-    end
+      attr_reader(
+        :headers, :token, :orcid_profile_id, :body, :request_method, :path
+      )
+      def initialize(orcid_profile_id, options = {})
+        @orcid_profile_id = orcid_profile_id
+        @request_method = options.fetch(:request_method) { :get }
+        @body = options.fetch(:body) { '' }
+        @token = options.fetch(:token) { default_token }
+        @headers = options.fetch(:headers) { default_headers }
+        @path = options.fetch(:path) { default_path }
+      end
 
-    # :post will append works to the Orcid Profile
-    # :put will replace the existing Orcid Profile works with the payload
-    # :get will retrieve the Orcid Profile
-    # http://support.orcid.org/knowledgebase/articles/177528-add-works-technical-developer
-    def call
-      response = deliver
-      response.body
-    end
+      # :post will append works to the Orcid Profile
+      # :put will replace the existing Orcid Profile works with the payload
+      # :get will retrieve the Orcid Profile
+      # http://support.orcid.org/knowledgebase/articles/177528-add-works-technical-developer
+      def call
+        response = deliver
+        response.body
+      end
 
-    protected
-    def deliver
-      token.request(request_method, path, body: body, headers: headers)
-    rescue OAuth2::Error => e
-      raise Orcid::RemoteServiceError.new(
-        response_body: e.response.body,
-        response_status: e.response.status,
-        client: token.client,
-        token: token,
-        request_method: request_method,
-        request_path: path,
-        request_body: body,
-        request_headers: headers
-      )
-    end
+      protected
 
-    def default_headers
-      { 'Accept' => 'application/xml', 'Content-Type'=>'application/orcid+xml' }
-    end
+      def deliver
+        token.request(request_method, path, body: body, headers: headers)
+      rescue OAuth2::Error => e
+        handle_oauth_error(e)
+      end
 
-    def default_path
-      "v1.1/#{orcid_profile_id}/orcid-works/"
-    end
+      def handle_oauth_error(e)
+        fail Orcid::RemoteServiceError,
+             response_body:    e.response.body,
+             response_status:  e.response.status,
+             client:           token.client,
+             token:            token,
+             request_method:   request_method,
+             request_path:     path,
+             request_body:     body,
+             request_headers:  headers
+      end
+
+      def default_token
+        Orcid.access_token_for(orcid_profile_id)
+      end
 
+      def default_headers
+        {
+          'Accept' => 'application/xml',
+          'Content-Type' => 'application/orcid+xml'
+        }
+      end
+
+      def default_path
+        "v1.1/#{orcid_profile_id}/orcid-works/"
+      end
+    end
   end
 end

data/app/templates/orcid/work.template.v1.1.xml.erb

@@ -9,10 +9,41 @@
       <orcid-work>
         <work-title>
           <title><%= work.title %></title>
+          <% if work.subtitle.present? %><subtitle><%= work.subtitle %></subtitle><% end %>
         </work-title>
+        <% if work.journal_title.present? %><journal-title><%= work.journal_title %></journal-title><% end %>
+        <% if work.short_description.present? %><short-description><%= work.short_description %></short-description><% end %>
+        <% if work.work_citation? %><work-citation>
+          <work-citation-type><%= work.citation_type %></work-citation-type>
+          <citation><%= work.citation %></citation>
+        </work-citation><% end %>
         <work-type><%= work.work_type %></work-type>
+        <% if work.publication_date? %><publication-date>
+        <year><%= work.publication_year %></year>
+        <% if work.publication_month.present? %><month><%= work.publication_month %></month><% end %>
+        <publication-date><% end %>
+        <% if work.external_identifiers.present? %><work-external-identifiers>
+          <% work.external_identifiers.each do |external_identifier| %><work-external-identifier>
+            <work-external-identifier-type><%= external_identifier.type %></work-external-identifier-type>
+            <work-external-identifier-id><%= external_identifier.identifier %></work-external-identifier-id>
+          </work-external-identifier><% end %>
+        </work-external-identifiers><% end %>
+        <% if work.url.present? %><url><%= work.url %></url><% end %>
+        <!--
+        <work_contributors>
+          <contributor>
+            <credit_name/>
+            <contributor_attributes>
+              <contributor_sequence/>
+              <contributor_role/>
+            </contributor_attributes>
+          </contributor>
+        </work_contributors>
+        -->
+        <% if work.language_code.present? %><language-code><%= work.language_code %></language-code><% end %>
+        <% if work.country.present? %><country><%= work.country %></country><% end %>
       </orcid-work>
     <% end %></orcid-works>
   </orcid-activities>
 </orcid-profile>
-</orcid-message>
+</orcid-message>

data/app/views/orcid/profile_connections/_orcid_connector.html.erb

@@ -0,0 +1,14 @@
+<% profile_connection = Orcid::ProfileConnection.new %>
+<p><br />
+<%= link_to "Look up your existing ORCID", orcid.new_profile_connection_path(profile_connection:{text: default_search_text}) %>
+  <span>-OR-</span>
+<%= link_to "Create an ORCID", orcid.new_profile_request_path %>
+</p>
+<p>-OR-</p>
+<%= simple_form_for(profile_connection, as: :profile_connection, url: orcid.profile_connections_path, method: :post) do |f| %>
+    <%= f.input :orcid_profile_id, label: "Enter your existing ORCID (####-####-####-####)", class:"orcid-input" %>
+    <button type="submit" class="search-submit btn btn-primary" id="keyword-search-submit" tabindex="2">
+      <span class="orcid-connect">Connect</span>
+    </button>
+<% end %>
+

data/app/views/orcid/profile_connections/new.html.erb

@@ -1,19 +1,19 @@
 <%= simple_form_for(profile_connection, as: :profile_connection, url: orcid.new_profile_connection_path, method: :get, html: {class: 'search-form'}) do |f| %>
-  <%= field_set_tag("Search ORCID Profiles", class: 'accessible-hidden') do %>
+  <%= field_set_tag("Search ORCID Profiles") do %>
     <% profile_connection.available_query_attribute_names.each do |field_name| %>
       <%= f.input field_name, as: :search %>
     <% end %>
   <% end %>
   <button type="submit" class="search-submit btn btn-primary" id="keyword-search-submit" tabindex="2">
-    <i class="icon-search icon-white"></i><span class="accessible-hidden">Search</span>
+    <i class="icon-search icon-white"></i><span>Search</span>
   </button>
 <% end %>
 
 <% profile_connection.with_orcid_profile_candidates do |candidates| %>
   <%= simple_form_for(profile_connection, as: :profile_connection, url: orcid.profile_connections_path,) do |f| %>
-    <%= field_set_tag("Select an ORCID Profile", class: 'accessible-hidden') do %>
+    <%= field_set_tag("Select an ORCID Profile") do %>
       <%= f.collection_radio_buttons :orcid_profile_id, candidates, :id, :label %>
     <% end %>
     <%= f.submit %>
   <% end %>
-<% end %>
+<% end %>

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/orcid/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/{application.yml → application.yml.example}

@@ -6,20 +6,10 @@
 # GMAIL_USERNAME: Your_Gmail_Username
 # makes 'Your_Gmail_Username' available as ENV["GMAIL_USERNAME"]
 
-# Add application configuration variables here, as shown below.
-#
-ADMIN_NAME: First User
-ADMIN_EMAIL: user@example.com
-ADMIN_PASSWORD: changeme
-
 # From http://support.orcid.org/knowledgebase/articles/162412-tutorial-create-a-new-profile-using-curl
-ORCID_APP_ID: 0000-0002-6683-6607
-ORCID_APP_SECRET: e1ff26a2-d889-40be-bd41-acac09214cae
-
-ORCID_EXISTING_PUB_EMAIL: jeremy.n.friesen@gmail.com
-ORCID_EXISTING_PUB_PROFILE_ID: 0000-0002-3636-1153
-ORCID_EXISTING_PUB_NAME: Jeremy Friesen
+ORCID_APP_ID: 0000-0000-0000-0000
+ORCID_APP_SECRET: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 
-ORCID_CLAIMED_PROFILE_ID: 0000-0002-1117-8571
+ORCID_CLAIMED_PROFILE_ID: 0000-0000-0000-0000
 ORCID_CLAIMED_PROFILE_PASSWORD: password1A
 ORCID_CLAIMED_PROFILE_EMAIL: cwksfxyqkmrudrfrdxvlzjxl@mailinator.com

data/config/locales/orcid.en.yml

@@ -25,4 +25,8 @@ en:
       messages:
         existing_request_not_found: "Unable to find an existing Orcid Profile request. Go ahead and create one."
         existing_request: "You have already submitted an Orcid Profile request."
-        previously_connected_profile: "You have already connected to an Orcid Profile (%{orcid_profile_id})."
+        previously_connected_profile: "You have already connected to an Orcid Profile (%{orcid_profile_id})."
+    connections:
+      messages:
+        profile_connection_not_found: "Unable to find an existing Orcid Profile connection."
+        verified_profile_connection_exists: "You have already connected and verified your Orcid Profile (%{orcid_profile_id})."

data/config/routes.rb

@@ -1,4 +1,6 @@
 Orcid::Engine.routes.draw do
-  resource :profile_request, only: [:show, :new, :create]
-  resources :profile_connections, only: [:new, :create, :index]
+  scope module: 'orcid' do
+    resource :profile_request, only: [:show, :new, :create]
+    resources :profile_connections, only: [:new, :create, :index]
+  end
 end

data/lib/generators/orcid/install/install_generator.rb

@@ -1,10 +1,28 @@
 require 'rails/generators'
 
 module Orcid
+  # If you want to quickly add Orcid integration into your application.
+  # This assumes the use of the ubiqutous Devise gem.
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 
     class_option :devise, default: false, type: :boolean
+    class_option :skip_application_yml, default: false, type: :boolean
+
+    def create_application_yml
+      unless options[:skip_application_yml]
+        create_file 'config/application.yml' do
+          orcid_app_id = ask('What is your Orcid Client ID?')
+          orcid_app_secret = ask('What is your Orcid Client Secret?')
+          [
+            '',
+            "ORCID_APP_ID: #{orcid_app_id}",
+            "ORCID_APP_SECRET: #{orcid_app_secret}",
+            ''
+          ].join("\n")
+        end
+      end
+    end
 
     def install_devise_multi_auth
       if options[:devise]
@@ -14,14 +32,26 @@ module Orcid
       end
     end
 
+    def copy_locale
+      copy_file(
+        '../../../../../config/locales/orcid.en.yml',
+        'config/locales/orcid.en.yml'
+      )
+    end
+
     def install_migrations
-      rake "orcid:install:migrations"
+      rake 'orcid:install:migrations'
     end
 
-    def install_omniauth_strategies
-      config_code = ", :omniauthable, :omniauth_providers => [:orcid]"
-      insert_into_file 'app/models/user.rb', config_code, { :after => /:validatable/, :verbose => false }
+    def update_devise_user
+      config_code = ', :omniauthable, :omniauth_providers => [:orcid]'
+      insert_into_file(
+        'app/models/user.rb',
+        config_code, after: /:validatable/, verbose: false
+      )
+    end
 
+    def update_devise_omniauth_provider
       init_code = %(
         config.omniauth(:orcid, Orcid.provider.id, Orcid.provider.secret,
                         scope: Orcid.provider.authentication_scope,
@@ -32,16 +62,25 @@ module Orcid
                         }
                         )
       )
-      insert_into_file 'config/initializers/devise.rb', init_code, {after: /Devise\.setup.*$/, verbose: true}
+      insert_into_file(
+        'config/initializers/devise.rb',
+        init_code, after: /Devise\.setup.*$/, verbose: true
+      )
     end
 
     def mount_orcid_engine
       route 'mount Orcid::Engine => "/orcid"'
     end
 
-    def install_initializer
-      template 'orcid_initializer.rb.erb', 'config/orcid_initializer.rb'
+    def migrate_the_database
+      rake 'db:migrate'
     end
 
+    def install_initializer
+      template(
+        'orcid_initializer.rb.erb',
+        'config/initializers/orcid_initializer.rb'
+      )
+    end
   end
 end