rea 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.0.1 / FIX ME
+
+* Enhancements
+
+  * Birthday!

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+group :runtime do
+  gem "http", "~> 0.1.0"
+  gem "nokogiri", "~> 1.5"
+  gem "quickl", "~> 0.4.2"
+  gem "pdf-toolkit", "= 1.0.0.rc1"
+  gem "epath", "~> 0.0.1"
+  gem "alf", "~> 0.12.0"
+  gem "bibtex-ruby", "~> 2.0"
+end
+
+group :development do
+  gem "rake", "~> 0.9.2"
+  gem "rspec", "~> 2.8.0"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    alf (0.12.0)
+      backports (~> 2.3.0)
+      myrrha (~> 1.2.1)
+      quickl (~> 0.4.2)
+    backports (2.3.0)
+    bibtex-ruby (2.0.4)
+      latex-decode (>= 0.0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    epath (0.0.1)
+    http (0.1.0)
+    latex-decode (0.0.12)
+      unicode (~> 0.4)
+    latex-decode (0.0.12-java)
+    multi_json (1.0.4)
+    myrrha (1.2.2)
+    nokogiri (1.5.0)
+    nokogiri (1.5.0-java)
+    pdf-toolkit (1.0.0.rc1)
+    quickl (0.4.2)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    unicode (0.4.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  alf (~> 0.12.0)
+  bibtex-ruby (~> 2.0)
+  epath (~> 0.0.1)
+  http (~> 0.1.0)
+  nokogiri (~> 1.5)
+  pdf-toolkit (= 1.0.0.rc1)
+  quickl (~> 0.4.2)
+  rake (~> 0.9.2)
+  rspec (~> 2.8.0)

data/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2012 - Bernard Lambeau
+
+    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/Manifest.txt

@@ -0,0 +1,15 @@
+rea.gemspec
+rea.noespec
+.gemtest
+CHANGELOG.md
+Gemfile
+Gemfile.lock
+bin/**/*
+lib/**/*
+LICENCE.md
+Manifest.txt
+Rakefile
+README.md
+spec/**/*
+tasks/**/*
+test/**/*

data/README.md

@@ -0,0 +1,7 @@
+# Rea
+
+Research Exploring Assistant
+
+## Links
+
+https://github.com/blambeau/rea

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  gem "bundler", "~> 1.0"
+  require "bundler/setup"
+rescue LoadError => ex
+  puts ex.message
+  abort "Bundler failed to load, (did you run 'gem install bundler' ?)"
+end
+
+# Dynamically load the gem spec
+$gemspec_file = File.expand_path('../rea.gemspec', __FILE__)
+$gemspec      = Kernel.eval(File.read($gemspec_file))
+
+# We run tests by default
+task :default => :test
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  load taskfile
+end

data/bin/rea

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+Dir.chdir File.dirname(__FILE__) do
+  require 'bundler/setup'
+end
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'rea/command'
+Rea::Command.run(ARGV)
+

data/lib/rea-dblp/rea/dblp.rb

@@ -0,0 +1,59 @@
+module Rea
+  module DBLP
+
+    def grab(identifier)
+      Grab.new.call(identifier)
+    end
+    module_function :grab
+
+    def search(query)
+      Search.new.call(query)
+    end
+    module_function :search
+
+    def url
+      "http://www.dblp.org"
+    end
+    module_function :url
+
+    def shortcut
+      "dblp"
+    end
+    module_function :shortcut
+
+    private
+
+    include Rea::ErrorUtils
+
+    def entry_url(identifier)
+      "#{url}/rec/bibtex/#{identifier}.xml"
+    end
+
+    def search_url
+      "#{url}/search/api"
+    end
+
+    def get(url)
+      got = Http.get(url, :response => :object)
+      case got.status
+      when 200...300
+        not_found_error!(url) if got.body.empty?
+        got.body
+      when 400...500
+        not_found_error!(url)
+      when 500...600
+        third_party_error!(url)
+      else
+        unexpected_error!(url)
+      end
+    end
+
+    Rea::register_provider(self)
+  end # module DBLP
+end # module Rea
+require_relative 'dblp/parser'
+require_relative 'dblp/entry_parser'
+require_relative 'dblp/query_result_parser'
+require_relative 'dblp/grab'
+require_relative 'dblp/search'
+

data/lib/rea-dblp/rea/dblp/entry_parser.rb

@@ -0,0 +1,48 @@
+module Rea
+  module DBLP
+    class EntryParser < Parser
+
+      def parse_text(entry, source = nil)
+        entries = []
+        parse_xml(entry, source) do |doc|
+          doc.xpath("/dblp/*").each do |entry|
+            entries << send(:"parse_#{entry.name}", entry)
+          end
+        end
+        entries
+      end
+
+      private
+
+      ###
+
+      def parse_inproceedings(entry)
+        { :kind       => "inproceedings",
+          :key        => work_key(entry.attribute("key").text),
+          :title      => entry.xpath("title").text,
+          :source     => entry.xpath("booktitle").text,
+          :year       => entry.xpath("year").text,
+          :authors    => entry.xpath("author").map(&:text) }
+      end
+
+      def parse_article(entry)
+        { :kind       => "article",
+          :key        => work_key(entry.attribute("key").text),
+          :title      => entry.xpath("title").text,
+          :source     => entry.xpath("journal").text,
+          :year       => entry.xpath("year").text,
+          :authors    => entry.xpath("author").map(&:text) }
+      end
+
+      def parse_queryentry(entry)
+        { :kind       => entry.xpath('type').text,
+          :key        => work_key(entry.attribute("key").text),
+          :title      => entry.xpath("title").text,
+          :source     => entry.xpath("venue").text,
+          :year       => entry.xpath("year").text,
+          :authors    => entry.xpath("authors/author").map(&:text) }
+      end
+
+    end # class EntryParser
+  end # module DBLP
+end # module Rea

data/lib/rea-dblp/rea/dblp/grab.rb

@@ -0,0 +1,14 @@
+module Rea
+  module DBLP
+    class Grab
+      include DBLP
+
+      def call(identifier)
+        xml    = get entry_url(identifier)
+        tuples = EntryParser.parse(xml)
+        tuples.first
+      end
+
+    end # class Grab
+  end # module DBLP
+end # module Rea

data/lib/rea-dblp/rea/dblp/parser.rb

@@ -0,0 +1,36 @@
+module Rea
+  module DBLP
+    class Parser
+      include Rea::ErrorUtils
+
+      def self.parse(*args, &bl)
+        new.parse(*args, &bl)
+      end
+
+      def parse(path)
+        if path.respond_to?(:to_path)
+          parse_text(Path(path).read, path)
+        else
+          parse_text(path, nil)
+        end
+      end
+
+      private
+
+      def work_key(identifier)
+        WorkKey.new("dblp", identifier)
+      end
+
+      def parse_xml(xml, source)
+        options = Nokogiri::XML::ParseOptions::STRICT
+        parsed  = Nokogiri::XML(xml.to_s, source.to_s, nil, options)
+        block_given? ? yield(parsed) : parsed
+      rescue NoMethodError
+        parse_format_error!(source)
+      rescue Nokogiri::XML::SyntaxError
+        parse_error!(source)
+      end
+
+    end # class Parser
+  end # module DBLP
+end # module Rea

data/lib/rea-dblp/rea/dblp/query_result_parser.rb

@@ -0,0 +1,38 @@
+module Rea
+  module DBLP
+    class QueryResultParser < Parser
+
+      def parse_text(result, source = nil)
+        entries = []
+        parse_xml(result, source) do |doc|
+          unrecognized!(source) if doc.xpath('/result').empty?
+          doc.xpath("/result/hits/hit").each do |entry|
+            entries << send(:"xml_parse_hit", entry)
+          end
+        end
+        entries
+      end
+
+      private
+
+      def fix_xmlns(xml)
+        xml.gsub %r{<result>}, 
+                 %q{<result xmlns:dblp="http://www.dblp.org/xmlns/dblp">}
+      end
+
+      def xml_parse_hit(hit)
+        key = hit.xpath('url').text[%r{http://www.dblp.org/rec/bibtex/(.*)}, 1]
+        content = <<-XML.gsub(/\n\s*/, "")
+          <dblp>
+            <queryentry key="#{key}">
+              #{hit.xpath('title').inner_text}
+            </queryentry>
+          </dblp>
+        XML
+        EntryParser.parse(content).first
+      end
+
+    end # class QueryResultParser
+  end # module DBLP
+end # module Rea
+

data/lib/rea-dblp/rea/dblp/search.rb

@@ -0,0 +1,18 @@
+module Rea
+  module DBLP
+    class Search
+      include DBLP
+
+      def call(query)
+        unless query.size == 1 and query[:title]
+          not_implemented_error!("Unable to search with #{query.inspect}")
+        end
+        title  = query[:title].gsub(/\s+/, "%20")
+        xml    = get("#{search_url}?q=#{title}")
+        tuples = QueryResultParser.parse(xml)
+        Relation(tuples)
+      end
+
+    end # class Search
+  end # module DBLP
+end # module Rea

data/lib/rea.rb

@@ -0,0 +1,28 @@
+require_relative "rea/version"
+require_relative "rea/loader"
+require_relative "rea/errors"
+
+#
+# Research Exploring Assistant
+#
+module Rea
+
+  def WorkKey(str)
+    WorkKey.parse(str)
+  end
+  module_function :WorkKey
+
+  def register_provider(provider)
+    providers << provider
+  end
+  module_function :register_provider
+
+  def providers
+    @providers ||= []
+  end
+  module_function :providers
+
+end # module Rea
+
+require_relative 'rea/work_key'
+require_relative 'rea-dblp/rea/dblp'

data/lib/rea/command.rb

@@ -0,0 +1,62 @@
+require 'rea'
+module Rea
+  #
+  # rea - The Research Exploring Assistant
+  #
+  # SYNOPSIS
+  #   #{program_name} [--version] [--help] COMMAND [cmd opts] ARGS...
+  #
+  # OPTIONS
+  # #{summarized_options}
+  #
+  # COMMANDS
+  # #{summarized_subcommands}
+  #
+  # See '#{program_name} help COMMAND' for more information on a specific command.
+  #
+  class Command < Quickl::Delegator(__FILE__, __LINE__)
+
+    # Install options
+    options do |opt|
+      @trace = false
+      opt.on('--trace') do
+        @trace = true
+      end
+      opt.on_tail("--help", "Show help") do
+        raise Quickl::Help
+      end
+      opt.on_tail("--version", "Show version") do
+        raise Quickl::Exit, 
+              "rea #{Rea::VERSION} (c) 2012, Bernard Lambeau"
+      end
+    end
+
+    def execute(*args)
+      super
+    rescue Quickl::Error
+      raise
+    rescue Rea::Error => ex
+      if @trace
+        dump_exception(ex)
+      else
+        $stderr.puts ex.message
+      end
+    rescue Exception => ex
+      puts "Sorry, an internal error occured. Please report --trace to developers."
+      dump_exception(ex) if @trace
+    end
+
+    private
+
+    def dump_exception(ex, indent = 0)
+      $stderr.puts ex.message.gsub(/^/m,"  "*indent)
+      $stderr.puts ex.backtrace.map{|s|
+        s.gsub(/^/m,"  "*(indent+1))
+      }.join("\n")
+      dump_exception(ex.cause, indent + 1) if ex.respond_to?(:cause)
+    end
+
+  end # class Command
+end # module Rea
+require_relative "command/utils"
+require_relative "command/search"