serrano 0.3.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 36aad2a16040c5453b6f8254a7b6d01fad661c43
-  data.tar.gz: abdf146c4875f0ef7abbdf9b14dafb71c47bc7a9
+SHA256:
+  metadata.gz: e329983c57815e197e683e64cf0a55300ede36bec3ada9a58612d4abd209f02a
+  data.tar.gz: 25dbce2ee336448219f50ea8e669da1bab787ccdd535f86d59c3aece3798fc71
 SHA512:
-  metadata.gz: '008664dcd932464f6360bf16c6a6cb097e326809c57d4e76e38ceee321aef9fe21d42ce1972e9a1e4db21cb53f2326f2aa9b3e8323be1a984ea13277b9f33756'
-  data.tar.gz: b5aeb13570f7907266f79879b4b141c1eea6576313d8758eb1c6cdf3f9b8467ea96cb3fa036ee73dd8b2a332dff4c04a2481e81795111e98010d2dfd388e55e8
+  metadata.gz: ffaf70de61b00919b7418125f73e23b34195445de5fcb23d9b32793e30d5d4971ba266e1d8421c76cef6f1e824b6ee87e6235f23a7fb3945f2c5447eea351f8d
+  data.tar.gz: ab93cece3c5e5661bedcf06812ff28276e192fc54a648b0e97902799cabc333ea5d14d51f67a60ef6b83555aabade56a19b5b664152ca1eef0bc2d4667ba217f

data/.travis.yml

@@ -3,6 +3,6 @@ cache: bundler
 rvm:
   - 2.1.8
   - 2.2.4
