tripod 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tripod.gemspec
 gemspec
+
+group :test do
+  gem "rspec", "~> 2.11"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 RicSwirrl
+Copyright (c) 2012 Swirrl IT Limited. http://swirrl.com
 
 MIT License
 

data/README.md

@@ -1,3 +1,7 @@
 # Tripod
 
-Coming soon: Active Model style Ruby ORM for RDF data.
+Active Model style Ruby ORM for RDF data, inspired by http://github.com/mongoid/mongoid
+
+Warning: Work still in progress / experimental. Not production ready!
+
+Copyright (c) 2012 Swirrl IT Limited. http://swirrl.com. Released under MIT License

data/Rakefile

@@ -1,2 +1,15 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec
+

data/lib/tripod.rb

@@ -1,5 +1,76 @@
+# Copyright (c) 2012 Swirrl IT Limited. http://swirrl.com
+
+# MIT License
+
+# 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.
+
 require "tripod/version"
 
+require "active_support/core_ext"
+require 'active_support/json'
+require "active_support/inflector"
+require "active_model"
+
+require 'rdf'
+require 'rdf/rdfxml'
+require 'rdf/n3'
+require 'rdf/json'
+
+require 'rest_client'
+
 module Tripod
-  # Your code goes here...
+
+  mattr_accessor :update_endpoint
+  @@update_endpoint = 'http://127.0.0.1:3030/tripod/update'
+
+  mattr_accessor :query_endpoint
+  @@query_endpoint = 'http://127.0.0.1:3030/tripod/sparql'
+
+  mattr_accessor :timeout_seconds
+  @@timeout_seconds = 30
+
+  # Use +configure+ to override configuration in an app, e.g.:
+  #
+  #   Tripod.configure do |config|
+  #     config.update_endpoint = 'http://127.0.0.1:3030/tripod/update'
+  #     config.query_endpoint = 'http://127.0.0.1:3030/tripod/sparql'
+  #     config.timeout_seconds = 30
+  #   end
+  #
+  def self.configure
+    yield self
+  end
+
 end
+
+require "tripod/sparql_client"
+
+require "tripod/attributes"
+require "tripod/errors"
+require "tripod/fields"
+require "tripod/finders"
+require "tripod/persistence"
+require "tripod/repository"
+require "tripod/state"
+require "tripod/version"
+
+# these need to be at the end
+require "tripod/components"
+require "tripod/resource"

