ref2bibtex 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/.ref2bibtex_user_email +1 -0
  3. data/Gemfile.lock +22 -20
  4. data/README.md +14 -1
  5. data/lib/ref2bibtex.rb +11 -1
  6. data/lib/ref2bibtex/version.rb +1 -1
  7. data/ref2bibtex.gemspec +6 -4
  8. metadata +28 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9347ef3a44df67822d6b32772740952b9964a487
4
- data.tar.gz: 212dc75413f1a0b1f443cb354809d619df77b7ff
3
+ metadata.gz: ca25c7e6a5d42c5acfc5f6a7541392e3860b9abc
4
+ data.tar.gz: 72ee02840be1198392321bfbf1da7990a25d87fb
5
5
  SHA512:
6
- metadata.gz: 2932f6e00caaab1aaf60741711f4c85abd8f64a54e1f5766d989e4845bb875858b08e52fe1be3ecc16e70cfb4d59de9ab116c2461b10a89b710481a62727f689
7
- data.tar.gz: ae48bf3cb3724165ce0c2508ca0efd598c9520e19b4aa6587d3d9467bd10858856a5691ec2d77f7db10d895f89525d78234b72cd6f5a49a3a110f55a1fca3d34
6
+ metadata.gz: 84613b9093e2e02215fbfa4ab126295e7dcf0010a86d29a0dbca01f8f2be7017ce6850798f38823dd204db1dfb09ad2aa3c54a51ee3f63e6e35c8f110d239d26
7
+ data.tar.gz: c61bdb10dc5c4ce5c5cde585bc6ae27fdb27be00976fac712674c3847e16cfddfb3e414a5dc1e3600d22e90b79751cfbbdc5ed4cab69209e0d15eda4be212250
data/.ref2bibtex_user_email ADDED
@@ -0,0 +1 @@
1
+ https%3A%2F%2Fgithub.com%2FSpeciesFileGroup%2Fref2bibtex
data/Gemfile.lock CHANGED
@@ -1,39 +1,41 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- ref2bibtex (0.1.1)
4
+ ref2bibtex (0.2.0)
5
+ json (~> 2.1)
5
6
 
6
7
  GEM
7
8
  remote: https://rubygems.org/
8
9
  specs:
9
- awesome_print (1.7.0)
10
- byebug (9.0.6)
10
+ awesome_print (1.8.0)
11
+ byebug (9.1.0)
11
12
  diff-lcs (1.3)
12
- rake (12.0.0)
13
- rspec (3.6.0)
14
- rspec-core (~> 3.6.0)
15
- rspec-expectations (~> 3.6.0)
16
- rspec-mocks (~> 3.6.0)
17
- rspec-core (3.6.0)
18
- rspec-support (~> 3.6.0)
19
- rspec-expectations (3.6.0)
13
+ json (2.1.0)
14
+ rake (12.3.0)
15
+ rspec (3.7.0)
16
+ rspec-core (~> 3.7.0)
17
+ rspec-expectations (~> 3.7.0)
18
+ rspec-mocks (~> 3.7.0)
19
+ rspec-core (3.7.0)
20
+ rspec-support (~> 3.7.0)
21
+ rspec-expectations (3.7.0)
20
22
  diff-lcs (>= 1.2.0, < 2.0)
21
- rspec-support (~> 3.6.0)
22
- rspec-mocks (3.6.0)
23
+ rspec-support (~> 3.7.0)
24
+ rspec-mocks (3.7.0)
23
25
  diff-lcs (>= 1.2.0, < 2.0)
24
- rspec-support (~> 3.6.0)
25
- rspec-support (3.6.0)
26
+ rspec-support (~> 3.7.0)
27
+ rspec-support (3.7.0)
26
28
 
27
29
  PLATFORMS
28
30
  ruby
29
31
 
30
32
  DEPENDENCIES
