monkeyhelper-sameasdotorg_fu 0.0.1

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 Rattle (http://www.rattlecentral.com)
+
+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,67 @@
+= sameasdotorg_fu
+
+Allows querying of the http://sameas.org site using ruby
+
+== Sample Usage
+
+Querying a URI/resource
+
+  #!/usr/bin/ruby
+
+  require 'rubygems'
+  require 'sameasdotorg_fu'
+
+  sameas = Sameas.new()
+  results = sameas.find_by_uri('http://dbpedia.org/resource/Otley')
+
+  puts "For #{results.uri} :"
+  pp results.duplicates
+
+Outputs:
+
+  For http://dbpedia.org/resource/Otley :
+  ["http://dbpedia.org/resource/Otley",
+   "http://mpii.de/yago/resource/Otley",
+   "http://rdf.freebase.com/ns/guid.9202a8c04000641f800000000011e4f9",
+   "http://sws.geonames.org/2640857/",
+   "http://umbel.org/umbel/ne/wikipedia/Otley"]
+
+Querying a term
+
+  #!/usr/bin/ruby
+
+  require 'rubygems'
+  require 'sameasdotorg_fu'
+
+  sameas = Sameas.new()
+  results = sameas.find_by_term('Otley')
+
+  results.each do |result|
+    puts "For #{result.label} :"
+    pp result.duplicates
+  end
+
+Outputs:
+
+  For http://dbpedia.org/resource/Otley :
+  ["http://dbpedia.org/resource/Otley",
+   "http://mpii.de/yago/resource/Otley",
+   "http://rdf.freebase.com/ns/guid.9202a8c04000641f800000000011e4f9",
+   "http://sws.geonames.org/2640857/",
+   "http://umbel.org/umbel/ne/wikipedia/Otley"]
+  For Otley R.U.F.C. :
+  ["http://dbpedia.org/resource/Otley_R.U.F.C.",
+   "http://mpii.de/yago/resource/Otley_R.U.F.C.",
+   "http://rdf.freebase.com/ns/guid.9202a8c04000641f8000000000d0130d",
+   "http://umbel.org/umbel/ne/wikipedia/Otley_R.U.F.C."]
+  For Otley Run :
+  ["http://dbpedia.org/resource/Otley_Run",
+   "http://mpii.de/yago/resource/Otley_Run",
+   "http://rdf.freebase.com/ns/guid.9202a8c04000641f800000000098bef8"]
+  <snip></snip>
+
+For further details see the examples dir
+
+== Copyright
+
+Copyright (c) 2009 Rattle (http://www.rattlecentral.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sameasdotorg_fu"
+    gem.summary = %Q{TODO}
+    gem.email = "robl@monkeyhelper.com"
+    gem.homepage = "http://github.com/monkeyhelper/sameasdotorg_fu"
+    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 = "sameasdotorg_fu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/term.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'sameasdotorg_fu'
+
+sameas = Sameas.new()
+results = sameas.find_by_term('Otley')
+
+results.each do |result|
+  puts "For #{result.label} :"
+  pp result.duplicates
+end

data/examples/uri.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'sameasdotorg_fu'
+
+sameas = Sameas.new()
+results = sameas.find_by_uri('http://dbpedia.org/resource/Otley')
+
+puts "For #{results.uri} :"
+pp results.duplicates

data/lib/sameas/base.rb

@@ -0,0 +1,135 @@
+module Sameas
+
+  def self.new(options = nil)
+    Sameas::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://www.sameas.org/json'
+
+    # create a new sameas 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 sameas 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)
+      # Strip any js wrapping methods
+      #puts res.body
+      if res.body =~ /^.+\((.+)\)$/
+        r = JSON.parse($1)
+      else
+        r = JSON.parse(res.body)
+      end
+      
+      return r
+    end
+
+    def find(identifier, typeof)
+      raise "no identifier specified" if identifier.nil?
+      raise "no type specified" if typeof.nil?
+
+      case typeof
+      when :uri
+        api_url = "#{API_ENDPOINT}?uri=#{identifier}"
+      when :term
+        api_url = "#{API_ENDPOINT}?q=#{identifier}"
+      else
+        raise "Unknown type specified"
+      end
+
+      results = []
+      response = send_request(api_url, :get, {})
+      response.each do |result|
+        results.push Sameas::Results.new(result)
+      end
+
+      case typeof
+      when :uri
+        return results.first
+      when :term
+        return results
+      end
+    end
+
+    def find_by_uri(uri)
+      find(uri, :uri)
+    end
+
+    def find_by_term(term)
+      find(term, :term)
+    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 = { "Accept" => "application/json", "User-Agent" => "sameasdotorg_fu" }
+      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.start do |http|
+        res = http.request(req)
+        case res
+        when Net::HTTPSuccess
+          return res
+        else
+          raise Sameas::Errors.error_for(res.code, 'HTTP Error')
+        end
+      end
+
+    end
+
+
+  end
+end

data/lib/sameas/results.rb

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

data/lib/sameasdotorg_fu.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'net/http'
+require 'cgi'
+require 'json'
+
+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).each do |file|
+  require File.join(File.dirname(__FILE__), 'sameas', file)
+end
+
+

data/test/sameasdotorg_fu_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SameasdotorgFuTest < 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 'sameasdotorg_fu'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: monkeyhelper-sameasdotorg_fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- robl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: robl@monkeyhelper.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/term.rb
+- examples/uri.rb
+- lib/sameas/base.rb
+- lib/sameas/results.rb
+- lib/sameasdotorg_fu.rb
+- test/sameasdotorg_fu_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/monkeyhelper/sameasdotorg_fu
+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: TODO
+test_files: 
+- test/sameasdotorg_fu_test.rb
+- test/test_helper.rb
+- examples/uri.rb
+- examples/term.rb