plos 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,2 @@
+script:
+  - bundle exec rake spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christopher Petersen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# PLoS [![Build Status](https://travis-ci.org/cpetersen/plos.png?branch=master)](https://travis-ci.org/cpetersen/plos)
+
+A Ruby library for interacting with the Public Library of Science (PLoS) API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'plos'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plos
+
+## Usage
+
+```ruby
+require 'plos'
+
+client = PLOS::Client.new(ENV["API_KEY"])
+hits = client.search("xenograft")
+hits.each do |hits|
+  puts "#{hit.score} - #{hit.title}"
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/plos.rb

@@ -0,0 +1,3 @@
+require "plos/article_ref"
+require "plos/client"
+require "plos/version"

data/lib/plos/article_ref.rb

@@ -0,0 +1,43 @@
+require "rest_client"
+
+module PLOS
+  class ArticleRef
+    attr_accessor :client
+    attr_accessor :score
+    attr_accessor :type
+    attr_accessor :authors
+    attr_accessor :eissn
+    attr_accessor :id
+    attr_accessor :journal
+    attr_accessor :published_at
+    attr_accessor :title
+    alias :article_type= :type=
+    alias :author_display= :authors=
+    alias :title_display= :title=
+    alias :publication_date= :published_at=
+
+    def self.parse_node(node, obj=nil)
+      value = case(node.name)
+      when "arr"
+        node.children.collect { |child| parse_node(child) }
+      when "date"
+        DateTime.parse(node.content)
+      when "float"
+        node.content.to_f
+      else
+        node.content
+      end
+      if node.attr("name") && obj
+        obj.send("#{node.attr("name")}=",value)
+      end
+      value
+    end
+
+    def initialize(client, node)
+      self.client = client
+      node.children.each do |child|
+        ArticleRef.parse_node(child, self)
+      end
+    end
+  end
+end

data/lib/plos/client.rb

@@ -0,0 +1,36 @@
+require "nokogiri"
+require "rest_client"
+
+module PLOS
+  class Client
+    attr_accessor :api_key
+    attr_accessor :base_url
+
+    def initialize(api_key, base_url="http://api.plos.org")
+      self.api_key = api_key
+      self.base_url = base_url
+    end
+
+    def search(query)
+      result = []
+      doc = execute( search_url, { :q => query } )
+      if doc && doc.root
+        doc.root.children.each do |child|
+          next unless child.name == "result"
+          child.children.each do |doc|
+            result << PLOS::ArticleRef.new(self, doc)
+          end
+        end
+      end
+      result
+    end
+
+    def search_url
+      "/search"
+    end
+
+    def execute(url, params={})
+      Nokogiri::XML(RestClient.post( "#{self.base_url}#{url}", { :api_key => self.api_key }.merge(params) ) )
+    end
+  end
+end

data/lib/plos/version.rb

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

data/plos.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/plos/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christopher Petersen"]
+  gem.email         = ["christopher.petersen@gmail.com"]
+  gem.description   = %q{A Ruby library for interacting with the Public Library of Science (PLoS) API}
+  gem.summary       = %q{A Ruby library for interacting with the Public Library of Science (PLoS) API}
+  gem.homepage      = "https://github.com/cpetersen/plos"
+
+  gem.add_dependency('nokogiri')
+  gem.add_dependency('rest-client')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec')
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "plos"
+  gem.require_paths = ["lib"]
+  gem.version       = Plos::VERSION
+end

data/spec/plos_spec.rb

@@ -0,0 +1,42 @@
+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"
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: plos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: rspec
+  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'
+description: A Ruby library for interacting with the Public Library of Science (PLoS)
+  API
+email:
+- christopher.petersen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/plos.rb
+- lib/plos/article_ref.rb
+- lib/plos/client.rb
+- lib/plos/version.rb
+- plos.gemspec
+- spec/plos_spec.rb
+homepage: https://github.com/cpetersen/plos
+licenses: []
+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: -583380218853756903
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -583380218853756903
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby library for interacting with the Public Library of Science (PLoS)
+  API
+test_files:
+- spec/plos_spec.rb