monkeyhelper-dbpedialookup 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+nbproject

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 robl
+
+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.rdoc

@@ -0,0 +1,56 @@
+= dbpedialookup
+
+A ruby interface to the lookup.dbpedia.org service.
+
+== Example Usage
+
+Searching by keyword
+
+  #!/usr/bin/ruby
+
+  require 'rubygems'
+  require 'dbpedialookup'
+
+  lookup = DBpediaLookup.new()
+  results = lookup.find_by_keyword('Otley', :maxhits => 1)
+
+  results.each do |result|
+    puts "#{result.Label} #{result.URI}"
+  end
+
+Output
+
+  Otley http://dbpedia.org/resource/Otley
+
+Searching by prefix
+
+  #!/usr/bin/ruby
+
+  require 'rubygems'
+  require 'dbpedialookup'
+
+  lookup = DBpediaLookup.new()
+  results = lookup.find_by_prefix('Otle')
+
+  results.each do |result|
+    puts "#{result.Label} #{result.URI}"
+  end
+
+Output
+
+  Otley http://dbpedia.org/resource/Otley
+  Otley R.U.F.C. http://dbpedia.org/resource/Otley_R.U.F.C.
+  Otley (UK Parliament constituency) http://dbpedia.org/resource/Otley_%28UK_Parliament_constituency%29
+  Pudsey and Otley (UK Parliament constituency) http://dbpedia.org/resource/Pudsey_and_Otley_%28UK_Parliament_constituency%29
+  Otley (film) http://dbpedia.org/resource/Otley_%28film%29
+  Prince Henry's Grammar School, Otley http://dbpedia.org/resource/Prince_Henry%27s_Grammar_School%2C_Otley
+  Otley, Suffolk http://dbpedia.org/resource/Otley%2C_Suffolk
+  Otley Run http://dbpedia.org/resource/Otley_Run
+  A660 road http://dbpedia.org/resource/A660_road
+  H. Otley Beyer http://dbpedia.org/resource/H._Otley_Beyer
+
+For further details see the examples dir
+
+== Copyright
+
+Copyright (c) 2009 robl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dbpedialookup"
+    gem.summary = "A ruby interface to lookup.dbpedia.org"
+    gem.email = "robl[at]monkeyhelper.com"
+    gem.homepage = "http://github.com/monkeyhelper/dbpedialookup"
+    gem.authors = ["robl"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dbpedialookup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/dbpedialookup.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dbpedialookup}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["robl"]
+  s.date = %q{2009-06-07}
+  s.email = %q{robl[at]monkeyhelper.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dbpedialookup.gemspec",
+     "examples/lookup-keyword.rb",
+     "examples/lookup-prefix.rb",
+     "lib/dbpedialookup.rb",
+     "lib/dbpedialookup/base.rb",
+     "lib/dbpedialookup/errors.rb",
+     "lib/dbpedialookup/results.rb",
+     "test/dbpedialookup_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/monkeyhelper/dbpedialookup}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A ruby interface to lookup.dbpedia.org}
+  s.test_files = [
+    "test/dbpedialookup_test.rb",
+     "test/test_helper.rb",
+     "examples/lookup-keyword.rb",
+     "examples/lookup-prefix.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/examples/lookup-keyword.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'dbpedialookup'
+
+lookup = DBpediaLookup.new()
+results = lookup.find_by_keyword('Otley', :maxhits => 1)
+
+results.each do |result|
+  puts "#{result.URI}"
+  puts "#{result.Label}"
+  puts "#{result.Description}"
+  puts "#{result.Refcount}"
+  puts "#{result.Classes.inspect}"
+end
+

data/examples/lookup-prefix.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'dbpedialookup'
+
+lookup = DBpediaLookup.new()
+results = lookup.find_by_prefix('Otle')
+
+results.each do |result|
+  puts "#{result.Label} #{result.URI}"
+end

data/lib/dbpedialookup.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'net/http'
+require 'cgi'
+require 'xmlsimple'
+
+require 'pp'
+
+
+class Module
+  def class_attr_accessor(attribute_name)
+    class_eval <<-CODE
+      def self.#{attribute_name}
+        @@#{attribute_name} ||= nil
+      end
+      def self.#{attribute_name}=(value)
+        @@#{attribute_name} = value
+      end
+    CODE
+  end
+end
+
+class Hash
+  # File merb/core_ext/hash.rb, line 166
+  def nested_symbolize_keys!
+    each do |k,v|
+      sym = k.respond_to?(:to_sym) ? k.to_sym : k
+      self[sym] = Hash === v ? v.nested_symbolize_keys! : v
+      delete(k) unless k == sym
+    end
+    self
+  end
+
+  def nested_stringify_keys!
+    each do |k,v|
+      s = k.respond_to?(:to_s) ? k.to_s : k
+      self[s] = Hash === v ? v.nested_stringify_keys! : v
+      delete(k) unless k == s
+    end
+    self
+  end
+
+end
+
+# base must load first
+%w(base results errors).each do |file|
+  require File.join(File.dirname(__FILE__), 'dbpedialookup', file)
+end
+
+

data/lib/dbpedialookup/base.rb

@@ -0,0 +1,128 @@
+module DBpediaLookup
+
+  def self.new(options = nil)
+    DBpediaLookup::Base.new(options)
+  end
+
+  class Base
+    class_attr_accessor :http_open_timeout
+    class_attr_accessor :http_read_timeout
+    attr_accessor :api_endpoint
+
+    @@http_open_timeout = 60
+    @@http_read_timeout = 60
+
+    API_ENDPOINT = 'http://lookup.dbpedia.org/api/search.asmx'
+
+    # create a new dbpedialookup object
+    #
+    def initialize(config_hash_or_file)
+      return if config_hash_or_file.nil?
+      if config_hash_or_file.is_a? Hash
+        config_hash_or_file.nested_symbolize_keys!
+        @api_endpoint = config_hash_or_file[:api_endpoint]
+      else
+        config = YAML.load_file(config_hash_or_file)
+        config.nested_symbolize_keys!
+        @api_endpoint = config[:api_endpoint]
+      end
+    end
+
+    # sends a request to the dbpedialookup api
+    #
+    # Params
+    # * api_url (Required)
+    #     the request url (uri.path)
+    # * http_method (Optional)
+    #     choose between GET (default), POST, PUT, DELETE http request.
+    # * options (Optional)
+    #     hash of query parameters
+    #
+    def send_request(api_url, http_method = :get, options= {})
+
+      raise 'no api_url supplied' unless api_url
+
+      res = request_over_http(api_url, http_method, options)
+      return XmlSimple.xml_in(res.body)
+
+    end
+
+    def find(identifier, typeof, options)
+      raise "no identifier specified" if identifier.nil?
+      raise "no type specified" if typeof.nil?
+
+      case typeof
+      when :keyword
+        api_url = "#{API_ENDPOINT}/KeywordSearch"
+      when :prefix
+        api_url = "#{API_ENDPOINT}/PrefixSearch"
+      else
+        raise "Unknown type specified"
+      end
+
+      opts = { :QueryString => identifier }
+      opts[:QueryClass] = options[:queryclass]
+      opts[:MaxHits] = options[:maxhits]
+      # QueryString=string&QueryClass=string&MaxHits=string
+
+      results = []
+      response = send_request(api_url, :post, opts)
+      response['Result'].each do |result|
+        results.push DBpediaLookup::Results.new(result)
+      end
+      return results
+    end
+
+    def find_by_keyword(keyword, options = {})
+      find(keyword, :keyword, options)
+    end
+
+    def find_by_prefix(prefix, options = {})
+      find(prefix, :prefix, options)
+    end
+
+    protected
+
+    # For easier testing. You can mock this method with a XML file you re expecting to receive
+    def request_over_http(api_url, http_method, options)
+
+      req = nil
+      http_opts = {  "User-Agent" => "dbpedialookup" }
+      url = URI.parse(api_url)
+
+      case http_method
+        when :get
+          u = url.query.nil? ? url.path : url.path+"?"+url.query
+          req = Net::HTTP::Get.new(u, http_opts)
+        when :post
+          req = Net::HTTP::Post.new(url.path, http_opts)
+        when :put
+          req = Net::HTTP::Put.new(url.path, http_opts)
+        when :delete
+          req = Net::HTTP::Delete.new(url.path, http_opts)
+      else
+        raise 'invalid http method specified'
+      end
+
+      req.set_form_data(options) unless options.keys.empty?
+      #req.basic_auth @username, @password
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.open_timeout = @@http_open_timeout
+      http.read_timeout = @@http_read_timeout
+      #http.set_debug_output $stderr
+      http.start do |http|
+        res = http.request(req)
+        case res
+        when Net::HTTPSuccess
+          return res
+        else
+          raise DBpediaLookup::Errors.error_for(res.code, 'HTTP Error')
+        end
+      end
+
+    end
+
+
+  end
+end

data/lib/dbpedialookup/errors.rb

@@ -0,0 +1,19 @@
+module DBpediaLookup
+
+    class Error < RuntimeError
+      attr_accessor :code
+    end
+
+    class Errors
+      # Method used for raising the appropriate error class for a given error code.
+      # Currently raises only DBpediaLookup::Error
+      def self.error_for(code, message)
+        raise RuntimeError.new("Internal error.  API error not identified or unknown error.") if (code.nil? || message.nil? || message.empty?)
+        raise RuntimeError.new("Internal error. Unknown error.") if code.to_i == 0 # We assume that error code 0 is never returned
+        e = DBpediaLookup::Error.new("#{code}: #{message}")
+        e.code = code
+        raise e
+      end
+    end
+
+end

data/lib/dbpedialookup/results.rb

@@ -0,0 +1,21 @@
+class DBpediaLookup::Results < DBpediaLookup::Base
+
+  attr_accessor :attributes
+
+  def initialize(attributes = {})
+    @attributes = attributes.nested_symbolize_keys!
+  end
+
+  def method_missing(method, args = nil)
+    unless @attributes.has_key?(method)
+      raise "No method named #{method.to_s}"
+    end
+    if args.nil?
+      @attributes[method]
+    else
+      @attributes[method] = args
+      return true
+    end
+  end
+
+end

data/test/dbpedialookup_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DbpedialookupTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dbpedialookup'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: monkeyhelper-dbpedialookup
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- robl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: robl[at]monkeyhelper.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- dbpedialookup.gemspec
+- examples/lookup-keyword.rb
+- examples/lookup-prefix.rb
+- lib/dbpedialookup.rb
+- lib/dbpedialookup/base.rb
+- lib/dbpedialookup/errors.rb
+- lib/dbpedialookup/results.rb
+- test/dbpedialookup_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/monkeyhelper/dbpedialookup
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A ruby interface to lookup.dbpedia.org
+test_files: 
+- test/dbpedialookup_test.rb
+- test/test_helper.rb
+- examples/lookup-keyword.rb
+- examples/lookup-prefix.rb