orcid 0.8.0 → 0.8.1

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

@@ -12,9 +12,7 @@ module Orcid
       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
+        @token = config.fetch(:token) { default_token }
         @path = config.fetch(:path) { 'v1.1/orcid-profile' }
         @headers = config.fetch(:headers) { default_headers }
       end
@@ -56,10 +54,11 @@ module Orcid
       end
 
       def default_headers
-        {
-          'Accept' => 'application/xml',
-          'Content-Type' => 'application/vdn.orcid+xml'
-        }
+        { 'Accept' => 'application/xml', 'Content-Type' => 'application/vdn.orcid+xml' }
+      end
+
+      def default_token
+        Orcid.client_credentials_token('/orcid-profile/create')
       end
     end
   end

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

@@ -35,14 +35,11 @@ module Orcid
       end
 
       def default_headers
-        {
-          :accept => 'application/orcid+json',
-          'Content-Type' => 'application/orcid+xml'
-        }
+        { :accept => 'application/orcid+json', 'Content-Type' => 'application/orcid+xml' }
       end
 
       def issue_callbacks(search_results)
-        if Array(search_results).flatten.compact.any?
+        if Array.wrap(search_results).any?(&:present?)
           callback(:found, search_results)
         else
           callback(:not_found)

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

@@ -2,6 +2,7 @@ require_dependency 'orcid/remote/profile_query_service'
 module Orcid
   module Remote
     class ProfileQueryService
+      # Responsible for parsing a response document
       class ResponseParser
 
         # A convenience method to expose entry into the ResponseParser function
@@ -10,14 +11,10 @@ module Orcid
         end
 
         attr_reader :response_builder, :logger
-
+        private :response_builder, :logger
         def initialize(collaborators = {})
-          @response_builder = collaborators.fetch(:response_builder) do
-            SearchResponse
-          end
-          @logger = collaborators.fetch(:logger) do
-            Rails.logger
-          end
+          @response_builder = collaborators.fetch(:response_builder) { default_response_builder }
+          @logger = collaborators.fetch(:logger) { default_logger }
         end
 
         def call(document)
@@ -47,6 +44,15 @@ module Orcid
             returning_value
           end
         end
+
+        private
+        def default_logger
+          Rails.logger
+        end
+
+        def default_response_builder
+          SearchResponse
+        end
       end
     end
   end

data/db/migrate/20140205185339_update_orcid_profile_requests.rb

@@ -0,0 +1,6 @@
+class UpdateOrcidProfileRequests < ActiveRecord::Migration
+  def change
+    add_column :orcid_profile_requests, :response_text, :text
+    add_column :orcid_profile_requests, :response_status, :string, index: true
+  end
+end

data/lib/orcid.rb

@@ -1,4 +1,4 @@
-require 'orcid/engine'
+require 'orcid/engine' if defined?(Rails)
 require 'orcid/configuration'
 require 'orcid/exceptions'
 require 'figaro'
@@ -87,4 +87,18 @@ module Orcid
     tokenizer = options.fetch(:tokenizer) { oauth_client.client_credentials }
     tokenizer.get_token(scope: scope)
   end
+
+  # 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
 end

data/lib/orcid/engine.rb

@@ -1,20 +1,5 @@
 # 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

data/lib/orcid/exceptions.rb

@@ -1,6 +1,28 @@
 module Orcid
 
-  class ConfigurationError < RuntimeError
+  # Intended to be the base for all exceptions raised by the Orcid gem.
+  class BaseError < RuntimeError
+  end
+
+  class ProfileRequestStateError < BaseError
+    def initialize(user)
+      super("Unexpected Orcid::ProfileRequest state for #{user.class} ID=#{user.to_param}.")
+    end
+  end
+
+  class ProfileRequestMethodExpectedError < BaseError
+    def initialize(request, method_name)
+      super("Expected #{request.inspect} to respond to :#{method_name}.")
+    end
+  end
+
+  class MissingUserForProfileRequest < BaseError
+    def initialize(request)
+      super("#{request.class} ID=#{request.to_param} is not associated with a :user.")
+    end
+  end
+
+  class ConfigurationError < BaseError
     def initialize(key_name)
       super("Unable to find #{key_name.inspect} in configuration storage.")
     end
@@ -8,7 +30,7 @@ module Orcid
 
   # Because in trouble shooting what all goes into this remote call,
   # you may very well want all of this.
-  class RemoteServiceError < RuntimeError
+  class RemoteServiceError < BaseError
     def initialize(options)
       text = []
       text << "-- Client --"

data/lib/orcid/version.rb

@@ -1,3 +1,3 @@
 module Orcid
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/orcid.gemspec

@@ -13,7 +13,11 @@ Gem::Specification.new do |s|
   s.email       = [
     'jeremy.n.friesen@gmail.com'
   ]
