orcid 0.0.4 → 0.1.0

data/lib/orcid.rb

@@ -1,7 +1,7 @@
 require 'orcid/engine'
 require 'orcid/configuration'
 require 'orcid/exceptions'
-
+require 'figaro'
 require 'mappy'
 require 'devise_multi_auth'
 require 'virtus'
@@ -9,8 +9,8 @@ require 'omniauth-orcid'
 require 'email_validator'
 require 'simple_form'
 
+# The namespace for all things related to Orcid integration
 module Orcid
-
   class << self
     attr_writer :configuration
 
@@ -32,26 +32,39 @@ module Orcid
     configuration.provider
   end
 
+  def parent_controller
+    configuration.parent_controller
+  end
+
   def authentication_model
     configuration.authentication_model
   end
 
   def connect_user_and_orcid_profile(user, orcid_profile_id)
-    authentication_model.create!(provider: 'orcid', uid: orcid_profile_id, user: user)
+    authentication_model.create!(
+      provider: 'orcid', uid: orcid_profile_id, user: user
+    )
   end
 
   def access_token_for(orcid_profile_id, options = {})
     client = options.fetch(:client) { oauth_client }
     tokenizer = options.fetch(:tokenizer) { authentication_model }
-    tokenizer.to_access_token(uid: orcid_profile_id, provider: 'orcid', client: client)
+    tokenizer.to_access_token(
+      uid: orcid_profile_id, provider: 'orcid', client: client
+    )
+  end
+
+  # Returns true if the person with the given ORCID has already obtained an
+  # ORCID access token by authenticating via ORCID.
+  def authenticated_orcid?(orcid_profile_id)
+    Orcid.access_token_for(orcid_profile_id).present?
+  rescue Devise::MultiAuth::AccessTokenError
+    return false
   end
 
   def profile_for(user)
-    if auth = authentication_model.where(provider: 'orcid', user: user).first
-      Orcid::Profile.new(auth.uid)
-    else
-      nil
-    end
+    auth = authentication_model.where(provider: 'orcid', user: user).first
+    auth && Orcid::Profile.new(auth.uid)
   end
 
   def enqueue(object)
@@ -60,7 +73,7 @@ module Orcid
 
   def oauth_client
     # passing the site: option as Orcid's Sandbox has an invalid certificate
-    # for the api.sandbox-1.orcid.org
+    # for the api.sandbox.orcid.org
     @oauth_client ||= Devise::MultiAuth.oauth_client_for(
       'orcid', options: { site: provider.site_url }
     )
@@ -70,5 +83,4 @@ module Orcid
     tokenizer = options.fetch(:tokenizer) { oauth_client.client_credentials }
     tokenizer.get_token(scope: scope)
   end
-
 end

data/lib/orcid/configuration.rb

@@ -1,28 +1,47 @@
 module Orcid
+  # Responsible for exposing the customization mechanism
   class Configuration
     attr_reader :mapper
     def initialize(options = {})
-      @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
-      }
+      @mapper = options.fetch(:mapper) { default_mapper }
+      @provider = options.fetch(:provider) { default_provider }
+      @authentication_model = options.fetch(:authentication_model) do
+        default_authenticaton_model
+      end
+      @parent_controller = options.fetch(:parent_controller) do
+        '::ApplicationController'
+      end
     end
 
     attr_accessor :provider
     attr_accessor :authentication_model
+    attr_accessor :parent_controller
 
     def register_mapping_to_orcid_work(source_type, legend)
       mapper.configure do |config|
-        config.register(source: source_type, target: 'orcid/work', legend: legend)
+        config.register(
+          source: source_type,
+          target: 'orcid/work',
+          legend: legend
+        )
       end
     end
+
+    protected
+
+    def default_mapper
+      require 'mappy'
+      ::Mappy
+    end
+
+    def default_provider
+      require 'orcid/configuration/provider'
+      Provider.new
+    end
+
+    def default_authenticaton_model
+      require 'devise-multi_auth'
+      ::Devise::MultiAuth::Authentication
+    end
   end
 end

data/lib/orcid/configuration/provider.rb

@@ -1,5 +1,10 @@
+require 'orcid/exceptions'
 module Orcid
   class Configuration
+    # Responsible for negotiating the retrieval of Orcid provider information.
+    # Especially important given that you have private auth keys.
+    # Also given that you may want to request against the sandbox versus the
+    # production Orcid service.
     class Provider
       attr_reader :store
       def initialize(store = ::ENV)
@@ -8,43 +13,52 @@ module Orcid
 
       attr_writer :authentication_scope
       def authentication_scope
-        @authentication_scope ||= store.fetch('ORCID_APP_AUTHENTICATION_SCOPE') {
-          "/authenticate,/orcid-works/create,/orcid-works/update,/read-public"
-        }
+        @authentication_scope ||=
+        store.fetch('ORCID_APP_AUTHENTICATION_SCOPE') do
+          '/authenticate,/orcid-works/create,/orcid-works/update,/read-public'
+        end
       end
 
       attr_writer :site_url
       def site_url
