plos 0.0.1 → 0.0.2

data/README.md

@@ -23,9 +23,12 @@ require 'plos'
 
 client = PLOS::Client.new(ENV["API_KEY"])
 hits = client.search("xenograft")
-hits.each do |hits|
-  puts "#{hit.score} - #{hit.title}"
+hits.each do |hit|
+  puts "#{hit.score} - #{hit.title} - #{hit.article_url}"
 end
+
+xml = hit[2].article_xml
+puts hit[2].citation
 ```
 
 ## Contributing

data/lib/plos/article_ref.rb

@@ -11,6 +11,7 @@ module PLOS
     attr_accessor :journal
     attr_accessor :published_at
     attr_accessor :title
+
     alias :article_type= :type=
     alias :author_display= :authors=
     alias :title_display= :title=
@@ -39,5 +40,31 @@ module PLOS
         ArticleRef.parse_node(child, self)
       end
     end
+
+    def article_xml
+      Nokogiri::XML(RestClient.get(article_url))
+    end
+
+    def citation(format="RIS")
+      url = (format == "RIS" ? ris_citation_url : bib_tex_citation_url)
+      RestClient.get(url)
+    end
+
+    def base_url
+      "http://www.plosone.org"
+    end
+
+    def article_url(format="XML")
+      # format = "XML|PDF"
+      "#{base_url}/article/fetchObjectAttachment.action?uri=info:doi/#{id}&representation=#{format}"
+    end
+    
+    def ris_citation_url
+      "#{base_url}/article/getRisCitation.action?articleURI=info:doi/#{id}"
+    end
+
+    def bib_tex_citation_url
+      "#{base_url}/article/getBibTexCitation.action?articleURI=info:doi/#{id}"
+    end
   end
 end

data/lib/plos/client.rb

@@ -11,9 +11,13 @@ module PLOS
       self.base_url = base_url
     end
 
-    def search(query)
+    def all(rows=50, start=0)
+      search("*:*", rows, start)
+    end
+
+    def search(query, rows=50, start=0)
       result = []
-      doc = execute( search_url, { :q => query } )
+      doc = execute( search_url, { :q => query, :rows => rows, :start => start } )
       if doc && doc.root
         doc.root.children.each do |child|
           next unless child.name == "result"

data/lib/plos/version.rb

@@ -1,3 +1,3 @@
 module Plos
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/plos_spec.rb

@@ -1,42 +1,79 @@
 require 'plos'
 
 describe PLOS do
-  context "A single document" do
-    it "should parse an ArticleRef" do
-      xml =<<END 
-<doc>
-  <float name="score">0.6637922</float>
-  <str name="article_type">Research Article</str>
-  <arr name="author_display">
-    <str>Thomas D. Pfister</str>
-    <str>Melinda Hollingshead</str>
-    <str>Robert J. Kinders</str>
-    <str>Yiping Zhang</str>
-    <str>Yvonne A. Evrard</str>
-    <str>Jiuping Ji</str>
-    <str>Sonny A. Khin</str>
-    <str>Suzanne Borgel</str>
-    <str>Howard Stotler</str>
-    <str>John Carter</str>
-    <str>Raymond Divelbiss</str>
-    <str>Shivaani Kummar</str>
-    <str>Yves Pommier</str>
-    <str>Ralph E. Parchment</str>
-    <str>Joseph E. Tomaszewski</str>
-    <str>James H. Doroshow</str>
-  </arr>
-  <str name="eissn">1932-6203</str>
-  <str name="id">10.1371/journal.pone.0050494</str>
-  <str name="journal">PLoS ONE</str>
-  <date name="publication_date">2012-12-28T00:00:00Z</date>
-  <str name="title_display">
-  Development and Validation of an Immunoassay for Quantification of Topoisomerase I in Solid Tumor Tissues
-  </str>
-</doc>
-END
-      client = PLOS::Client.new("API_KEY")
-      article = PLOS::ArticleRef.new(client, Nokogiri::XML(xml).root)
-      article.type.should == "Research Article"
+  context "A client" do
+    let(:client) { client = PLOS::Client.new("API_KEY") }
+
+    it "should call the correct search url" do
+      RestClient.should_receive(:post).with("http://api.plos.org/search", {:api_key=>"API_KEY", :q=>"xenograft", :rows=>50, :start=>0}).and_return("")
+      client.search("xenograft")
+    end
+
+    it "should call the correct search url when rows and start are specified" do
+      RestClient.should_receive(:post).with("http://api.plos.org/search", {:api_key=>"API_KEY", :q=>"xenograft", :rows=>100, :start=>200}).and_return("")
+      client.search("xenograft", 100, 200)
+    end
+
+    it "should call the correct search url when finding all" do
+      RestClient.should_receive(:post).with("http://api.plos.org/search", {:api_key=>"API_KEY", :q=>"*:*", :rows=>50, :start=>0}).and_return("")
+      client.all
+    end
+
+    context "A single document" do
+      let(:article) {
+        xml =<<-END
+          <doc>
+            <float name="score">0.6637922</float>
+            <str name="article_type">Research Article</str>
+            <arr name="author_display">
+              <str>Thomas D. Pfister</str>
+              <str>Melinda Hollingshead</str>
+              <str>Robert J. Kinders</str>
+              <str>Yiping Zhang</str>
+              <str>Yvonne A. Evrard</str>
+              <str>Jiuping Ji</str>
+              <str>Sonny A. Khin</str>
+              <str>Suzanne Borgel</str>
+              <str>Howard Stotler</str>
+              <str>John Carter</str>
+              <str>Raymond Divelbiss</str>
+              <str>Shivaani Kummar</str>
+              <str>Yves Pommier</str>
+              <str>Ralph E. Parchment</str>
+              <str>Joseph E. Tomaszewski</str>
+              <str>James H. Doroshow</str>
+            </arr>
+            <str name="eissn">1932-6203</str>
+            <str name="id">10.1371/journal.pone.0050494</str>
+            <str name="journal">PLoS ONE</str>
+            <date name="publication_date">2012-12-28T00:00:00Z</date>
+            <str name="title_display">
+            Development and Validation of an Immunoassay for Quantification of Topoisomerase I in Solid Tumor Tissues
+            </str>
+          </doc>
+          END
+          article = PLOS::ArticleRef.new(client, Nokogiri::XML(xml).root)
+      }
+
+      it "should parse an ArticleRef" do
+        article.type.should == "Research Article"
+      end
+
+      it "should have the proper xml article url" do
+        article.article_url.should == "http://www.plosone.org/article/fetchObjectAttachment.action?uri=info:doi/10.1371/journal.pone.0050494&representation=XML"
+      end
+
+      it "should have the proper pdf article url" do
+        article.article_url("PDF").should == "http://www.plosone.org/article/fetchObjectAttachment.action?uri=info:doi/10.1371/journal.pone.0050494&representation=PDF"
+      end
+
+      it "should have the proper ris citation url" do
+        article.ris_citation_url.should == "http://www.plosone.org/article/getRisCitation.action?articleURI=info:doi/10.1371/journal.pone.0050494"
+      end
+
+      it "should have the proper bib tex citation url" do
+        article.bib_tex_citation_url.should == "http://www.plosone.org/article/getBibTexCitation.action?articleURI=info:doi/10.1371/journal.pone.0050494"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plos
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -109,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -583380218853756903
+      hash: 3325667330743682461
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -583380218853756903
+      hash: 3325667330743682461
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24