Merge pull request #620 from datacite/add-unpaywall

Add contentUrl to GraphQL API, using information from Unpaywall for Crossref DOIs

app/graphql/resolvers/base.rb

@@ -0,0 +1,5 @@
+module Resolvers
+  class Base < GraphQL::Schema::Resolver
+
+  end
+end

app/graphql/resolvers/content_url.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class ContentUrl < Resolvers::Base
+  type Url, null: false
+
+  def resolve
+    # Use Unpaywall API if DOI is from Crossref
+    # This will be a future feature in the DataCite metadata schema
+    return nil if object.agency != "crossref"
+
+    url = "https://api.unpaywall.org/v2/#{object.doi}[email protected]"
+    response = Maremma.get(url)
+    return nil if response.status != 200
+
+    response.body.dig("data", "best_oa_location", "url")
+  end
+end

app/graphql/schema.graphql

@@ -135,6 +135,11 @@ type Audiovisual implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -426,6 +431,11 @@ type Book implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -674,6 +684,11 @@ type BookChapter implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -1008,6 +1023,11 @@ type Collection implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -1298,6 +1318,11 @@ type ConferencePaper implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -1874,6 +1899,11 @@ type DataManagementPlan implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -2166,6 +2196,11 @@ type DataPaper implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -2457,6 +2492,11 @@ type Dataset implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -2859,6 +2899,11 @@ type Dissertation implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -3154,6 +3199,11 @@ interface DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -3402,6 +3452,11 @@ type Event implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -3678,6 +3733,11 @@ type EventData implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -4246,6 +4306,11 @@ type Image implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -4537,6 +4602,11 @@ type Instrument implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -4827,6 +4897,11 @@ type InteractiveResource implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -5143,6 +5218,11 @@ type JournalArticle implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -5680,6 +5760,11 @@ type Model implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -6096,6 +6181,11 @@ type Other implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -6412,6 +6502,11 @@ type PeerReview implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -6834,6 +6929,11 @@ type PhysicalObject implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -7178,6 +7278,11 @@ type Preprint implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -7470,6 +7575,11 @@ type Publication implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -8206,6 +8316,11 @@ type Service implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -8499,6 +8614,11 @@ type Software implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -8822,6 +8942,11 @@ type Sound implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -9296,6 +9421,11 @@ type Work implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.
@@ -9589,6 +9719,11 @@ type Workflow implements DoiItem {
   """
   container: Container
 
+  """
+  Url to download the content directly, if available
+  """
+  contentUrl: Url!
+
   """
   The institution or person responsible for collecting, managing, distributing,
   or otherwise contributing to the development of the resource.

app/graphql/types/doi_item.rb

@@ -52,6 +52,7 @@ module DoiItem
   field :geolocations, [GeolocationType], null: true, hash_key: "geo_locations", description: "Spatial region or named place where the data was gathered or about which the data is focused."
   field :funding_references, [FundingType], null: true, description: "Information about financial support (funding) for the resource being registered"
   field :url, Url, null: true, description: "The URL registered for the resource"
+  field :content_url,resolver: ContentUrl, null: true, description: "Url to download the content directly, if available"
   field :repository, RepositoryType, null: true,  hash_key: "client", description: "The repository account managing this resource"
   field :member, MemberType, null: true, hash_key: "provider", description: "The member account managing this resource"
   field :registration_agency, RegistrationAgencyType, hash_key: "agency", null: true, description: "The DOI registration agency for the resource"

config/application.rb

@@ -70,6 +70,7 @@ class Application < Rails::Application
     config.paths.add Rails.root.join('app', 'graphql', 'types').to_s, eager_load: true
     config.paths.add Rails.root.join('app', 'graphql', 'mutations').to_s, eager_load: true
     config.paths.add Rails.root.join('app', 'graphql', 'connections').to_s, eager_load: true
+    config.paths.add Rails.root.join('app', 'graphql', 'resolvers').to_s, eager_load: true
 
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers