iq_triplestorage 0.1.0

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+
+script: bundle exec rake test
+
+branches:
+  only:
+    - master
+
+notifications:
+  recipients:
+    - iqvoc@innoq.com

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gem "rake"
+gem "typhoeus"
+
+group :test do
+  gem "minitest"
+  gem "webmock"
+end

data/README.md

@@ -0,0 +1,3 @@
+# IqTriplestorage - library for interacting with RDF triplestores / quadstores [![build status](https://secure.travis-ci.org/innoq/iq_triplestorage.png)](http://travis-ci.org/innoq/iq_triplestorage)
+
+see tests for usage examples

data/Rakefile

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run tests"
+task :default => :test

data/iq_triplestorage.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path("../lib/iq_triplestorage", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "iq_triplestorage"
+  s.version     = IqTriplestorage::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.summary     = "IqTriplestorage - library for interacting with RDF triplestores / quadstores"
+  s.homepage    = "http://github.com/innoq/iq_triplestorage"
+  s.rubyforge_project = s.name
+  s.authors     = ["FND"]
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/iq_triplestorage.rb

@@ -0,0 +1,3 @@
+module IqTriplestorage
+  VERSION = "0.1.0"
+end

data/lib/iq_triplestorage/virtuoso_adaptor.rb

@@ -0,0 +1,105 @@
+require 'net/http'
+require 'base64'
+require 'typhoeus'
+
+module IqTriplestorage
+  class VirtuosoAdaptor
+
+    def initialize(host, port, username, password)
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+    end
+
+    def reset(uri)
+      return sparql_pull("CLEAR GRAPH <#{uri}>") # XXX: s/CLEAR/DROP/ was rejected (405)
+    end
+
+    # expects a hash of N-Triples by graph URI
+    def batch_update(triples_by_graph)
+      # apparently Virtuoso gets confused when mixing CLEAR and INSERT queries,
+      # so we have to do use separate requests
+
+      reset_queries = triples_by_graph.keys.map do |graph_uri|
+        "CLEAR GRAPH <#{graph_uri}>" # XXX: duplicates `reset`
+      end
+      success = sparql_query(reset_queries)
+      return false unless success
+
+      insert_queries = triples_by_graph.map do |graph_uri, ntriples|
+        "INSERT IN GRAPH <#{graph_uri}> {\n#{ntriples}\n}"
+      end
+      success = sparql_query(insert_queries)
+
+      return success
+    end
+
+    # uses push method if `rdf_data` is provided, pull otherwise
+    def update(uri, rdf_data=nil, content_type=nil)
+      reset(uri)
+
+      if rdf_data
+        res = sparql_push(uri, rdf_data.strip, content_type)
+      else
+        res = sparql_pull(%{LOAD "#{uri}" INTO GRAPH <#{uri}>})
+      end
+
+      return res
+    end
+
+    def sparql_push(uri, rdf_data, content_type)
+      raise TypeError, "missing content type" unless content_type
+
+      filename = uri.gsub(/[^0-9A-Za-z]/, "_") # XXX: too simplistic?
+      path = "/DAV/home/#{@username}/rdf_sink/#{filename}"
+
+      auth = Base64.encode64([@username, @password].join(":")).strip
+      headers = {
+        "Authorization" => "Basic #{auth}", # XXX: seems like this should be built into Typhoeus!?
+        "Content-Type" => content_type
+      }
+      res = Typhoeus::Request.put("#{@host}:#{@port}#{path}",
+          :headers => headers, :body => rdf_data)
+
+      return res.code == 201
+    end
+
+    def sparql_pull(query)
+      path = "/DAV/home/#{@username}/rdf_sink" # XXX: shouldn't this be /sparql?
+      res = http_request("POST", path, query, {
+        "Content-Type" => "application/sparql-query"
+      })
+      return res.code == "200" # XXX: always returns 409
+    end
+
+    # query is a string or an array of strings
+    def sparql_query(query)
+      query = query.join("\n\n") + "\n" rescue query
+
+      path = "/DAV/home/#{@username}/query"
+
+      auth = Base64.encode64([@username, @password].join(":")).strip
+      headers = {
+        "Authorization" => "Basic #{auth}", # XXX: seems like this should be built into Typhoeus!?
+        "Content-Type" => "application/sparql-query"
+      }
+      res = Typhoeus::Request.put("#{@host}:#{@port}#{path}",
+          :headers => headers, :body => query)
+
+      return res.code == 201
+    end
+
+    def http_request(method, path, body, headers={}) # TODO: switch to Typhoeus
+      uri = URI.parse("#{@host}:#{@port}#{path}")
+
+      req = Net::HTTP.const_get(method.downcase.capitalize).new(uri.to_s)
+      req.basic_auth(@username, @password)
+      headers.each { |key, value| req[key] = value }
+      req.body = body
+
+      return Net::HTTP.new(uri.host, uri.port).request(req)
+    end
+
+  end
+end

data/test/virtuoso_test.rb

@@ -0,0 +1,138 @@
+require 'base64'
+require "minitest/autorun"
+require 'webmock/test_unit'
+
+require "iq_triplestorage/virtuoso_adaptor"
+
+class VirtuosoTest < MiniTest::Unit::TestCase
+
+  def setup
+    # HTTP request mocking
+    @observers = [] # one per request
+    WebMock.stub_request(:any, /.*example.org.*/).with do |req|
+      # not using WebMock's custom assertions as those didn't seem to provide
+      # sufficient flexibility
+      fn = @observers.shift
+      raise(TypeError, "missing request observer") unless fn
+      fn.call(req)
+      true
+    end.to_return do |req|
+      { :status => req.uri.to_s.end_with?("/rdf_sink") ? 200 : 201 }
+    end
+
+    @username = "foo"
+    @password = "bar"
+    @host = "example.org"
+    @port = 80
+    @adaptor = IqTriplestorage::VirtuosoAdaptor.new("http://#{@host}", @port,
+        @username, @password)
+  end
+
+  def teardown
+    WebMock.reset!
+    raise(TypeError, "unhandled request observer") unless @observers.length == 0
+  end
+
+  def test_reset
+    uri = "http://example.com/foo"
+
+    @observers << lambda do |req|
+      ensure_basics(req)
+      assert_equal :post, req.method
+      assert_equal "/DAV/home/#{@username}/rdf_sink", req.uri.path
+      assert_equal "application/sparql-query", req.headers["Content-Type"]
+      assert_equal "CLEAR GRAPH <#{uri}>", req.body
+    end
+    assert @adaptor.reset(uri)
+  end
+
+  def test_pull
+    uri = "http://example.com/bar"
+
+    @observers << lambda do |req|
+      assert_equal "CLEAR GRAPH <#{uri}>", req.body
+    end
+    @observers << lambda do |req|
+      assert_equal :post, req.method
+      assert_equal "/DAV/home/#{@username}/rdf_sink", req.uri.path
+      assert_equal "application/sparql-query", req.headers["Content-Type"]
+      assert_equal %(LOAD "#{uri}" INTO GRAPH <#{uri}>), req.body
+    end
+    assert @adaptor.update(uri)
+  end
+
+  def test_push
+    uri = "http://example.com/baz"
+
+    rdf_data = <<-EOS.strip
+<?xml version="1.0" encoding="UTF-8"?>
+<rdf:RDF xmlns="http://try.iqvoc.net/"
+    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+    xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
+    xmlns:owl="http://www.w3.org/2002/07/owl#"
+    xmlns:skos="http://www.w3.org/2004/02/skos/core#"
+    xmlns:dct="http://purl.org/dc/terms/"
+    xmlns:coll="http://try.iqvoc.net/collections/"
+    xmlns:schema="http://try.iqvoc.net/schema#">
+  <rdf:Description rdf:about="http://try.iqvoc.net/model_building">
+    <rdf:type rdf:resource="http://www.w3.org/2004/02/skos/core#Concept"/>
+    <skos:prefLabel xml:lang="en">Model building</skos:prefLabel>
+    <skos:narrower rdf:resource="http://try.iqvoc.net/model_rocketry"/>
+    <skos:narrower rdf:resource="http://try.iqvoc.net/radio-controlled_modeling"/>
+    <skos:narrower rdf:resource="http://try.iqvoc.net/scale_modeling"/>
+    <skos:broader rdf:resource="http://try.iqvoc.net/achievement_hobbies"/>
+  </rdf:Description>
+</rdf:RDF>
+    EOS
+
+    @observers << lambda do |req|
+      assert_equal "CLEAR GRAPH <#{uri}>", req.body
+    end
+    @observers << lambda do |req|
+      assert_equal :put, req.method
+      assert req.uri.path.start_with?("/DAV/home/#{@username}/rdf_sink/")
+      assert_equal "application/rdf+xml", req.headers["Content-Type"]
+      assert_equal rdf_data, req.body
+    end
+    assert @adaptor.update(uri, rdf_data, "application/rdf+xml")
+  end
+
+  def test_batch
+    data = {
+      "http://example.com/foo" => "<aaa> <bbb> <ccc> .\n<ddd> <eee> <fff> .",
+      "http://example.com/bar" => "<ggg> <hhh> <iii> .\n<jjj> <kkk> <lll> ."
+    }
+
+    @observers << lambda do |req|
+      data.keys.each do |graph_uri|
+        assert req.body.include?("CLEAR GRAPH <#{graph_uri}>")
+      end
+    end
+    @observers << lambda do |req|
+      data.each do |graph_uri, ntriples|
+        assert req.body.
+            include?(<<-EOS)
+INSERT IN GRAPH <#{graph_uri}> {
+#{ntriples}
+}
+            EOS
+      end
+    end
+    assert @adaptor.batch_update(data)
+  end
+
+  def ensure_basics(req) # TODO: rename
+    assert_equal "#{@host}:#{@port}", "#{req.uri.hostname}:#{req.uri.port}"
+
+    if auth_header = req.headers["Authorization"]
+      auth = Base64.encode64([@username, @password].join(":")).strip
+      assert_equal auth, auth_header
+    else
+      # MockWeb appears to prevent the Authorization header being set, instead
+      # retaining username and password in URI
+      assert req.uri.to_s.
+          start_with?("#{req.uri.scheme}://#{@username}:#{@password}@")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: iq_triplestorage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- FND
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- iq_triplestorage.gemspec
+- lib/iq_triplestorage.rb
+- lib/iq_triplestorage/virtuoso_adaptor.rb
+- test/virtuoso_test.rb
+homepage: http://github.com/innoq/iq_triplestorage
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: iq_triplestorage
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: IqTriplestorage - library for interacting with RDF triplestores / quadstores
+test_files:
+- test/virtuoso_test.rb