ref2bibtex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1a0dce05782be34b45170a878fa53b2e424b650
+  data.tar.gz: 0f9e559f4eac387d0c753d2d54b373fe6075973d
+SHA512:
+  metadata.gz: 8277b854333a500918e8078129f1fb98006f3eef9c34bbc1ac2d0966c45859fce5f8bd7e5b089dd059effdb142a1afb7521034dfbe82e74a073048bbc03d5ead
+  data.tar.gz: 0fea146404963493dad41379687bc65ab0ed3d78d290ea7838d9eb598ef781a5d48a71ad662b8414490087de38cfef0d28fedf5de1fd6036fdfe3974ded2b221

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*~
+*.swp
+idea/
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ref3bibtex.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    ref2bibtex (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.2.0)
+    byebug (3.4.0)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    rake (10.3.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.6)
+  byebug
+  rake
+  ref2bibtex!

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2014, Species File Group
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of ref2bibtex nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,53 @@
+ref2bibtex
+==========
+
+A single purpose gem wrapping Crossref's API.  Pass it a full reference string, get back bibtex.
+
+usage
+=====
+
+Use citation2bibtex (aliased _get_):
+
+```ruby
+
+ gem install ref2bibtex
+
+ require 'ref2bibtex' 
+
+ Ref2bibtex.get('Yoder, M. J., A. A. Valerio, A. Polaszek, L. Masner, and N. F. Johnson. 2009. Revision of Scelio pulchripennis - group species (Hymenoptera, Platygastroidea, Platygastridae). ZooKeys 20:53-118.') # => "@article{Yoder_2009,\n\tdoi = {10.3897/zookeys.20.205},\n\turl = {http://dx.doi.org/10.3897/zookeys.20.205},\n\tyear = 2009,\n\tmonth = {sep},\n\tpublisher = {Pensoft Publishers},\n\tvolume = {20},\n\tnumber = {0},\n\tauthor = {Matthew Yoder and Andrew Polaszek and Lubomir Masner and Norman Johnson and Alejandro Valerio},\n\ttitle = {Revision of Scelio pulchripennis - group species (Hymenoptera, Platygastroidea, Platygastridae)},\n\tjournal = {{ZOOKEYS}}\n}"
+
+```
+
+If you want the doi:
+
+```ruby
+
+   Ref2bibtex.get_doi('Yoder, M. J., A. A. Valerio, A. Polaszek, L. Masner, and N. F. Johnson. 2009. Revision of Scelio pulchripennis - group species (Hymenoptera, Platygastroidea, Platygastridae). ZooKeys 20:53-118.') #  => "http://dx.doi.org/10.3897/zookeys.20.205" 
+
+```
+
+If you have the doi:
+
+```ruby
+
+ Ref2bibtex.get_bibtex('http://dx.doi.org/10.3897/zookeys.20.205') # => "@article{Yoder_2009,\n\tdoi = {10.3897/zookeys.20.205},\n\turl = {http://dx.doi.org/10.3897/zookeys.20.205},\n\tyear = 2009,\n\tmonth = {sep},\n\tpublisher = {Pensoft Publishers},\n\tvolume = {20},\n\tnumber = {0},\n\tauthor = {Matthew Yoder and Andrew Polaszek and Lubomir Masner and Norman Johnson and Alejandro Valerio},\n\ttitle = {Revision of Scelio pulchripennis - group species (Hymenoptera, Platygastroidea, Platygastridae)},\n\tjournal = {{ZOOKEYS}}\n}" 
+
+```
+
+faq
+===
+
+What if there are multiple results?
+-----------------------------------
+The code is dumb, it takes the first.
+
+acknowledgements
+================
+
+The Crossref API, and John Hill for his Python version.
+
+license
+=======
+
+NCSA, UI flavour.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ref2bibtex/version.rb

@@ -0,0 +1,3 @@
+module Ref2bibtex
+  VERSION = "0.0.1"
+end

data/lib/ref2bibtex.rb

@@ -0,0 +1,94 @@
+recent_ruby = RUBY_VERSION >= '2.1.0'
+raise "IMPORTANT:  gem requires ruby >= 2.1.0" unless recent_ruby
+
+require "ref2bibtex/version"
+require 'json'
+require 'net/http'
+
+module Ref2bibtex
+
+  CROSSREF_URI = URI('http://search.crossref.org/links')
+
+  # Parse the response into json
+  def self.parse_json(string)
+    begin
+      @json = JSON.parse(string) 
+    rescue JSON::ParserError => e
+      puts e.message
+      ap request
+    end
+  end
+
+  # Pass a String doi get a bibtex formatted string back 
+  def self.get_bibtex(doi)
+    response = Ref2bibtex.request(URI(doi), headers: {'Accept' => 'application/x-bibtex' }, protocol: 'GET', process_response_as: 'text') 
+  end
+
+  # Pass a String citation, get a doi back
+  def self.get_doi(citation)
+    if citation.class == String
+      citation = [citation]
+    elsif citation.class != Array
+      raise
+    end
+    
+    response = Ref2bibtex.request(payload: citation) 
+    response['results'].first['doi']
+  end
+
+  # Pass a citation, get a String in bibtex back
+  def self.citation2bibtex(citation)
+    get_bibtex( get_doi(citation) )
+  end
+
+  class << self
+    alias_method :get, :citation2bibtex
+  end
+
+  def self.request(url = CROSSREF_URI, payload: nil, headers: {'content-type' => 'application/json' }, protocol: 'POST', process_response_as: 'json', redirect_limit: 10)
+    raise 'Infinite redirect?' if redirect_limit == 0
+    data = nil
+    if protocol == 'POST'
+      if payload.nil?
+        payload = {}
+      end
+      data = JSON.generate(payload) # Json.new(payload) # utf-8 encoding?
+    else
+      data = nil
+    end
+
+    if protocol == 'POST'
+      request = Net::HTTP::Post.new(url, initheader = headers) 
+    elsif protocol == 'GET'
+      request = Net::HTTP::Get.new(url, initheader = headers) 
+    end
+
+    response = Net::HTTP.start(request.uri.hostname, request.uri.port) do |http|
+      request.body = data 
+      http.request(request)
+    end
+
+    case response
+    when Net::HTTPSuccess then
+      response = response
+    when Net::HTTPRedirection then
+      url = URI(response['location'])
+      request = Net::HTTP::Get.new(url, initheader = {'Accept' => 'application/x-bibtex'}) 
+      response = Net::HTTP.start(request.uri.hostname, request.uri.port) do |http|
+        http.request(request) 
+      end
+    else
+      response = response.value
+    end
+
+    case process_response_as
+    when 'text' 
+      response.body
+    when 'json'
+      parse_json(response.body)
+    else
+      raise
+    end
+  end
+
+end

data/ref2bibtex.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ref2bibtex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ref2bibtex"
+  spec.version       = Ref2bibtex::VERSION
+  spec.authors       = ["Matt Yoder"]
+  spec.email         = ["diapriid@gmail.com"]
+  spec.summary       = %q{Pass a full citation, get the bibtex back, that's all.}
+  spec.description   = %q{Ok, maybe a bit more, you can have the DOI too.}
+  spec.homepage      = "http://github.com/SpeciesFileGroup/ref2bibtex"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "awesome_print"
+
+end

data/spec/ref2bibtex_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Ref2bibtex do
+
+  context '#request' do
+    let(:request) { Ref2bibtex.request(payload: [CITATIONS[:first]]) }
+
+    specify '#Ref2bibtex.request makes a query_ok request' do
+      expect(request['query_ok']).to eq(true)
+    end
+
+    specify '#Ref2bibtex.request returns Hash' do
+      expect(request.class).to eq(Hash)
+    end
+
+    specify '#Ref2bibtex.request results is an Array' do
+      expect(request['results'].class).to eq(Array)
+    end
+
+    specify '#Ref2bibtex.request results is an Array of Hashes' do
+      expect(request['results'].first.class).to eq(Hash)
+    end
+
+    specify '#Ref2bibtex.request results is an Array of Hashes, each one having a doi' do
+      expect(request['results'].first['doi']).to be_truthy 
+    end
+  end
+
+  context '#get_doi' do
+    specify 'Ref2bibtex.get_doi() 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')
+    end
+  end
+
+  context '#get_bibtex' do
+    let(:response) { Ref2bibtex.get_bibtex('http://dx.doi.org/10.3897/zookeys.20.205')}
+    specify 'Ref2bibtex.get_bibtex() takes a full citation and returns bibtex' do
+      expect(response).to match(/author\s=/)
+      expect(response).to match(/title\s=/)
+      expect(response).to match(/year\s=\s2009/)
+    end
+  end
+
+
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# require 'coveralls'
+# Coveralls.wear!
+
+# These are development helpers.
+require 'awesome_print'
+require 'byebug'
+require 'yaml'
+
+# These are required to run tests.
+require 'ref2bibtex' 
+
+
+CITATIONS = YAML.load_file(File.expand_path('support/citations.yml', File.dirname(__FILE__)))
+
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end
+

data/spec/support/citations.yml

@@ -0,0 +1,9 @@
+---
+:first:
+  'Yoder, M. J., A. A. Valerio, A. Polaszek, L. Masner, and N. F. Johnson. 2009. Revision of Scelio pulchripennis - group species (Hymenoptera, Platygastroidea, Platygastridae). ZooKeys 20:53-118.'
+:second: 
+  'Jost & K.L. Shaw. 2006. Phylogeny of Ensifera (Hexapoda: Orthoptera) using three ribosomal loci, with implications for the evolution of acoustic communication. Molecular Phylogenetics and Evolution (Mol. Phylogenet. Evol.) 38:510-530'
+:third:
+  'Collins, N., van den Berghe & Carson. 2014. Two new species of Neoxabea, three new species of Oecanthus, and documentation of two other species in Nicaragua (Orthoptera: Gryllidae: Oecanthinae). Transactions of the American Entomological Society (Trans. Amer. Entomol. Soc.) 140:170'
+:fourth:
+  "Otte, D. 1994. Crickets (Grylloidea). Orthoptera Species File, The Orthopterists' Society and The Academy of Natural Sciences of Philadelphia, Philadelphia 1:87"

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ref2bibtex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Yoder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ok, maybe a bit more, you can have the DOI too.
+email:
+- diapriid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ref2bibtex.rb
+- lib/ref2bibtex/version.rb
+- ref2bibtex.gemspec
+- spec/ref2bibtex_spec.rb
+- spec/spec_helper.rb
+- spec/support/citations.yml
+homepage: http://github.com/SpeciesFileGroup/ref2bibtex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Pass a full citation, get the bibtex back, that's all.
+test_files:
+- spec/ref2bibtex_spec.rb
+- spec/spec_helper.rb
+- spec/support/citations.yml