-        @site_url ||= store.fetch('ORCID_SITE_URL') { "http://api.sandbox-1.orcid.org" }
+        @site_url ||= store.fetch('ORCID_SITE_URL') do
+          'http://api.sandbox.orcid.org'
+        end
       end
 
       attr_writer :token_url
       def token_url
-        @token_url ||= store.fetch('ORCID_TOKEN_URL') { "https://api.sandbox-1.orcid.org/oauth/token" }
+        @token_url ||= store.fetch('ORCID_TOKEN_URL') do
+          'https://api.sandbox.orcid.org/oauth/token'
+        end
       end
 
       attr_writer :signin_via_json_url
       def signin_via_json_url
-        @signin_via_json_url ||= store.fetch('ORCID_REMOTE_SIGNIN_URL') { "https://sandbox-1.orcid.org/signin/auth.json" }
+        @signin_via_json_url ||= store.fetch('ORCID_REMOTE_SIGNIN_URL') do
+          'https://sandbox.orcid.org/signin/auth.json'
+        end
       end
 
       attr_writer :authorize_url
       def authorize_url
-        @authorize_url ||= store.fetch('ORCID_AUTHORIZE_URL') { "https://sandbox-1.orcid.org/oauth/authorize" }
+        @authorize_url ||= store.fetch('ORCID_AUTHORIZE_URL') do
+          'https://sandbox.orcid.org/oauth/authorize'
+        end
       end
 
       attr_writer :id
       def id
-        @id ||= store.fetch('ORCID_APP_ID') {
-          Rails.logger.error('Set your Orcid.provider.id')
-        }
+        @id ||= store.fetch('ORCID_APP_ID')
+      rescue KeyError
+        raise ConfigurationError, 'ORCID_APP_ID'
       end
 
       attr_writer :secret
       def secret
-        @secret ||= store.fetch('ORCID_APP_SECRET') {
-          Rails.logger.error('Set your Orcid.provider.secret')
-        }
+        @secret ||= store.fetch('ORCID_APP_SECRET')
+      rescue KeyError
+        raise ConfigurationError, 'ORCID_APP_SECRET'
       end
     end
   end

data/lib/orcid/engine.rb

@@ -1,15 +1,31 @@
+# The namespace for all things related to Orcid integration
 module Orcid
+  module_function
+
+  # As per an isolated_namespace Rails engine.
+  # But the isolated namespace creates issues.
+  # @api private
+  def table_name_prefix
+    'orcid_'
+  end
+
+  # Because I am not using isolate_namespace for Orcid::Engine
+  # I need this for the application router to find the appropriate routes.
+  # @api private
+  def use_relative_model_naming?
+    true
+  end
+
+  # While not an isolated namespace engine
+  # @See http://guides.rubyonrails.org/engines.html
   class Engine < ::Rails::Engine
-    isolate_namespace Orcid
+    engine_name 'orcid'
 
     initializer 'orcid.initializers' do |app|
       app.config.paths.add 'app/services', eager_load: true
-      app.config.paths.add 'app/runners', eager_load: true
       app.config.autoload_paths += %W(
         #{config.root}/app/services
-        #{config.root}/app/runners
       )
     end
-
   end
 end

data/lib/orcid/exceptions.rb

@@ -1,11 +1,28 @@
 module Orcid
+
+  class ConfigurationError < RuntimeError
+    def initialize(key_name)
+      super("Unable to find #{key_name.inspect} in configuration storage.")
+    end
+  end
+
   # Because in trouble shooting what all goes into this remote call,
   # you may very well want all of this.
   class RemoteServiceError < RuntimeError
     def initialize(options)
       text = []
       text << "-- Client --"
-      if client = options[:client]
+      append_client_options(options[:client], text)
+      append_token(options[:token], text)
+      append_request(options, text)
+      append_response(options, text)
+      super(text.join("\n"))
+    end
+
+    private
+
+    def append_client_options(client, text)
+      if client
         text << "id:\n\t#{client.id.inspect}"
         text << "site:\n\t#{client.site.inspect}"
         text << "options:\n\t#{client.options.inspect}"
@@ -13,19 +30,31 @@ module Orcid
           text << "scopes:\n\t#{Orcid.provider.authentication_scope}"
         end
       end
+      text
+    end
+
+    def append_token(token, text)
       text << "\n-- Token --"
-      if token = options[:token]
+      if token
         text << "access_token:\n\t#{token.token.inspect}"
         text << "refresh_token:\n\t#{token.refresh_token.inspect}"
       end
+      text
+    end
+
+    def append_request(options, text)
       text << "\n-- Request --"
       text << "path:\n\t#{options[:request_path].inspect}" if options[:request_path]
       text << "headers:\n\t#{options[:request_headers].inspect}" if options[:request_headers]
       text << "body:\n\t#{options[:request_body]}" if options[:request_body]
+      text
+    end
+
+    def append_response(options, text)
       text << "\n-- Response --"
       text << "status:\n\t#{options[:response_status].inspect}" if options[:response_status]
       text << "body:\n\t#{options[:response_body]}" if options[:response_body]
-      super(text.join("\n"))
+      text
     end
   end
-end
+end

