orcid 0.0.1.pre → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 318aa12d99b90f05892d8ad841b07b82b5884e95
-  data.tar.gz: e1c66b565ddb73077a1d242aef6243118e558ab8
+  metadata.gz: 148909130b9d10ade4c7e2e6b32d07321dcac06f
+  data.tar.gz: 0fb6c0784ef0a0000bda7e737fe7604519c7afe3
 SHA512:
-  metadata.gz: c8502f9b04da7c9514f775f69919e41a36b190f710a8ebc1c507a1f05879e84c97b9a1c66eea9642dc4ab1a741441c9e1da813e414e98c6b8deec0210eaddf03
-  data.tar.gz: 5d2feb28a15ff95b3479ad30abe1c545ab1fa3854548f46229d737f8bcfde73f9f4f9fc1ec44a5db501fb71f35c9c2944f42b85f39c1da3dad8409a9217f906e
+  metadata.gz: 7d8b914e980f40cb79f6d19942c56ba5f3a5d27330b05d3ef3cb3b3f2c809b829e5c566803b1b5ac1b5025a52da4163e1ee495c232142e2ee1a63fa69575d34c
+  data.tar.gz: 9bc94eba6a209de41c0fefa4719d511eb9528ff9c2fc02882bb3be065a0e80a1af06cef5d4afc7f2a23b77a731e76ce4460652536dd4eae7c9c2ebde71db0cd6

data/README.md

@@ -1,3 +1,7 @@
-= Orcid
+# Orcid
 
-This project rocks and uses MIT-LICENSE.
+A Rails Engine for integrating with Orcid
+
+## TODO
+
+* Create a generator for installing configuration options into your Rails application.

data/Rakefile

@@ -4,18 +4,33 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
+Bundler::GemHelper.install_tasks
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Orcid'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'engine_cart/rake_task'
 
+require 'rspec/core/rake_task'
 
+namespace :spec do
+  desc 'Only run specs that do not require net connect'
+  RSpec::Core::RakeTask.new(:offline) do |t|
+    t.rspec_opts = "--tag ~requires_net_connect"
+  end
 
+  desc 'Only run specs that require net connect'
+  RSpec::Core::RakeTask.new(:online) do |t|
+    t.rspec_opts = "--tag requires_net_connect"
+  end
 
-Bundler::GemHelper.install_tasks
+  desc 'Run the Travis CI specs'
+  task :travis do
+    ENV['RAILS_ENV'] = 'test'
+    ENV['SPEC_OPTS'] = "--profile 20"
+    Rake::Task['engine_cart:clean'].invoke
+    Rake::Task['engine_cart:generate'].invoke
+    Rake::Task['spec:offline'].invoke
+  end
+end
+Rake::Task["default"].clear rescue nil
+Rake::Task["spec"].clear
 
+task :spec => 'spec:offline'

data/app/controllers/orcid/application_controller.rb

@@ -1,4 +1,14 @@
 module Orcid
   class ApplicationController < ActionController::Base
+    private
+    def redirecting_because_user_already_has_a_connected_orcid_profile
+      if orcid_profile = Orcid.profile_for(current_user)
+        flash[:notice] = I18n.t("orcid.requests.messages.previously_connected_profile", orcid_profile_id: orcid_profile.orcid_profile_id)
+        redirect_to main_app.root_path
+        return true
+      else
+        return false
+      end
+    end
   end
 end

data/app/controllers/orcid/profile_connections_controller.rb

@@ -0,0 +1,46 @@
+module Orcid
+  class ProfileConnectionsController < Orcid::ApplicationController
+    respond_to :html
+    before_filter :authenticate_user!
+
+    def index
+      render text: 'Not yet implemented!'
+    end
+
+    def new
+      return false if redirecting_because_user_already_has_a_connected_orcid_profile
+      assign_attributes(new_profile_connection)
+      respond_with(new_profile_connection)
+    end
+
+    def create
+      return false if redirecting_because_user_already_has_a_connected_orcid_profile
+      assign_attributes(new_profile_connection)
+      create_profile_connection(new_profile_connection)
+      respond_with(new_profile_connection)
+    end
+
+    protected
+
+    attr_reader :profile_connection
+    helper_method :profile_connection
+
+    def assign_attributes(profile_connection)
+      profile_connection.attributes = profile_connection_params
+      profile_connection.user = current_user
+    end
+
+    def profile_connection_params
+      params[:profile_connection] || {}
+    end
+
+    def create_profile_connection(profile_connection)
+      profile_connection.save
+    end
+
+    def new_profile_connection
+      @profile_connection ||= Orcid::ProfileConnection.new(params[:profile_connection])
+    end
+
+  end
+end