-  s.homepage    = 'https://github.com/jeremyf/orcid'
+  s.homepage    = 'https://github.com/projecthydra-labs/orcid'
+  s.metadata    = {
+    'source' => 'https://github.com/projecthydra-labs/orcid',
+    'issue_tracker' => 'https://github.com/projecthydra-labs/orcid/issues'
+  }
   s.summary     = 'A Rails engine for orcid.org integration.'
   s.description = 'A Rails engine for orcid.org integration.'
 

data/spec/controllers/orcid/profile_requests_controller_spec.rb

@@ -96,7 +96,7 @@ module Orcid
 
         it 'should render a profile request form' do
           Orcid::ProfileRequest.should_receive(:find_by_user).with(user).and_return(nil)
-          Orcid.should_receive(:enqueue).with(an_instance_of(Orcid::ProfileRequest))
+          Orcid::ProfileRequestCoordinator.should_receive(:call).with(an_instance_of(Orcid::ProfileRequest))
 
           expect do
             post :create, profile_request: profile_request_attributes, use_route: :orcid
@@ -106,7 +106,7 @@ module Orcid
 
         it 'should handle invalid data' do
           Orcid::ProfileRequest.should_receive(:find_by_user).with(user).and_return(nil)
-          Orcid.should_not_receive(:enqueue)
+          Orcid::ProfileRequestCoordinator.should_not_receive(:call)
 
           expect do
             post :create, profile_request: {}, use_route: :orcid

data/spec/features/non_ui_based_interactions_spec.rb

@@ -21,6 +21,7 @@ describe 'non-UI based interactions' , requires_net_connect: true do
     let(:profile_request) {
       FactoryGirl.create(:orcid_profile_request, user: user, primary_email: email, primary_email_confirmation: email)
     }
+    let(:profile_request_coordinator) { Orcid::ProfileRequestCoordinator.new(profile_request)}
 
     before(:each) do
       # Making sure things are properly setup
@@ -28,7 +29,8 @@ describe 'non-UI based interactions' , requires_net_connect: true do
     end
 
     it 'creates a profile' do
-      profile_request.run
+      profile_request_coordinator.call
+      profile_request.reload
 
       orcid_profile_id = profile_request.orcid_profile_id
 

data/spec/features/orcid_work_query_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'orcid work query', requires_net_connect: true do
+  around(:each) do |example|
+    WebMock.allow_net_connect!
+    example.run
+    WebMock.disable_net_connect!
+  end
+  Given(:token) { Orcid.client_credentials_token('/read-public') }
+
+  # This profile exists on the Sandbox. But for how long? Who knows.
+  Given(:orcid_profile_id) { '0000-0002-1117-8571' }
+  Given(:remote_work_service) { Orcid::Remote::WorkService.new(orcid_profile_id, method: :get, token: token) }
+  Given(:remote_work_document) { remote_work_service.call }
+  When(:works) { Orcid::Work::XmlParser.call(remote_work_document) }
+  Then { expect(works.size).to_not be 0 }
+end

data/spec/lib/orcid/exceptions_spec.rb

@@ -0,0 +1,33 @@
+require 'fast_helper'
+require 'orcid/exceptions'
+
+module Orcid
+  describe BaseError do
+    it { should be_a_kind_of RuntimeError }
+  end
+
+  describe ProfileRequestStateError do
+    subject { described_class }
+    its(:superclass) { should be BaseError }
+  end
+
+  describe MissingUserForProfileRequest do
+    subject { described_class }
+    its(:superclass) { should be BaseError }
+  end
+
+  describe ConfigurationError do
+    subject { described_class }
+    its(:superclass) { should be BaseError }
+  end
+
+  describe RemoteServiceError do
+    subject { described_class }
+    its(:superclass) { should be BaseError }
+  end
+
+  describe ProfileRequestMethodExpectedError do
+    subject { described_class }
+    its(:superclass) { should be BaseError }
+  end
+end

data/spec/lib/orcid_spec.rb

@@ -8,6 +8,7 @@ describe Orcid do
   its(:provider) { should respond_to :secret }
   its(:mapper) { should respond_to :map }
   its(:use_relative_model_naming?) { should eq true }
+  its(:table_name_prefix) { should be_an_instance_of String }
 
   context '.authentication_model' do
     subject { Orcid.authentication_model }

data/spec/models/orcid/profile_connection_spec.rb

@@ -1,19 +1,23 @@
-require 'spec_helper'
+require 'fast_helper'
+require 'orcid/profile_connection'
 
 # :nodoc:
 module Orcid
   describe ProfileConnection do
     let(:email) { 'test@hello.com' }
     let(:dois) { '123' }
-    let(:user) { FactoryGirl.build_stubbed(:user) }
+    let(:user) { double('User') }
     let(:profile_query_service) { double('Profile Lookup Service') }
