serrano 0.6.0 → 1.4

data/lib/serrano.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'erb'
-require 'serrano/version'
-require 'serrano/request'
-require 'serrano/request_cursor'
-require 'serrano/filterhandler'
-require 'serrano/cnrequest'
-require 'serrano/filters'
-require 'serrano/styles'
-
-require 'rexml/document'
-require 'rexml/xpath'
+require "erb"
+require "serrano/version"
+require "serrano/request"
+require "serrano/request_cursor"
+require "serrano/filterhandler"
+require "serrano/cnrequest"
+require "serrano/filters"
+require "serrano/styles"
+
+require "rexml/document"
+require "rexml/xpath"
 
 # @!macro serrano_params
 #   @param offset [Fixnum] Number of record to start at, any non-negative integer up to 10,000
@@ -42,8 +42,7 @@ require 'rexml/xpath'
 #   @param cursor [String] Cursor character string to do deep paging. Default is `nil`.
 #       Pass in '*' to start deep paging. Any combination of query, filters and facets may be
 #       used with deep paging cursors. While limit may be specified along with cursor, offset
-#       and sample cannot be used. See
-#       https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md#deep-paging-with-cursors
+#       and sample cannot be used. See https://api.crossref.org/
 #   @param cursor_max [Fixnum] Max records to retrieve. Only used when cursor
 #       param used. Because deep paging can result in continuous requests until all
 #       are retrieved, use this parameter to set a maximum number of records. Of course,
@@ -63,8 +62,7 @@ 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://api.crossref.org/
 #       Field query parameters mut be named, and must start with `query_`. Any dashes or
 #       periods should be replaced with underscores. The options include:
 #       - query_container_title: Query container-title aka. publication name
@@ -99,18 +97,16 @@ require 'rexml/xpath'
 # For example, if you want to inspect headers returned from the HTTP request,
 # and parse the raw result in any way you wish.
 #
-# @see https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md for
-# detailed description of the Crossref API
+# @see https://api.crossref.org for detailed description of the Crossref API
 #
 # What am I actually searching when using the Crossref search API?
 #
-# You are using the Crossref search API described at
-# https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md.
+# You are using the Crossref search API described at https://api.crossref.org
 # When you search with query terms, on Crossref servers they are not
 # searching full text, or even abstracts of articles, but only what is
 # available in the data that is returned to you. That is, they search
 # article titles, authors, etc. For some discussion on this, see
-# https://gitlab.com/crossref/issues/issues/101
+# https://gitlab.com/crossref/issues/-/issues/101
 #
 #
 # The Polite Pool
@@ -152,8 +148,8 @@ module Serrano
 
   define_setting :access_token
   define_setting :access_secret
-  define_setting :mailto, ENV['CROSSREF_EMAIL']
-  define_setting :base_url, 'https://api.crossref.org/'
+  define_setting :mailto, ENV["CROSSREF_EMAIL"]
+  define_setting :base_url, "https://api.crossref.org/"
 
   ##
   # Search the works route
@@ -229,14 +225,14 @@ module Serrano
   #      # 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,
-                 select: nil, options: nil, verbose: false, cursor: nil,
-                 cursor_max: 5000, **args)
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    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
+    RequestCursor.new("works", ids, query, filter, offset,
+      limit, sample, sort, order, facet, select, nil, nil, options,
+      verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -286,14 +282,14 @@ module Serrano
   #      # 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,
-                   select: nil, works: false, options: nil, verbose: false,
-                   cursor: nil, cursor_max: 5000, **args)
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    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
+    RequestCursor.new("members", ids, query, filter, offset,
+      limit, sample, sort, order, facet, select, works, nil,
+      options, verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -334,14 +330,14 @@ module Serrano
   #      # 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,
-                    select: nil, works: false, options: nil, verbose: false,
-                    cursor: nil, cursor_max: 5000, **args)
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    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
+    RequestCursor.new("prefixes", ids, nil, filter, offset,
+      limit, sample, sort, order, facet, select, works, nil,
+      options, verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -387,14 +383,14 @@ module Serrano
   #      # 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,
-                   select: nil, works: false, options: nil, verbose: false,
-                   cursor: nil, cursor_max: 5000, **args)
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    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
+    RequestCursor.new("funders", ids, query, filter, offset,
+      limit, sample, sort, order, facet, select, works, nil, options,
+      verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -440,14 +436,14 @@ module Serrano
   #      # 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,
-                    select: nil, works: false, options: nil, verbose: false,
-                    cursor: nil, cursor_max: 5000, **args)
+    limit: nil, sample: nil, sort: nil, order: nil, facet: nil,
+    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
+    RequestCursor.new("journals", ids, query, filter, offset,
+      limit, sample, sort, order, facet, select, works, nil, options,
+      verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -485,11 +481,11 @@ module Serrano
   #      # 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)
+    options: nil, verbose: false, cursor: nil, cursor_max: 5000, **args)
 
-    RequestCursor.new('types', ids, nil, nil, offset,
-                      limit, nil, nil, nil, nil, select, works, nil, options,
-                      verbose, cursor, cursor_max, args).perform
+    RequestCursor.new("types", ids, nil, nil, offset,
+      limit, nil, nil, nil, nil, select, works, nil, options,
+      verbose, cursor, cursor_max, args).perform
   end
 
   ##
@@ -525,11 +521,11 @@ module Serrano
   #      Serrano.licenses()
   #      Serrano.licenses(limit: 3)
   def self.licenses(query: nil, offset: nil,
-                    limit: nil, sample: nil, sort: nil, order: nil,
-                    facet: nil, options: nil, verbose: false)
+    limit: nil, sample: nil, sort: nil, order: nil,
+    facet: nil, options: nil, verbose: false)
 
-    Request.new('licenses', nil, query, nil, offset,
-                limit, sample, sort, order, facet, nil, nil, nil, options, verbose).perform
+    Request.new("licenses", nil, query, nil, offset,
+      limit, sample, sort, order, facet, nil, nil, nil, options, verbose).perform
   end
 
   ##
@@ -544,8 +540,8 @@ module Serrano
   #      Serrano.registration_agency(ids: '10.1371/journal.pone.0033693')
   #      Serrano.registration_agency(ids: ['10.1007/12080.1874-1746','10.1007/10452.1573-5125', '10.1111/(issn)1442-9993'])
   def self.registration_agency(ids:, options: nil, verbose: false)
-    Request.new('works', ids, nil, nil, nil,
-                nil, nil, nil, nil, nil, nil, false, true, options, verbose).perform
+    Request.new("works", ids, nil, nil, nil,
+      nil, nil, nil, nil, nil, nil, false, true, options, verbose).perform
   end
 
   ##
@@ -566,9 +562,9 @@ module Serrano
   #      Serrano.random_dois(sample: 10)
   #      Serrano.random_dois(sample: 100)
   def self.random_dois(sample: 10, options: nil, verbose: false)
-    tmp = Request.new('works', nil, nil, nil, nil,
-                      nil, sample, nil, nil, nil, nil, false, nil, options, verbose).perform
-    tmp['message']['items'].collect { |x| x['DOI'] }
+    tmp = Request.new("works", nil, nil, nil, nil,
+      nil, sample, nil, nil, nil, nil, false, nil, options, verbose).perform
+    tmp["message"]["items"].collect { |x| x["DOI"] }
   end
 
   ##
@@ -631,7 +627,7 @@ module Serrano
   #      '10.5167/UZH-38402','10.5167/UZH-41217']
   #     x = Serrano.content_negotiation(ids: dois)
   #     puts x
-  def self.content_negotiation(ids:, format: 'bibtex', style: 'apa', locale: 'en-US')
+  def self.content_negotiation(ids:, format: "bibtex", style: "apa", locale: "en-US")
     ids = Array(ids).map { |x| ERB::Util.url_encode(x) }
     CNRequest.new(ids, format, style, locale).perform
   end
@@ -643,7 +639,8 @@ module Serrano
   # @param url [String] the API url for the function (should be left to default)
   # @param key [String] your API key
   #
-  # @see http://labs.crossref.org/openurl/ for more info on this Crossref API service.
+  # @see https://www.crossref.org/documentation/retrieve-metadata/openurl/ for
+  # more info on this Crossref API service.
   #
   # @example
   #   require 'serrano'
@@ -651,17 +648,16 @@ module Serrano
   #   Serrano.citation_count(doi: "10.1016/j.fbr.2012.01.001")
   #   # DOI not found
   #   Serrano.citation_count(doi: "10.1016/j.fbr.2012")
-  def self.citation_count(doi:, url: 'http://www.crossref.org/openurl/',
-                          key: 'cboettig@ropensci.org', options: nil)
+  def self.citation_count(doi:, url: "https://www.crossref.org/openurl/",
+    key: "cboettig@ropensci.org", options: nil)
 
-    args = { id: 'doi:' + doi, pid: key, noredirect: true }
+    args = {id: "doi:" + doi, pid: key, noredirect: true}
     opts = args.delete_if { |_k, v| v.nil? }
     conn = Faraday.new(url: url, request: options)
-    res = conn.get '', opts
+    res = conn.get "", opts
     x = res.body
     oc = REXML::Document.new("<doc>#{x}</doc>")
-    value = REXML::XPath.first(oc, '//query').attributes['fl_count'].to_i
-    value
+    REXML::XPath.first(oc, "//query").attributes["fl_count"].to_i
   end
 
   # Get csl styles

data/serrano.gemspec

@@ -1,50 +1,51 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'serrano/version'
+require "serrano/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'serrano'
-  s.version     = Serrano::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.1'
-  s.date        = '2020-02-18'
-  s.summary     = 'Crossref Client'
-  s.description = 'Low Level Ruby Client for the Crossref Search API'
-  s.authors     = 'Scott Chamberlain'
-  s.email       = 'myrmecocystus@gmail.com'
-  s.homepage    = 'https://github.com/sckott/serrano'
-  s.licenses    = 'MIT'
+  s.name = "serrano"
+  s.version = Serrano::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 2.1"
+  s.summary = "Crossref Client"
+  s.description = "Low Level Ruby Client for the Crossref Search API"
+  s.authors = "Scott Chamberlain"
+  s.email = "myrmecocystus@gmail.com"
+  s.homepage = "https://github.com/sckott/serrano"
+  s.licenses = "MIT"
 
   s.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
 
-  s.bindir      = 'bin'
-  s.executables = ['serrano']
+  s.bindir = "bin"
+  s.executables = ["serrano"]
 
-  s.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.2'
-  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.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_development_dependency "bundler", "~> 2.1", ">= 2.1.4"
+  s.add_development_dependency "codecov", "~> 0.5.0"
+  s.add_development_dependency "json", "~> 2.3", ">= 2.3.1"
+  s.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  s.add_development_dependency "standard", "~> 1.0"
+  s.add_development_dependency "simplecov", "~> 0.21.2"
+  s.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.6"
+  s.add_development_dependency "vcr", "~> 6.1"
+  s.add_development_dependency "webmock", "~> 3.14"
 
-  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', '< 1.1'
+  s.add_runtime_dependency "faraday", "~> 2.2"
+  s.add_runtime_dependency "faraday-follow_redirects", "~> 0.1.0"
+  s.add_runtime_dependency "multi_json", "~> 1.15"
+  s.add_runtime_dependency "rexml", "~> 3.2", ">= 3.2.5"
+  s.add_runtime_dependency "thor", "~> 1.2", ">= 1.2.1"
 
   s.metadata = {
-    'homepage_uri' => 'https://github.com/sckott/serrano',
-    'changelog_uri' =>
+    "homepage_uri" => "https://github.com/sckott/serrano",
+    "documentation_uri" => "https://www.rubydoc.info/gems/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'
+    "source_code_uri" => "https://github.com/sckott/serrano",
+    "bug_tracker_uri" => "https://github.com/sckott/serrano/issues"
   }
 end