paper_metadata 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6feae0c4735bc5e79114e6ade692e83b31cafcaa
+  data.tar.gz: 177849e6b701c11472db0cf332eb58a554a8f419
+SHA512:
+  metadata.gz: 635965a8441b3d67fd8c659ebd44a642c0ee9bc5da72e720922a23c72c64d1c884122c01cfc4ae3969e9c629123f2f3addabe6575974745f94ac7d584a41bd3d
+  data.tar.gz: 47cbc3c5b7d8e5ea250c2da42dffd3f87d9c4fc8c55bc06da3e35a959df5d00f181bd43adf8ab559405fc41aaa0842887904b6da07534f0ce9e25cc6d9972952

data/README.md

@@ -1,6 +1,6 @@
 # PaperMetadata
 
-TODO: Write a gem description
+PaperMetadata is a gem that gets a publication's metadata by accessing the CrossRef OpenURL API.
 
 ## Installation
 
@@ -18,7 +18,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You must first configure PaperMetadata with your CrossRef API username (which you can obtain here [http://www.crossref.org/requestaccount/](http://www.crossref.org/requestaccount/)):
+
+    PaperMetadata.doi_username = 'email@example.com'
+
+You can then access API:
+
+    result = PaperMetadata.metadata_for('doi:10.1021/ac1014832')
+
+The result will be a hash similar to this one:
+
+    { :volume=>"82",
+      :isssue=>"19",
+      :first_page=>"8153",
+      :last_page=>"8160",
+      :title=>
+      "Basic Modeling Approach To Optimize Elemental Imaging by Laser Ablation ICPMS",
+      :authors=>"Jure Triglav, Johannes T. van Elteren, Vid S. Šelih",
+      :journal=>"Anal. Chem. 2010",
+      :resource=>"http://pubs.acs.org/doi/abs/10.1021/ac1014832" }
 
 ## Contributing
 
@@ -27,3 +45,5 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Be sure to run the specs too.

data/lib/paper_metadata/version.rb

@@ -1,3 +1,3 @@
 module PaperMetadata
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/paper_metadata.rb

@@ -2,6 +2,7 @@ require 'paper_metadata/version'
 require 'nokogiri'
 require 'net/http'
 require 'open-uri'
+require 'cgi'
 
 module PaperMetadata
   class << self
@@ -21,7 +22,7 @@ module PaperMetadata
     end
 
     def metadata_for_doi(doi)
-      doc = Nokogiri::XML(open("http://www.crossref.org/openurl/?id=doi:#{doi}&noredirect=true&pid=#{PaperMetadata.doi_username}&format=unixref"))
+      doc = Nokogiri::XML(open("http://www.crossref.org/openurl/?id=#{CGI.escape(doi)}&noredirect=true&pid=#{PaperMetadata.doi_username}&format=unixref"))
       paper = Hash.new
 
       if doc.xpath("//titles/title").first
@@ -48,7 +49,7 @@ module PaperMetadata
 
     def metadata_for_arxiv(identifier)
       identifier.gsub!(/^arXiv\:/i, '')
-      url = URI.parse("http://export.arxiv.org/api/query?search_query=#{identifier}&start=0&max_results=1")
+      url = URI.parse("http://export.arxiv.org/api/query?search_query=#{CGI.escape(identifier)}&start=0&max_results=1")
       res = Net::HTTP.get_response(url)
       doc = Nokogiri::XML(res.body)
       doc.remove_namespaces!

data/test/test_paper_metadata.rb

@@ -10,6 +10,7 @@ class PaperMetadataTest < Test::Unit::TestCase
       to_return(:body => doi_response, :status => 200,  :headers => { 'Content-Length' => doi_response.length } )
 
     PaperMetadata.doi_username = 'test@example.com'
+
     assert_equal "Basic Modeling Approach To Optimize Elemental Imaging by Laser Ablation ICPMS",
       PaperMetadata.metadata_for('doi:10.1021/ac1014832')[:title]
   end

metadata

@@ -1,68 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: paper_metadata
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Jure Triglav
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -97,33 +88,26 @@ files:
 - test/test_paper_metadata.rb
 homepage: http://github.com/jure/paper_metadata
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3600841422175900460
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3600841422175900460
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Paper_metadata gem gets the metadata for papers with a DOI or an arXiv identifier
 test_files:
 - test/arxiv.xml