data/app/controllers/orcid/profile_requests_controller.rb

@@ -0,0 +1,67 @@
+module Orcid
+  class ProfileRequestsController < Orcid::ApplicationController
+    respond_to :html
+    before_filter :authenticate_user!
+
+    attr_reader :profile_request
+    helper_method :profile_request
+
+    def show
+      return false if redirecting_because_user_already_has_a_connected_orcid_profile
+      return false if redirecting_because_no_profile_request_was_found
+      respond_with(existing_profile_request)
+    end
+
+    def new
+      return false if redirecting_because_user_already_has_a_connected_orcid_profile
+      return false if redirecting_because_user_has_existing_profile_request
+      assign_attributes(new_profile_request)
+      respond_with(new_profile_request)
+    end
+
+    def create
+      return false if redirecting_because_user_already_has_a_connected_orcid_profile
+      return false if redirecting_because_user_has_existing_profile_request
+      assign_attributes(new_profile_request)
+      create_profile_request(new_profile_request)
+      respond_with(new_profile_request)
+    end
+
+    protected
+
+    def redirecting_because_no_profile_request_was_found
+      return false if existing_profile_request
+      flash[:notice] = I18n.t("orcid.requests.messages.existing_request_not_found")
+      redirect_to new_profile_request_path
+      true
+    end
+
+    def redirecting_because_user_has_existing_profile_request
+      return false if ! existing_profile_request
+      flash[:notice] = I18n.t("orcid.requests.messages.existing_request")
+      redirect_to profile_request_path
+      true
+    end
+
+    def existing_profile_request
+      @profile_request ||= Orcid::ProfileRequest.find_by_user(current_user)
+    end
+
+    def new_profile_request
+      @profile_request ||= Orcid::ProfileRequest.new(user: current_user)
+    end
+
+    def assign_attributes(profile_request)
+      profile_request.attributes = profile_request_params
+    end
+
+    def create_profile_request(profile_request)
+      profile_request.save && Orcid.enqueue(profile_request)
+    end
+
+    def profile_request_params
+      return {} unless params.has_key?(:profile_request)
+      params[:profile_request].permit(:given_names, :family_name, :primary_email, :primary_email_confirmation)
+    end
+  end
+end

data/app/models/orcid/configuration.rb

@@ -0,0 +1,19 @@
+module Orcid
+  class Configuration
+    attr_reader :store
+    def initialize(store = ::ENV)
+      @store = store
+    end
+
+    attr_writer :provider_name
+    def provider_name
+      @provider_name ||= 'orcid'
+    end
+
+    attr_writer :authentication_model
+    def authentication_model
+      @authentication_model ||= Devise::MultiAuth::Authentication
+    end
+
+  end
+end

data/app/models/orcid/profile.rb

@@ -0,0 +1,44 @@
+module Orcid
+  class Profile
+
+    attr_reader :orcid_profile_id, :mapper, :remote_service, :xml_renderer, :xml_parser
+    private :mapper
+    def initialize(orcid_profile_id, config = {})
+      @orcid_profile_id = orcid_profile_id
+      @mapper = config.fetch(:mapper) { ::Mappy }
+      @remote_service = config.fetch(:remote_service) { Orcid::RemoteWorkService }
+      @xml_renderer = config.fetch(:xml_renderer) { Orcid::Work::XmlRenderer }
+      @xml_parser = config.fetch(:xml_parser) { Orcid::Work::XmlParser }
+    end
+
+    def remote_works(options = {})
+      @remote_works = nil if options.fetch(:force, false)
+      @remote_works ||= begin
+        response = remote_service.call(orcid_profile_id, request_method: :get)
+        xml_parser.call(response)
+      end
+    end
+
+    def append_new_work(*works)
+      orcid_works = normalize_work(*works)
+      xml = xml_renderer.call(orcid_works)
+      remote_service.call(orcid_profile_id, request_method: :post, body: xml)
+    end
+
+    def replace_works_with(*works)
+      orcid_works = normalize_work(*works)
+      xml = xml_renderer.call(orcid_works)
+      remote_service.call(orcid_profile_id, request_method: :put, body: xml)
+    end
+
+    protected
+
+    # Note: We can handle
+    def normalize_work(*works)
+      Array(works).flatten.compact.collect do |work|
+        mapper.map(work, target: 'orcid/work')
+      end
+    end
+
+  end
+end