31
- awesome_print
32
- bundler (~> 1.6)
33
- byebug (~> 9.0)
34
- rake (~> 12.0)
33
+ awesome_print (~> 1.8.0)
34
+ bundler (~> 1.16)
35
+ byebug (~> 9.1)
36
+ rake (~> 12.3)
35
37
  ref2bibtex!
36
38
  rspec
37
39
 
38
40
  BUNDLED WITH
39
- 1.14.6
41
+ 1.16.0
data/README.md CHANGED
@@ -1,11 +1,24 @@
1
1
  [![Build Status](https://travis-ci.org/SpeciesFileGroup/ref2bibtex.svg?branch=master)](https://travis-ci.org/SpeciesFileGroup/ref2bibtex)
2
+ [![Dependency Status](https://gemnasium.com/badges/github.com/SpeciesFileGroup/ref2bibtex.svg)](https://gemnasium.com/github.com/SpeciesFileGroup/ref2bibtex)
2
3
 
3
4
  # ref2bibtex
4
5
 
5
- An (almost) single purpose gem wrapping Crossref's API. Pass it a full reference string, get back BibTeX. Pass it a DOI, get BibTeX.
6
+ An (almost) single purpose gem wrapping Crossref's API. Pass it a full reference string, get back BibTeX. Pass it a DOI, get BibTeX. Want something more complex? See [serrano](https://github.com/sckott/serrano).
6
7
 
7
8
  # usage
8
9
 
10
+ Be polite (https://github.com/CrossRef/rest-api-doc#etiquette). Provide a email as per CrossRef recommendations. Do this by:
11
+
12
+ 1) Add it to the file ~/.ref2bibtex_user_email.
13
+
14
+ 2) Add it to the file .env in the root of your application:
15
+
16
+ REF2BIBTEX_USER_EMAIL=user@example.com
17
+
18
+ 3) Set REF2BIBTEX_USER_EMAIL in your shell profile.
19
+
20
+ If the email is set in multiple places priority is reverse order listed here.
21
+
9
22
  Use citation2bibtex (aliased _get_):
10
23
 
11
24
  ```ruby
data/lib/ref2bibtex.rb CHANGED
@@ -7,8 +7,18 @@ require 'net/http'
7
7
 
8
8
  module Ref2bibtex
9
9
 
10
+ USER_EMAIL_FILE_PATH = File.expand_path("~/.ref2bibtex_user_email")
11
+ key = nil
12
+ key = File.read(USER_EMAIL_FILE_PATH).strip if File.exists?(USER_EMAIL_FILE_PATH)
13
+ USER_EMAIL_FILE = key
14
+ USER_EMAIL_ENV = ENV['REF2BIBTEX_USER_EMAIL']
15
+
16
+ USER_EMAIL = USER_EMAIL_FILE || USER_EMAIL_ENV || nil
17
+
18
+ warn "\n\n !! User email not set in ~/.ref2bibtex_user_email, .env, or ENV, you're not being a polite user! (https://github.com/CrossRef/rest-api-doc)!! \n\n" if USER_EMAIL.nil? || USER_EMAIL == 'https%3A%2F%2Fgithub.com%2FSpeciesFileGroup%2Fref2bibtex'
19
+
10
20
  # By default sorts by score
11
- CROSSREF_URI = URI('http://search.crossref.org/links')
21
+ CROSSREF_URI = URI("https://search.crossref.org/links?mailto=#{USER_EMAIL}")
12
22
 
13
23
  DEFAULT_CUTOFF = 50
14
24
 
data/lib/ref2bibtex/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Ref2bibtex
2
- VERSION = "0.1.1"
2
+ VERSION = "0.2.0"
3
3
  end
data/ref2bibtex.gemspec CHANGED
@@ -18,10 +18,12 @@ Gem::Specification.new do |spec|
18
18
  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
19
  spec.require_paths = ["lib"]
20
20
 
21
- spec.add_development_dependency "bundler", "~> 1.6"
22
- spec.add_development_dependency "rake", "~> 12.0"
23
- spec.add_development_dependency "byebug", "~> 9.0"
24
- spec.add_development_dependency "awesome_print"
21
+ spec.add_dependency "json", "~> 2.1"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.16"
24
+ spec.add_development_dependency "rake", "~> 12.3"
25
+ spec.add_development_dependency "byebug", "~> 9.1"
26
+ spec.add_development_dependency "awesome_print", "~> 1.8.0"
25
27
  spec.add_development_dependency "rspec"
26
28
 
27
29
  end
metadata CHANGED
@@ -1,71 +1,85 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ref2bibtex
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Matt Yoder
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-06-07 00:00:00.000000000 Z
11
+ date: 2017-11-30 00:00:00.000000000 Z
12
12
  dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: json
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.1'
13
27
  - !ruby/object:Gem::Dependency
14
28
  name: bundler
15
29
  requirement: !ruby/object:Gem::Requirement
16
30
  requirements:
17
31
  - - "~>"
18
32
  - !ruby/object:Gem::Version
19
- version: '1.6'
33
+ version: '1.16'
20
34
  type: :development
21
35
  prerelease: false
22
36
  version_requirements: !ruby/object:Gem::Requirement
23
37
  requirements:
24
38
  - - "~>"
25
39
  - !ruby/object:Gem::Version
26
- version: '1.6'
40
+ version: '1.16'
27
41
  - !ruby/object:Gem::Dependency
28
42
  name: rake
29
43
  requirement: !ruby/object:Gem::Requirement
30
44
  requirements:
31
45
  - - "~>"
32
46
  - !ruby/object:Gem::Version
33
- version: '12.0'
47
+ version: '12.3'
34
48
  type: :development
35
49
  prerelease: false
36
50
  version_requirements: !ruby/object:Gem::Requirement
37
51
  requirements:
38
52
  - - "~>"
39
53
  - !ruby/object:Gem::Version
40
- version: '12.0'
54
+ version: '12.3'
41
55
  - !ruby/object:Gem::Dependency
42
56
  name: byebug
43
57
  requirement: !ruby/object:Gem::Requirement
44
58
  requirements:
45
59
  - - "~>"
46
60
  - !ruby/object:Gem::Version
47
- version: '9.0'
61
+ version: '9.1'
48
62
  type: :development
49
63
  prerelease: false
50
64
  version_requirements: !ruby/object:Gem::Requirement
51
65
  requirements:
52
66
  - - "~>"
53
67
  - !ruby/object:Gem::Version
54
- version: '9.0'
68
+ version: '9.1'
55
69
  - !ruby/object:Gem::Dependency
56
70
  name: awesome_print
57
71
  requirement: !ruby/object:Gem::Requirement
58
72
  requirements:
59
- - - ">="
73
+ - - "~>"
60
74
  - !ruby/object:Gem::Version
61
- version: '0'
75
+ version: 1.8.0
62
76
  type: :development
63
77
  prerelease: false
64
78
  version_requirements: !ruby/object:Gem::Requirement
65
79
  requirements:
66
- - - ">="
80
+ - - "~>"
67
81
  - !ruby/object:Gem::Version
68
- version: '0'
82
+ version: 1.8.0
69
83
  - !ruby/object:Gem::Dependency
70
84
  name: rspec
71
85
  requirement: !ruby/object:Gem::Requirement
@@ -89,6 +103,7 @@ extensions: []
89
103
  extra_rdoc_files: []
90
104
  files:
91
105
  - ".gitignore"
106
+ - ".ref2bibtex_user_email"
92
107
  - ".travis.yml"
93
108
  - Gemfile
94
109
  - Gemfile.lock
@@ -121,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
121
136
  version: '0'
122
137
  requirements: []
123
138
  rubyforge_project:
124
- rubygems_version: 2.6.12
139
+ rubygems_version: 2.6.13
125
140
  signing_key:
126
141
  specification_version: 4
127
142
  summary: Pass a full citation, get the bibtex back, that's all.