serrano 0.3.0 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e8d485b799d87d73a32f1b1324a004647407fa
-  data.tar.gz: cbba210bf1dbb7df00ef98b8e6824294a00472cd
+  metadata.gz: 36aad2a16040c5453b6f8254a7b6d01fad661c43
+  data.tar.gz: abdf146c4875f0ef7abbdf9b14dafb71c47bc7a9
 SHA512:
-  metadata.gz: 65b752d0ab2e82da21b73569217a630affc64faa25947050311c30925f8eedd55469ae622d6bd19734929b4fb791c6e146f32d7c627300bd65ff5b9dd7eb4875
-  data.tar.gz: bdd2dbe1a0e6b6c21ce71d404efdf0b97b61b02387f9363519821bd570eddc819bdcb545e375a7a794f186f9fb34cacc4a7fa800cf7634b3dd2b203e9d82b7ad
+  metadata.gz: '008664dcd932464f6360bf16c6a6cb097e326809c57d4e76e38ceee321aef9fe21d42ce1972e9a1e4db21cb53f2326f2aa9b3e8323be1a984ea13277b9f33756'
+  data.tar.gz: b5aeb13570f7907266f79879b4b141c1eea6576313d8758eb1c6cdf3f9b8467ea96cb3fa036ee73dd8b2a332dff4c04a2481e81795111e98010d2dfd388e55e8

data/.travis.yml

@@ -3,5 +3,6 @@ cache: bundler
 rvm:
   - 2.1.8
   - 2.2.4
