serrano 0.6.0 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7115cc1e655085ff2114f8f5a9a7c093b4b6b53b0292264ba83336d6299f4f21
-  data.tar.gz: 352701f211ca40a431cc4ccbb01d9431dc12484ce1c2efc2fbe27f145e29cf52
+  metadata.gz: 4cfcf7f23380a97af986d90644b8ab541f89c14e5df46485ad84fbcff437a361
+  data.tar.gz: ff3571fbbe79b62cb203e54887c09a0f5af81838a7e0e7aec8c2cb3fa1376890
 SHA512:
-  metadata.gz: 3b66d48e05bc4233a426154d142004f59a26272f043e56cb384c03045b896dee82ed1b9fc9c3dedf74e64a524676206e86ce8b7694f0e48fe751dc6a235e65af
-  data.tar.gz: 94a984d7d49ecea0623e546bdf99cdc26ec279ff45f7f88e2c5f0b76e2b9a42b5cb7bfd145fa079c53c8b460b3a0d3b57436d7643fb2f9685c48695ccbe73d51
+  metadata.gz: 057e9ff07332d37fcd6711695ddd2648d7fd76f74a87585c795a9412883ee4346cf0868b5819f6025e8fee3ef687ac1da035f8ecbfb07424450f5a161daa88a2
+  data.tar.gz: a47b838e2812df16d600df5530175d31682679e2070e78ad0c8c6250f6b65c1e67d71d6a9cc31fefc055caa59de40148f842ec607b68264845eca55ab1a9cfab

data/.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: codecov
+    versions:
+    - "> 0.1.17, < 0.2"
+  - dependency-name: codecov
+    versions:
+    - "> 0.2.1, < 0.3"
+  - dependency-name: codecov
+    versions:
+    - 0.4.2
+    - 0.4.3
+  - dependency-name: simplecov
+    versions:
+    - 0.20.0

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macos-11 ]
+        ruby: [ 2.6, 2.7, 3.0, 3.1 ]
+    runs-on: ${{ matrix.os }}
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      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,17 @@
+## 1.4 (2022-03-26)
+
+* Moved to faraday > v2. There's no user facing changes here, but let me know if any issues arise (#172)
+* PR by @LocoDelAssembly fixes `Serrano.content_negotiation(format: "citeproc-json")` by having it return `nil` instead of `Resource not found` when no DOI is found, so that the output is more compatible with flows that use serrano to create JSON (#169)
+* PR by @xuanxu adds `REXML` as a runtime dependency (#159)
+
+## 1.0.0 (2020-10-19)
+
+* updated dependency versions
+
+## 0.6.2 (2020-05-29)
+
+* put documentation link back in rubygems page (#132)
+
 ## 0.6.0 (2020-02-18)
 
 * query.title (`query_title` query filter as used here) has been removed; use `query_bibliographic` instead (#111)

data/Gemfile

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

data/LICENSE

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

@@ -2,13 +2,14 @@ serrano
 =========
 
 [![gem version](https://img.shields.io/gem/v/serrano.svg)](https://rubygems.org/gems/serrano)
-[![Build Status](https://api.travis-ci.org/sckott/serrano.png)](https://travis-ci.org/sckott/serrano)
-[![codecov.io](http://codecov.io/github/sckott/serrano/coverage.svg?branch=master)](http://codecov.io/github/sckott/serrano?branch=master)
+[![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=main)](https://codecov.io/github/sckott/serrano?branch=main)
 [![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:
 
@@ -46,7 +47,7 @@ Other methods:
 
 Note about searching:
 
-You are using the Crossref search API described at https://github.com/CrossRef/rest-api-doc 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
+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
 
 Rate limits:
 
@@ -183,6 +184,8 @@ Commands:
 
 # Many DOIs
 ~$ serrano works "10.1007/12080.1874-1746,10.1007/10452.1573-5125"
+## if above two dois in a file called dois.txt 
+~$ cat dois.txt | xargs -I{} serrano works {}
 
 # output JSON, then parse with e.g., jq
 ~$ serrano works --filter=has_orcid:true --json --limit=2 | jq '.message.items[].author[].ORCID | select(. != null)'
@@ -193,9 +196,8 @@ Commands:
 * Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
 * License: MIT
 
-[crapi]: https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md
-[cn]: http://www.crosscite.org/cn/
-[tdm]: http://www.crossref.org/tdm/
-[ccount]: http://labs.crossref.org/openurl/
+[crapi]: https://api.crossref.org/
+[cn]: https://citation.crosscite.org/docs.html
+[ccount]: https://www.crossref.org/documentation/retrieve-metadata/openurl/
 [csl]: https://github.com/citation-style-language/styles
-[changelog]: https://github.com/sckott/serrano/blob/master/CHANGELOG.md
+[changelog]: https://github.com/sckott/serrano/blob/main/CHANGELOG.md

data/Rakefile

@@ -1,49 +1,51 @@
 # 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
+
+desc "open an irb session preloaded with this gem"
+task :console do
+  sh "irb -r pp -r ./lib/serrano.rb"
+end

data/lib/serrano/cn.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'serrano/version'
-require 'serrano/cnrequest'
+require "serrano/version"
+require "serrano/cnrequest"
 
 ##
 # ContentNegotiation - Content Negotiation class
 #
-# @see http://www.crosscite.org/cn/ for details
+# @see https://citation.crosscite.org/docs.html for details
 module Serrano
   class ContentNegotiation
     attr_accessor :ids
@@ -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,38 +1,38 @@
 # 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/follow_redirects"
+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
 #
 # Class to perform HTTP requests to the Crossref API
 module Serrano
-  class CNRequest #:nodoc:
+  class CNRequest # :nodoc:
     attr_accessor :ids
     attr_accessor :format
     attr_accessor :style
     attr_accessor :locale
 
     CN_FORMATS = %w[rdf-xml turtle citeproc-json
-                    citeproc-json-ish text ris bibtex
-                    crossref-xml datacite-xml bibentry
-                    crossref-tdm].freeze
+      citeproc-json-ish text ris bibtex
+      crossref-xml datacite-xml bibentry
+      crossref-tdm].freeze
 
     def initialize(ids, format, style, locale)
       self.ids = ids
@@ -43,16 +43,16 @@ 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|
-        c.use FaradayMiddleware::FollowRedirects
+      conn = Faraday.new "https://doi.org/" do |c|
+        c.use Faraday::FollowRedirects::Middleware
         c.adapter :net_http
       end
 
       if ids.length == 1
-        self.ids = ids[0] if ids.class == Array
+        self.ids = ids[0] if ids.instance_of?(Array)
         make_request(conn, ids, format, style, locale)
       else
         coll = []
@@ -68,38 +68,24 @@ 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 = 'http://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
+  res.body if res.success?
 end
-
-# parser <- cn_types[[self.format]]
-# if (raw) {
-#   content(response, "text")
-# } else {
-#   out <- content(response, "parsed", parser, "UTF-8")
-#   if (format == "text") {
-#     out <- gsub("\n", "", out)
-#   }
-#   if (format == "bibentry") {
-#     out <- parse_bibtex(out)
-#   }
-#   out
-# }

data/lib/serrano/faraday.rb

@@ -1,72 +1,74 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'multi_json'
+require "faraday"
+require "multi_json"
 
 # @private
-module FaradayMiddleware
-  # @private
-  class RaiseHttpException < Faraday::Middleware
-    def call(env)
-      @app.call(env).on_complete do |response|
-        case response[:status].to_i
-        when 400
-          raise Serrano::BadRequest, error_message_400(response)
-        when 404
-          raise Serrano::NotFound, error_message_400(response)
-        when 500
-          raise Serrano::InternalServerError, error_message_500(response, 'Something is technically wrong.')
-        when 502
-          raise Serrano::BadGateway, error_message_500(response, 'The server returned an invalid or incomplete response.')
-        when 503
-          raise Serrano::ServiceUnavailable, error_message_500(response, 'Crossref is rate limiting your requests.')
-        when 504
-          raise Serrano::GatewayTimeout, error_message_500(response, '504 Gateway Time-out')
+module Faraday
+  module SerranoErrors
+    # @private
+    class Middleware < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+          when 400
+            raise Serrano::BadRequest, error_message_400(response)
+          when 404
+            raise Serrano::NotFound, error_message_400(response)
+          when 500
+            raise Serrano::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 502
+            raise Serrano::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+          when 503
+            raise Serrano::ServiceUnavailable, error_message_500(response, "Crossref is rate limiting your requests.")
+          when 504
+            raise Serrano::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+          end
         end
       end
-    end
 
-    def initialize(app)
-      super app
-      @parser = nil
-    end
+      def initialize(app)
+        super app
+        @parser = nil
+      end
 
-    private
+      private
 
-    def error_message_400(response)
-      "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
-    end
+      def error_message_400(response)
+        "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
+      end
 
-    def error_body(body)
-      if !body.nil? && !body.empty? && body.is_a?(String)
-        if json?(body)
-          body = ::MultiJson.load(body)
-          if body['message'].nil?
-            body = nil
-            elseif body['message'].length == 1
-            body = body['message']
-          else
-            body = body['message'].collect { |x| x['message'] }.join('; ')
+      def error_body(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          if json?(body)
+            body = ::MultiJson.load(body)
+            if body["message"].nil?
+              body = nil
+              elseif body["message"].length == 1
+              body = body["message"]
+            else
+              body = body["message"].collect { |x| x["message"] }.join("; ")
+            end
           end
         end
-      end
 
-      if body.nil?
-        nil
-      else
-        ": #{body}"
+        if body.nil?
+          nil
+        else
+          ": #{body}"
+        end
       end
-    end
 
-    def error_message_500(response, body = nil)
-      "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
-    end
+      def error_message_500(response, body = nil)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ":", body].compact.join(" ")}"
+      end
 
-    def json?(string)
-      MultiJson.load(string)
-      true
-    rescue MultiJson::ParseError
-      false
+      def json?(string)
+        MultiJson.load(string)
+        true
+      rescue MultiJson::ParseError
+        false
+      end
     end
   end
 end

data/lib/serrano/filterhandler.rb

@@ -4,41 +4,41 @@
 module Helpers
   def filter_handler(x = nil)
     others = %w[license_url license_version license_delay full_text_version full_text_type
-                award_number award_funder]
+      award_number award_funder]
     if x.nil?
       nil
     else
       x = stringify(x)
       nn = x.keys.collect(&:to_s)
       if nn.collect { |w| others.include? w }.any?
-        nn = nn.collect do |b|
+        nn = nn.collect { |b|
           if others.include? b
             case b
-            when 'license_url'
-              'license.url'
-            when 'license_version'
-              'license.version'
-            when 'license_delay'
-              'license.delay'
-            when 'full_text_version'
-              'full-text.version'
-            when 'full_text_type'
-              'full-text.type'
-            when 'award_number'
-              'award.number'
-            when 'award_funder'
-              'award.funder'
+            when "license_url"
+              "license.url"
+            when "license_version"
+              "license.version"
+            when "license_delay"
+              "license.delay"
+            when "full_text_version"
+              "full-text.version"
+            when "full_text_type"
+              "full-text.type"
+            when "award_number"
+              "award.number"
+            when "award_funder"
+              "award.funder"
             end
           else
             b
           end
-        end
+        }
       end
 
-      newnn = nn.collect { |m| m.tr('_', '-') }
+      newnn = nn.collect { |m| m.tr("_", "-") }
       x = rename_keys(x, newnn)
-      x = x.collect { |k, v| [k, v].join(':') }.join(',')
-      x
+      x.collect { |k, v| [k, v].join(":") }.join(",")
+
     end
   end
 
@@ -52,11 +52,11 @@ module Helpers
 end
 
 module Serrano
-  class Request #:nodoc:
+  class Request # :nodoc:
     include Helpers
   end
 
-  class RequestCursor #:nodoc:
+  class RequestCursor # :nodoc:
     include Helpers
   end
 end