serrano 0.3.6 → 0.6.2

data/lib/serrano/cn.rb

@@ -1,20 +1,20 @@
-require "serrano/version"
-require "serrano/cnrequest"
+# frozen_string_literal: true
+
+require 'serrano/version'
+require 'serrano/cnrequest'
 
 ##
 # ContentNegotiation - Content Negotiation class
 #
-# @see http://www.crosscite.org/cn/ for details
+# @see https://citation.crosscite.org/docs.html for details
 module Serrano
-
   class ContentNegotiation
-
     attr_accessor :ids
     attr_accessor :format
     attr_accessor :style
     attr_accessor :locale
 
-    def initialize(ids, format = "bibtex", style = "apa", locale = "en-US")
+    def initialize(ids, format = 'bibtex', style = 'apa', locale = 'en-US')
       self.ids = ids
       self.format = format
       self.style = style
@@ -22,9 +22,7 @@ module Serrano
     end
 
     def cn
-      CNRequest.new(self.ids, self.format, self.style, self.locale).perform
+      CNRequest.new(ids, format, style, locale).perform
     end
-
   end
-
 end

data/lib/serrano/cnrequest.rb

@@ -1,23 +1,39 @@
-require "faraday"
-require "faraday_middleware"
-require "multi_json"
-require "serrano/error"
-require "serrano/constants"
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'multi_json'
+require 'serrano/error'
 require 'serrano/utils'
 require 'serrano/helpers/configuration'
 
+CN_FORMAT_HEADERS = { 'rdf-xml' => 'application/rdf+xml',
+                      'turtle' => 'text/turtle',
+                      'citeproc-json' => 'transform/application/vnd.citationstyles.csl+json',
+                      'text' => 'text/x-bibliography',
+                      'ris' => 'application/x-research-info-systems',
+                      'bibtex' => 'application/x-bibtex',
+                      'crossref-xml' => 'application/vnd.crossref.unixref+xml',
+                      'datacite-xml' => 'application/vnd.datacite.datacite+xml',
+                      'bibentry' => 'application/x-bibtex',
+                      'crossref-tdm' => 'application/vnd.crossref.unixsd+xml' }.freeze
+
 ##
 # Serrano::CNRequest
 #
 # Class to perform HTTP requests to the Crossref API
 module Serrano
   class CNRequest #:nodoc:
-
     attr_accessor :ids
     attr_accessor :format
     attr_accessor :style
     attr_accessor :locale
 
+    CN_FORMATS = %w[rdf-xml turtle citeproc-json
+                    citeproc-json-ish text ris bibtex
+                    crossref-xml datacite-xml bibentry
+                    crossref-tdm].freeze
+
     def initialize(ids, format, style, locale)
       self.ids = ids
       self.format = format
@@ -26,54 +42,52 @@ module Serrano
     end
 
     def perform
-      if !$cn_formats.include? self.format
-        raise "format not one of accepted types"
+      unless CN_FORMATS.include? format
+        raise 'format not one of accepted types'
       end
 
-      $conn = Faraday.new "http://dx.doi.org/" do |c|
+      conn = Faraday.new 'https://doi.org/' do |c|
         c.use FaradayMiddleware::FollowRedirects
         c.adapter :net_http
       end
 
-      if self.ids.length == 1
-        if self.ids.class == Array
-          self.ids = self.ids[0]
-        end
-        return make_request(self.ids, self.format, self.style, self.locale)
+      if ids.length == 1
+        self.ids = ids[0] if ids.class == Array
+        make_request(conn, ids, format, style, locale)
       else
         coll = []
-        Array(self.ids).each do |x|
-          coll << make_request(x, self.format, self.style, self.locale)
+        Array(ids).each do |x|
+          coll << make_request(conn, x, format, style, locale)
         end
-        return coll
+        coll
       end
     end
   end
 end
 
-def make_request(ids, format, style, locale)
-  type = $cn_format_headers.select { |x, _| x.include? format }.values[0]
+def make_request(conn, ids, format, style, locale)
+  type = CN_FORMAT_HEADERS.select { |x, _| x.include? format }.values[0]
 
-  if format == "citeproc-json"
-    endpt = "http://api.crossref.org/works/" + ids + "/" + type
-    cr_works = Faraday.new(:url => endpt)
+  if format == 'citeproc-json'
+    endpt = 'https://api.crossref.org/works/' + ids + '/' + type
+    cr_works = Faraday.new(url: endpt)
     cr_works.headers[:user_agent] = make_ua
-    cr_works.headers["X-USER-AGENT"] = make_ua
+    cr_works.headers['X-USER-AGENT'] = make_ua
     res = cr_works.get
   else
-    if format == "text"
-      type = type + "; style = " + style + "; locale = " + locale
+    if format == 'text'
+      type = type + '; style = ' + style + '; locale = ' + locale
     end
 
-    res = $conn.get do |req|
+    res = conn.get do |req|
       req.url ids
       req.headers['Accept'] = type
       req.headers[:user_agent] = make_ua
-      req.headers["X-USER-AGENT"] = make_ua
+      req.headers['X-USER-AGENT'] = make_ua
     end
   end
 
-  return res.body
+  res.body
 end
 
 # parser <- cn_types[[self.format]]

data/lib/serrano/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Serrano
   # Custom error class for rescuing from all Serrano errors
   class Error < StandardError; end

data/lib/serrano/faraday.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'multi_json'
 
@@ -13,13 +15,13 @@ module FaradayMiddleware
         when 404
           raise Serrano::NotFound, error_message_400(response)
         when 500
-          raise Serrano::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          raise Serrano::InternalServerError, error_message_500(response, 'Something is technically wrong.')
         when 502
-          raise Serrano::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+          raise Serrano::BadGateway, error_message_500(response, 'The server returned an invalid or incomplete response.')
         when 503
-          raise Serrano::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+          raise Serrano::ServiceUnavailable, error_message_500(response, 'Crossref is rate limiting your requests.')
         when 504
-          raise Serrano::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+          raise Serrano::GatewayTimeout, error_message_500(response, '504 Gateway Time-out')
         end
       end
     end
@@ -32,16 +34,16 @@ module FaradayMiddleware
     private
 
     def error_message_400(response)
-      "\n   #{response[:method].to_s.upcase} #{response[:url].to_s}\n   Status #{response[:status]}#{error_body(response[:body])}"
+      "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
     end
 
     def error_body(body)
-      if not body.nil? and not body.empty? and body.kind_of?(String)
-        if is_json?(body)
+      if !body.nil? && !body.empty? && body.is_a?(String)
+        if json?(body)
           body = ::MultiJson.load(body)
           if body['message'].nil?
             body = nil
-          elseif body['message'].length == 1
+            elseif body['message'].length == 1
             body = body['message']
           else
             body = body['message'].collect { |x| x['message'] }.join('; ')
@@ -56,16 +58,15 @@ module FaradayMiddleware
       end
     end
 
-    def error_message_500(response, body=nil)
-      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    def error_message_500(response, body = nil)
+      "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
     end
 
-    def is_json?(string)
+    def json?(string)
       MultiJson.load(string)
-      return true
+      true
     rescue MultiJson::ParseError
-      return false
+      false
     end
-
   end
 end

data/lib/serrano/filterhandler.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 # helper functions
 module Helpers
-
-  $others = ['license_url','license_version','license_delay','full_text_version','full_text_type',
-             'award_number','award_funder']
-
   def filter_handler(x = nil)
+    others = %w[license_url license_version license_delay full_text_version full_text_type
+                award_number award_funder]
     if x.nil?
       nil
     else
       x = stringify(x)
-      nn = x.keys.collect{ |z| z.to_s }
-      if nn.collect{ |w| $others.include? w }.any?
-        nn = nn.collect{ |b|
-          if $others.include? b
+      nn = x.keys.collect(&:to_s)
+      if nn.collect { |w| others.include? w }.any?
+        nn = nn.collect do |b|
+          if others.include? b
             case b
             when 'license_url'
               'license.url'
@@ -32,24 +32,23 @@ module Helpers
           else
             b
           end
-        }
+        end
       end
 
-      newnn = nn.collect{ |m| m.gsub("_", "-") }
+      newnn = nn.collect { |m| m.tr('_', '-') }
       x = rename_keys(x, newnn)
-      x = x.collect{ |k,v| [k, v].join(":") }.join(',')
-      return x
+      x = x.collect { |k, v| [k, v].join(':') }.join(',')
+      x
     end
   end
 
   def stringify(x)
-    (x.keys.map{ |k,v| k.to_s }.zip x.values).to_h
+    (x.keys.map { |k, _v| k.to_s }.zip x.values).to_h
   end
 
   def rename_keys(x, y)
     (y.zip x.values).to_h
   end