+  - 2.4.1
 script:
   bundle exec rake test TESTOPTS="-v"

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.3.6 (2017-04-04)
+
+* Updated dependency versions
+* Now using `vcr` gem for caching HTTP requests for test suite (#38)
+* Changed base URL for Crossref API for all requests to `https` (#37)
+* Updated docs for `facet` parameter that it can be either a
+boolean or a query string, e.g,. `license:*` to facet by license (#36)
+* Documented in `offset` parameter the max of 10K instituted somewhat
+recently (#34)
+* Documented in top level `Serrano` module and in README the new
+rate limit on all requests - which varies through time. (#32)
+
 ## 0.3.0 (2016-10-20)
 
 * Field queries now supported in appropriate methods:

data/Gemfile.lock

@@ -1,50 +1,64 @@
 PATH
   remote: .
   specs:
-    serrano (0.3.0)
-      faraday (~> 0.9.2)
-      faraday_middleware (~> 0.10.0)
+    serrano (0.3.1)
+      faraday (~> 0.12.0.1)
+      faraday_middleware (~> 0.11.0.1)
       multi_json (~> 1.12, >= 1.12.1)
-      thor (~> 0.19.1)
+      thor (~> 0.19.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    codecov (0.1.6)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    codecov (0.1.10)
       json
       simplecov
       url
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     docile (1.1.5)
-    faraday (0.9.2)
+    faraday (0.12.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.10.0)
-      faraday (>= 0.7.4, < 0.10)
-    json (2.0.2)
+    faraday_middleware (0.11.0.1)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.2)
+    json (2.0.3)
     multi_json (1.12.1)
     multipart-post (2.0.0)
     power_assert (0.3.1)
-    rake (11.3.0)
-    simplecov (0.12.0)
+    public_suffix (2.0.5)
+    rake (12.0.0)
+    safe_yaml (1.0.4)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     test-unit (3.2.1)
       power_assert
-    thor (0.19.1)
+    thor (0.19.4)
     url (0.3.2)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.13, >= 1.13.5)
-  codecov (~> 0.1.6)
-  json (~> 2.0, >= 2.0.2)
-  rake (~> 11.3)
+  bundler (~> 1.14, >= 1.14.6)
+  codecov (~> 0.1.10)
+  json (~> 2.0, >= 2.0.3)
+  rake (~> 12.0, >= 12.0.0)
   serrano!
-  simplecov (~> 0.12.0)
+  simplecov (~> 0.14.1)
   test-unit (~> 3.2, >= 3.2.1)
+  vcr (~> 3.0, >= 3.0.3)
+  webmock (~> 2.3, >= 2.3.2)
 
 BUNDLED WITH
-   1.13.5
+   1.14.6

data/README.md

@@ -46,6 +46,15 @@ Note about searching:
 
 You are using the Crossref search API described at https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md. 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://github.com/CrossRef/rest-api-doc/issues/101
 
+Rate limits:
+
+Crossref introduced rate limiting recently. The rate limits apparently vary,
+so we can't give a predictable rate limit. As of this writing, the rate
+limit is 50 requests per second. Look for the headers `X-Rate-Limit-Limit`
+and `X-Rate-Limit-Interval` in requests to see what the current rate
+limits are.
+
+
 ## Install
 
 ### Release version

data/lib/serrano.rb

@@ -10,8 +10,9 @@ require 'rexml/document'
 require 'rexml/xpath'
 
 # @!macro serrano_params
-#   @param offset [Fixnum] Number of record to start at, from 1 to infinity.
-#   @param limit [Fixnum] Number of results to return. Not relavant when searching with specific dois. Default: 20. Max: 1000
+#   @param offset [Fixnum] Number of record to start at, any non-negative integer up to 10,000
+#   @param limit [Fixnum] Number of results to return. Not relavant when searching with specific dois.
+#       Default: 20. Max: 1000
 #   @param sample [Fixnum] Number of random results to return. when you use the sample parameter,
 #       the limit and offset parameters are ignored. This parameter only used when works requested.
 #       Max: 100.
@@ -22,7 +23,8 @@ require 'rexml/xpath'
 #       order will be by the relevance score. If no query is included, then the sort order
 #       will be by DOI update date.
 #   @param order [String] Sort order, one of 'asc' or 'desc'
-#   @param facet [Boolean] Include facet results. Default: false
+#   @param facet [Boolean/String] Include facet results OR a query (e.g., `license:*`) to facet by
+#       license. Default: false
 #   @param verbose [Boolean] Print request headers to stdout. Default: false
 
 # @!macro cursor_params
@@ -90,13 +92,20 @@ require 'rexml/xpath'
 # available in the data that is returned to you. That is, they search
 # article titles, authors, etc. For some discussion on this, see
 # https://github.com/CrossRef/rest-api-doc/issues/101
+#
+# Rate limiting
+# Crossref introduced rate limiting recently. The rate limits apparently vary,
+# so we can't give a predictable rate limit. As of this writing, the rate
+# limit is 50 requests per second. Look for the headers `X-Rate-Limit-Limit`
+# and `X-Rate-Limit-Interval` in requests to see what the current rate
+# limits are.
 
 module Serrano
   extend Configuration
 
   define_setting :access_token
   define_setting :access_secret
-  define_setting :base_url, "http://api.crossref.org/"
+  define_setting :base_url, "https://api.crossref.org/"
 
   ##
   # Search the works route

data/lib/serrano/faraday.rb

@@ -63,7 +63,7 @@ module FaradayMiddleware
     def is_json?(string)
       MultiJson.load(string)
       return true
-    rescue MultiJson::ParseError => e
+    rescue MultiJson::ParseError
       return false
     end
 

data/lib/serrano/request.rb

@@ -56,13 +56,13 @@ module Serrano
       opts = args.delete_if { |k, v| v.nil? }
 
       if verbose
-        conn = Faraday.new(:url => Serrano.base_url, :request => options) do |f|
+        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|
+        conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
           f.adapter  Faraday.default_adapter
           f.use FaradayMiddleware::RaiseHttpException
         end

data/lib/serrano/request_cursor.rb

@@ -74,13 +74,13 @@ module Serrano
       opts = arguments.delete_if { |k, v| v.nil? }
 
       if verbose
-        $conn = Faraday.new(:url => Serrano.base_url, :request => options) do |f|
+        $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|
+        $conn = Faraday.new(:url => Serrano.base_url, :request => options || []) do |f|
           f.adapter Faraday.default_adapter
           f.use FaradayMiddleware::RaiseHttpException
         end

data/lib/serrano/version.rb

@@ -1,3 +1,3 @@
 module Serrano
-  VERSION = "0.3.0"
+  VERSION = "0.3.6"
 end

data/serrano.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version     = Serrano::VERSION
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.0'
-  s.date        = '2016-10-20'
+  s.date        = '2017-04-04'
   s.summary     = "Crossref Client"
   s.description = "Low Level Ruby Client for the Crossref Search API"
   s.authors     = "Scott Chamberlain"
@@ -22,15 +22,17 @@ Gem::Specification.new do |s|
   s.bindir      = 'bin'
   s.executables = ['serrano']
 
-  s.add_development_dependency 'bundler', '~> 1.13', '>= 1.13.5'
-  s.add_development_dependency 'rake', '~> 11.3'
+  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.12.0'
-  s.add_development_dependency 'codecov', '~> 0.1.6'
-  s.add_development_dependency 'json', '~> 2.0', '>= 2.0.2'
+  s.add_development_dependency 'simplecov', '~> 0.14.1'
+  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_runtime_dependency 'faraday', '~> 0.9.2'
-  s.add_runtime_dependency 'faraday_middleware', '~> 0.10.0'
-  s.add_runtime_dependency 'thor', '~> 0.19.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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serrano
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.6
 platform: ruby
 authors:
 - Scott Chamberlain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,34 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.5
+        version: 1.14.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.13.5
+        version: 1.14.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -70,28 +76,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.10
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +107,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -111,49 +117,89 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.12.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 0.12.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.4
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -227,9 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Crossref Client
 test_files: []
-has_rdoc: