serrano 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2534dbe1c8771066e2263d50eb52287e2dc0ac3e968097839a8b05c31be35fdc
-  data.tar.gz: 3723eb652195fcb93ad1c08ab40616b78725509bb8d7ab7f69eeda77773fb573
+  metadata.gz: 7115cc1e655085ff2114f8f5a9a7c093b4b6b53b0292264ba83336d6299f4f21
+  data.tar.gz: 352701f211ca40a431cc4ccbb01d9431dc12484ce1c2efc2fbe27f145e29cf52
 SHA512:
-  metadata.gz: 2fa11879521f6bf6895323b177f70de75b72daee2b841f46c658f95c12afe72672b80a747290740bddb0bde900e03cc3595c9d00c899709070b29e15b3785b5d
-  data.tar.gz: e58e6ed19721fc8188375bb96a5a6a690f6c72b7e026040427207729f661e22f13171fbf858ccf7ea1cfa1c17fecb1d7feba2a62ac442e27c0d62942c05566d5
+  metadata.gz: 3b66d48e05bc4233a426154d142004f59a26272f043e56cb384c03045b896dee82ed1b9fc9c3dedf74e64a524676206e86ce8b7694f0e48fe751dc6a235e65af
+  data.tar.gz: 94a984d7d49ecea0623e546bdf99cdc26ec279ff45f7f88e2c5f0b76e2b9a42b5cb7bfd145fa079c53c8b460b3a0d3b57436d7643fb2f9685c48695ccbe73d51

data/.rubocop.yml

@@ -7,8 +7,24 @@ Naming/FileName:
 Metrics/ParameterLists:
   Max: 18
 
+Metrics/ModuleLength:
+  Max: 800
+
 # Offense count: 22
 # Configuration parameters: AllowedVariables.
 Lint/UselessAssignment:
   Exclude:
     - 'lib/serrano/filters.rb'
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 525
+  

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-12-18 19:46:09 -0800 using RuboCop version 0.61.1.
+# on 2020-02-18 08:24:37 -0800 using RuboCop version 0.80.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -17,12 +17,6 @@ Gemspec/RequiredRubyVersion:
 Metrics/AbcSize:
   Max: 91
 
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 28
-
 # Offense count: 1
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
@@ -37,7 +31,7 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 20
+# Offense count: 21
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 54
@@ -48,8 +42,8 @@ Metrics/PerceivedComplexity:
 
 # Offense count: 7
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to, by, on, in, at, ip, db
-Naming/UncommunicativeMethodParamName:
+# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
+Naming/MethodParameterName:
   Exclude:
     - 'lib/serrano/filterhandler.rb'
     - 'lib/serrano/request_cursor.rb'
@@ -83,16 +77,11 @@ Style/FormatString:
     - 'lib/serrano/utils.rb'
 
 # Offense count: 1
-# Configuration parameters: .
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: annotated, template, unannotated
 Style/FormatStringToken:
-  EnforcedStyle: unannotated
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
   Exclude:
-    - 'lib/serrano/response.rb'
+    - 'lib/serrano/utils.rb'
 
 # Offense count: 3
 # Cop supports --auto-correct.
@@ -114,9 +103,3 @@ Style/SelfAssignment:
 Style/StringLiterals:
   Exclude:
     - 'lib/serrano/utils.rb'
-
-# Offense count: 198
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 525

data/.travis.yml

@@ -1,12 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.0
   - 2.6.0
+  - 2.6.5
+  - 2.7.0
 before_install:
-  - gem update --system
   - gem install bundler
-  - gem --version
 script:
   - bundle exec rake test TESTOPTS="-v"
   - bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.6.0 (2020-02-18)