data/app/models/orcid/profile_connection.rb

@@ -0,0 +1,40 @@
+module Orcid
+  # Responsible for connecting an authenticated user to the ORCID profile that
+  # the user searched for and selected.
+  class ProfileConnection
+    include Virtus.model
+    include ActiveModel::Validations
+    extend ActiveModel::Naming
+    attribute :email
+    attribute :orcid_profile_id
+    attribute :user
+
+    validates :user, presence: true
+    validates :orcid_profile_id, presence: true
+
+    def persisted?; false; end
+
+    def save(config = {})
+      persister = config.fetch(:persister) { Orcid.method(:connect_user_and_orcid_profile) }
+      valid? ? persister.call(user, orcid_profile_id) : false
+    end
+
+    def with_orcid_profile_candidates
+      if query_for_orcid_profile_candidates?
+        yield(orcid_profile_candidates)
+      end
+    end
+    attr_writer :orcid_profile_querier
+    protected
+    def orcid_profile_candidates
+      @orcid_profile_candidates ||= orcid_profile_querier.call({q: "email:#{email}"})
+    end
+    def query_for_orcid_profile_candidates?
+      email.present?
+    end
+
+    def orcid_profile_querier
+      @orcid_profile_querier ||= ProfileLookupService
+    end
+  end
+end

data/app/models/orcid/profile_request.rb

@@ -0,0 +1,84 @@
+module Orcid
+  # Responsible for:
+  # * acknowledging that an ORCID Profile was requested
+  # * 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
+
+    self.table_name = :orcid_profile_requests
+
+    validates :user_id, presence: true, uniqueness: true
+    validates :given_names, presence: true
+    validates :family_name, presence: true
+    validates :primary_email, presence: true, email: true, confirmation: true
+
+    belongs_to :user
+
+    def run(options = {})
+      # Why dependency injection? Because this is going to be a plugin, and things
+      # can't possibly be simple.
+      before_run_validator = options.fetch(:before_run_validator) { method(:validate_before_run) }
+      return false unless before_run_validator.call(self)
+
+      payload_xml_builder = options.fetch(:payload_xml_builder) { method(:xml_payload) }
+      profile_creation_service = options.fetch(:profile_creation_service) { Orcid::ProfileCreationService }
+      profile_creation_responder = options.fetch(:profile_creation_responder) { method(:handle_profile_creation_response) }
+
+      orcid_profile_id = profile_creation_service.call(payload_xml_builder.call(attributes))
+      profile_creation_responder.call(orcid_profile_id)
+    end
+
+    def validate_before_run(context = self)
+
+      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
+
+      true
+    end
+
+    # 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)
+      self.class.transaction do
+        update_column(:orcid_profile_id, orcid_profile_id)
+        Orcid.connect_user_and_orcid_profile(user, orcid_profile_id)
+      end
+    end
+
+  end
+end

data/app/models/orcid/work.rb

@@ -0,0 +1,90 @@
+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
+
+    include Virtus.model
+    include ActiveModel::Validations
+    extend ActiveModel::Naming
+
+    attribute :title, String
+    validates :title, presence: true
+
+    attribute :work_type, String
+    validates :work_type, presence: true, inclusion: { in: VALID_WORK_TYPES }
+
+    attribute :put_code, String
+
+    def to_xml
+      XmlRenderer.call(self)
+    end
+
+    def ==(comparison_object)
+      super || comparison_object.instance_of?(self.class) &&
+        id.present? &&
+        comparison_object.id == id
+    end
+
+    def id
+      if put_code.present?
+        put_code
+      elsif title.present? && work_type.present?
+        [title, work_type]
+      else
+        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/services/orcid/profile_creation_service.rb

