orcid 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be9ad04a8c327b62e782d442e012920e824e3054
-  data.tar.gz: fad8d6daf69492a8cf851257e8879562f6219876
+  metadata.gz: c138546f55044cf0a5a24bc027071c4a825f9aa5
+  data.tar.gz: e376ae1a6e011f2c74ef68c12c4aceede22240e4
 SHA512:
-  metadata.gz: 8ddfbeef40f5ec7c9a810f4ecea25b6d8b968e6e36c7a70b2454728e40c6d13e312e8eb12136b9b3dcfa769a91d3302e66b4a3015b2ec6da6ae19666897428e1
-  data.tar.gz: c734a55b50001f919d674b2f70c9f7dd7e2f12b413b1b6c44c00f27f3507296a5ef9c6a6319d8fb94508d9d76996287ca4ac9e9cac0223c6ba27149d811d6b38
+  metadata.gz: d8ca33ed888b474c53ca7d36ec9a9b73e3449fbe285ca19ac2a1fd92a2b10255c7eb108231b130b6970ceeffde234880d39fb78756641acb10f6a28c36c74bf8
+  data.tar.gz: 2e690ffa69dd81e14ec8ae6820289789781c8f5d3ff8960bc2d79bf4898e3d94573414504612190e8bf73016daaea1a1f69783e699979a8925a07f550c6ce5e6

data/Gemfile

@@ -12,4 +12,7 @@ gemspec
 
 # To use debugger
 # gem 'debugger'
-gem 'coveralls', require: false
+gem 'coveralls', require: false
+gem 'execjs'
+gem 'therubyracer', platforms: :ruby
+gem 'byebug', require: false

data/README.md

@@ -69,6 +69,23 @@ $ rails generate orcid:install
 
 *Note: It will prompt you for your Orcid application secrets.*
 
+
+### Caveat
+
+You will also need to **update your devise configuration** in your routes.
+
+From something like this:
+
+```ruby
+devise_for :users
+```
+
+To:
+
+```ruby
+devise_for :users, controllers: { omniauth_callbacks: 'devise/multi_auth/omniauth_callbacks' }
+```
+
 You may find it helpful to review the help text, as there are a few options for the generator.
 
 ```console
@@ -156,6 +173,23 @@ Run the online tests with
 $ rake spec:online
 ```
 
+### Running ALL of the Tests
+
+Not all of the tests run. There are a few very long running tests that run.
+
+```console
+$ ORCID_APP_ID=<YOUR ORCID APP ID> \
+  ORCID_APP_SECRET=<YOUR ORCID APP SECRET> \
+  MAILINATOR_API_KEY=<YOUR MAILINATOR KEY> \
+  ORCID_CLAIMED_PROFILE_ID=<AN ORCID PROFILE YOUR APP HAS ALREADY CLAIMED> \
+  ORCID_CLAIMED_PROFILE_PASSWORD=<THE PASSWORD FOR THE ALREADY CLAIMED ORCID> \
+  bundle exec rake spec:jenkins
+```
+
+By setting all of the above environment variables, you will run tests that will:
+
+* Create an Orcid, then claim it, and authenticate with your application via ORCID
+
 ## Versioning
 
 **Orcid** uses [Semantic Versioning 2.0.0](http://semver.org/)

data/Rakefile

@@ -21,6 +21,7 @@ namespace :spec do
   RSpec::Core::RakeTask.new(:all) do
     ENV['COVERAGE'] = 'true'
   end
+
   desc 'Only run specs that do not require net connect'
   RSpec::Core::RakeTask.new(:offline) do |t|
     t.rspec_opts = '--tag ~requires_net_connect'
@@ -31,6 +32,15 @@ namespace :spec do
     t.rspec_opts = '--tag requires_net_connect'
   end
 
+  desc 'Run the Jenkins CI specs'
+  task :jenkins 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:all'].invoke
+  end
+
   desc 'Run the Travis CI specs'
   task :travis do
     ENV['RAILS_ENV'] = 'test'

data/config/application.yml.example

@@ -12,4 +12,3 @@ ORCID_APP_SECRET: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
 
 ORCID_CLAIMED_PROFILE_ID: 0000-0000-0000-0000
 ORCID_CLAIMED_PROFILE_PASSWORD: password1A
-ORCID_CLAIMED_PROFILE_EMAIL: cwksfxyqkmrudrfrdxvlzjxl@mailinator.com

data/lib/orcid/configuration/provider.rb

@@ -17,7 +17,7 @@ module Orcid
       def authentication_scope
         @authentication_scope ||=
         store.fetch('ORCID_APP_AUTHENTICATION_SCOPE') do
-          '/authenticate /orcid-works/create /orcid-works/update /read-public'
+          '/authenticate /orcid-works/create /orcid-works/update'
         end
       end
 

data/lib/orcid/spec_support.rb

@@ -1,12 +1,16 @@
 require 'rest_client'
+
+# This follows the instructions from:
+# http://support.orcid.org/knowledgebase/articles/179969-methods-to-generate-an-access-token-for-testing#curl
 class RequestSandboxAuthorizationCode
 
-  def self.call(options = {}, config = {})
-    new(config).call(options)
+  def self.call(options = {})
+    new(options).call
   end
 
   attr_reader :cookies, :access_scope, :authorize_url, :login_url
   attr_reader :oauth_redirect_uri, :orcid_client_id, :authorization_code, :orcid_client_secret
+  attr_reader :orcid_profile_id, :password
 
   def initialize(options = {})
     @orcid_client_id = options.fetch(:orcid_client_id) { Orcid.provider.id }
@@ -15,13 +19,13 @@ class RequestSandboxAuthorizationCode
     @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 }
