orcid 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba10205d401221950e7596687248cd0bd5a370e8
-  data.tar.gz: 25c078f04696083a4e71fb896a344a73f4fd4929
+  metadata.gz: 76d282e5fe1e457a4e664b9744c7798a699868b0
+  data.tar.gz: 8e9d224124856d459ba29a413116667553d16307
 SHA512:
-  metadata.gz: a252eb074a444073a01d31ce1b453c4b36a003dc3d412815932303498b968621141821aff853222804a1b202b9baac3584fc1851d05c421f088b4cf2fc80f58b
-  data.tar.gz: f281ed0b68af192d53f1a5f51d038a80f250130ea485cfdd6efbf7026e46412053e2b1d609ecc86b1fd574226938d42be08b62c37191bcfef4ff7c16956671df
+  metadata.gz: 1fbcf299a9e8d0701c2d42438f61d56094f35eda93bce08ba0b6829184616aeba9bf2eb9c149ae66a252433d77b5f5cfc7f41647c33e17071de1fb6ed12b123b
+  data.tar.gz: 1bedcf2b30666c9e9131b52070641954dc334d5e26ee1eae3fb7f583735567efc63f32d31d0fbdc8660b13383c71ba173e5fc2e2aefec920089ab2267956a8cc

data/LICENSE

@@ -1,6 +1,6 @@
 ##########################################################################
 #
-# Copyright 2013 University of Notre Dame
+# Copyright 2014 University of Notre Dame
 #
 # Additional copyright may be held by others, as reflected in the commit log
 #

data/README.md

@@ -16,3 +16,8 @@ And then execute:
 And then install:
 
     $ rails generate orcid:install
+
+
+## TODO Items
+
+* When searching for your profile, expose Name and associated DOI as query parameters.

data/app/models/orcid/profile_connection.rb

@@ -5,7 +5,14 @@ module Orcid
     include Virtus.model
     include ActiveModel::Validations
     extend ActiveModel::Naming
-    attribute :email
+
+    self.class_attribute :available_query_attribute_names
+    self.available_query_attribute_names = [:email, :text]
+
+    available_query_attribute_names.each do |attribute_name|
+      attribute attribute_name
+    end
+
     attribute :orcid_profile_id
     attribute :user
 
@@ -35,7 +42,7 @@ module Orcid
     private :default_profile_lookup_service
 
     def with_orcid_profile_candidates
-      yield(orcid_profile_candidates) if email.present?
+      yield(orcid_profile_candidates) if query_requested?
     end
 
     attr_writer :orcid_profile_candidates
@@ -45,11 +52,22 @@ module Orcid
     end
 
     def lookup_profile_candidates
-      if email.present?
-        profile_lookup_service.call(email: email)
+      if query_requested?
+        profile_lookup_service.call(query_attributes)
       end
     end
     private :lookup_profile_candidates
 
+    def query_requested?
+      !!available_query_attribute_names.detect { |attribute_name|
+        attributes[attribute_name].present?
+      }
+    end
+    private :query_requested?
+
+    def query_attributes
+      attributes.slice(*available_query_attribute_names)
+    end
+
   end
 end

data/app/runners/orcid/profile_lookup_runner.rb

@@ -1,17 +1,21 @@
-require_dependency './app/runners/orcid/runner'
+require 'orcid/runner'
 module Orcid
   class ProfileLookupRunner < Runner
 
     def initialize(config = {}, &block)
       super(&block)
       @query_service = config.fetch(:query_service) { Remote::ProfileLookupService }
+      @query_builder = config.fetch(:query_parameter_builder) {
+        require 'orcid/query_parameter_builder'
+        Orcid::QueryParameterBuilder
+      }
     end
-    attr_reader :query_service
-    private :query_service
+    attr_reader :query_service, :query_builder
+    private :query_service, :query_builder
 
-    def call(parameters)
-      email = parameters.fetch(:email)
-      response = query_service.call({q: "email:#{email}"})
+    def call(raw_parameters)
+      query_parameters = query_builder.call(raw_parameters)
+      response = query_service.call(query_parameters)
       handle(response)
     end
 

data/app/runners/orcid/runner.rb

@@ -1,4 +1,4 @@
-require_dependency './lib/orcid/named_callbacks'
+require 'orcid/named_callbacks'
 module Orcid
   class Runner
     def initialize

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

@@ -1,4 +1,4 @@
-require_dependency './app/services/orcid/remote/service'
+require 'orcid/remote/service'
 module Orcid::Remote
   # Responsible for minting a new ORCID for the given payload.
   class ProfileCreationService < Orcid::Remote::Service

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

@@ -40,9 +40,12 @@ module Orcid::Remote
         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 = orcid_bio.fetch('contact-details').fetch('email').collect {|email| email.fetch('value') }