data/lib/tripod/attributes.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+# This module defines behaviour for attributes.
+module Tripod::Attributes
+
+  extend ActiveSupport::Concern
+
+  # Reads values from this respource's in-memory statement repository, where the predicate matches that of the uri passed in.
+  # Returns an Array of RDF::Terms object.
+  #
+  # @example Read an attribute.
+  #   person.read_attribute('http://foo')
+  #   person.read_attribute(RDF::URI.new('http://foo'))
+  #
+  # @example Read an attribute (alternate syntax.)
+  #   person['http://foo']
+  #   person[RDF::URI.new('http://foo')]
+  #
+  # @param [ String, RDF::URI ] uri The uri of the attribute to get.
+  #
+  # @return [ Array ] An array of RDF::Terms.
+  def read_attribute(predicate_uri)
+    values = []
+    @repository.query( [:subject, RDF::URI.new(predicate_uri.to_s), :object] ) do |statement|
+      values << statement.object
+    end
+    values
+  end
+  alias :[] :read_attribute
+
+  # Replace the statement-values for a single predicate in this resource's in-memory repository.
+  #
+  # @example Write the attribute.
+  #   person.write_attribute('http://title', "Mr.")
+  #   person.write_attribute('http://title', ["Mrs.", "Ms."])
+  #
+  # @example Write the attribute (alternate syntax.)
+  #   person['http://title'] = "Mr."
+  #   person['http://title'] = ["Mrs.", "Ms."]
+  #
+  # @param [ String, RDF::URI ] predicate_uri The name of the attribute to update.
+  # @param [ Object, Array ] value The values to set for the attribute. Can be an array, or single item. They should compatible with RDF::Terms
+  def write_attribute(predicate_uri, objects)
+    # remove existing
+    remove_attribute(predicate_uri)
+
+    # ... and replace
+    objects = [objects] unless objects.kind_of?(Array)
+    objects.each do |object|
+      @repository << RDF::Statement.new( @uri, RDF::URI.new(predicate_uri.to_s), object )
+    end
+
+    # returns the new values
+    read_attribute(predicate_uri)
+  end
+  alias :[]= :write_attribute
+
+  # Append the statement-values for a single predicate in this resource's in-memory repository. Basically just adds a new statement for this ((resource's uri)+predicate)
+  #
+  # @example Write the attribute.
+  #   person.append_attribute('http://title', "Mrs.")
+  #   person.append_attribute('http://title', "Ms.")
+  #
+  # @example Write the attribute (alternate syntax.)
+  #   person['http://title'] << "Mrs."
+  #   person['http://title'] << "Ms."
+  #
+  # @param [ String, RDF::URI ] predicate_uri The uri of the attribute to update.
+  # @param [ Object ] value The values to append for the attribute. Should compatible with RDF::Terms
+  def append_to_attribute(predicate_uri, object )
+    @repository << RDF::Statement.new(@uri, RDF::URI.new(predicate_uri.to_s), object)
+  end
+
+  def remove_attribute(predicate_uri)
+    @repository.query( [:subject, RDF::URI.new(predicate_uri.to_s), :object] ) do |statement|
+      @repository.delete( statement )
+    end
+  end
+
+end

data/lib/tripod/components.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+# All modules that a +Resource+ is composed of are defined in this
+# module, to keep the resource module from getting too cluttered.
+module Tripod::Components
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  include ActiveModel::Conversion # to_param, to_key etc.
+  # include ActiveModel::MassAssignmentSecurity
+  include ActiveModel::Naming
+  include ActiveModel::Validations
+
+  include Tripod::Attributes
+  include Tripod::Persistence
+  include Tripod::Fields
+  include Tripod::Finders
+  include Tripod::Repository
+  include Tripod::State
+
+end

data/lib/tripod/errors.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require 'tripod/errors/resource_not_found'
+require 'tripod/errors/uri_not_set'
+require 'tripod/errors/validations'

data/lib/tripod/errors/resource_not_found.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module Tripod::Errors
+
+  # not found error.
+  class ResourceNotFound < StandardError
+  end
+
+end

data/lib/tripod/errors/uri_not_set.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+module Tripod::Errors
+
+  # Action attempted on a resource which requires the uri to be set.
+  class UriNotSet < StandardError
+
+  end
+
+end

data/lib/tripod/errors/validations.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+module Tripod::Errors
+
+  # Raised when a persistence method ending in ! fails validation. The message
+  # will contain the full error messages from the +Resource+ in question.
+  #
+  # @example Create the error.
+  #   Validations.new(person.errors)
+  class Validations < StandardError
+    attr_reader :resource
+    alias :record :resource
+
+    def initialize(resource)
+      @resource = resource
+    end
+  end
+
+end

data/lib/tripod/fields.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+ # This module defines behaviour for fields.
+module Tripod::Fields
+  extend ActiveSupport::Concern
+
+end

data/lib/tripod/finders.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+# This module defines behaviour for finders.
+module Tripod::Finders
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    # Find a +Resource+ by its uri.
+    #
+    # @example Find a single resource by a uri.
+    #   Person.find('http://ric')
+    #   Person.find(RDF::URI('http://ric'))
+    #
+    # @param [ String, RDF::URI ] uri The uri of the resource to find
+    #
+    # @raise [ Errors::DocumentNotFound ] If no document found.
+    #
+    # @return [ Resource ] A single resource
+    def find(uri)
+
+      # do a quick select to see what graph to use.
+      select_query = "SELECT ?g WHERE { GRAPH ?g {<#{uri.to_s}> ?p ?o } } LIMIT 1"
+      result = Tripod::SparqlClient::Query.select(select_query)
+      if result.length > 0
+        graph_uri_str = result[0]["g"]["value"]
+      else
+        raise Tripod::Errors::ResourceNotFound.new
+      end
+
+      # instantiate and hydrate the resource
+      resource = self.new(uri, graph_uri_str)
+      resource.hydrate!
+
+      # check that there are triples for the resource (catches case when someone has deleted data
+      # between our original check for the graph and hydrating the object.
+      raise Tripod::Errors::ResourceNotFound.new if resource.repository.empty?
+
+      # return the instantiated, hydrated resource
+      resource
+    end
+
+  end
+end

