serrano 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53cd7acc47b07971aa23568ba4abb703eb1f7ac4d73483c9b74efc97e9245234
-  data.tar.gz: 6307728ec83729a96377ac3a3b7a1c3642f19b746e7eb1d69e6805e9cfbe3d47
+  metadata.gz: 75729f32a4cfabb79a33d78638a91c253fb76a8ec3abc8d9ecc743056464d38d
+  data.tar.gz: 8e47227794125651a8c35450a8f7f5aaa5c377ac461ea2433836d00b76fdb699
 SHA512:
-  metadata.gz: b322cef9465854069679385525b296b9cdfcdba1b8b2b3b1a831bbeabc4e4b77f3686845619898d8809e02bf0079cebe23c9eb1c95908eeaa7df4b4de80d1a03
-  data.tar.gz: f511e386ab6c92b1e3f7984de2ca6e044fac87e7d824b7f8360c3165b7e9d7591b5d93b5af283f3c0e128c1a301146a7e8aedf5777ed9ceac5e34f4cd1e898ee
+  metadata.gz: a1be1549ce95a4fa7bac8d417f28f9c2d70e800b48f1f7b8c4471cf8461ca37288dd9a2f06c5c15376364e3af4f8d4e61589ad0b4e0f8cdbbd6c1bf46fc170db
+  data.tar.gz: d21603574250c471ea20c3fe7f433d5ef56715307442d8067814757b522306afdca717bbcd612eda4055c1e1b41fc2a8a3f9d340d45dd57127c9a3950b24f70a

data/.github/workflows/ruby.yml

@@ -14,6 +14,8 @@ jobs:
         os: [ ubuntu-latest, macos-latest ]
         ruby: [ 2.5, 2.6, 2.7 ]
     runs-on: ${{ matrix.os }}
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     steps:
     - uses: actions/checkout@v2
     - name: Setup Ruby
@@ -23,6 +25,6 @@ jobs:
     - name: Install dependencies
       run: bundle install
     - name: Run tests
-      run: bundle exec rake test TESTOPTS="-v"
-    - name: Run rubocop
-      run: bundle exec rubocop
+      run: |
+        bundle exec rake install
+        bundle exec rake test TESTOPTS="-v"

data/.gitignore

@@ -26,7 +26,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-#Gemfile.lock
+Gemfile.lock
 .ruby-version
 .ruby-gemset
 

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.0 (2020-10-19)
+
+* updated dependency versions
+
 ## 0.6.2 (2020-05-29)
 
 * put documentation link back in rubygems page (#132)

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -5,10 +5,11 @@ serrano
 [![Ruby](https://github.com/sckott/serrano/workflows/Ruby/badge.svg)](https://github.com/sckott/serrano/actions)
 [![codecov.io](https://codecov.io/github/sckott/serrano/coverage.svg?branch=master)](https://codecov.io/github/sckott/serrano?branch=master)
 [![DOI](https://zenodo.org/badge/2600/sckott/serrano.svg)](https://zenodo.org/badge/latestdoi/2600/sckott/serrano)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 `serrano` is a low level client for Crossref APIs
 
-Docs: http://www.rubydoc.info/gems/serrano
+Docs: https://www.rubydoc.info/gems/serrano
 
 Other Crossref API clients:
 

data/Rakefile

@@ -1,49 +1,46 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard"
+require "standard/rake"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/test_*.rb']
+  t.libs << "test"
+  t.test_files = FileList["test/test_*.rb"]
   t.verbose = true
   t.warning = false
 end
 
-desc 'Run tests'
+desc "Run tests"
 task default: :test
 
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['--display-cop-names']
-end
-
-desc 'Build serrano docs'
+desc "Build serrano docs"
 task :docs do
-  system 'yardoc'
+  system "yardoc"
 end
 
-desc 'bundle install'
+desc "bundle install"
 task :bundle do
-  system 'bundle install'
+  system "bundle install"
 end
 
-desc 'clean out builds'
+desc "clean out builds"
 task :clean do
-  system 'ls | grep [0-9].gem | xargs rm'
+  system "ls | grep [0-9].gem | xargs rm"
 end
 
-desc 'Build serrano'
+desc "Build serrano"
 task :build do
-  system 'gem build serrano.gemspec'
+  system "gem build serrano.gemspec"
 end
 
-desc 'Install serrano'
+desc "Install serrano"
 task install: %i[bundle build] do
   system "gem install serrano-#{Serrano::VERSION}.gem"
 end
 
-desc 'Release to Rubygems'
+desc "Release to Rubygems"
 task release: :build do
   system "gem push serrano-#{Serrano::VERSION}.gem"
 end

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
@@ -152,8 +152,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 +229,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 +286,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 +334,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 +387,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 +440,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 +485,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 +525,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 +544,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 +566,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 +631,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
@@ -651,17 +651,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: 'https://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/lib/serrano/cn.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'serrano/version'
-require 'serrano/cnrequest'
+require "serrano/version"
+require "serrano/cnrequest"
 
 ##
 # ContentNegotiation - Content Negotiation class
@@ -14,7 +14,7 @@ module Serrano
     attr_accessor :style
     attr_accessor :locale
 
-    def initialize(ids, format = 'bibtex', style = 'apa', locale = 'en-US')
+    def initialize(ids, format = "bibtex", style = "apa", locale = "en-US")
       self.ids = ids
       self.format = format
       self.style = style

data/lib/serrano/cnrequest.rb

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'faraday_middleware'
-require 'multi_json'
-require 'serrano/error'
-require 'serrano/utils'
-require 'serrano/helpers/configuration'
+require "faraday"
+require "faraday_middleware"
+require "multi_json"
+require "serrano/error"
+require "serrano/utils"
+require "serrano/helpers/configuration"
 
-CN_FORMAT_HEADERS = { 'rdf-xml' => 'application/rdf+xml',
-                      'turtle' => 'text/turtle',
-                      'citeproc-json' => 'transform/application/vnd.citationstyles.csl+json',
-                      'text' => 'text/x-bibliography',
-                      'ris' => 'application/x-research-info-systems',
-                      'bibtex' => 'application/x-bibtex',
-                      'crossref-xml' => 'application/vnd.crossref.unixref+xml',
-                      'datacite-xml' => 'application/vnd.datacite.datacite+xml',
-                      'bibentry' => 'application/x-bibtex',
-                      'crossref-tdm' => 'application/vnd.crossref.unixsd+xml' }.freeze
+CN_FORMAT_HEADERS = {"rdf-xml" => "application/rdf+xml",
+                     "turtle" => "text/turtle",
+                     "citeproc-json" => "transform/application/vnd.citationstyles.csl+json",
+                     "text" => "text/x-bibliography",
+                     "ris" => "application/x-research-info-systems",
+                     "bibtex" => "application/x-bibtex",
+                     "crossref-xml" => "application/vnd.crossref.unixref+xml",
+                     "datacite-xml" => "application/vnd.datacite.datacite+xml",
+                     "bibentry" => "application/x-bibtex",
+                     "crossref-tdm" => "application/vnd.crossref.unixsd+xml"}.freeze
 
 ##
 # Serrano::CNRequest
@@ -30,9 +30,9 @@ module Serrano
     attr_accessor :locale
 
     CN_FORMATS = %w[rdf-xml turtle citeproc-json
-                    citeproc-json-ish text ris bibtex
-                    crossref-xml datacite-xml bibentry
-                    crossref-tdm].freeze
+      citeproc-json-ish text ris bibtex
+      crossref-xml datacite-xml bibentry
+      crossref-tdm].freeze
 
     def initialize(ids, format, style, locale)
       self.ids = ids
@@ -43,10 +43,10 @@ module Serrano
 
     def perform
       unless CN_FORMATS.include? format
-        raise 'format not one of accepted types'
+        raise "format not one of accepted types"
       end
 
-      conn = Faraday.new 'https://doi.org/' do |c|
+      conn = Faraday.new "https://doi.org/" do |c|
         c.use FaradayMiddleware::FollowRedirects
         c.adapter :net_http
       end
@@ -68,23 +68,23 @@ end
 def make_request(conn, ids, format, style, locale)
   type = CN_FORMAT_HEADERS.select { |x, _| x.include? format }.values[0]
 
-  if format == 'citeproc-json'
-    endpt = 'https://api.crossref.org/works/' + ids + '/' + type
+  if format == "citeproc-json"
+    endpt = "https://api.crossref.org/works/" + ids + "/" + type
     cr_works = Faraday.new(url: endpt)
     cr_works.headers[:user_agent] = make_ua
-    cr_works.headers['X-USER-AGENT'] = make_ua
+    cr_works.headers["X-USER-AGENT"] = make_ua
     res = cr_works.get
   else
-    if format == 'text'
-      type = type + '; style = ' + style + '; locale = ' + locale
+    if format == "text"
+      type = type + "; style = " + style + "; locale = " + locale
     end
 
-    res = conn.get do |req|
+    res = conn.get { |req|
       req.url ids
-      req.headers['Accept'] = type
+      req.headers["Accept"] = type
       req.headers[:user_agent] = make_ua
-      req.headers['X-USER-AGENT'] = make_ua
-    end
+      req.headers["X-USER-AGENT"] = make_ua
+    }
   end
 
   res.body