-  - 2.4.1
+  - 2.5.0
 script:
   bundle exec rake test TESTOPTS="-v"

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.5.0 (2018-04-08)
+
+* Updated dependency versions
+* Change url used in content negotation from `http://dx.doi.org/` to `https://doi.org/` (#49)
+* Fix `cursor_max` parameter type check to avoid Fixnum warning (#50)
+* Add support for `mailto` email polite pool, and docs updated with info (#46) (#47)
+* Add select parameter throughout methods (#43)
+* Added additional filter options (#45) (#40)
+* Added to docs info about additional `sort` parameter options (#41)
+* Added to docs info about additional field query options (#42)
+
 ## 0.3.6 (2017-04-04)
 
 * Updated dependency versions

data/Gemfile.lock

@@ -1,47 +1,47 @@
 PATH
   remote: .
   specs:
-    serrano (0.3.1)
-      faraday (~> 0.12.0.1)
-      faraday_middleware (~> 0.11.0.1)
-      multi_json (~> 1.12, >= 1.12.1)
-      thor (~> 0.19.4)
+    serrano (0.5.0)
+      faraday (~> 0.14.0)
+      faraday_middleware (~> 0.12.2)
+      multi_json (~> 1.13, >= 1.13.1)
+      thor (~> 0.20.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     codecov (0.1.10)
       json
       simplecov
       url
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    docile (1.1.5)
-    faraday (0.12.0.1)
+    docile (1.3.0)
+    faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.11.0.1)
+    faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    hashdiff (0.3.2)
-    json (2.0.3)
-    multi_json (1.12.1)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    multi_json (1.13.1)
     multipart-post (2.0.0)
-    power_assert (0.3.1)
-    public_suffix (2.0.5)
-    rake (12.0.0)
+    power_assert (1.1.1)
+    public_suffix (3.0.2)
+    rake (12.3.1)
     safe_yaml (1.0.4)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    test-unit (3.2.1)
+    simplecov-html (0.10.2)
+    test-unit (3.2.7)
       power_assert
-    thor (0.19.4)
+    thor (0.20.0)
     url (0.3.2)
-    vcr (3.0.3)
-    webmock (2.3.2)
+    vcr (4.0.0)
+    webmock (3.3.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -50,15 +50,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.14, >= 1.14.6)
+  bundler (~> 1.16, >= 1.16.1)
   codecov (~> 0.1.10)
-  json (~> 2.0, >= 2.0.3)
-  rake (~> 12.0, >= 12.0.0)
+  json (~> 2.1)
+  rake (~> 12.3, >= 12.3.1)
   serrano!
-  simplecov (~> 0.14.1)
-  test-unit (~> 3.2, >= 3.2.1)
-  vcr (~> 3.0, >= 3.0.3)
-  webmock (~> 2.3, >= 2.3.2)
+  simplecov (~> 0.16.1)
+  test-unit (~> 3.2, >= 3.2.7)
+  vcr (~> 4.0)
+  webmock (~> 3.3)
 
 BUNDLED WITH
-   1.14.6
+   1.16.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2016 Scott Chamberlain
+Copyright (C) 2018 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

@@ -54,6 +54,11 @@ limit is 50 requests per second. Look for the headers `X-Rate-Limit-Limit`
 and `X-Rate-Limit-Interval` in requests to see what the current rate
 limits are.
 
+The Polite Pool:
+
+To get in the polite pool it's a good idea now to include a `mailto` email
+address. See docs for more information. TLDR: set your email in an env var `CROSSREF_EMAIL`.
+
 
 ## Install
 
@@ -79,10 +84,20 @@ This will also be the way to set up other user options, as needed down the road.
 
 ```ruby
 Serrano.configuration do |config|
-  config.base_url = "http://api.crossref.org"
+  config.base_url = "https://api.crossref.org"
 end
 ```
 
+We recommend you set your `mailto` email here so you can get in the "polite pool" which gives you faster rate limits:
+
+```ruby
+Serrano.configuration do |config|
+  config.mailto = "jane@doe.org"
+end
+```
+
+Or use an env var with name `CROSSREF_EMAIL`
+
 ## Examples
 
 ### Use in a Ruby repl

data/Rakefile

@@ -5,6 +5,7 @@ Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/test-*.rb']
   t.verbose = true
+  t.warning = false
 end
 
 desc "Run tests"

data/lib/serrano.rb

@@ -18,13 +18,21 @@ require 'rexml/xpath'
 #       Max: 100.
 #   @param sort [String] Field to sort on, one of score, relevance,
 #       updated (date of most recent change to metadata - currently the same as deposited),
-#       deposited (time of most recent deposit), indexed (time of most recent index), or
-#       published (publication date). Note: If the API call includes a query, then the sort
+#       deposited (time of most recent deposit), indexed (time of most recent index),
+#       published (publication date), published-print (print publication date), 
+#       published-online (online publication date), issued (issued date (earliest known publication date)), 
+#       is-referenced-by-count (number of times this DOI is referenced by other Crossref DOIs), or 
+#       references-count (number of references included in the references section of the document 
+#       identified by this DOI). Note: If the API call includes a query, then the sort
 #       order will be by the relevance score. If no query is included, then the sort order
 #       will be by DOI update date.
 #   @param order [String] Sort order, one of 'asc' or 'desc'
 #   @param facet [Boolean/String] Include facet results OR a query (e.g., `license:*`) to facet by
 #       license. Default: false
+#   @param select [String/Array(String)] Crossref metadata records can be
+#       quite large. Sometimes you just want a few elements from the schema. You can "select"
+#       a subset of elements to return. This can make your API calls much more efficient. Not
+#       clear yet which fields are allowed here. 
 #   @param verbose [Boolean] Print request headers to stdout. Default: false
 
 # @!macro cursor_params
@@ -52,10 +60,19 @@ require 'rexml/xpath'
 #     - oauth [Hash] A hash with OAuth details
 
 # @!macro field_queries
-#   @param [Hash<Object>] args Field queries, as named parameters.
-#       See https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md#field-queries
+#   @param [Hash<Object>] args Field queries, as named parameters. See 
+#       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.
+#       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
+#       - query_chair: Query chair given and family names
+#       - query_translator: Query translator given and family names
+#       - query_contributor: Query author, editor, chair and translator given and family names
+#       - query_bibliographic: Query bibliographic information, useful for citation look up. Includes titles, authors, ISSNs and publication years
+#       - query_affiliation: Query contributor affiliations
 
 ##
 # Serrano - The top level module for using methods
@@ -93,6 +110,28 @@ require 'rexml/xpath'
 # article titles, authors, etc. For some discussion on this, see
 # https://github.com/CrossRef/rest-api-doc/issues/101
 #
+#
+# The Polite Pool
+# As of September 18th 2017 any API queries that use HTTPS and have
+# appropriate contact information will be directed to a special pool
+# of API machines that are reserved for polite users. If you connect
+# to the Crossreef API using HTTPS and provide contact
+# information, then they will send you to a separate pool of machines,
+# with better control the performance of these machines because they can
+# block abusive users.
+# 
+# We have been using `https` in `serrano` for a while now, so that's good
+# to go. To get into the Polite Pool, also set your `mailto` email address
+# with `Serrano.configuration` (example below), or set as an environment
+# variable with the name `CROSSREF_EMAIL` and your mailto will be set
+# for each request automatically. 
+# 
+# require 'serrano'
+# Serrano.configuration do |config|
+#   config.mailto = "foo@bar.com"
+# end
+#
+#
 # Rate limiting
 # Crossref introduced rate limiting recently. The rate limits apparently vary,
 # so we can't give a predictable rate limit. As of this writing, the rate
@@ -105,6 +144,7 @@ module Serrano
 
   define_setting :access_token
   define_setting :access_secret
+  define_setting :mailto, ENV["CROSSREF_EMAIL"]
   define_setting :base_url, "https://api.crossref.org/"
 
   ##
@@ -153,9 +193,13 @@ module Serrano
   #
   #      # sample
   #      Serrano.works(sample: 2)
+  #  
+  #      # select - pass an array or a comma separated string
+  #      Serrano.works(query: "ecology", select: "DOI,title", limit: 30)
+  #      Serrano.works(query: "ecology", select: ["DOI","title"], limit: 30)
   #
   #      # cursor for deep paging
-  #      Serrano.works(query: "widget", cursor: "*", limit: 100)
+  #      Serrano.works(query: "widget", cursor: "*", limit: 100, cursor_max: 1000)
   #      # another query, more results this time
   #      res = Serrano.works(query: "science", cursor: "*", limit: 250, cursor_max: 1000);
   #      res.collect { |x| x['message']['items'].length }.reduce(0, :+)
@@ -173,12 +217,16 @@ module Serrano
   #      ## query.container-title
   #      res = Serrano.works(query: "ecology", query_container_title: 'Ecology')
   #      res['message']['items'].collect { |x| x['container-title'] }
+  #
+  #      # select certain fields
+  #      Serrano.works(select: ['DOI', 'title'], limit: 3)
   def self.works(ids: nil, query: nil, filter: nil, offset: nil,
     limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
-    options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args)
+    select: nil, options: nil, verbose: false, cursor: nil, 
+    cursor_max: 5000, **args)
 
     RequestCursor.new('works', ids, query, filter, offset,
-      limit, sample, sort, order, facet, nil, nil, options,
+      limit, sample, sort, order, facet, select, nil, nil, options,
       verbose, cursor, cursor_max, args).perform
   end
 
@@ -225,14 +273,17 @@ module Serrano
   #      ## query.title
   #      res = Serrano.members(ids: 221, works: true, query_container_title: 'Advances')
   #      res[0]['message']['items'].collect { |x| x['container-title'] }
+  #
+  #      # select certain fields
+  #      Serrano.members(ids: 340, works: true, select: ['DOI', 'title'], limit: 3)
   def self.members(ids: nil, query: nil, filter: nil, offset: nil,
     limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
-    works: false, options: nil, verbose: false,
+    select: nil, works: false, options: nil, verbose: false,
     cursor: nil, cursor_max: 5000, **args)
 
     RequestCursor.new('members', ids, query, filter, offset,
-      limit, sample, sort, order, facet, works, nil, options,
-      verbose, cursor, cursor_max, args).perform
+      limit, sample, sort, order, facet, select, works, nil, 
+      options, verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -269,14 +320,17 @@ module Serrano
   #      ## query.title
   #      res = Serrano.prefixes(ids: "10.1016", works: true, query_title: 'cell biology')
   #      res[0]['message']['items'].collect { |x| x['title'] }
+  #
+  #      # select certain fields
+  #      Serrano.prefixes(ids: "10.1016", works: true, select: ['DOI', 'title'], limit: 3) 
   def self.prefixes(ids:, filter: nil, offset: nil,
     limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
-    works: false, options: nil, verbose: false,
+    select: nil, works: false, options: nil, verbose: false,
     cursor: nil, cursor_max: 5000, **args)
 
     RequestCursor.new('prefixes', ids, nil, filter, offset,
-      limit, sample, sort, order, facet, works, nil, options,
-      verbose, cursor, cursor_max, args).perform
+      limit, sample, sort, order, facet, select, works, nil, 
+      options, verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -318,13 +372,16 @@ module Serrano
   #      ## query.title
   #      res = Serrano.funders(ids: "10.13039/100000001", works: true, query_author: 'Simon')
   #      res[0]['message']['items'].collect { |x| x['author'][0]['family'] }
+  #
+  #      # select certain fields
+  #      Serrano.funders(ids: "10.13039/100000001", works: true, select: ['DOI', 'title'], limit: 3) 
   def self.funders(ids: nil, query: nil, filter: nil, offset: nil,
     limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
-    works: false, options: nil, verbose: false,
+    select: nil, works: false, options: nil, verbose: false,
     cursor: nil, cursor_max: 5000, **args)
 
     RequestCursor.new('funders', ids, query, filter, offset,
-      limit, sample, sort, order, facet, works, nil, options,
+      limit, sample, sort, order, facet, select, works, nil, options,
       verbose, cursor, cursor_max, args).perform
   end
 
@@ -367,13 +424,16 @@ module Serrano
   #      ## query.title
   #      res = Serrano.journals(ids: "2167-8359", works: true, query_container_title: 'Advances')
   #      res[0]['message']['items'].collect { |x| x['container-title'] }
+  #
+  #      # select certain fields
+  #      Serrano.journals(ids: "2167-8359", works: true, select: ['DOI', 'title'], limit: 3) 
   def self.journals(ids: nil, query: nil, filter: nil, offset: nil,
     limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
-    works: false, options: nil, verbose: false,
+    select: nil, works: false, options: nil, verbose: false,
     cursor: nil, cursor_max: 5000, **args)
 
     RequestCursor.new('journals', ids, query, filter, offset,
-      limit, sample, sort, order, facet, works, nil, options,
+      limit, sample, sort, order, facet, select, works, nil, options,
       verbose, cursor, cursor_max, args).perform
   end
 
@@ -385,6 +445,10 @@ module Serrano
   # @!macro field_queries
   # @param ids [Array] DOIs (digital object identifier) or other identifiers
   # @param works [Boolean] If true, works returned as well. Default: false
+  # @param select [String/Array(String)] Crossref metadata records can be
+  #     quite large. Sometimes you just want a few elements from the schema. You can "select"
+  #     a subset of elements to return. This can make your API calls much more efficient. Not
+  #     clear yet which fields are allowed here. 
   # @return [Array] An array of hashes
   #
   # @example
@@ -404,11 +468,14 @@ module Serrano
   #      ## query.title
   #      res = Serrano.types(ids: "journal", works: true, query_container_title: 'Advances')
   #      res[0]['message']['items'].collect { |x| x['container-title'] }
-  def self.types(ids: nil, offset: nil, limit: nil, works: false,
+  #
+  #      # select certain fields
+  #      Serrano.types(ids: "journal", works: true, select: ['DOI', 'title'], limit: 3) 
+  def self.types(ids: nil, offset: nil, limit: nil, select: nil, works: false,
     options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args)
 
     RequestCursor.new('types', ids, nil, nil, offset,
-      limit, nil, nil, nil, nil, works, nil, options,
+      limit, nil, nil, nil, nil, select, works, nil, options,
       verbose, cursor, cursor_max, args).perform
   end
 
@@ -430,7 +497,7 @@ module Serrano
     facet: nil, options: nil, verbose: false)
 
     Request.new('licenses', nil, query, nil, offset,
-      limit, sample, sort, order, facet, nil, nil, options, verbose).perform
+      limit, sample, sort, order, facet, nil, nil, nil, options, verbose).perform
   end
 
   ##
@@ -470,7 +537,7 @@ module Serrano
   def self.random_dois(sample: 10, options: nil, verbose: false)
 
     tmp = Request.new('works', nil, nil, nil, nil,
-      nil, sample, nil, nil, nil, false, nil, options, verbose).perform
+      nil, sample, nil, nil, nil, nil, false, nil, options, verbose).perform
     tmp['message']['items'].collect { |x| x['DOI'] }
   end
 

data/lib/serrano/cnrequest.rb

@@ -30,7 +30,7 @@ module Serrano
         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

data/lib/serrano/filters.rb

@@ -4,6 +4,7 @@
 # Information on Crossref API filters
 #
 # @example
+#    require 'serrano'
 #    # List filter names
 #    Serrano::Filters.names
 #    # List filter values and description
@@ -13,7 +14,7 @@
 module Serrano
   module Filters
     def self.names
-      $filter_list
+      $filter_details.keys
     end
 
     def self.filters
@@ -22,22 +23,10 @@ module Serrano
   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" },
+  "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}" },
@@ -50,6 +39,14 @@ $filter_details = {
   "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}'"},
@@ -57,31 +54,41 @@ $filter_details = {
   "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" },
+  "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'." },
-  "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" => { "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" },
-  "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_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" },
-  "has_abstract" => { "possible_values" => nil, "description" => "metadata for records which include an abstract" }
+  "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

@@ -22,14 +22,15 @@ module Serrano
     attr_accessor :sort
     attr_accessor :order
     attr_accessor :facet
+    attr_accessor :select
     attr_accessor :works
     attr_accessor :agency
     attr_accessor :options
     attr_accessor :verbose
 
     def initialize(endpt, id, query, filter, offset,
-      limit, sample, sort, order, facet, works, agency,
-      options, verbose)
+      limit, sample, sort, order, facet, select, 
+      works, agency, options, verbose)
 
       self.endpt = endpt
       self.id = id
