ref2bibtex 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c153ef1ea1467b62160f9e8459db3a108d88a3dd
-  data.tar.gz: 4a4f80870eb9512f4d2b747f809ea9a6cfdf4486
+SHA256:
+  metadata.gz: ca0c289e6130dd3be2e0f7a550a7d05c3f492c9cf1fe0d3ec66e64ec04d2dba2
+  data.tar.gz: 2f2f5e9d4c1b79092a72a27851b64a6cf4e608d44c9f4ac6acfac30d5afdaaaa
 SHA512:
-  metadata.gz: c2316279add7c7bbd4b77c43786d7b5c9dc1ada8b0f7d57be9a936b51859512c02958907baf5214f802aeae713450d332c5e0b751367c71f4dfecb5607669d59
-  data.tar.gz: c73aacc42c22c4d7c87d1e4450325dffffb31912800551d5aba3cc522f77b440cb73e41c3061acd753e10581d616a4d39708062a2711c5ae241291f9d1791540
+  metadata.gz: 1fea65fa7e3b3931440512a5df8c6f4c01ea8ae2537868c97a6e83a6118f4efe9a5f0f0eb615db08080cbb3fc1e4f67368725c1c31db84c9bc053914660f49fe
+  data.tar.gz: 3923cc54cfbf6c0cff0c1c2d1fe5d170af15dad1de7b47d4000aaf04c3352dcfd94d4ecc2f136de991f47b0cfcbcfb7c27e976877fec51c0b0aab98002b75d5d

data/.travis.yml

@@ -1,8 +1,10 @@
 ---
 rvm:
-  - 2.3.3
+  - 2.5.1
 branches:
   only:
     - master
 install:
   - bundle install