+    @orcid_profile_id = options.fetch(:orcid_profile_id) { ENV['ORCID_CLAIMED_PROFILE_ID'] }
+    @password = options.fetch(:password) { ENV['ORCID_CLAIMED_PROFILE_PASSWORD'] }
   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)
+  def call
+    puts "Attempting to login to orcid { PROFILE_ID: '#{orcid_profile_id}', PASSWORD: '#{password}' }"
+    login_to_orcid
     request_authorization
     request_authorization_code
   end
@@ -31,10 +35,19 @@ class RequestSandboxAuthorizationCode
 
   private
 
-  def login_to_orcid(orcid_profile_id, password)
-    response = RestClient.post(
-      login_url, userId: orcid_profile_id, password: password
-    )
+  def custom_authorization_url
+    authorize_url.sub('oauth/authorize', 'oauth/custom/authorize.json')
+  end
+
+  def resource_options
+    { ssl_version: :SSLv23 }.tap {|options|
+      options[:headers] = { cookies: cookies } if cookies
+    }
+  end
+
+  def login_to_orcid
+    resource = RestClient::Resource.new(login_url, resource_options)
+    response = resource.post({ userId: orcid_profile_id, password: password })
     if JSON.parse(response)['success']
       self.cookies = response.cookies
     else
@@ -49,16 +62,70 @@ class RequestSandboxAuthorizationCode
       scope: access_scope,
       redirect_uri: oauth_redirect_uri
     }
-    RestClient.get(authorize_url, { params: parameters, cookies: cookies })
+    resource = RestClient::Resource.new("#{authorize_url}?#{parameters.to_query}", resource_options)
+    response = resource.get
+    response
   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))
+    options = resource_options
+    options[:headers] ||= {}
+    options[:headers][:content_type] = :json
+    options[:headers][:accept] = :json
+    resource = RestClient::Resource.new(custom_authorization_url, options)
+    response = resource.post(authorization_code_payload.to_json)
+    json = JSON.parse(response)
+    redirected_to = json.fetch('redirectUri').fetch('value')
+    uri = URI.parse(redirected_to)
     CGI.parse(uri.query).fetch('code').first