@@ -0,0 +1,35 @@
+# Responsible for minting a new ORCID for the given payload.
+module Orcid
+  class ProfileCreationService
+
+    def self.call(payload, config = {})
+      new(config).call(payload)
+    end
+
+    attr_reader :token, :path, :headers
+    def initialize(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
+
+    protected
+    def deliver(body)
+      token.post(path, body: body, headers: headers)
+    end
+
+    def parse(response)
+      uri = URI.parse(response.headers.fetch(:location))
+      uri.path.sub(/\A\//, "").split("/").first
+    end
+
+    def default_headers
+      { "Accept" => 'application/xml', 'Content-Type'=>'application/vdn.orcid+xml' }
+    end
+  end
+end

data/app/services/orcid/profile_lookup_service.rb

@@ -0,0 +1,65 @@
+module Orcid
+  class ProfileLookupService
+    class SearchResponse
+      delegate :fetch, :has_key?, :[], to: :@attributes
+      def initialize(attributes = {})
+        @attributes = attributes.with_indifferent_access
+      end
+      def id
+        @attributes.fetch(:id)
+      end
+
+      def label
+        @attributes.fetch(:label)
+      end
+    end
+
+    def self.call(query, config = {})
+      new(config).call(query)
+    end
+
+    attr_reader :token, :path, :headers, :response_builder
+    def initialize(config = {})
+      @token = config.fetch(:token) { Orcid.client_credentials_token('/read-public') }
+      @response_builder = config.fetch(:response_builder) { SearchResponse }
+      @path = config.fetch(:path) { "v1.1/search/orcid-bio/" }
+      @headers = config.fetch(:headers) {
+        {
+          :accept => 'application/orcid+json',
+          'Content-Type'=>'application/orcid+xml'
+        }
+      }
+    end
+
+    def call(parameters)
+      response = deliver(parameters)
+      parse(response.body)
+    end
+    alias_method :search, :call
+
+    protected
+    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 = orcid_bio.fetch('contact-details').fetch('email').collect {|email| email.fetch('value') }
+        label = "#{given_names} #{family_name}"
+        label << " (" << emails.join(",") << ")" if emails.present?
+        label << " [ORCID: #{identifier}]"
+
+        returning_value << response_builder.new("id" => identifier, "label" => label)
+      end
+    end
+
+  end
+end

data/app/services/orcid/remote_work_service.rb

@@ -0,0 +1,51 @@
+module Orcid
+  class RemoteWorkService
+    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
+
+    # :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 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
+
+    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

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

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<orcid-message xmlns="http://www.orcid.org/ns/orcid"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://raw.github.com/ORCID/ORCID-Source/master/orcid-model/src/main/resources/orcid-message-1.1.xsd">
+<message-version>1.1</message-version>
+<orcid-profile>
+  <orcid-activities>
+    <orcid-works><% works.each do |work| %>
+      <orcid-work>
+        <work-title>
+          <title><%= work.title %></title>
+        </work-title>
+        <work-type><%= work.work_type %></work-type>
+      </orcid-work>
+    <% end %></orcid-works>
+  </orcid-activities>
+</orcid-profile>
+</orcid-message>

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

@@ -0,0 +1,17 @@
+<%= 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 %>
+  <% 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>
+  </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 %>
+      <%= f.collection_radio_buttons :orcid_profile_id, candidates, :id, :label %>
+    <% end %>
+    <%= f.submit %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,9 @@
+<%= simple_form_for profile_request, as: :profile_request, url: orcid.profile_request_path do |f| %>
+  <%= field_set_tag do%>
+    <%= f.input :given_names %>
+    <%= f.input :family_name %>
+    <%= f.input :primary_email %>
+    <%= f.input :primary_email_confirmation %>
+  <% end %>
+  <%= f.submit %>
+<% end %>

data/app/views/orcid/profile_requests/show.html.erb

@@ -0,0 +1,5 @@
+<p><strong>Requestor:</strong> <%= profile_request.user %></p>
+<p><strong>Given names:</strong> <%= profile_request.given_names %></p>
+<p><strong>Family name:</strong> <%= profile_request.family_name %></p>
+<p><strong>Primary email:</strong> <%= profile_request.primary_email %></p>
+<p><strong>ORCID Profile ID:</strong> <%= profile_request.orcid_profile_id %></p>

data/config/locales/orcid.en.yml

@@ -0,0 +1,28 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  orcid:
+    requests:
+      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})."