data/lib/orcid/named_callbacks.rb

@@ -6,7 +6,9 @@ module Orcid
       @callbacks = {}
     end
 
-    def method_missing(callback_name, *args, &block)
+    # Note this very specific implementation of #method_missing will raise
+    # errors on non-zero method arity.
+    def method_missing(callback_name, &block)
       @callbacks[callback_name] = block
     end
 

data/lib/orcid/spec_support.rb

@@ -19,7 +19,7 @@ class RequestSandboxAuthorizationCode
 
   def call(options = {})
     orcid_profile_id = options.fetch(:orcid_profile_id) { ENV['ORCID_CLAIMED_PROFILE_ID'] }
-    password = options.fetch(:password) { ENV['ORCID_CLAIMED_PROFILE_PASSWORD']}
+    password = options.fetch(:password) { ENV['ORCID_CLAIMED_PROFILE_PASSWORD'] }
 
     login_to_orcid(orcid_profile_id, password)
     request_authorization
@@ -30,25 +30,35 @@ class RequestSandboxAuthorizationCode
   private :cookies
 
   private
+
   def login_to_orcid(orcid_profile_id, password)
-    response = RestClient.post(login_url, userId: orcid_profile_id, password: password )
-    if ! JSON.parse(response)["success"]
-      raise "Response not successful: \n#{response}"
-    else
+    response = RestClient.post(
+      login_url, userId: orcid_profile_id, password: password
+    )
+    if JSON.parse(response)['success']
       self.cookies = response.cookies
+    else
+      fail "Response not successful: \n#{response}"
     end
   end
 
   def request_authorization
-    parameters = { client_id: orcid_client_id, response_type: 'code', scope: access_scope, redirect_uri: oauth_redirect_uri }
-    RestClient.get(authorize_url, {params: parameters, cookies: cookies})
+    parameters = {
+      client_id: orcid_client_id,
+      response_type: 'code',
+      scope: access_scope,
+      redirect_uri: oauth_redirect_uri
+    }
+    RestClient.get(authorize_url, { params: parameters, cookies: cookies })
   end
 
   def request_authorization_code
-    RestClient.post(authorize_url, {user_oauth_approval: true}, {cookies: cookies})
+    RestClient.post(
+      authorize_url, { user_oauth_approval: true }, { cookies: cookies }
+    )
   rescue RestClient::Found => e
     uri = URI.parse(e.response.headers.fetch(:location))
-    CGI::parse(uri.query).fetch('code').first
+    CGI.parse(uri.query).fetch('code').first
   end
 
 end

data/lib/orcid/version.rb

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

data/lib/tasks/orcid_tasks.rake

@@ -6,7 +6,7 @@ namespace :orcid do
     task :query_runner do
       @runner = lambda { |person|
         puts "Processing: #{person.email}"
-        Orcid::ProfileLookupRunner.new {|on|
+        Orcid::Remote::ProfileLookupRunner.new {|on|
           on.found {|results|
             person.found(results)
             puts "\tfound" if verbose
@@ -39,7 +39,7 @@ namespace :orcid do
       }
       @runner = lambda { |person|
         puts "Processing: #{person.email}"
-        Orcid::ProfileLookupRunner.new {|on|
+        Orcid::Remote::ProfileQueryService.new {|on|
           on.found {|results|
             person.found(results)
             puts "\tfound" if verbose
@@ -92,7 +92,7 @@ namespace :orcid do
           end
 
           def found(existing_orcids)
-            @existing_orcids = Array(existing_orcids).collect(&:orcid_profile_id).join("; ")
+            @existing_orcids = Array.wrap(existing_orcids).collect(&:orcid_profile_id).join("; ")
           end
 
           def to_output_row

data/orcid.gemspec

@@ -0,0 +1,51 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'orcid/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'orcid'
+  s.version     = Orcid::VERSION
+  s.authors     = [
+    'Jeremy Friesen'
+  ]
+  s.email       = [
+    'jeremy.n.friesen@gmail.com'
+  ]
+  s.homepage    = 'https://github.com/jeremyf/orcid'
+  s.summary     = 'A Rails engine for orcid.org integration.'
+  s.description = 'A Rails engine for orcid.org integration.'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  # Deliberately removing bin executables as it appears to relate to
+  # https://github.com/cbeer/engine_cart/issues/9
+  s.executables   = s.executables   = s.files.grep(%r{^bin/}) do |f|
+    f == 'bin/rails' ? nil : File.basename(f)
+  end.compact
+  s.test_files    = s.files.grep(/^(test|spec|features)\//)
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rails', '~> 4.0.3'
+  s.add_dependency 'mappy', '~> 0.1.0'
+  s.add_dependency 'figaro'
+  s.add_dependency 'devise-multi_auth', '~> 0.1.0'
+  s.add_dependency 'omniauth-orcid'
+  s.add_dependency 'virtus'
+  s.add_dependency 'email_validator'
+  s.add_dependency 'simple_form'
+  s.add_dependency 'byebug'
+
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'engine_cart'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'rspec-html-matchers'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'capybara-webkit'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rest_client'
+  s.add_development_dependency 'rspec-given'
+end