+  rescue RestClient::Exception => e
+    File.open("/Users/jfriesen/Desktop/orcid.html", 'w+') {|f| f.puts e.response.body.force_encoding('UTF-8') }
+    $stderr.puts "Response Code: #{e.response.code}\n\tCookies: #{cookies.inspect}\n\tAuthorizeURL: #{authorize_url.inspect}"
+    raise e
+  end
+
+  def authorization_code_payload
+    {
+      "errors" => [],
+      "userName" => {
+        "errors" => [],
+        "value" => "",
+        "required" => true,
+        "getRequiredMessage" => nil
+      },
+      "password" => {
+        "errors" => [],
+        "value" => "",
+        "required" => true,
+        "getRequiredMessage" => nil
+      },
+      "clientId" => {
+        "errors" => [],
+        "value" => "#{orcid_client_id}",
+        "required" => true,
+        "getRequiredMessage" => nil
+      },
+      "redirectUri" => {
+        "errors" => [],
+        "value" => "=#{URI.escape(oauth_redirect_uri)}",
+        "required" => true,
+        "getRequiredMessage" => nil
+      },
+      "scope" => {
+        "errors" => [],
+        "value" => "#{access_scope}",
+        "required" => true,
+        "getRequiredMessage" => nil
+      },
+      "responseType" => {
+        "errors" => [],
+        "value" => "code",
+        "required" => true,
+        "getRequiredMessage" => nil
+      },
+      "approved" => true,
+      "persistentTokenEnabled" => false
+    }
   end
 
 end

data/lib/orcid/version.rb

@@ -1,3 +1,3 @@
 module Orcid
-  VERSION = '0.8.2'
+  VERSION = '0.8.3'
 end

data/orcid.gemspec

@@ -31,10 +31,10 @@ Gem::Specification.new do |s|
   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 'devise-multi_auth', '~> 0.1'
   s.add_dependency 'omniauth-orcid'
+  s.add_dependency 'mappy'
   s.add_dependency 'virtus'
   s.add_dependency 'email_validator'
   s.add_dependency 'simple_form'

data/spec/features/non_ui_based_interactions_spec.rb

@@ -28,23 +28,25 @@ describe 'non-UI based interactions' , requires_net_connect: true do
       expect(profile_request.orcid_profile_id).to be_nil
     end
 
-    it 'creates a profile' do
-      profile_request_coordinator.call
-      profile_request.reload
+    if ENV['MAILINATOR_API_KEY']
+      it 'creates a profile' do
+        profile_request_coordinator.call
+        profile_request.reload
 
-      orcid_profile_id = profile_request.orcid_profile_id
+        orcid_profile_id = profile_request.orcid_profile_id
 
-      expect(orcid_profile_id).to match(/\w{4}-\w{4}-\w{4}-\w{4}/)
+        expect(orcid_profile_id).to match(/\w{4}-\w{4}-\w{4}-\w{4}/)
 
-      claim_the_orcid!(random_valid_email_prefix)
+        claim_the_orcid!(random_valid_email_prefix)
 
-      authenticate_the_orcid!(orcid_profile_id, orcid_profile_password)
+        authenticate_the_orcid!(orcid_profile_id, orcid_profile_password)
 
-      orcid_profile = Orcid::Profile.new(orcid_profile_id)
+        orcid_profile = Orcid::Profile.new(orcid_profile_id)
 
-      orcid_profile.append_new_work(work)
+        orcid_profile.append_new_work(work)
 
-      expect(orcid_profile.remote_works(force: true).count).to eq(1)
+        expect(orcid_profile.remote_works(force: true).count).to eq(1)
+      end
     end
 
   end
@@ -55,11 +57,11 @@ describe 'non-UI based interactions' , requires_net_connect: true do
 
     before(:each) do
       expect(work).to be_valid
-      authenticate_the_orcid!(orcid_profile_id, orcid_profile_password)
     end
 
     subject { Orcid::Profile.new(orcid_profile_id) }
     it 'should increment orcid works' do
+      authenticate_the_orcid!(orcid_profile_id, orcid_profile_password)
       replacement_work = Orcid::Work.new(title: "Test Driven Orcid Integration", work_type: 'test')
       appended_work = Orcid::Work.new(title: "Another Test Drive", work_type: 'test')
 