@@ -41,6 +42,7 @@ module Serrano
       self.sort = sort
       self.order = order
       self.facet = facet
+      self.select = select
       self.works = works
       self.agency = agency
       self.options = options
@@ -50,21 +52,24 @@ module Serrano
     def perform
       filt = filter_handler(self.filter)
 
+      self.select = self.select.join(",") if self.select && self.select.class == Array
+
       args = { query: self.query, filter: filt, offset: self.offset,
               rows: self.limit, sample: self.sample, sort: self.sort,
-              order: self.order, facet: self.facet }
+              order: self.order, facet: self.facet, 
+              select: self.select }
       opts = args.delete_if { |k, v| v.nil? }
 
       if verbose
         conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
           f.response :logger
-          f.adapter  Faraday.default_adapter
           f.use FaradayMiddleware::RaiseHttpException
+          f.adapter  Faraday.default_adapter
         end
       else
         conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
-          f.adapter  Faraday.default_adapter
           f.use FaradayMiddleware::RaiseHttpException
+          f.adapter  Faraday.default_adapter
         end
       end
 

data/lib/serrano/request_cursor.rb

@@ -26,6 +26,7 @@ module Serrano
     attr_accessor :sort
     attr_accessor :order
     attr_accessor :facet
+    attr_accessor :select
     attr_accessor :works
     attr_accessor :agency
     attr_accessor :options
@@ -35,8 +36,9 @@ module Serrano
     attr_accessor :args
 
     def initialize(endpt, id, query, filter, offset,
-      limit, sample, sort, order, facet, works, agency,
-      options, verbose, cursor, cursor_max, args)
+      limit, sample, sort, order, facet, select, 
+      works, agency, options, verbose, cursor, 
+      cursor_max, args)
 
       self.endpt = endpt
       self.id = id
@@ -48,6 +50,7 @@ module Serrano
       self.sort = sort
       self.order = order
       self.facet = facet
+      self.select = select
       self.works = works
       self.agency = agency
       self.options = options
@@ -60,29 +63,31 @@ module Serrano
     def perform
       filt = filter_handler(self.filter)
       fieldqueries = field_query_handler(self.args)
+      self.select = self.select.join(",") if self.select && self.select.class == Array
 
       if self.cursor_max.class != nil
-        if self.cursor_max.class != Fixnum
+        if !self.cursor_max.kind_of?(Integer)
           raise "cursor_max must be of class int"
         end
       end
 
       arguments = { query: self.query, filter: filt, offset: self.offset,
               rows: self.limit, sample: self.sample, sort: self.sort,
-              order: self.order, facet: self.facet, cursor: self.cursor }.tostrings
+              order: self.order, facet: self.facet, select: self.select, 
+              cursor: self.cursor }.tostrings
       arguments = arguments.merge(fieldqueries)
       opts = arguments.delete_if { |k, v| v.nil? }
 
       if verbose
         $conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
           f.response :logger
-          f.adapter Faraday.default_adapter
           f.use FaradayMiddleware::RaiseHttpException
+          f.adapter Faraday.default_adapter
         end
       else
         $conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
-          f.adapter Faraday.default_adapter
           f.use FaradayMiddleware::RaiseHttpException
+          f.adapter Faraday.default_adapter
         end
       end
 
@@ -90,6 +95,7 @@ module Serrano
       $conn.headers["X-USER-AGENT"] = make_ua
 
       if self.id.nil?
+        $endpt2 = self.endpt
         js = self._req(self.endpt, opts)
         cu = js['message']['next-cursor']
         max_avail = js['message']['total-results']

data/lib/serrano/utils.rb

@@ -1,7 +1,11 @@
 def make_ua
-	requa = 'Faraday/v' + Faraday::VERSION
+  requa = 'Faraday/v' + Faraday::VERSION
   habua = 'Serrano/v' + Serrano::VERSION
-  return requa + ' ' + habua
+  ua = requa + ' ' + habua
+  if Serrano.mailto
+    ua = ua + " (mailto:%s)" % Serrano.mailto
+  end
+  return ua
 end
 
 def field_query_handler(x)

data/lib/serrano/version.rb

@@ -1,3 +1,3 @@
 module Serrano
-  VERSION = "0.3.6"
+  VERSION = "0.5.0"
 end