+    let(:persister) { double('Persister') }
 
     subject do
       Orcid::ProfileConnection.new(email: email, user: user).tap do |pc|
+        pc.persister = persister
         pc.profile_query_service = profile_query_service
       end
     end
 
+    its(:default_persister) { should respond_to(:call) }
     its(:email) { should eq email }
     its(:to_model) { should eq subject }
     its(:user) { should eq user }
@@ -53,7 +57,6 @@ module Orcid
 
     context '#save' do
       let(:orcid_profile_id) { '1234-5678' }
-      let(:persister) { double('Persister') }
 
       it 'should call the persister when valid' do
         subject.orcid_profile_id = orcid_profile_id
@@ -61,15 +64,14 @@ module Orcid
           with(user, orcid_profile_id).
           and_return(:persisted)
 
-        expect(subject.save(persister: persister)).to eq(:persisted)
+        expect(subject.save).to eq(:persisted)
       end
 
       it 'should NOT call the persister and add errors when not valid' do
         subject.user = nil
         subject.orcid_profile_id = nil
 
-        expect { subject.save(persister: persister) }.
-          to change { subject.errors.count }.by(2)
+        expect { subject.save }.to change { subject.errors.count }.by(2)
       end
     end
 

data/spec/models/orcid/profile_request_spec.rb

@@ -27,104 +27,22 @@ module Orcid
 
     end
 
-    context '#handle_profile_creation_response' do
-      it 'should update local' do
+    context '#successful_profile_creation' do
+      it 'should update profile request' do
         # Don't want to hit the database
         subject.should_receive(:update_column).with(:orcid_profile_id, orcid_profile_id)
         Orcid.should_receive(:connect_user_and_orcid_profile).with(user, orcid_profile_id)
 
-        subject.handle_profile_creation_response(orcid_profile_id)
+        subject.successful_profile_creation(orcid_profile_id)
       end
     end
 
-    context '#xml_payload' do
-      it 'should be a parsable XML document' do
-        expect {
-          ActiveSupport::XmlMini.parse(subject.xml_payload)
-        }.to_not raise_error
-      end
-    end
-
-    context '#validate_before_run' do
-      let(:orcid_profile) { double('Orcid Profile', to_param: orcid_profile_id) }
-
-      context 'when no orcid profile has been assigned' do
-        before { Orcid.should_receive(:profile_for).with(user).and_return(nil) }
-        it 'should return true' do
-          expect(subject.validate_before_run).to eq(true)
-        end
-      end
-
-      context 'orcid_profile_id is set' do
-        before { subject.orcid_profile_id = orcid_profile_id }
-
-        it 'should return false' do
-          expect(subject.validate_before_run).to eq(false)
-        end
-
-        it 'should set an error' do
-          expect {
-            subject.validate_before_run
-          }.to change { subject.errors.full_messages.count }.by(1)
-        end
-
-      end
-
-      context 'user has an orcid_profile' do
-        before { Orcid.should_receive(:profile_for).with(user).and_return(orcid_profile) }
-
-        it 'should return false' do
-          expect(subject.validate_before_run).to eq(false)
-        end
-
-        it 'should set an error' do
-          expect {
-            subject.validate_before_run
-          }.to change { subject.errors.full_messages.count }.by(1)
-        end
-
-      end
-    end
-
-    context '#run' do
-      let(:profile_creation_service) { double('Profile Creation Service') }
-      let(:payload_xml_builder) { double('Payload Xml Builder') }
-      let(:validator) { double('Submission Guardian') }
-      let(:xml_payload) { double('Xml Payload') }
-
-      context 'with the submission guardian permitting the request' do
-        before(:each) do
-          validator.should_receive(:call).with(subject).
-            and_return(true)
-          payload_xml_builder.should_receive(:call).with(subject.attributes).
-            and_return(xml_payload)
-          profile_creation_service.should_receive(:call).with(xml_payload).
-            and_return(orcid_profile_id)
-        end
-
-        it 'should run a request and handle the response' do
-          subject.run(
-            payload_xml_builder: payload_xml_builder,
-            profile_creation_service: profile_creation_service,
-            validator: validator
-          )
-        end
-      end
-
-      context 'with the submission guardian returning false' do
-        before(:each) do
-          validator.should_receive(:call).with(subject).
-            and_return(false)
-          payload_xml_builder.should_not_receive(:call)
-        end
-
-        it 'should raise an exception' do
-          subject.run(
-            payload_xml_builder: payload_xml_builder,
-            profile_creation_service: profile_creation_service,
-            validator: validator
-          )
-        end
+    context '#validation_error_on_profile_creation' do
+      it 'should update profile request' do
+        error_message = '123'
+        # Don't want to hit the database
+        subject.should_receive(:update_column).with(:response_text, error_message)
+        subject.validation_error_on_profile_creation(error_message)
       end
     end
   end