@@ -80,32 +82,41 @@ describe 'non-UI based interactions' , requires_net_connect: true do
     Devise::MultiAuth::CaptureSuccessfulExternalAuthentication.call(user, normalized_token)
   end
 
-  # Achtung, this is going to be fragile
   def claim_the_orcid!(email_prefix)
-    Capybara.current_driver = :webkit
-    Capybara.app_host = 'http://mailinator.com'
-    Capybara.run_server = false
+    $stdout.puts "Claiming an ORCID. This could take a while."
+    api_token = ENV.fetch('MAILINATOR_API_KEY')
 
-    sleep(2) # Because Orcid may not have delivered the mail just yet
-
-    visit("/inbox.jsp?to=#{email_prefix}")
-    sleep(2) # Because mailinator might be slow
-    begin
-      page.find('#mailcontainer a').click
-    rescue Capybara::ElementNotFound => e
-      filename = Rails.root.join('tmp/claim_orcid_failure.png')
-      page.save_screenshot(filename, full: true)
-      `open #{filename}`
-      raise e
+    mailbox_uri = "https://api.mailinator.com/api/inbox?to=#{email_prefix}&token=#{api_token}"
+
+    orcid_messages = []
+    mailinator_requests(mailbox_uri) do |response|
+      orcid_messages = response['messages'].select {|m| m['from'] =~ /\.orcid\.org\Z/ }
+      !!orcid_messages.first
     end
 
-    sleep(2) # Because mailinator might be slow
-    href = page.all('.mailview a').collect { |a| a[:href] }.find {|href| href = /\/claim\//}
+    orcid_message = orcid_messages.first
+    raise "Unable to retrieve email for #{email_prefix}@mailinator.com" unless orcid_message
+
+    message_uri = "https://api.mailinator.com/api/email?msgid=#{orcid_message.fetch('id')}&token=#{api_token}"
+    claim_uri = nil
+    mailinator_requests(message_uri) do |response|
+      bodies = response.fetch('data').fetch('parts').map { |part| part.fetch('body') }
+      bodies.each do |body|
+        if body =~ %r{(https://sandbox.orcid.org/claim/[\w\?=]+)}
+          claim_uri = $1.strip
+          break
+        end
+      end
+      claim_uri
+    end
 
-    uri = URI.parse(href)
+    # I have the href for the claim
+    uri = URI.parse(claim_uri)
+    Capybara.current_driver = :webkit
+    Capybara.run_server = false
     Capybara.app_host = "#{uri.scheme}://#{uri.host}"
 
-    visit(uri.path)
+    visit("#{uri.path}?#{uri.query}")
     page.all('input').each do |input|
       case input[:name]
       when 'password' then input.set(orcid_profile_password)
@@ -114,6 +125,28 @@ describe 'non-UI based interactions' , requires_net_connect: true do
       end
     end
     page.all('button').find {|i| i.text == 'Claim' }.click
-    sleep(2) # Because claiming your orcid could be slowe
+    sleep(5) # Because claiming your orcid could be slow
+  end
+
+  def mailinator_requests(uri)
+    base_sleep_duration = ENV.fetch('MAILINATOR_SECONDS_TO_RETRY', 120).to_i
+    retry_attempts = ENV.fetch('MAILINATOR_RETRY_ATTEMPTS', 6).to_i
+    (0...retry_attempts).each do |attempt|
+      sleep_duration = base_sleep_duration * (attempt +1)
+      $stdout.print "\n=-=-= Connecting to Mailinator. Attempt #{attempt+1}\n\tWaiting #{sleep_duration} seconds to connect: "
+      $stdout.flush
+      (0...sleep_duration).each do |second|
+        $stdout.print 'z' if (second % 5 == 0)
+        $stdout.flush
+        sleep(1)
+      end
+      resource = RestClient::Resource.new(uri, ssl_version: :SSLv23)
+      response = JSON.parse(resource.get(format: :json))
+      if yield(response)
+        $stdout.print "\n=-=-= Success on attempt #{attempt+1}. Moving on."
+        $stdout.flush
+        break
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orcid
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ 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: figaro
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: omniauth-orcid
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mappy
+  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