orcid_client 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54f06cf497dfe171a49f47fde54c1e48ea99d23e
+  data.tar.gz: 080aa75e6d0fe7f21caf5bba3989089a942f7028
+SHA512:
+  metadata.gz: ff5f961def7bff03bcee0d545eba8239866ed41a3f35ea7ca575764b611f859cc0d237588bf30c12333c57b6da9039a25a8f000d8bd9c91a9aecd6fa48b86ffe
+  data.tar.gz: 0e92bcefad358d649f24df1807f36c9bb4b210ad9a259c321f683b3ce3dc70b6635d17de6d2f328d04e817f7d84a956cb3a3c99f4e025db8d7b246d597b58ff8

data/.env.example

@@ -0,0 +1,10 @@
+ORCID_API_URL=
+
+# needed to post works
+ACCESS_TOKEN=
+
+
+# needed to post notifications
+ORCID_CLIENT_ID=
+ORCID_CLIENT_SECRET=
+NOTIFICATION_ACCESS_TOKEN=

data/.gitignore

@@ -0,0 +1,42 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+coverage/
+
+.env
+.env.*
+!.env.example
+!.env.travis

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+- 2.3.1
+install:
+- travis_retry bundle install
+script: bundle exec rspec
+notifications:
+  slack: "$SLACK_TOKEN"
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: KZGdqCgmlAGQveK/b/bRSvUIO9wTlCUFngbmKLDHS9tf2gczBYNY3qnzD6GPJ7T12YFudWLH3W8D9CbRN6WyauwseKm+dRYVaeEg+tURobVD8FZgJBEaTnFr1EJNvb8x+iKxYjhV2XgCJHD6t7xbz+ONRVc71CrOi3qtVSRJKML2QocaUlgW+b6a7kMDT5/HtjOHipGf5MCXej+tlK1FESMYG5oNB/ogfbeDR928BCH7Kr4qtvndeF1QHwe5u4mD8UaVBPZNhm2ldEmxiI5+50B/BIjvX5afo0MPiWIJg+A3GlMpdQk4ETAxoT4WPyHYB4pjc2EwnEx9P7k1Zi/64oj+aAAwFlRw0Tof7GQ+zsFLtRSBGtKrWcmRU80iid0ATt+ZFBBNxZ8VDLRstm83wk5TShMPo2qil3eqvNzcvbbE4AwWdTDoky8Ipzto90RSFO1F2+8iLLC1+FLjKEwYakqdNhUz9ur2eVWWJFf2PHFpMDVDH907sRjFs2JaM81KJF4xuryPOlcvEFU/wlv42lSZ3oQPYH4TgV9PDYdcsFhmJkIIMb+RqAYn7PQYzwHUpEhklg0KaOns9hGi1V/iBE2X3Gy01QNITMtfSfIRGfHiFXEoHrXy7K9cZ0Zq2U7iaGsrQRAiv3zzz0FJ+uYH9nLXAC9U9UOUkqdGDNfbrl0=
+  gem: orcid_client
+  on:
+    tags: true
+    repo: datacite/orcid_client

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-github.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    orcid_client (0.1)
+      activesupport (~> 4.2, >= 4.2.5)
+      builder (~> 3.2, >= 3.2.2)
+      dotenv (~> 2.1, >= 2.1.1)
+      maremma (~> 2.5)
+      namae (~> 0.10.1)
+      nokogiri (~> 1.6.8)
+      sanitize (~> 4.0, >= 4.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    builder (3.2.2)
+    codeclimate-test-reporter (1.0.3)
+      simplecov
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.2)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    dotenv (2.1.1)
+    excon (0.45.4)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-encoding (0.0.4)
+      faraday
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    maremma (2.5.3)
+      activesupport (~> 4.2, >= 4.2.5)
+      builder (~> 3.2, >= 3.2.2)
+      excon (~> 0.45.0)
+      faraday (~> 0.9.2)
+      faraday-encoding (~> 0.0.1)
+      faraday_middleware (~> 0.10.0)
+      multi_json (~> 1.11.2)
+      nokogiri (~> 1.6.7)
+      oj (~> 2.13.1)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
+    multi_json (1.11.3)
+    multipart-post (2.0.0)
+    namae (0.10.2)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    nokogumbo (1.4.10)
+      nokogiri
+    oj (2.13.1)
+    public_suffix (2.0.4)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (11.3.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    sanitize (4.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.4.4)
+      nokogumbo (~> 1.4.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  codeclimate-test-reporter (~> 1.0.0)
+  orcid_client!
+  rack-test (~> 0)
+  rake
+  rspec (~> 3.4)
+  simplecov
+  vcr
+  webmock (~> 1.22, >= 1.22.3)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 DataCite
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Ruby client for ORCID API
+
+[![Gem Version](https://badge.fury.io/rb/orcid_client.svg)](https://badge.fury.io/rb/orcid_client)
+[![Build Status](https://travis-ci.org/datacite/orcid_client.svg?branch=master)](https://travis-ci.org/datacite/orcid_client)
+[![Test Coverage](https://codeclimate.com/github/datacite/orcid_client/badges/coverage.svg)](https://codeclimate.com/github/datacite/orcid_client/coverage)
+[![Code Climate](https://codeclimate.com/github/datacite/orcid_client/badges/gpa.svg)](https://codeclimate.com/github/datacite/orcid_client)
+
+Ruby gem for integrating Ruby applications with the ORCID API.
+
+## Features
+
+The following functionality is supported:
+
+* get all works from an ORCID record, including those set to limited access
+* create work in an ORCID record
+* create notification for an ORCID record (needs special permissions)
+
+## Requirements
+
+* [ORCID membership](https://orcid.org/about/membership), needed to create, update or delete content via the ORCID API
+* valid access tokens for ORCID user accounts, collected and safely stored in your application using for example the [omniauth-orcid](https://github.com/datacite/omniauth-orcid) gem.
+
+## Installation
+
+The usual way with Bundler: add the following to your `Gemfile` to install the current version of the gem:
+
+```ruby
+gem 'orcid_client'
+```
+
+Then run `bundle install` to install into your environment.
+
+You can also install the gem system-wide in the usual way:
+
+```bash
+gem install orcid_client
+```
+
+## Use
+
+TBD.
+
+## License
+
+[MIT](license.md)

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+
+# Get useful helper tasks from Bundler
+require "bundler/gem_tasks"
+

data/lib/orcid_client.rb

@@ -0,0 +1,3 @@
+require "orcid_client/work"
+require "orcid_client/notification"
+require "orcid_client/version"

data/lib/orcid_client/api.rb

@@ -0,0 +1,75 @@
+require "uri"
+
+module OrcidClient
+  module Api
+    API_VERSION = "2.0_rc3"
+
+    def get_works(options={})
+      return { "errors" => [{ "title" => "Access token missing" }] } unless access_token.present?
+
+      orcid_api_url = options[:sandbox] ? 'https://api.sandbox.orcid.org' : 'https://api.orcid.org'
+
+      url = "#{orcid_api_url}/v#{API_VERSION}/#{orcid}/works"
+      Maremma.get(url, accept: 'json', bearer: access_token)
+    end
+
+    def create_work(options={})
+      return { "errors" => [{ "title" => "Access token missing" }] } unless access_token.present?
+
+      orcid_api_url = options[:sandbox] ? 'https://api.sandbox.orcid.org' : 'https://api.orcid.org'
+
+      url = "#{orcid_api_url}/v#{API_VERSION}/#{orcid}/work"
+      response = Maremma.post(url, content_type: 'application/vnd.orcid+xml', data: data, bearer: access_token)
+      put_code = response.fetch("headers", {}).fetch("Location", "").split("/").last
+      response.merge("put_code" => put_code)
+    end
+
+    def update_work(options={})
+      return { "errors" => [{ "title" => "Access token missing" }] } unless access_token.present?
+      return { "errors" => [{ "title" => "Put code missing" }] } unless put_code.present?
+
+      orcid_api_url = options[:sandbox] ? 'https://api.sandbox.orcid.org' : 'https://api.orcid.org'
+
+      url = "#{orcid_api_url}/v#{API_VERSION}/#{orcid}/work/#{put_code}"
+      response = Maremma.put(url, content_type: 'application/vnd.orcid+xml', data: data, bearer: access_token)
+      put_code = response.fetch("headers", {}).fetch("Location", "").split("/").last
+      response.merge("put_code" => put_code)
+    end
+
+    def delete_work(options={})
+      return { "errors" => [{ "title" => "Access token missing" }] } unless access_token.present?
+      return { "errors" => [{ "title" => "Put code missing" }] } unless put_code.present?
+
+      orcid_api_url = options[:sandbox] ? 'https://api.sandbox.orcid.org' : 'https://api.orcid.org'
+
+      url = "#{orcid_api_url}/v#{API_VERSION}/#{orcid}/work/#{put_code}"
+      response = Maremma.delete(url, content_type: 'application/vnd.orcid+xml', bearer: access_token)
+      put_code = response.fetch("headers", {}).fetch("Location", "").split("/").last
+      response.merge("put_code" => put_code)
+    end
+
+    def get_notification_access_token(client_id:, client_secret:, **options)
+      orcid_api_url = options[:sandbox] ? 'https://api.sandbox.orcid.org' : 'https://api.orcid.org'
+
+      params = { 'client_id' => client_id,
+                 'client_secret' => client_secret,
+                 'scope' => '/premium-notification',
+                 'grant_type' => 'client_credentials' }
+
+      url = "#{orcid_api_url}/oauth/token"
+      data = URI.encode_www_form(params)
+      Maremma.post(url, content_type: 'application/x-www-form-urlencoded', data: data, accept: 'application/json')
+    end
+
+    def create_notification(options={})
+      return { "errors" => [{ "title" => "Notification access token missing" }] } unless notification_access_token.present?
+
+      orcid_api_url = options[:sandbox] ? 'https://api.sandbox.orcid.org' : 'https://api.orcid.org'
+
+      url = "#{orcid_api_url}/v#{API_VERSION}/#{orcid}/notification-permission"
+      response = Maremma.post(url, content_type: 'application/vnd.orcid+xml', data: data, bearer: notification_access_token)
+      put_code = response.fetch("headers", {}).fetch("Location", "").split("/").last
+      response.merge("put_code" => put_code)
+    end
+  end
+end

data/lib/orcid_client/author.rb

@@ -0,0 +1,56 @@
+require 'namae'
+
+module OrcidClient
+  module Author
+    # parse author string into CSL format
+    def get_one_author(author)
+      return "" if author.blank?
+
+      names = Namae.parse(author)
+      if names.present?
+        name = names.first
+
+        { "family" => name.family,
+          "given" => name.given }.compact
+      else
+        { "literal" => author }
+      end
+    end
+
+    # parse array of author strings into CSL format
+    def get_authors(authors)
+      Array(authors).map { |author| get_one_author(author) }
+    end
+
+    # parse array of author hashes into CSL format
+    def get_hashed_authors(authors)
+      Array(authors).map { |author| get_one_hashed_author(author) }
+    end
+
+    def get_one_hashed_author(author)
+      raw_name = author.fetch("creatorName", nil)
+
+      author_hsh = get_one_author(raw_name)
+      author_hsh["ORCID"] = get_name_identifier(author)
+      author_hsh.compact
+    end
+
+    def get_name_identifier(author)
+      name_identifier = author.fetch("nameIdentifier", nil)
+      name_identifier_scheme = author.fetch("nameIdentifierScheme", "orcid").downcase
+      if name_identifier.present? && name_identifier_scheme == "orcid"
+        "http://orcid.org/#{name_identifier}"
+      else
+        nil
+      end
+    end
+
+    def get_credit_name(author)
+      [author['given'], author['family']].compact.join(' ').presence || author['literal']
+    end
+
+    def get_full_name(author)
+      [author['family'], author['given']].compact.join(', ')
+    end
+  end
+end

data/lib/orcid_client/base.rb

@@ -0,0 +1,21 @@
+module OrcidClient
+  module Base
+    # load ENV variables from .env file if it exists
+    env_file = File.expand_path("../../../.env", __FILE__)
+    if File.exist?(env_file)
+      require 'dotenv'
+      Dotenv.load! env_file
+    end
+
+    # load ENV variables from container environment if json file exists
+    # see https://github.com/phusion/baseimage-docker#envvar_dumps
+    env_json_file = "/etc/container_environment.json"
+    if File.exist?(env_json_file)
+      env_vars = JSON.parse(File.read(env_json_file))
+      env_vars.each { |k, v| ENV[k] = v }
+    end
+
+    # default values for some ENV variables
+    ENV['ORCID_API_URL'] ||= "https://api.sandbox.orcid.org"
+  end
+end