-
 end
 
 module Serrano
@@ -61,4 +60,3 @@ module Serrano
     include Helpers
   end
 end
-

data/lib/serrano/filters.rb

@@ -1,87 +1,100 @@
-##
-# Serrano::Filters
-#
-# Information on Crossref API filters
-#
-# @example
-#    # List filter names
-#    Serrano::Filters.names
-#    # List filter values and description
-#    Serrano::Filters.filters
-#    Serrano::Filters.filters['has_funder']
-#    Serrano::Filters.filters['has_funder']['description']
+# frozen_string_literal: true
+
 module Serrano
+  def self.filters
+    Filters
+  end
+
+  ##
+  # Serrano::Filters
+  #
+  # Information on Crossref API filters
+  #
+  # @example
+  #    require 'serrano'
+  #    # List filter names
+  #    Serrano::Filters.names
+  #    # List filter values and description
+  #    Serrano::Filters.filters
+  #    Serrano::Filters.filters['has_funder']
+  #    Serrano::Filters.filters['has_funder']['description']
   module Filters
     def self.names
-      $filter_list
+      FILTER_DETAILS.keys
     end
 
     def self.filters
-      $filter_details
+      FILTER_DETAILS
     end
+
+    FILTER_DETAILS = {
+      'has_funder' => { 'possible_values' => nil, 'description' => 'metadata which includes one or more funder entry' },
+      'funder' => { 'possible_values' => '{funder_id}', 'description' => 'metadata which include the {funder_id} in FundRef data' },
+      'location' => { 'possible_values' => '{country_name}', 'description' => 'funder records where location = {country name}. Only works on /funders route' },
+      'prefix' => { 'possible_values' => '{owner_prefix}', 'description' => "metadata belonging to a DOI owner prefix {owner_prefix} (e.g. '10.1016' )" },
+      'member' => { 'possible_values' => '{member_id}', 'description' => 'metadata belonging to a CrossRef member' },
+      'from_index_date' => { 'possible_values' => '{date}', 'description' => 'metadata indexed since (inclusive) {date}' },
+      'until_index_date' => { 'possible_values' => '{date}', 'description' => 'metadata indexed before (inclusive) {date}' },
+      'from_deposit_date' => { 'possible_values' => '{date}', 'description' => 'metadata last (re)deposited since (inclusive) {date}' },
+      'until_deposit_date' => { 'possible_values' => '{date}', 'description' => 'metadata last (re)deposited before (inclusive) {date}' },
+      'from_update_date' => { 'possible_values' => '{date}', 'description' => "Metadata updated since (inclusive) {date} Currently the same as 'from_deposit_date'" },
+      'until_update_date' => { 'possible_values' => '{date}', 'description' => "Metadata updated before (inclusive) {date} Currently the same as 'until_deposit_date'" },
+      'from_created_date' => { 'possible_values' => '{date}', 'description' => 'metadata first deposited since (inclusive) {date}' },
+      'until_created_date' => { 'possible_values' => '{date}', 'description' => 'metadata first deposited before (inclusive) {date}' },
+      'from_pub_date' => { 'possible_values' => '{date}', 'description' => 'metadata where published date is since (inclusive) {date}' },
+      'until_pub_date' => { 'possible_values' => '{date}', 'description' => 'metadata where published date is before (inclusive)  {date}' },
+      'from_online_pub_date' => { 'possible_values' => '{date}', 'description' => 'metadata where online published date is since (inclusive) {date}' },
+      'until_online_pub_date' => { 'possible_values' => '{date}', 'description' => 'metadata where online published date is before (inclusive) {date}' },
+      'from_print_pub_date' => { 'possible_values' => '{date}', 'description' => 'metadata where print published date is since (inclusive) {date}' },
+      'until_print_pub_date' => { 'possible_values' => '{date}', 'description' => 'metadata where print published date is before (inclusive) {date}' },
+      'from_posted_date' => { 'possible_values' => '{date}', 'description' => 'metadata where posted date is since (inclusive) {date}' },
+      'until_posted_date' => { 'possible_values' => '{date}', 'description' => 'metadata where posted date is before (inclusive) {date}' },
+      'from_accepted_date' => { 'possible_values' => '{date}', 'description' => 'metadata where accepted date is since (inclusive) {date}' },
+      'until_accepted_date' => { 'possible_values' => '{date}', 'description' => 'metadata where accepted date is before (inclusive) {date}' },
+      'has_license' => { 'possible_values' => nil, 'description' => "metadata that includes any '<license_ref>' elements" },
+      'license_url' => { 'possible_values' => '{url}', 'description' => "metadata where '<license_ref>' value equals {url}" },
+      'license_version' => { 'possible_values' => '{string}', 'description' => "metadata where the '<license_ref>''s 'applies_to' attribute  is '{string}'" },
+      'license_delay' => { 'possible_values' => '{integer}', 'description' => "metadata where difference between publication date and the '<license_ref>''s 'start_date' attribute is <= '{integer}' (in days" },
+      'has_full_text' => { 'possible_values' => nil, 'description' => "metadata that includes any full text '<resource>' elements_" },
+      'full_text_version' => { 'possible_values' => '{string}', 'description' => "metadata where '<resource>' element's 'content_version' attribute is '{string}'" },
+      'full_text_type' => { 'possible_values' => '{mime_type}', 'description' => "metadata where '<resource>' element's 'content_type' attribute is '{mime_type}' (e.g. 'application/pdf')" },
+      'full_text_application' => { 'possible_values' => '{string}', 'description' => 'metadata where <resource> link has one of the following intended applications: text-mining, similarity-checking or unspecified' },
+      'has_references' => { 'possible_values' => nil, 'description' => 'metadata for works that have a list of references' },
+      'has_archive' => { 'possible_values' => nil, 'description' => 'metadata which include name of archive partner' },
+      'archive' => { 'possible_values' => '{string}', 'description' => "metadata which where value of archive partner is '{string}'" },
+      'has_orcid' => { 'possible_values' => nil, 'description' => 'metadata which includes one or more ORCIDs' },
+      'has_authenticated_orcid' => { 'possible_values' => nil, 'description' => 'metadata which includes one or more ORCIDs where the depositing publisher claims to have witness the ORCID owner authenticate with ORCID' },
+      'orcid' => { 'possible_values' => '{orcid}', 'description' => "metadata where '<orcid>' element's value = '{orcid}'" },
+      'issn' => { 'possible_values' => '{issn}', 'description' => "metadata where record has an ISSN = '{issn}' Format is 'xxxx_xxxx'." },
+      'directory' => { 'possible_values' => '{directory}', 'description' => "metadata records whose article or serial are mentioned in the given '{directory}'. Currently the only supported value is 'doaj'" },
+      'doi' => { 'possible_values' => '{doi}', 'description' => "metadata describing the DOI '{doi}'" },
+      'updates' => { 'possible_values' => '{doi}', 'description' => "metadata for records that represent editorial updates to the DOI '{doi}'" },
+      'is_update' => { 'possible_values' => nil, 'description' => 'metadata for records that represent editorial updates' },
+      'has_update_policy' => { 'possible_values' => nil, 'description' => 'metadata for records that include a link to an editorial update policy' },
+      'container_title' => { 'possible_values' => nil, 'description' => 'metadata for records with a publication title exactly with an exact match' },
+      'category_name' => { 'possible_values' => nil, 'description' => 'metadata for records with an exact matching category label' },
+      'type' => { 'possible_values' => '{type}', 'description' => "metadata records whose type = '{type}' Type must be an ID value from the list of types returned by the '/types' resource" },
+      'type_name' => { 'possible_values' => nil, 'description' => 'metadata for records with an exacty matching type label' },
+      'award_number' => { 'possible_values' => '{award_number}', 'description' => "metadata for records with a matching award nunber_ Optionally combine with 'award_funder'" },
+      'award_funder' => { 'possible_values' => '{funder doi or id}', 'description' => "metadata for records with an award with matching funder. Optionally combine with 'award_number'" },
+      'has_assertion' => { 'possible_values' => nil, 'description' => 'metadata for records with any assertions' },
+      'assertion_group' => { 'possible_values' => nil, 'description' => 'metadata for records with an assertion in a particular group' },
+      'assertion' => { 'possible_values' => nil, 'description' => 'metadata for records with a particular named assertion' },
+      'has_affiliation' => { 'possible_values' => nil, 'description' => 'metadata for records that have any affiliation information' },
+      'alternative_id' => { 'possible_values' => nil, 'description' => 'metadata for records with the given alternative ID, which may be a publisher_specific ID, or any other identifier a publisher may have provided' },
+      'article_number' => { 'possible_values' => nil, 'description' => 'metadata for records with a given article number' },
+      'has_abstract' => { 'possible_values' => nil, 'description' => 'metadata for records which include an abstract' },
+      'has_clinical_trial_number' => { 'possible_values' => nil, 'description' => 'metadata for records which include a clinical trial number' },
+      'content_domain' => { 'possible_values' => nil, 'description' => 'metadata where the publisher records a particular domain name as the location Crossmark content will appear' },
+      'has_content_domain' => { 'possible_values' => nil, 'description' => 'metadata where the publisher records a domain name location for Crossmark content' },
+      'has_crossmark_restriction' => { 'possible_values' => nil, 'description' => 'metadata where the publisher restricts Crossmark usage to content domains' },
+      'has_relation' => { 'possible_values' => nil, 'description' => 'metadata for records that either assert or are the object of a relation' },
+      'relation_type' => { 'possible_values' => nil, 'description' => 'One of the relation types from the Crossref relations schema (e.g. is-referenced-by, is-parent-of, is-preprint-of)' },
+      'relation_object' => { 'possible_values' => nil, 'description' => 'Relations where the object identifier matches the identifier provided' },
+      'relation_object_type' => { 'possible_values' => nil, 'description' => 'One of the identifier types from the Crossref relations schema (e.g. doi, issn)' },
+      'public_references' => { 'possible_values' => nil, 'description' => 'metadata where publishers allow references to be distributed publically' },
+      'publisher_name' => { 'possible_values' => nil, 'description' => 'metadata for records with an exact matching publisher name' },
+      'affiliation' => { 'possible_values' => nil, 'description' => 'metadata for records with at least one contributor with the given affiliation' }
+    }.freeze
   end
 end
-
-$filter_list = [
-  'has_funder','funder','prefix','member','from_index_date','until_index_date',
-  'from_deposit_date','until_deposit_date','from_update_date','until_update_date',
-  'from_first_deposit_date','until_first_deposit_date','from_pub_date','until_pub_date',
-  'has_license','license_url','license_version','license_delay','has_full_text',
-  'full_text_version','full_text_type','public_references','has_references','has_archive',
-  'archive','has_orcid','orcid','issn','type','directory','doi','updates','is_update',
-  'has_update_policy','container_title','publisher_name','category_name','type_name',
-  'from_created_date', 'until_created_date', 'affiliation', 'has_affiliation',
-  'assertion_group', 'assertion', 'article_number', 'alternative_id',
-  'has_clinical_trial_number', 'has_abstract'
-]
-
-$filter_details = {
-  "has_funder" => { "possible_values" => nil, "description" => "metadata which includes one or more funder entry" },
-  "funder" => { "possible_values" => "{funder_id}", "description" => "metadata which include the {funder_id} in FundRef data" },
-  "prefix" => { "possible_values" => "{owner_prefix}", "description" => "metadata belonging to a DOI owner prefix {owner_prefix} (e.g. '10.1016' )" },
-  "member" => { "possible_values" => "{member_id}", "description" => "metadata belonging to a CrossRef member" },
-  "from_index_date" => { "possible_values" => '{date}', "description" => "metadata indexed since (inclusive) {date}" },
-  "until_index_date" => { "possible_values" => '{date}', "description" => "metadata indexed before (inclusive) {date}" },
-  "from_deposit_date" => { "possible_values" => '{date}', "description" => "metadata last (re)deposited since (inclusive) {date}" },
-  "until_deposit_date" => { "possible_values" => '{date}', "description" => "metadata last (re)deposited before (inclusive) {date}" },
-  "from_update_date" => { "possible_values" => '{date}', "description" => "Metadata updated since (inclusive) {date} Currently the same as 'from_deposit_date'" },
-  "until_update_date" => { "possible_values" => '{date}', "description" => "Metadata updated before (inclusive) {date} Currently the same as 'until_deposit_date'" },
-  "from_created_date" => { "possible_values" => '{date}', "description" => "metadata first deposited since (inclusive) {date}" },
-  "until_created_date" => { "possible_values" => '{date}', "description" => "metadata first deposited before (inclusive) {date}" },
-  "from_pub_date" => { "possible_values" => '{date}', "description" => "metadata where published date is since (inclusive) {date}" },
-  "until_pub_date" => { "possible_values" => '{date}', "description" => "metadata where published date is before (inclusive)  {date}" },
-  "has_license" => { "possible_values" => nil, "description" => "metadata that includes any '<license_ref>' elements" },
-  "license_url" => { "possible_values" => '{url}', "description" => "metadata where '<license_ref>' value equals {url}" },
-  "license_version" => { "possible_values" => '{string}', "description" => "metadata where the '<license_ref>''s 'applies_to' attribute  is '{string}'"},
-  "license_delay" => { "possible_values" => "{integer}", "description" => "metadata where difference between publication date and the '<license_ref>''s 'start_date' attribute is <= '{integer}' (in days"},
-  "has_full_text" => { "possible_values" => nil, "description" => "metadata that includes any full text '<resource>' elements_" },
-  "full_text_version" => { "possible_values" => '{string}' , "description" => "metadata where '<resource>' element's 'content_version' attribute is '{string}'" },
-  "full_text_type" => { "possible_values" => '{mime_type}' , "description" => "metadata where '<resource>' element's 'content_type' attribute is '{mime_type}' (e.g. 'application/pdf')" },
-  "public_references" => { "possible_values" => nil, "description" => "metadata where publishers allow references to be distributed publically" },
-  "has_references" => { "possible_values" => nil , "description" => "metadata for works that have a list of references" },
-  "has_archive" => { "possible_values" => nil , "description" => "metadata which include name of archive partner" },
-  "archive" => { "possible_values" => '{string}', "description" => "metadata which where value of archive partner is '{string}'" },
-  "has_orcid" => { "possible_values" => nil, "description" => "metadata which includes one or more ORCIDs" },
-  "orcid" => { "possible_values" => '{orcid}', "description" => "metadata where '<orcid>' element's value = '{orcid}'" },
-  "issn" => { "possible_values" => '{issn}', "description" => "metadata where record has an ISSN = '{issn}' Format is 'xxxx_xxxx'." },
-  "type" => { "possible_values" => '{type}', "description" => "metadata records whose type = '{type}' Type must be an ID value from the list of types returned by the '/types' resource" },
-  "directory" => { "possible_values" => "{directory}", "description" => "metadata records whose article or serial are mentioned in the given '{directory}'. Currently the only supported value is 'doaj'" },
-  "doi" => { "possible_values" => '{doi}', "description" => "metadata describing the DOI '{doi}'" },
-  "updates" => { "possible_values" => '{doi}', "description" => "metadata for records that represent editorial updates to the DOI '{doi}'" },
-  "is_update" => { "possible_values" => nil, "description" => "metadata for records that represent editorial updates" },
-  "has_update_policy" => { "possible_values" => nil, "description" => "metadata for records that include a link to an editorial update policy" },
-  "container_title" => { "possible_values" => nil, "description" => "metadata for records with a publication title exactly with an exact match" },
-  "publisher_name" => { "possible_values" => nil, "description" => "metadata for records with an exact matching publisher name" },
-  "category_name" => { "possible_values" => nil, "description" => "metadata for records with an exact matching category label" },
-  "type_name" => { "possible_values" => nil, "description" => "metadata for records with an exacty matching type label" },
-  "award_number" => { "possible_values" => "{award_number}", "description" => "metadata for records with a matching award nunber_ Optionally combine with 'award_funder'" },
-  "award_funder" => { "possible_values" => '{funder doi or id}', "description" => "metadata for records with an award with matching funder. Optionally combine with 'award_number'" },
-  "assertion_group" => { "possible_values" => nil, "description" => "metadata for records with an assertion in a particular group" },
-  "assertion" => { "possible_values" => nil, "description" => "metadata for records with a particular named assertion" },
-  "affiliation" => { "possible_values" => nil, "description" => "metadata for records with at least one contributor with the given affiliation" },
-  "has_affiliation" => { "possible_values" => nil, "description" => "metadata for records that have any affiliation information" },
-  "alternative_id" => { "possible_values" => nil, "description" => "metadata for records with the given alternative ID, which may be a publisher_specific ID, or any other identifier a publisher may have provided" },
-  "article_number" => { "possible_values" => nil, "description" => "metadata for records with a given article number" },
-  "has_clinical_trial_number" => { "possible_values" => nil, "description" => "metadata for records which include a clinical trial number" },
-  "has_abstract" => { "possible_values" => nil, "description" => "metadata for records which include an abstract" }
-}