easy_sparql 0.1.1

data/lib/easy_sparql.rb

@@ -0,0 +1,98 @@
+# easy-sparql
+#
+# Copyright (c) 2011 British Broadcasting Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'easy_sparql', 'store.rb')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'easy_sparql', 'resource.rb')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'easy_sparql', 'mock_cache.rb')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'easy_sparql', 'vocab.rb')
+require 'securerandom'
+require 'date'
+
+module EasySparql
+
+  def self.store=(store)
+    @store = store
+  end
+
+  def self.store
+    raise Exception.new("You need to specify a store using EasySparql.store = ... before trying to access it") unless @store
+    @store
+  end
+
+  def self.query
+    store.sparql_client
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def query
+      EasySparql.query
+    end
+
+    def count_all_by_sparql(query)
+      results = query.execute
+      results.empty? ? 0 : query.execute.first[:count].to_i
+    end
+
+    def find_all_by_sparql(query, params = {})
+      to_map = query.values.map { |symbol, var| symbol }
+      results = query.execute
+      objects = {}
+      results.each do |result|
+        if params[:key] and result[params[:key]]
+          key = result[params[:key]]
+        else
+          key = SecureRandom.uuid
+        end
+        object = (objects.has_key? key) ? objects[key] : new
+        to_map.each do |symbol|
+          unless symbol == params[:key]
+            value = result[symbol]
+            if value and value.literal?
+              value = value.object
+            end
+            setter = (symbol.to_s + '=').to_sym
+            old_val = object.send(symbol)
+            if old_val and old_val.kind_of? Array
+              new_val = (old_val + [value])
+            elsif old_val
+              new_val = [old_val, value]
+            else
+              new_val = value
+            end
+            object.send(setter, new_val)
+          end
+        end
+        objects[key] = object
+      end
+      objects.values
+    end
+
+    def find_by_sparql(query)
+      find_all_by_sparql(query)[0]
+    end
+
+  end
+
+  def query
+    EasySparql.query
+  end
+
+end

data/lib/easy_sparql/mock_cache.rb

@@ -0,0 +1,39 @@
+# easy-sparql
+#
+# Copyright (c) 2011 British Broadcasting Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module EasySparql
+
+  class MockCache
+
+    def initialize
+      @cache = {}
+    end
+
+    def get(key)
+      @cache[key] if @cache.has_key? key
+    end
+
+    def set(key, value)
+      @cache[key] = value
+    end
+
+    def reset!
+      @cache = {}
+    end
+
+  end
+
+end

data/lib/easy_sparql/resource.rb