data/lib/tripod/persistence.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+# This module defines behaviour for persisting to the database.
+module Tripod::Persistence
+  extend ActiveSupport::Concern
+  # Save the resource.
+  # Note: regardless of whether it's a new_record or not, we always make the
+  # db match the contents of this resource's statements.
+  #
+  # @example Save the resource.
+  #   resource.save
+  #
+  # @return [ true, false ] True is success, false if not.
+  def save()
+    if self.valid?
+      query = "
+        DELETE {GRAPH ?g {<#{@uri.to_s}> ?p ?o}} WHERE {GRAPH ?g {<#{@uri.to_s}> ?p ?o}};
+        INSERT DATA {
+          GRAPH <#{@graph_uri}> {
+            #{ @repository.dump(:ntriples) }
+          }
+        }
+      "
+      success = Tripod::SparqlClient::Update::update(query)
+      @new_record = false if success
+      success
+    else
+      false
+    end
+  end
+
+  def save!()
+    # try to save
+    unless self.save()
+      # if we get in here, save failed.
+      self.class.fail_validate!(self)
+      # TODO: similar stuff for callbacks?
+    end
+    return true
+  end
+
+  def destroy()
+    query = "
+      # delete from default graph:
+      DELETE {<#{@uri.to_s}> ?p ?o} WHERE {<#{@uri.to_s}> ?p ?o};
+      # delete from named graphs:
+      DELETE {GRAPH ?g {<#{@uri.to_s}> ?p ?o}} WHERE {GRAPH ?g {<#{@uri.to_s}> ?p ?o}};
+    "
+    success = Tripod::SparqlClient::Update::update(query)
+    @destroyed = true if success
+    success
+  end
+
+  module ClassMethods #:nodoc:
+
+    # Raise an error if validation failed.
+    #
+    # @example Raise the validation error.
+    #   Person.fail_validate!(person)
+    #
+    # @param [ Resource ] resource The resource to fail.
+    def fail_validate!(resource)
+      raise Tripod::Errors::Validations.new(resource)
+    end
+
+  end
+
+end

data/lib/tripod/repository.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+# This module wraps access to an RDF::Repository
+module Tripod::Repository
+  extend ActiveSupport::Concern
+
+  attr_reader :repository
+
+  # hydrates the resource's repo with statements from the db or passed in graph of statements.
+  # where the subject is the uri of this resource.
+  #
+  # @example Hydrate the resource from the db
+  #   person.hydrate!
+  #
+  # @example Hydrate the resource from a passed in graph
+  #   person.hydrate!(my_graph)
+  #
+  # @return [ RDF::Repository ] A reference to the repository for this instance.
+  def hydrate!(graph = nil)
+
+    # we require that the uri is set.
+    raise Tripod::Errors::UriNotSet.new() unless @uri
+
+    if graph
+      graph.each_statement do |statement|
+        # only use statements about this resource!
+        if statement.subject.to_s == @uri.to_s
+          @repository << statement
+        end
+      end
+    else
+      triples = Tripod::SparqlClient::Query::describe("DESCRIBE <#{uri}>")
+      @repository = RDF::Repository.new
+      RDF::Reader.for(:ntriples).new(triples) do |reader|
+        reader.each_statement do |statement|
+          @repository << statement
+        end
+      end
+    end
+
+  end
+
+end