data/config/routes.rb

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

data/db/migrate/20140205185338_create_orcid_profile_requests.rb

@@ -0,0 +1,12 @@
+class CreateOrcidProfileRequests < ActiveRecord::Migration
+  def change
+    create_table :orcid_profile_requests do |t|
+      t.integer :user_id, unique: true, index: true, null: false
+      t.string :given_names, null: false
+      t.string :family_name, null: false
+      t.string :primary_email, null: false
+      t.string :orcid_profile_id, unique: true, index: true
+      t.timestamps
+    end
+  end
+end

data/lib/orcid.rb

@@ -1,4 +1,72 @@
-require "orcid/engine"
+require 'orcid/engine'
+require 'orcid/configuration'
+require 'orcid/exceptions'
+
+require 'mappy'
+require 'devise_multi_auth'
+require 'virtus'
+require 'omniauth-orcid'
+require 'email_validator'
+require 'simple_form'
 
 module Orcid
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  module_function
+  def configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def provider
+    @provider ||= Configuration::Provider.new
+  end
+
+  def provider_name
+    configuration.provider_name
+  end
+
+  def authentication_model
+    configuration.authentication_model
+  end
+
+
+  def connect_user_and_orcid_profile(user, orcid_profile_id, options = {})
+    authentication_model.create!(provider: provider_name, 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: provider_name, client: client)
+  end
+
+  def profile_for(user)
+    if auth = authentication_model.where(provider: provider_name, user: user).first
+      Orcid::Profile.new(auth.uid)
+    else
+      nil
+    end
+  end
+
+  def enqueue(object)
+    object.run
+  end
+
+  def oauth_client
+    # passing the site: option as Orcid's Sandbox has an invalid certificate
+    # for the api.sandbox-1.orcid.org
+    @oauth_client ||= Devise::MultiAuth.oauth_client_for(
+      provider_name, options: { site: provider.site_url }
+    )
+  end
+
+  def client_credentials_token(scope, options = {})
+    tokenizer = options.fetch(:tokenizer) { oauth_client.client_credentials }
+    tokenizer.get_token(scope: scope)
+  end
+
 end

data/lib/orcid/configuration.rb

@@ -0,0 +1,20 @@
+module Orcid
+  class Configuration
+    attr_reader :store
+    def initialize(store = ::ENV)
+      @store = store
+    end
+
+    attr_writer :provider_name
+    def provider_name
+      @provider_name ||= 'orcid'
+    end
+
+    attr_writer :authentication_model
+    def authentication_model
+      @authentication_model ||= Devise::MultiAuth::Authentication
+    end
+
+  end
+end
+require 'orcid/configuration/provider'

data/lib/orcid/configuration/provider.rb

@@ -0,0 +1,45 @@
+module Orcid
+  class Configuration::Provider
+    attr_reader :store
+    def initialize(store = ::ENV)
+      @store = store
+    end
+
+    attr_writer :authentication_scope
+    def authentication_scope
+      @authentication_scope ||= store.fetch('ORCID_APP_AUTHENTICATION_SCOPE') {
+        "/authenticate,/orcid-works/create,/orcid-works/update,/read-public,/orcid-grants/create"
+      }
+    end
+
+    attr_writer :site_url
+    def site_url
+      @site_url ||= store.fetch('ORCID_SITE_URL') { "http://api.sandbox-1.orcid.org" }
+    end
+
+    attr_writer :token_url
+    def token_url
+      @token_url ||= store.fetch('ORCID_TOKEN_URL') { "https://api.sandbox-1.orcid.org/oauth/token" }
+    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" }
+    end
+
+    attr_writer :authorize_url
+    def authorize_url
+      @authorize_url ||= store.fetch('ORCID_AUTHORIZE_URL') { "https://sandbox-1.orcid.org/oauth/authorize" }
+    end
+
+    attr_writer :id
+    def id
+      @id ||= store.fetch('ORCID_APP_ID')
+    end
+
+    attr_writer :secret
+    def secret
+      @secret ||= store.fetch('ORCID_APP_SECRET')
+    end
+  end
+end