+cache:
+  bundler: true

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    ref2bibtex (0.2.3)
-      addressable (~> 2.5)
+    ref2bibtex (0.3.0)
+      addressable (~> 2.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     awesome_print (1.8.0)
-    byebug (9.1.0)
+    byebug (11.0.0)
     diff-lcs (1.3)
     public_suffix (3.0.3)
     rake (12.3.2)
@@ -33,11 +33,11 @@ PLATFORMS
 
 DEPENDENCIES
   awesome_print (~> 1.8.0)
-  bundler (~> 1.16)
-  byebug (~> 9.1)
+  bundler (~> 2.0)
+  byebug (~> 11)
   rake (~> 12.3)
   ref2bibtex!
-  rspec
+  rspec (~> 3.8)
 
 BUNDLED WITH
-   1.17.1
+   2.0.1

data/lib/ref2bibtex.rb

@@ -1,11 +1,13 @@
-recent_ruby = RUBY_VERSION >= '2.1.0'
-raise "IMPORTANT:  gem requires ruby >= 2.1.0" unless recent_ruby
+recent_ruby = RUBY_VERSION >= '2.3.0'
+raise "IMPORTANT:  gem requires ruby >= 2.3.0" unless recent_ruby
 
 require "ref2bibtex/version"
 require 'json'
 require 'net/http'
 require 'cgi'
-require "addressable/uri"
+require 'addressable/uri'
+
+# require 'serrano'
 
 module Ref2bibtex
 
@@ -48,33 +50,46 @@ module Ref2bibtex
     end
   end
 
-  # Pass a String doi get a bibtex formatted string back 
-  #
+  # @params doi [String]
+  # @return [String, false] 
   def self.get_bibtex(doi)
     return false if !doi
+
     doi = Addressable::URI.parse(doi).normalize.to_s
     uri = URI(doi)
     return false if uri.class == URI::Generic
-    response = Ref2bibtex.request(uri, headers: {'Accept' => 'application/x-bibtex' }, protocol: 'GET', process_response_as: 'text') 
+
+    # Serrano.content_negotiation(ids: doi).first
+
+    Ref2bibtex.request(uri, headers: {'Accept' => 'application/x-bibtex' }, protocol: 'GET', process_response_as: 'text') 
   end
- 
+
+  # @param citation [String] 
+  # @return [String, false]
   # Pass a String citation, get a DOI back
   def self.get_doi(citation)
     citation = validate_query(citation)
     response = Ref2bibtex.request(payload: citation) 
-
-    return false if !response['results'][0]['match']
+    return false unless has_match?(response) 
     return false if response['results'][0]['score'] < @@cutoff
-
     response['results'][0]['doi']
   end
 
+  # @param citation [String]
+  # @return [Float, -1.0
   # Pass a String citation, get a score back
   def self.get_score(citation)
     citation = validate_query(citation)
     response = Ref2bibtex.request(payload: citation) 
-    return false if !response['results'][0]['match']
-    response['results'][0]['score']
+    if has_match?(response)
+      response['results'].first['score']
+    else
+      -1.0
+    end
+  end
+
+  def self.has_match?(response)
+    response['query_ok'] && response['results']&.first['match']
   end
 
   def self.validate_query(citation)
@@ -116,10 +131,11 @@ module Ref2bibtex
         http.request(request) 
       end
     else
+
       response = response.value
     end
 
-     process_response(response, process_response_as)
+    process_response(response, process_response_as)
   end
 
   protected

data/lib/ref2bibtex/version.rb

@@ -1,3 +1,3 @@
 module Ref2bibtex
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/ref2bibtex.gemspec

@@ -18,12 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "addressable", "~> 2.5"
+  spec.add_dependency "addressable", "~> 2.6"
+  # spec.add_dependency "serrano"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "byebug", "~> 11"
   spec.add_development_dependency "awesome_print", "~> 1.8.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.8"
 
 end

data/spec/ref2bibtex_spec.rb

@@ -28,7 +28,7 @@ describe Ref2bibtex do
 
   context '.get_doi' do
     specify 'takes a full citation and returns a string' do
-      expect(Ref2bibtex.get_doi(CITATIONS[:first])).to eq('http://dx.doi.org/10.3897/zookeys.20.205')
+      expect(Ref2bibtex.get_doi(CITATIONS[:first])).to eq('https://doi.org/10.3897/zookeys.20.205')
     end
 
     specify 'a citation that can not be resolved returns false' do
@@ -41,7 +41,7 @@ describe Ref2bibtex do
   end
 
   context '.get_bibtex' do  
-    let(:response) { Ref2bibtex.get_bibtex('http://dx.doi.org/10.3897/zookeys.20.205')}
+    let(:response) { Ref2bibtex.get_bibtex('https://dx.doi.org/10.3897/zookeys.20.205')}
     specify 'takes a full citation and returns bibtex' do
       expect(response).to match(/author\s=/)
       expect(response).to match(/title\s=/)
@@ -71,10 +71,12 @@ describe Ref2bibtex do
     context 'interpretation' do
       before(:all) {
         @scores =  CITATIONS.keys.inject({}) { |hsh, c|
+          sleep 0.5 # throttle timing a little 
           hsh.merge!(
             c => Ref2bibtex.get_score(CITATIONS[c])
           )
         }
+        @scores
       }
 
       specify 'mangled text is worse than good text' do
@@ -82,7 +84,7 @@ describe Ref2bibtex do
       end
 
       context 'default @@cutoff is reasonable and slightly conservative' do
-        let(:good_citations) { [:first, :second, :third, :fourth, :sixth] }
+        let(:good_citations) { [:first, :second, :third] } # remainders have moved to unresolvable
         let(:bad_citations) { CITATIONS.keys - good_citations }
 
         specify 'for good citations' do
@@ -94,6 +96,7 @@ describe Ref2bibtex do
         specify 'for bad citations' do
           bad_citations.each do |c|
             if @scores[c]
+
               expect(@scores[c]).to be < Ref2bibtex.cutoff
             end
           end
@@ -111,7 +114,8 @@ describe Ref2bibtex do
         expect(Ref2bibtex.get_doi(CITATIONS[:first])).to eq(false)
       end 
 
-      specify 'can be used to accept bad matches' do
+      # Cutoff is more finely tuned to exclude bad matches now. 
+      xspecify 'can be used to accept bad matches' do
         Ref2bibtex.cutoff = 1 
         expect(Ref2bibtex.get_doi(CITATIONS[:fifth])).to be_truthy
       end 

data/spec/support/citations.yml

@@ -10,7 +10,7 @@
 :fifth:
   "Iam, F.K. 1337. Let's go Crossref, give me a DOI for this fake reference in my unit test, I dare you. Journal of Examples for Unit tests. 13:37"
 :sixth:
-  "Simon, E. (1879b) Les Arachnides de France. Tome 7. Contenant les ordres des Chernetes, Scorpiones et Opiliones. Librairie Encyclopédique de Roret, Paris, pp. 1–332, pl. 17–24. "
+  "Simon, E. (1879b) Les Arachnides de France. Tome 7. Contenant les ordres des Chernetes, Scorpiones et Opiliones. Librairie Encyclopédique de Roret, Paris, pp. 1–332, pl. 17–24."
 :seventh: 
   'Jaost & K.P. Shuw. 2007. Phyloguny of Ensifere (Hesapoda: Prthoptera) usine threa rubosomal toci, wuth implocations far teh evolushun off acoustik commmunication. Tolecular Fylogenetics & Evolotion (Mul. Phylagenet. Evil.) 39:509-528'
 :eighth:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ref2bibtex
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Yoder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 description: Ok, maybe a bit more, you can pass a DOI and get the bibtex string back
   too.
 email:
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Pass a full citation, get the bibtex back, that's all.