serrano 0.3.6 → 0.6.2

data/lib/serrano/helpers/configuration.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 # taken from: https://viget.com/extend/easy-gem-configuration-variables-with-defaults
 module Configuration
-
   def configuration
     yield self
   end
@@ -22,5 +23,4 @@ module Configuration
       define_method name, &block
     end
   end
-
 end

data/lib/serrano/request.rb

@@ -1,7 +1,9 @@
-require "faraday"
-require "multi_json"
-require "serrano/error"
-require "serrano/constants"
+# frozen_string_literal: true
+
+require 'erb'
+require 'faraday'
+require 'multi_json'
+require 'serrano/error'
 require 'serrano/utils'
 require 'serrano/helpers/configuration'
 
@@ -11,7 +13,6 @@ require 'serrano/helpers/configuration'
 # Class to perform HTTP requests to the Crossref API
 module Serrano
   class Request #:nodoc:
-
     attr_accessor :endpt
     attr_accessor :id
     attr_accessor :query
@@ -22,14 +23,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 +43,7 @@ module Serrano
       self.sort = sort
       self.order = order
       self.facet = facet
+      self.select = select
       self.works = works
       self.agency = agency
       self.options = options
@@ -48,49 +51,53 @@ module Serrano
     end
 
     def perform
-      filt = filter_handler(self.filter)
+      filt = filter_handler(filter)
 
-      args = { query: self.query, filter: filt, offset: self.offset,
-              rows: self.limit, sample: self.sample, sort: self.sort,
-              order: self.order, facet: self.facet }
-      opts = args.delete_if { |k, v| v.nil? }
+      self.select = select.join(',') if select && select.class == Array
 
-      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
-        end
-      else
-        conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
-          f.adapter  Faraday.default_adapter
-          f.use FaradayMiddleware::RaiseHttpException
-        end
-      end
+      args = { query: query, filter: filt, offset: offset,
+               rows: limit, sample: sample, sort: sort,
+               order: order, facet: facet,
+               select: select }
+      opts = args.delete_if { |_k, v| v.nil? }
+
+      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
+               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['X-USER-AGENT'] = make_ua
 
-      if self.id.nil?
-        res = conn.get self.endpt, opts
-        return MultiJson.load(res.body)
+      if id.nil?
+        res = conn.get endpt, opts
+        MultiJson.load(res.body)
       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
-            endpt = self.endpt + '/' + x.to_s + "/works"
-          else
-            if self.agency
-              endpt = self.endpt + '/' + x.to_s + "/agency"
-            else
-              endpt = self.endpt + '/' + x.to_s
-            end
-          end
+        id.each do |x|
+          endpt = if works
+                    self.endpt + '/' + x.to_s + '/works'
+                  elsif agency
+                    self.endpt + '/' + x.to_s + '/agency'
+                  else
+                    self.endpt + '/' + x.to_s
+                  end
 
           res = conn.get endpt, opts
           coll << MultiJson.load(res.body)
         end
-        return coll
+        coll
       end
     end
   end

data/lib/serrano/request_cursor.rb

@@ -1,8 +1,10 @@
-require "faraday"
+# frozen_string_literal: true
+
+require 'erb'
+require 'faraday'
 require 'faraday_middleware'
-require "multi_json"
-require "serrano/error"
-require "serrano/constants"
+require 'multi_json'
+require 'serrano/error'
 require 'serrano/helpers/configuration'
 require 'serrano/filterhandler'
 require 'serrano/error'
@@ -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
@@ -26,6 +27,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 +37,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 +51,7 @@ module Serrano
       self.sort = sort
       self.order = order
       self.facet = facet
+      self.select = select
       self.works = works
       self.agency = agency
       self.options = options
@@ -58,86 +62,89 @@ module Serrano
     end
 
     def perform
-      filt = filter_handler(self.filter)
-      fieldqueries = field_query_handler(self.args)
+      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.class != Fixnum
-          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, 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|
-          f.response :logger
-          f.adapter Faraday.default_adapter
-          f.use FaradayMiddleware::RaiseHttpException
-        end
-      else
-        $conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
-          f.adapter Faraday.default_adapter
-          f.use FaradayMiddleware::RaiseHttpException
-        end
-      end
+      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
+               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 self.id.nil?
-        js = self._req(self.endpt, opts)
+      if id.nil?
+        endpt2 = endpt
+        js = _req(conn, endpt, opts)
         cu = js['message']['next-cursor']
         max_avail = js['message']['total-results']
-        res = self._redo_req(js, opts, cu, max_avail)
-        return res
+        res = _redo_req(conn, js, opts, cu, max_avail)
+        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"
-          else
-            if self.agency
-              $endpt2 = self.endpt + '/' + x.to_s + "/agency"
-            else
-              $endpt2 = self.endpt + '/' + x.to_s
-            end
-          end
+        id.each do |x|
+          endpt2 = if works
+                     endpt + '/' + x.to_s + '/works'
+                   else
+                     endpt2 = if agency
+                                endpt + '/' + x.to_s + '/agency'
+                              else
+                                endpt + '/' + x.to_s
+                              end
+                   end
 
-          js = self._req($endpt2, opts)
+          js = _req(conn, endpt2, opts)
           cu = js['message']['next-cursor']
           max_avail = js['message']['total-results']
-          coll << self._redo_req(js, opts, cu, max_avail)
+          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
+        while !cu.nil? && (cursor_max > total) && (total < max_avail)
           opts[:cursor] = cu
-          out = self._req($endpt2, opts)
+          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 }.reduce(0, :+)
         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 @@
-require "faraday"
-require "multi_json"
+# frozen_string_literal: true
 
-def get_styles
-  base = "https://api.github.com/repos/citation-style-language/styles"
-  conn = Faraday.new(:url => base)
+require 'faraday'
+require 'multi_json'
+
+def fetch_styles
+  base = 'https://api.github.com/repos/citation-style-language/styles'
+  conn = Faraday.new(url: base) do |f|
+    f.use FaradayMiddleware::RaiseHttpException
+    f.adapter Faraday.default_adapter
+  end
   args = { per_page: 1 }
   tt = conn.get 'commits', args
   commres = MultiJson.load(tt.body)
   sha = commres[0]['sha']
-  sty = conn.get "git/trees/" + sha
+  sty = conn.get 'git/trees/' + sha
   res = MultiJson.load(sty.body)
   files = res['tree'].collect { |x| x['path'] }
-  matches = files.collect { |x|
+  matches = files.collect do |x|
     if x.match('csl').nil?
       nil
     else
       x.match('csl').string
     end
-  }
+  end
   csls = matches.compact
-  return csls.collect { |z| z.gsub('.csl', '') }
+  csls.collect { |z| z.gsub('.csl', '') }
 end

data/lib/serrano/utils.rb

@@ -1,29 +1,36 @@
+# frozen_string_literal: true
+
 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
+  # 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 = foo.map { |x, y| [x.to_s.sub('query_', 'query.'), y] }.to_h
+  foo
 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.3.6"
+  VERSION = '0.6.2'
 end

data/serrano.gemspec

@@ -1,5 +1,6 @@
-# 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'
 
@@ -7,32 +8,44 @@ 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.summary     = "Crossref Client"
-  s.description = "Low Level Ruby Client for the Crossref Search API"
-  s.authors     = "Scott Chamberlain"
+  s.required_ruby_version = '>= 2.1'
+  s.date        = '2020-05-29'
+  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 {|f| f.match(%r{^(test|spec|features)/}) }
-  s.require_paths = ["lib"]
+  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.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', '~> 2.0', '>= 2.0.2'
   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 'rake', '>= 12.3.1', '~> 13.0'
+  s.add_development_dependency 'rubocop', '~> 0.84.0'
+  s.add_development_dependency 'simplecov', '~> 0.18.5'
+  s.add_development_dependency 'test-unit', '~> 3.2', '>= 3.2.7'
+  s.add_development_dependency 'vcr', '~> 6.0'
+  s.add_development_dependency 'webmock', '~> 3.4', '>= 3.4.1'
+
+  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'faraday_middleware', '~> 1.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', '~> 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.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