data/serrano.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.name        = 'serrano'
   s.version     = Serrano::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.0'
-  s.date        = '2017-04-04'
+  s.required_ruby_version = '>= 2.1'
+  s.date        = '2018-04-08'
   s.summary     = "Crossref Client"
   s.description = "Low Level Ruby Client for the Crossref Search API"
   s.authors     = "Scott Chamberlain"
@@ -22,17 +22,17 @@ Gem::Specification.new do |s|
   s.bindir      = 'bin'
   s.executables = ['serrano']
 
-  s.add_development_dependency 'bundler', '~> 1.14', '>= 1.14.6'
-  s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
-  s.add_development_dependency 'test-unit', '~> 3.2', '>= 3.2.1'
-  s.add_development_dependency 'simplecov', '~> 0.14.1'
+  s.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.1'
+  s.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
+  s.add_development_dependency 'test-unit', '~> 3.2', '>= 3.2.7'
+  s.add_development_dependency 'simplecov', '~> 0.16.1'
   s.add_development_dependency 'codecov', '~> 0.1.10'
-  s.add_development_dependency 'json', '~> 2.0', '>= 2.0.3'
-  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
-  s.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.2'
+  s.add_development_dependency 'json', '~> 2.1'
+  s.add_development_dependency 'vcr', '~> 4.0'
+  s.add_development_dependency 'webmock', '~> 3.3'
 
-  s.add_runtime_dependency 'faraday', '~> 0.12.0.1'
-  s.add_runtime_dependency 'faraday_middleware', '~> 0.11.0.1'
-  s.add_runtime_dependency 'thor', '~> 0.19.4'
-  s.add_runtime_dependency 'multi_json', '~> 1.12', '>= 1.12.1'
+  s.add_runtime_dependency 'faraday', '~> 0.14.0'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.12.2'
+  s.add_runtime_dependency 'thor', '~> 0.20.0'
+  s.add_runtime_dependency 'multi_json', '~> 1.13', '>= 1.13.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serrano
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Scott Chamberlain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2018-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.6
+        version: 1.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.6
+        version: 1.16.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 12.3.1
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.2.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,21 +69,21 @@ dependencies:
         version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.2.7
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -104,122 +104,104 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0.1
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0.1
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.1
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.1
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.13.1
 description: Low Level Ruby Client for the Crossref Search API
 email: myrmecocystus@gmail.com
 executables:
@@ -230,7 +212,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
-- CONDUCT.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -265,7 +247,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -273,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Crossref Client