dbpedia 0.0.1

data/README.md

@@ -0,0 +1,67 @@
+# DBpedia Client for Ruby
+
+## Features
+
+* Search for Dbpedia entries by *keyword* or *prefix* (e.g. autocompleter)
+* Use SPARQL via [Ruby RDFs great *sparql-client*](https://github.com/ruby-rdf/sparql-client) to query Dbpedia
+
+## Installation
+
+Simply add it to your Gemfile:
+
+    gem "dbpedia"
+    gem "sparql-client" # if you want to use sparql
+
+## Examples
+
+### Search by *keyword* and *prefix* (notice their different results)
+
+    # Default search is by keyword:
+    Dbpedia.search('Ham').collect(&:label)
+    Dbpedia.search('Ham', method: 'keyword').collect(&:label)
+    #=> ["West Ham United F.C.", "Ham", "West Ham", "East Ham", "Hamarkameratene"]
+
+    # To perform a prefix-search (which is usefull for autocompleter) pass `method`:
+    Dbpedia.search('Ham', method: 'prefix').collect(&:label)
+    #=> ["Hamburg", "Hampshire", "Hamlet (place)", "Hamlet", "Hamilton, Ontario"]
+
+### Fetch search details
+
+    results = Dbpedia.search('Hamburg')
+    puts results.first.label #=> "Hamburg"
+    puts results.first.categories.count #=> 15
+    puts results.first.categories.first.label #=> Populated places established in the 9th century"
+
+#### Possible methods
+
+    [results] (SearchResult)
+    |-- label
+    |-- uri
+    |-- description
+    +-- [categories] (SearchResult::Category)
+    |   |-- label
+    |   |-- uri
+    +-- [classes] (SearchResult::Klass)
+        |-- label
+        |-- uri
+
+### SPARQL Queries
+
+Marke sure you've installed [*sparql-client*](https://github.com/ruby-rdf/sparql-client)!
+
+    Dbpedia.sparql.select.whatever
+
+## Milestones
+
+* Implement `find` for known resources
+* Gemify
+
+## Specs
+
+Run `$ bundle exec rspec -c`
+
+## Gloss
+
+Copyright © 2013 [Roman Ernst](http://wanderwort.de), released under [CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/) license
+
+.. without warranty of any kind!

data/config/dbpedia.yml

@@ -0,0 +1,9 @@
+dbpedia:
+  uris:
+    search:
+      keyword: 'http://lookup.dbpedia.org/api/search.asmx/KeywordSearch'
+      prefix: 'http://lookup.dbpedia.org/api/search.asmx/PrefixSearch'
+    sparql: 'http://dbpedia.org/sparql'
+  params:
+    query_class: QueryClass
+    query_string: QueryString

data/lib/dbpedia.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+
+module Dbpedia
+
+  File.open(File.expand_path('../../config/dbpedia.yml', __FILE__)) do |file|
+    Dbpedia::Config = YAML::load(file)['dbpedia']
+  end
+
+  require 'dbpedia/exception'
+  require 'dbpedia/request'
+  require 'dbpedia/client'
+  require 'dbpedia/result'
+  require 'dbpedia/search_result'
+
+  ###
+  # Returns a Dbpedia::Result object for _name_
+  def self.find(name, *args)
+    client.find(name, *args)
+  end
+
+  ###
+  # Returns an array of matching strings for _query_
+  def self.search(query, *args)
+    client.search(query, *args)
+  end
+
+  ###
+  # Access to sparql delegator
+  def self.sparql
+    client.sparql
+  end
+
+  private
+
+  ###
+  # Initialize a new Dbpedia::Client
+  def self.client
+    @client ||= Dbpedia::Client.new
+  end
+end

data/lib/dbpedia/client.rb

@@ -0,0 +1,43 @@
+module Dbpedia
+  class Client
+
+    def initialize
+      @uris = Dbpedia::Config['uris']
+    end
+
+    def find(query, opts={})
+
+    end
+
+    ###
+    # Possible keys for _opts_:
+    # * *search_method*: Either *keyword_search* (default) or *prefix_search*
+    # * *query_class*: A DBpedia class that defines a search scope
+    def search(query, opts={})
+      search_method = (opts[:method] || :keyword).to_s
+      result = request @uris['search'][search_method] do |params|
+        params.query_class = opts[:query_class] if opts.has_key?(:query_class)
+        params.query_string = query
+      end
+      Dbpedia::SearchResult.load_many_from(result)
+    end
+
+    ###
+    # Delegate sparql calls to `sparql-client` gem if available
+    def sparql
+      return @sparql if @sparql
+      begin
+        require 'sparql/client'
+      rescue LoadError
+        raise Exception::SparqlLoadError
+      end
+      @sparql = SPARQL::Client.new(@uris['sparql'])
+    end
+
+    private
+
+    def request(uri, &block)
+      Dbpedia::Request.new(uri, &block)
+    end
+  end
+end

data/lib/dbpedia/exception.rb

@@ -0,0 +1,22 @@
+module Dbpedia
+  module Exception
+
+    class SparqlLoadError < StandardError
+      def message
+        """
+        You need to to install `sparql-client` in order to use `sparql`.
+        In your Gemfile: `gem \"sparql-client\"` and run `$ bundle install`.
+        """
+      end
+    end
+
+    class NoParserMethod < StandardError
+      def message
+        """
+        You should add a `parse` method to each Dbpedia::Parser class.
+        """
+      end
+    end
+
+  end
+end

data/lib/dbpedia/parser.rb

@@ -0,0 +1,35 @@
+module Dbpedia
+  class Parser
+    require 'nokogiri'
+    attr_reader :doc
+
+    ###
+    # Create a new SearchResult object for each result
+    def self.load_many_from(doc, selector='Result')
+      return [] if doc.empty?
+      doc = Nokogiri::XML(doc.body) unless doc.is_a? Nokogiri::XML::NodeSet
+      doc.css(selector).map do |result|
+        self.new(result).parse
+      end
+    end
+
+    def initialize(doc)
+      @doc = doc
+    end
+
+    def read_xml(attr)
+      @doc.css(attr)
+    end
+
+    def read(attr)
+      read_xml(attr).inner_text
+    end
+
+    ##
+    # Each SearchResult object shall
+    # define it's own parsing method
+    def parse
+      raise Exception::NoParserMethod
+    end
+  end
+end

data/lib/dbpedia/request.rb

@@ -0,0 +1,22 @@
+require 'dbpedia/request/params'
+
+module Dbpedia
+  class Request
+    require 'uri'
+    require 'open-uri'
+
+    attr_accessor :params, :uri, :body
+
+    def initialize(uri)
+      @params = Params.new and (yield(@params, uri) if block_given?)
+      @uri = URI.parse(uri)
+      @uri.query = URI.encode_www_form(@params.active)
+      @uri.tap { |uri| @body = uri.open.read }
+    end
+
+    def empty?
+      body.empty?
+    end
+
+  end
+end

data/lib/dbpedia/request/params.rb

@@ -0,0 +1,20 @@
+module Dbpedia
+  class Request
+    class Params
+      ###
+      # Read available params from config
+      # Initialize param setter methods
+      Dbpedia::Config['params'].each do |method_name, param_name|
+        define_method "#{method_name}=" do |value|
+          @active[param_name] = value
+        end
+      end
+
+      attr_accessor :active
+
+      def initialize
+        @active = {}
+      end
+    end
+  end
+end

data/lib/dbpedia/result.rb

@@ -0,0 +1,5 @@
+module Dbpedia
+  class Result
+
+  end
+end

data/lib/dbpedia/search_result.rb

@@ -0,0 +1,21 @@
+require 'dbpedia/parser'
+
+module Dbpedia
+  class SearchResult < Dbpedia::Parser
+    require 'dbpedia/search_result/category'
+    require 'dbpedia/search_result/klass'
+
+    attr_accessor :label, :uri, :description, :label, :categories, :classes
+
+    def parse
+      self.tap do |obj|
+        obj.label = read '> Label'
+        obj.uri = read '> URI'
+        obj.description = read '> Description'
+        obj.categories = Category.load_many_from(read_xml('> Categories'), 'Category')
+        obj.classes = Klass.load_many_from(read_xml('> Classes'), 'Class')
+      end
+    end
+
+  end
+end

data/lib/dbpedia/search_result/category.rb

@@ -0,0 +1,16 @@
+module Dbpedia
+  class SearchResult
+    class Category < Dbpedia::Parser
+
+      attr_accessor :label, :uri
+
+      def parse
+        self.tap do |obj|
+          obj.label = read '> Label'
+          obj.uri = read '> URI'
+        end
+      end
+
+    end
+  end
+end

data/lib/dbpedia/search_result/klass.rb

@@ -0,0 +1,16 @@
+module Dbpedia
+  class SearchResult
+    class Klass < Dbpedia::Parser
+
+      attr_accessor :label, :uri
+
+      def parse
+        self.tap do |obj|
+          obj.label = read '> Label'
+          obj.uri = read '> URI'
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: dbpedia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roman Ernst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 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: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: Simple search for DBpedia resources. Optional support for sparql.
+email: rernst@farbenmeer.bet
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dbpedia/client.rb
+- lib/dbpedia/exception.rb
+- lib/dbpedia/parser.rb
+- lib/dbpedia/request/params.rb
+- lib/dbpedia/request.rb
+- lib/dbpedia/result.rb
+- lib/dbpedia/search_result/category.rb
+- lib/dbpedia/search_result/klass.rb
+- lib/dbpedia/search_result.rb
+- lib/dbpedia.rb
+- config/dbpedia.yml
+homepage: https://github.com/farbenmeer/dbpedia
+licenses:
+- CC BY-SA 3.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: DBpedia Client for Ruby
+test_files: []
+has_rdoc: