plos 0.0.5 → 0.0.6

data/README.md

@@ -18,6 +18,17 @@ Or install it yourself as:
 
 ## Usage
 
+### Retrieving All Article References
+
+The ```all``` methods returns all references from PLOS. The method takes the form ```PLOS::Client.all(start, rows)```. You can page the results using the start parameter. Rows determines the page size.
+
+```ruby
+require 'plos'
+
+client = PLOS::Client.new(ENV["API_KEY"])
+hits = client.all
+```
+
 ### Searching
 
 You can perform a basic search using the ```PLOS::Client.search(query, start, rows)``` method. The second two parameters are optional. That method returns a ```PLOS::ArticleSet``` object. ```ArticleSet``` inherits from Array and includes some meta-information about the search. The following example show the information that's available:
@@ -55,10 +66,32 @@ client = PLOS::Client.new(ENV["API_KEY"])
 hits = client.all(200, 100)
 ```
 
+Note: there may be multiple ```ArticleRef```'s pointing to the same article. For instance, a search for "*:*" will return references for:
+
+ * 10.1371/journal.pbio.0040394
+ * 10.1371/journal.pbio.0040394/title
+ * 10.1371/journal.pbio.0040394/abstract
+ * 10.1371/journal.pbio.0040394/references
+ * 10.1371/journal.pbio.0040394/body
+
+which all point to the same article, 10.1371/journal.pbio.0040394. You can access the id of the article and identifier which part of the article this reference refers to with the methods ```article_id``` and ```article_part``` respectively.
+
+```ruby
+require 'plos'
+
+client = PLOS::Client.new(ENV["API_KEY"])
+hits = client.all
+
+hits.each do |hit|
+  puts "#{hit.title} - #{hit.article_id} - #{hit.article_part}"
+end
+```
+
 ### Getting the Article Details
 
 You may get an ```Article``` object using ```ArticleRef.article```. For example, the following returns a ```PLOS::Article```:
 
+
 ```ruby
 require 'plos'
 client = PLOS::Client.new(ENV["API_KEY"])
@@ -121,7 +154,7 @@ require 'plos'
 client = PLOS::Client.new(ENV["API_KEY"])
 hits = client.search("xenograft")
 article_id = hits.first.id
-PLOS::Article.content(id) # Returns the xml as a string
+PLOS::Article.content(article_id) # Returns the xml as a string
 ```
 
 ```PLOS::Article.xml(id)``` returns a ```Nokogiri::XML``` object of the xml contents.

data/lib/plos/article_ref.rb

@@ -27,8 +27,16 @@ module PLOS
       end
     end
 
+    def article_id
+      id.split("/")[0..1].join("/") if id
+    end
+
+    def article_part
+      id.split("/")[2] if id
+    end
+
     def article
-      @article ||= PLOS::Article.get(id)
+      @article ||= PLOS::Article.get(article_id)
     end
 
     def citation(format="RIS")

data/lib/plos/version.rb

@@ -1,3 +1,3 @@
 module Plos
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plos
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -122,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4503252399675787429
+      hash: -3893775921126940729
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4503252399675787429
+      hash: -3893775921126940729
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24