+
+* query.title (`query_title` query filter as used here) has been removed; use `query_bibliographic` instead (#111)
+* bump `faraday` to version 0.17.1 from 0.17.0 (via dependabot) (#107)
+* bump `json` to version 2.3 from 2.2 (via dependabot) (#109)
+* bump `thor` minimum version (via dependabot) (#110)
+* better checking of filters; always check filters for proper formatting and acceptable types; improve filter tests; link to information on filters (#105) via PR from @beechnut
+
 ## 0.5.4 (2019-11-27)
 
 * `Serrano.registration_agency` fixed: a change in an internal function caused this function to fail; tests added to prevent this in the future (#106)

data/CODE_OF_CONDUCT.md

@@ -21,5 +21,5 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor
 opening an issue or contacting one or more of the project maintainers.
 
 This Code of Conduct is adapted from the Contributor Covenant
-(http:contributor-covenant.org), version 1.0.0, available at
-http://contributor-covenant.org/version/1/0/0/
+(https://contributor-covenant.org), version 1.0.0, available at
+https://contributor-covenant.org/version/1/0/0/

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    serrano (0.5.4)
-      faraday (>= 0.15, < 0.18)
-      faraday_middleware (>= 0.12.2, < 0.14.0)
+    serrano (0.6.0)
+      faraday (>= 0.15, < 1.0)
+      faraday_middleware (>= 0.12.2, < 0.15.0)
       multi_json (~> 1.13, >= 1.13.1)
-      thor (~> 0.20.0)
+      thor (>= 0.20, < 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -20,27 +20,29 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     docile (1.3.2)
-    faraday (0.17.0)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
     hashdiff (1.0.0)
     jaro_winkler (1.5.4)
-    json (2.2.0)
+    json (2.3.0)
     multi_json (1.14.1)
     multipart-post (2.1.1)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     power_assert (1.1.5)
-    public_suffix (4.0.1)
+    public_suffix (3.1.1)
     rainbow (3.0.0)
     rake (12.3.3)
-    rubocop (0.76.0)
+    rexml (3.2.4)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
@@ -52,11 +54,11 @@ GEM
     simplecov-html (0.10.2)
     test-unit (3.3.4)
       power_assert
-    thor (0.20.3)
-    unicode-display_width (1.6.0)
+    thor (1.0.1)
+    unicode-display_width (1.6.1)
     url (0.3.2)
-    vcr (5.0.0)
-    webmock (3.7.6)
+    vcr (5.1.0)
+    webmock (3.8.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -69,7 +71,7 @@ DEPENDENCIES
   codecov (~> 0.1.10)
   json (~> 2.1)
   rake (~> 12.3, >= 12.3.1)
-  rubocop (~> 0.76.0)
+  rubocop (~> 0.80.0)
   serrano!
   simplecov (~> 0.17.0)
   test-unit (~> 3.2, >= 3.2.7)
@@ -77,4 +79,4 @@ DEPENDENCIES
   webmock (~> 3.4, >= 3.4.1)
 
 BUNDLED WITH
-   2.0.2
+   2.1.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2019 Scott Chamberlain
+Copyright (C) 2020 Scott Chamberlain
 
 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:
 

data/README.md

@@ -122,6 +122,12 @@ Search works by query string
 Serrano.works(query: "ecology")
 ```
 
+Search works using metadata filters. See [CrossRef filter docs](https://github.com/CrossRef/rest-api-doc#filter-names).
+
+```ruby
+Serrano.works(query: "ecology", filter: { has_abstract: true })
+```
+
 Search journals by publisher name
 
 ```ruby

data/lib/serrano.rb

@@ -67,7 +67,6 @@ require 'rexml/xpath'
 #       https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md#field-queries
 #       Field query parameters mut be named, and must start with `query_`. Any dashes or
 #       periods should be replaced with underscores. The options include:
-#       - query_title: Query title and subtitle
 #       - query_container_title: Query container-title aka. publication name
 #       - query_author: Query author given and family names
 #       - query_editor: Query editor given and family names
@@ -234,6 +233,7 @@ module Serrano
                  select: nil, options: nil, verbose: false, cursor: nil,
                  cursor_max: 5000, **args)
 
+    assert_valid_filters(filter) if filter
     RequestCursor.new('works', ids, query, filter, offset,
                       limit, sample, sort, order, facet, select, nil, nil, options,
                       verbose, cursor, cursor_max, args).perform
@@ -290,6 +290,7 @@ module Serrano
                    select: nil, works: false, options: nil, verbose: false,
                    cursor: nil, cursor_max: 5000, **args)
 
+    assert_valid_filters(filter) if filter
     RequestCursor.new('members', ids, query, filter, offset,
                       limit, sample, sort, order, facet, select, works, nil,
                       options, verbose, cursor, cursor_max, args).perform
@@ -326,8 +327,8 @@ module Serrano
   #      items.collect{ |z| z['DOI'] }[0,50]
   #
   #      # field queries
-  #      ## query.title
-  #      res = Serrano.prefixes(ids: "10.1016", works: true, query_title: 'cell biology')
+  #      ## query.bibliographic
+  #      res = Serrano.prefixes(ids: "10.1016", works: true, query_bibliographic: 'cell biology')
   #      res[0]['message']['items'].collect { |x| x['title'] }
   #
   #      # select certain fields
@@ -337,6 +338,7 @@ module Serrano
                     select: nil, works: false, options: nil, verbose: false,
                     cursor: nil, cursor_max: 5000, **args)
 
+    assert_valid_filters(filter) if filter
     RequestCursor.new('prefixes', ids, nil, filter, offset,
                       limit, sample, sort, order, facet, select, works, nil,
                       options, verbose, cursor, cursor_max, args).perform
@@ -389,6 +391,7 @@ module Serrano
                    select: nil, works: false, options: nil, verbose: false,
                    cursor: nil, cursor_max: 5000, **args)
 
+    assert_valid_filters(filter) if filter
     RequestCursor.new('funders', ids, query, filter, offset,
                       limit, sample, sort, order, facet, select, works, nil, options,
                       verbose, cursor, cursor_max, args).perform
@@ -441,6 +444,7 @@ module Serrano
                     select: nil, works: false, options: nil, verbose: false,
                     cursor: nil, cursor_max: 5000, **args)
 
+    assert_valid_filters(filter) if filter
     RequestCursor.new('journals', ids, query, filter, offset,
                       limit, sample, sort, order, facet, select, works, nil, options,
                       verbose, cursor, cursor_max, args).perform
@@ -669,4 +673,23 @@ module Serrano
   def self.csl_styles
     fetch_styles
   end
+
+  def self.assert_valid_filters(filters)
+    unless filters.is_a? Hash
+      raise ArgumentError, <<~ERR
+        Filters must be provided as a hash, like:
+
+            Serrano.works(query: "something", filters: { has_abstract: true })
+      ERR
+    end
+
+    filters.each do |name, _|
+      filter_strings = Filters.names.map(&:to_s)
+      next if filter_strings.include?(name.to_s)
+
+      raise ArgumentError, <<~ERR
+        The filter "#{name}" is not a valid filter. Please run `Serrano.filters.filters` to see all valid filters.
+      ERR
+    end
+  end
 end

data/lib/serrano/cnrequest.rb

@@ -53,13 +53,13 @@ module Serrano
 
       if ids.length == 1
         self.ids = ids[0] if ids.class == Array
-        return make_request(conn, ids, format, style, locale)
+        make_request(conn, ids, format, style, locale)
       else
         coll = []
         Array(ids).each do |x|
           coll << make_request(conn, x, format, style, locale)
         end
-        return coll
+        coll
       end
     end
   end

data/lib/serrano/filters.rb

@@ -1,96 +1,100 @@
 # frozen_string_literal: true
 
-##
-# 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 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_details.keys
+      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_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' }
-}

data/lib/serrano/request.rb

@@ -79,7 +79,7 @@ module Serrano
 
       if id.nil?
         res = conn.get endpt, opts
-        return MultiJson.load(res.body)
+        MultiJson.load(res.body)
       else
         self.id = Array(id)
         # url encoding
@@ -97,7 +97,7 @@ module Serrano
           res = conn.get endpt, opts
           coll << MultiJson.load(res.body)
         end
-        return coll
+        coll
       end
     end
   end

data/lib/serrano/request_cursor.rb

@@ -99,7 +99,7 @@ module Serrano
         cu = js['message']['next-cursor']
         max_avail = js['message']['total-results']
         res = _redo_req(conn, js, opts, cu, max_avail)
-        return res
+        res
       else
         self.id = Array(id)
         # url encoding
@@ -121,7 +121,7 @@ module Serrano
           max_avail = js['message']['total-results']
           coll << _redo_req(conn, js, opts, cu, max_avail)
         end
-        return coll
+        coll
       end
     end
 

data/lib/serrano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Serrano
-  VERSION = '0.5.4'
+  VERSION = '0.6.0'
 end

data/serrano.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.version     = Serrano::VERSION
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.1'
-  s.date        = '2019-11-27'
+  s.date        = '2020-02-18'
   s.summary     = 'Crossref Client'
   s.description = 'Low Level Ruby Client for the Crossref Search API'
   s.authors     = 'Scott Chamberlain'
@@ -17,7 +17,9 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/sckott/serrano'
   s.licenses    = 'MIT'
 
-  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   s.require_paths = ['lib']
 
   s.bindir      = 'bin'
@@ -27,14 +29,22 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'codecov', '~> 0.1.10'
   s.add_development_dependency 'json', '~> 2.1'
   s.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
-  s.add_development_dependency 'rubocop', '~> 0.76.0'
+  s.add_development_dependency 'rubocop', '~> 0.80.0'
   s.add_development_dependency 'simplecov', '~> 0.17.0'
   s.add_development_dependency 'test-unit', '~> 3.2', '>= 3.2.7'
   s.add_development_dependency 'vcr', '~> 5.0'
   s.add_development_dependency 'webmock', '~> 3.4', '>= 3.4.1'
 
-  s.add_runtime_dependency 'faraday', '>= 0.15', '< 0.18'
-  s.add_runtime_dependency 'faraday_middleware', '>= 0.12.2', '< 0.14.0'
+  s.add_runtime_dependency 'faraday', '>= 0.15', '< 1.0'
+  s.add_runtime_dependency 'faraday_middleware', '>= 0.12.2', '< 0.15.0'
   s.add_runtime_dependency 'multi_json', '~> 1.13', '>= 1.13.1'
-  s.add_runtime_dependency 'thor', '~> 0.20.0'
+  s.add_runtime_dependency 'thor', '>= 0.20', '< 1.1'
+
+  s.metadata = {
+    'homepage_uri' => 'https://github.com/sckott/serrano',
+    'changelog_uri' =>
+      "https://github.com/sckott/serrano/releases/tag/v#{s.version}",
+    'source_code_uri' => 'https://github.com/sckott/serrano',
+    'bug_tracker_uri' => 'https://github.com/sckott/serrano/issues'
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serrano
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Scott Chamberlain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.80.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +169,7 @@ dependencies:
         version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ dependencies:
         version: '0.15'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -189,7 +189,7 @@ dependencies:
         version: 0.12.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -199,7 +199,7 @@ dependencies:
         version: 0.12.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -224,16 +224,22 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.1'
 description: Low Level Ruby Client for the Crossref Search API
 email: myrmecocystus@gmail.com
 executables:
@@ -270,7 +276,11 @@ files:
 homepage: https://github.com/sckott/serrano
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/sckott/serrano
+  changelog_uri: https://github.com/sckott/serrano/releases/tag/v0.6.0
+  source_code_uri: https://github.com/sckott/serrano
+  bug_tracker_uri: https://github.com/sckott/serrano/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -286,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Crossref Client