data/lib/orcid/engine.rb

@@ -1,5 +1,19 @@
 module Orcid
   class Engine < ::Rails::Engine
     isolate_namespace Orcid
+
+    initializer 'orcid.initializers' do |app|
+      app.config.paths.add 'app/services', eager_load: true
+      app.config.autoload_paths += %W(
+        #{config.root}/app/services
+      )
+    end
+
+    config.before_initialize do |app|
+      Orcid.configure do |config|
+        config.provider_name = 'orcid'
+      end
+    end
+
   end
 end

data/lib/orcid/exceptions.rb

@@ -0,0 +1,28 @@
+module Orcid
+  # 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]
+        text << "id:\n\t#{client.id.inspect}"
+        text << "site:\n\t#{client.site.inspect}"
+        text << "options:\n\t#{client.options.inspect}"
+      end
+      text << "\n-- Token --"
+      if token = options[:token]
+        text << "access_token:\n\t#{token.token.inspect}"
+        text << "refresh_token:\n\t#{token.refresh_token.inspect}"
+      end
+      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 << "\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"))
+    end
+  end
+end

data/lib/orcid/spec_support.rb

@@ -0,0 +1,54 @@
+require 'rest_client'
+class RequestSandboxAuthorizationCode
+
+  def self.call(options = {}, config = {})
+    new(config).call(options)
+  end
+
+  attr_reader :cookies, :access_scope, :authorize_url, :login_url
+  attr_reader :oauth_redirect_uri, :orcid_client_id, :authorization_code, :orcid_client_secret
+
+  def initialize(options = {})
+    @orcid_client_id = options.fetch(:orcid_client_id) { Orcid.provider.id }
+    @orcid_client_secret = options.fetch(:orcid_client_secret) { Orcid.provider.secret }
+    @login_url = options.fetch(:login_url) { Orcid.provider.signin_via_json_url }
+    @authorize_url = options.fetch(:authorize_url) { Orcid.provider.authorize_url }
+    @oauth_redirect_uri = options.fetch(:oauth_redirect_uri) { 'https://developers.google.com/oauthplayground' }
+    @access_scope = options.fetch(:scope) { Orcid.provider.authentication_scope }
+  end
+
+  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']}
+
+    login_to_orcid(orcid_profile_id, password)
+    request_authorization
+    request_authorization_code
+  end
+
+  attr_writer :cookies
+  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
+      self.cookies = response.cookies
+    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})
+  end
+
+  def request_authorization_code
+    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
+  end
+
+end

data/lib/orcid/version.rb

@@ -1,3 +1,3 @@
 module Orcid
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orcid
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -24,6 +24,104 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: mappy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: devise-multi_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: omniauth-orcid
+  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: virtus
+  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: email_validator
+  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: simple_form
+  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: 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
@@ -38,6 +136,146 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: figaro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Rails engine for orcid.org integration.
 email:
 - jeremy.n.friesen@gmail.com
@@ -48,10 +286,30 @@ files:
 - app/assets/javascripts/orcid/application.js
 - app/assets/stylesheets/orcid/application.css
 - 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/configuration.rb
+- app/models/orcid/profile.rb
+- app/models/orcid/profile_connection.rb
+- app/models/orcid/profile_request.rb
+- app/models/orcid/work.rb
+- app/services/orcid/profile_creation_service.rb
+- app/services/orcid/profile_lookup_service.rb
+- app/services/orcid/remote_work_service.rb
+- app/templates/orcid/work.template.v1.1.xml.erb
 - app/views/layouts/orcid/application.html.erb
+- 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/locales/orcid.en.yml
 - config/routes.rb
+- db/migrate/20140205185338_create_orcid_profile_requests.rb
+- lib/orcid/configuration/provider.rb
+- lib/orcid/configuration.rb
 - lib/orcid/engine.rb
+- lib/orcid/exceptions.rb
+- lib/orcid/spec_support.rb
 - lib/orcid/version.rb
 - lib/orcid.rb
 - lib/tasks/orcid_tasks.rake
@@ -72,9 +330,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14