+        emails = []
+        if contact_details = orcid_bio['contact-details']
+          emails = (contact_details['email'] || []).collect {|email| email.fetch('value') }
+        end
         label = "#{given_names} #{family_name}"
-        label << " (" << emails.join(",") << ")" if emails.any?
+        label << " (" << emails.join(", ") << ")" if emails.any?
         label << " [ORCID: #{identifier}]"
 
         returning_value << response_builder.new("id" => identifier, "label" => label)

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

@@ -1,4 +1,4 @@
-require_dependency './lib/orcid/named_callbacks'
+require 'orcid/named_callbacks'
 module Orcid::Remote
   class Service
     def initialize

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

@@ -1,4 +1,4 @@
-require_dependency './lib/orcid/exceptions'
+require 'orcid/exceptions'
 module Orcid::Remote
   class WorkService
     def self.call(orcid_profile_id, options = {})

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

@@ -1,6 +1,8 @@
 <%= 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 %>
-    <%= f.input :email, type: :search %>
+    <% 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>

data/config/application.yml

@@ -0,0 +1,25 @@
+# Add account credentials and API keys here.
+# See http://railsapps.github.io/rails-environment-variables.html
+# This file should be listed in .gitignore to keep your settings secret!
+# Each entry sets a local environment variable and overrides ENV variables in the Unix shell.
+# For example, setting:
+# 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_CLAIMED_PROFILE_ID: 0000-0002-1117-8571
+ORCID_CLAIMED_PROFILE_PASSWORD: password1A
+ORCID_CLAIMED_PROFILE_EMAIL: cwksfxyqkmrudrfrdxvlzjxl@mailinator.com

data/lib/orcid.rb

@@ -36,7 +36,7 @@ module Orcid
     configuration.authentication_model
   end
 
-  def connect_user_and_orcid_profile(user, orcid_profile_id, options = {})
+  def connect_user_and_orcid_profile(user, orcid_profile_id)
     authentication_model.create!(provider: 'orcid', uid: orcid_profile_id, user: user)
   end
 

data/lib/orcid/configuration.rb

@@ -2,16 +2,22 @@ module Orcid
   class Configuration
     attr_reader :mapper
     def initialize(options = {})
-      @mapper = options.fetch(:mapper) { ::Mappy }
-      @provider = Configuration::Provider.new
+      @mapper = options.fetch(:mapper) {
+        require 'mappy'
+        ::Mappy
+      }
+      @provider = options.fetch(:provider) {
+        require 'orcid/configuration/provider'
+        Provider.new
+      }
+      @authentication_model = options.fetch(:authentication_model) {
+        require 'devise-multi_auth'
+        ::Devise::MultiAuth::Authentication
+      }
     end
 
-    attr_reader :provider
-
-    attr_writer :authentication_model
-    def authentication_model
-      @authentication_model ||= Devise::MultiAuth::Authentication
-    end
+    attr_accessor :provider
+    attr_accessor :authentication_model
 
     def register_mapping_to_orcid_work(source_type, legend)
       mapper.configure do |config|
@@ -20,4 +26,3 @@ module Orcid
     end
   end
 end
-require 'orcid/configuration/provider'

data/lib/orcid/query_parameter_builder.rb

@@ -0,0 +1,38 @@
+module Orcid
+  # 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

data/lib/orcid/version.rb

@@ -1,3 +1,3 @@
 module Orcid
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orcid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -108,20 +108,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -316,7 +302,6 @@ files:
 - app/controllers/orcid/application_controller.rb
 - app/controllers/orcid/profile_connections_controller.rb
 - app/controllers/orcid/profile_requests_controller.rb
-- app/helpers/orcid/application_helper.rb
 - app/models/orcid/profile.rb
 - app/models/orcid/profile_connection.rb
 - app/models/orcid/profile_request.rb
@@ -334,6 +319,7 @@ files:
 - app/views/orcid/profile_connections/new.html.erb
 - app/views/orcid/profile_requests/new.html.erb
 - app/views/orcid/profile_requests/show.html.erb
+- config/application.yml
 - config/locales/orcid.en.yml
 - config/routes.rb
 - db/migrate/20140205185338_create_orcid_profile_requests.rb
@@ -344,6 +330,7 @@ files:
 - lib/orcid/engine.rb
 - lib/orcid/exceptions.rb
 - lib/orcid/named_callbacks.rb
+- lib/orcid/query_parameter_builder.rb
 - lib/orcid/spec_support.rb
 - lib/orcid/version.rb
 - lib/orcid.rb

data/app/helpers/orcid/application_helper.rb

@@ -1,4 +0,0 @@
-module Orcid
-  module ApplicationHelper
-  end
-end