serrano 0.5.0 → 1.0.0

data/lib/serrano/request_cursor.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
+require "erb"
 require "faraday"
-require 'faraday_middleware'
+require "faraday_middleware"
 require "multi_json"
 require "serrano/error"
-require "serrano/constants"
-require 'serrano/helpers/configuration'
-require 'serrano/filterhandler'
-require 'serrano/error'
-require 'serrano/faraday'
-require 'serrano/utils'
+require "serrano/helpers/configuration"
+require "serrano/filterhandler"
+require "serrano/error"
+require "serrano/faraday"
+require "serrano/utils"
 
 ##
 # Serrano::RequestCursor
@@ -15,7 +17,6 @@ require 'serrano/utils'
 # Class to perform HTTP requests to the Crossref API
 module Serrano
   class RequestCursor #:nodoc:
-
     attr_accessor :endpt
     attr_accessor :id
     attr_accessor :query
@@ -36,8 +37,8 @@ module Serrano
     attr_accessor :args
 
     def initialize(endpt, id, query, filter, offset,
-      limit, sample, sort, order, facet, select, 
-      works, agency, options, verbose, cursor, 
+      limit, sample, sort, order, facet, select,
+      works, agency, options, verbose, cursor,
       cursor_max, args)
 
       self.endpt = endpt
@@ -61,89 +62,89 @@ module Serrano
     end
 
     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
+      filt = filter_handler(filter)
+      fieldqueries = field_query_handler(args)
+      self.select = select.join(",") if select && select.class == Array
 
-      if self.cursor_max.class != nil
-        if !self.cursor_max.kind_of?(Integer)
-          raise "cursor_max must be of class int"
-        end
+      unless cursor_max.class.nil?
+        raise "cursor_max must be of class int" unless cursor_max.is_a?(Integer)
       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, select: self.select, 
-              cursor: self.cursor }.tostrings
+      arguments = {query: query, filter: filt, offset: offset,
+                   rows: limit, sample: sample, sort: sort,
+                   order: order, facet: facet, select: select,
+                   cursor: cursor}.tostrings
       arguments = arguments.merge(fieldqueries)
-      opts = arguments.delete_if { |k, v| v.nil? }
+      opts = arguments.delete_if { |_k, v| v.nil? }
 
-      if verbose
-        $conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
+      conn = if verbose
+        Faraday.new(url: Serrano.base_url, request: options || []) do |f|
           f.response :logger
           f.use FaradayMiddleware::RaiseHttpException
           f.adapter Faraday.default_adapter
         end
       else
-        $conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
+        Faraday.new(url: Serrano.base_url, request: options || []) do |f|
           f.use FaradayMiddleware::RaiseHttpException
           f.adapter Faraday.default_adapter
         end
       end
 
-      $conn.headers[:user_agent] = make_ua
-      $conn.headers["X-USER-AGENT"] = make_ua
+      conn.headers[:user_agent] = make_ua
+      conn.headers["X-USER-AGENT"] = make_ua
+
+      if id.nil?
+        endpt2 = endpt
+        js = _req(conn, endpt, opts)
+        cu = js["message"]["next-cursor"]
+        max_avail = js["message"]["total-results"]
+        _redo_req(conn, js, opts, cu, max_avail)
 
-      if self.id.nil?
-        $endpt2 = self.endpt
-        js = self._req(self.endpt, opts)
-        cu = js['message']['next-cursor']
-        max_avail = js['message']['total-results']
-        res = self._redo_req(js, opts, cu, max_avail)
-        return res
       else
+        self.id = Array(id)
+        # url encoding
+        self.id = id.map { |x| ERB::Util.url_encode(x) }
         coll = []
-        Array(self.id).each do |x|
-          if self.works
-            $endpt2 = self.endpt + '/' + x.to_s + "/works"
+        id.each do |x|
+          endpt2 = if works
+            endpt + "/" + x.to_s + "/works"
           else
-            if self.agency
-              $endpt2 = self.endpt + '/' + x.to_s + "/agency"
+            endpt2 = if agency
+              endpt + "/" + x.to_s + "/agency"
             else
-              $endpt2 = self.endpt + '/' + x.to_s
+              endpt + "/" + x.to_s
             end
           end
 
-          js = self._req($endpt2, opts)
-          cu = js['message']['next-cursor']
-          max_avail = js['message']['total-results']
-          coll << self._redo_req(js, opts, cu, max_avail)
+          js = _req(conn, endpt2, opts)
+          cu = js["message"]["next-cursor"]
+          max_avail = js["message"]["total-results"]
+          coll << _redo_req(conn, js, opts, cu, max_avail)
         end
-        return coll
+        coll
       end
     end
 
-    def _redo_req(js, opts, cu, max_avail)
-      if !cu.nil? and self.cursor_max > js['message']['items'].length
+    def _redo_req(conn, js, opts, cu, max_avail)
+      if !cu.nil? && (cursor_max > js["message"]["items"].length)
         res = [js]
-        total = js['message']['items'].length
-        while !cu.nil? and self.cursor_max > total and total < max_avail do
+        total = js["message"]["items"].length
+        while !cu.nil? && (cursor_max > total) && (total < max_avail)
           opts[:cursor] = cu
-          out = self._req($endpt2, opts)
-          cu = out['message']['next-cursor']
+          out = _req(conn, endpt2, opts)
+          cu = out["message"]["next-cursor"]
           res << out
-          total = res.collect {|x| x['message']['items'].length}.reduce(0, :+)
+          total = res.collect { |x| x["message"]["items"].length }.sum
         end
-        return res
+        res
       else
-        return js
+        js
       end
     end
 
-    def _req(path, opts)
-      res = $conn.get path, opts
-      return MultiJson.load(res.body)
+    def _req(conn, path, opts)
+      res = conn.get path, opts
+      MultiJson.load(res.body)
     end
-
   end
 end

data/lib/serrano/styles.rb

@@ -1,23 +1,28 @@
+# frozen_string_literal: true
+
 require "faraday"
 require "multi_json"
 
-def get_styles
+def fetch_styles
   base = "https://api.github.com/repos/citation-style-language/styles"
-  conn = Faraday.new(:url => base)
-  args = { per_page: 1 }
-  tt = conn.get 'commits', args
+  conn = Faraday.new(url: base) { |f|
+    f.use FaradayMiddleware::RaiseHttpException
+    f.adapter Faraday.default_adapter
+  }
+  args = {per_page: 1}
+  tt = conn.get "commits", args
   commres = MultiJson.load(tt.body)
-  sha = commres[0]['sha']
+  sha = commres[0]["sha"]
   sty = conn.get "git/trees/" + sha
   res = MultiJson.load(sty.body)
-  files = res['tree'].collect { |x| x['path'] }
+  files = res["tree"].collect { |x| x["path"] }
   matches = files.collect { |x|
-    if x.match('csl').nil?
+    if x.match("csl").nil?
       nil
     else
-      x.match('csl').string
+      x.match("csl").string
     end
   }
   csls = matches.compact
-  return csls.collect { |z| z.gsub('.csl', '') }
+  csls.collect { |z| z.gsub(".csl", "") }
 end

data/lib/serrano/utils.rb

@@ -1,33 +1,35 @@
+# frozen_string_literal: true
+
 def make_ua
-  requa = 'Faraday/v' + Faraday::VERSION
-  habua = 'Serrano/v' + Serrano::VERSION
-  ua = requa + ' ' + habua
+  requa = "Faraday/v" + Faraday::VERSION
+  habua = "Serrano/v" + Serrano::VERSION
+  ua = requa + " " + habua
   if Serrano.mailto
-    ua = ua + " (mailto:%s)" % Serrano.mailto
+    ua += " (mailto:%s)" % Serrano.mailto
   end
-  return ua
+  # ua += format(' (mailto:%s)', Serrano.mailto) if Serrano.mailto
+  ua
 end
 
 def field_query_handler(x)
-	tmp = x.keep_if { |z| z.match(/query_/) }
-  return rename_query_filters(tmp)
+  tmp = x.keep_if { |z| z.match(/query_/) }
+  rename_query_filters(tmp)
 end
 
 def rename_query_filters(foo)
-	foo = foo.tostrings
-	foo = foo.map { |x,y| [x.to_s.sub('container_title', 'container-title'), y] }.to_h
-	foo = foo.map { |x,y| [x.to_s.sub('query_', 'query.'), y] }.to_h
-  return foo
+  foo = foo.tostrings
+  foo = foo.map { |x, y| [x.to_s.sub("container_title", "container-title"), y] }.to_h
+  foo.map { |x, y| [x.to_s.sub("query_", "query."), y] }.to_h
 end
 
 class Hash
-	def tostrings
-		Hash[self.map{|(k,v)| [k.to_s,v]}]
-	end
+  def tostrings
+    Hash[map { |(k, v)| [k.to_s, v] }]
+  end
 end
 
 class Hash
-	def tosymbols
-		Hash[self.map{|(k,v)| [k.to_sym,v]}]
-	end
+  def tosymbols
+    Hash[map { |(k, v)| [k.to_sym, v] }]
+  end
 end

data/lib/serrano/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Serrano
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/serrano.gemspec

@@ -1,38 +1,51 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+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        = '2018-04-08'
-  s.summary     = "Crossref Client"
+  s.name = "serrano"
+  s.version = Serrano::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 2.1"
+  s.date = "2020-10-19"
+  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.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 {|f| f.match(%r{^(test|spec|features)/}) }
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   s.require_paths = ["lib"]
 
-  s.bindir      = 'bin'
-  s.executables = ['serrano']
+  s.bindir = "bin"
+  s.executables = ["serrano"]
+
+  s.add_development_dependency "bundler", '~> 2.1', '>= 2.1.4'
+  s.add_development_dependency "codecov", "~> 0.2.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", "~> 0.7"
+  s.add_development_dependency "simplecov", "~> 0.19.0"
+  s.add_development_dependency "test-unit", '~> 3.3', '>= 3.3.6'
+  s.add_development_dependency "vcr", "~> 6.0"
+  s.add_development_dependency "webmock", '~> 3.9', '>= 3.9.3'
 
-  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.1'
-  s.add_development_dependency 'vcr', '~> 4.0'
-  s.add_development_dependency 'webmock', '~> 3.3'
+  s.add_runtime_dependency "faraday", "~> 1.1"
+  s.add_runtime_dependency "faraday_middleware", "~> 1.0"
+  s.add_runtime_dependency "multi_json", '~> 1.15'
+  s.add_runtime_dependency 'thor', '~> 1.0', '>= 1.0.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'
+  s.metadata = {
+    "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"
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serrano
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Scott Chamberlain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,192 +16,218 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.1
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '2.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.1
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.7
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.7
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: json
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.3
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: 1.0.1
 description: Low Level Ruby Client for the Crossref Search API
 email: myrmecocystus@gmail.com
 executables:
@@ -209,12 +235,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -222,8 +247,6 @@ files:
 - lib/serrano.rb
 - lib/serrano/cn.rb
 - lib/serrano/cnrequest.rb
-- lib/serrano/constants.rb
-- lib/serrano/cursor_testing.rb
 - lib/serrano/error.rb
 - lib/serrano/faraday.rb
 - lib/serrano/filterhandler.rb
@@ -238,7 +261,12 @@ files:
 homepage: https://github.com/sckott/serrano
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/sckott/serrano
+  documentation_uri: https://www.rubydoc.info/gems/serrano
+  changelog_uri: https://github.com/sckott/serrano/releases/tag/v1.0.0
+  source_code_uri: https://github.com/sckott/serrano
+  bug_tracker_uri: https://github.com/sckott/serrano/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -254,8 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Crossref Client