@@ -0,0 +1,139 @@
+# easy-sparql
+#
+# Copyright (c) 2011 British Broadcasting Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'sparql/client'
+require 'active_support/inflector'
+
+module EasySparql
+
+  class Resource
+
+    @@namespaces = {
+      'ws' => 'http://wsarchive.prototype0.net/ontology/',
+      'po' => 'http://purl.org/ontology/po/',
+      'dc' => 'http://purl.org/dc/elements/1.1/',
+      'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+      'rdfs' => 'http://www.w3.org/2000/01/rdf-schema#',
+    }
+    @@property_map = {}
+
+    attr_accessor :uri
+    attr_reader :method_bindings
+    attr_reader :properties
+    attr_reader :namespaces
+
+    @@cache = nil
+
+    def self.cache=(cache)
+      @@cache = cache
+    end
+
+    def self.cache
+      @@cache
+    end
+
+    def self.map(mapping)
+      @@property_map.merge! mapping
+    end
+
+    def self.add_namespace(mappings)
+      mappings.each do |k, v|
+        @@namespaces[k] = v
+      end
+    end
+
+    def self.namespaces
+      @@namespaces
+    end
+
+    def initialize(uri = nil, bindings = [])
+      @properties = []
+      @method_bindings = {}
+      @uri = uri
+      bindings.each do |property, value|
+        value = value.object if value.respond_to? :object
+        namespaces_i = @@namespaces.invert
+        namespaces_i.each do |base, short|
+          if property.to_s.start_with?(base)
+            method_name = property.to_s.sub(base, short + '_')
+            # If we already have a binding for that method, this
+            # method now outputs an array and we pluralise the method name
+            # The singular method name gives the first element of the array
+            if @method_bindings.has_key? method_name.pluralize.to_sym
+                @method_bindings[method_name.pluralize.to_sym] << value
+            elsif @method_bindings.has_key? method_name.to_sym
+              old_value = @method_bindings[method_name.to_sym]
+              @method_bindings[method_name.pluralize.to_sym] = [ old_value, value ]
+            else
+              @method_bindings[method_name.to_sym] = value
+            end
+            @properties << method_name.to_sym
+          end
+        end
+      end
+      @properties.uniq!
+    end
+
+    def self.find_by_uri(uri)
+      cached_resource = @@cache.get(uri) if @@cache
+      return cached_resource if cached_resource
+      resource = find_by_uri_from_sparql(uri)
+      @@cache.set(uri, resource) if @@cache
+      resource
+    end
+
+    def self.find_by_uri_from_sparql(uri)
+      uri = RDF::URI.new(uri) if uri.class == String
+      results = sparql.select.where([uri, :p, :o]).execute
+      bindings = []
+      results.each do |result|
+        bindings << [ result.p, result.o ]
+      end
+      resource = new(uri, bindings)
+    end
+
+    def self.find_type(uri)
+      uri = RDF::URI.new(uri) if uri.class == String
+      results = sparql.select.where([uri, RDF.type, :type]).execute
+      results[0][:type] unless results.empty?
+    end
+
+    def self.sparql
+      EasySparql.store.sparql_client
+    end
+
+    protected
+
+    def method_missing(name, *args, &block)
+      if args.empty? && @method_bindings.has_key?(name.to_sym)
+        value = @method_bindings[name.to_sym]
+        if value.class == RDF::URI
+          # Following our nose and caching the result in the object
+          if @@property_map.has_key? name.to_sym
+            @method_bindings[name.to_sym] = @@property_map[name.to_sym].find_by_uri(value)
+          else
+            @method_bindings[name.to_sym] = Resource.find_by_uri(value)
+          end
+        else
+          value
+        end
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/easy_sparql/store.rb

@@ -0,0 +1,52 @@
+# easy-sparql
+#
+# Copyright (c) 2011 British Broadcasting Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'sparql/client'
+
+module EasySparql
+
+  class Store
+
+    def initialize(sparql_uri = nil, update_uri = nil)
+      @sparql_uri = sparql_uri
+      @update_uri = update_uri
+    end
+
+    def sparql_uri=(uri)
+      @sparql_uri = uri
+    end
+
+    def sparql_uri
+      raise Exception.new "You need to set a valid SPARQL URI using Resource.sparql_uri = <uri>" unless @sparql_uri
+      @sparql_uri
+    end
+
+    def update_uri=(uri)
+      @update_uri = uri
+    end
+
+    def update_uri
+      raise Exception.new "You need to set a valid SPARQL Update URI using Resource.update_uri = <uri>" unless @update_uri
+      @update_uri
+    end
+
+    def sparql_client
+      SPARQL::Client.new @sparql_uri
+    end
+
+  end
+
+end

data/lib/easy_sparql/vocab.rb

@@ -0,0 +1,35 @@
+# easy-sparql
+#
+# Copyright (c) 2011 British Broadcasting Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module RDF
+
+  class WS < Vocabulary("http://wsarchive.prototype0.net/ontology/")
+
+  end
+
+  class PO < Vocabulary("http://purl.org/ontology/po/")
+
+  end
+
+  class O2 < Vocabulary("http://rdf.ontology2.com/vocab#")
+
+  end
+
+  class OKB < Vocabulary("http://rdf.ookaboo.com/object/")
+
+  end
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: easy_sparql
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Yves Raimond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sparql-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A (very limited) library for exploring SPARQL endpoints simply
+email: yves.raimond@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/easy_sparql.rb
+- lib/easy_sparql/resource.rb
+- lib/easy_sparql/mock_cache.rb
+- lib/easy_sparql/store.rb
+- lib/easy_sparql/vocab.rb
+homepage: 
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple wrapper to explore SPARQL endpoints
+test_files: []
+has_rdoc: false