sadi-rb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 073f8686ffefb783f5d1833aae09bf542894ccf1
-  data.tar.gz: 24326b372b6847239761400d6a9eff41088c4015
+  metadata.gz: ab2044de34253723c4b946f38ffd1aa6c05ecc4f
+  data.tar.gz: 0f6b13b3ee863ab5cf5fe751c4511f7ceacc44f0
 SHA512:
-  metadata.gz: 7fe92760c66dd37064c00adcaed32059769062fd1edd6cdee245fa93752e5a4d823401c827ff1b17b6d0b22d308f10bfea13699a643513706475a39888515109
-  data.tar.gz: cdb8922540ec0c35ff2184843f02d8c4357b681585b1db811fd81c7c14c9dcc43ede0bc9136e178a417a56ef22aac1d8ba9ad026279edc4ba61bb9c619b1becc
+  metadata.gz: 4282d1f8e806189166e83517603e57a4718d4a55e7d528c359f1e3b4778c10fdb107fc765a070e3faf336bd89e7790aa8eb5e0502844af1212e8a40a5f2b7d36
+  data.tar.gz: ba25e5a446f0229053c126cefbe0cc3b4caba059214f81efc0841d6d941b00566de933c164e4d6212e7390586ef4e29e70d4ca7d5af9367a715a738e0cae68d4

data/Gemfile

@@ -18,4 +18,9 @@ end
 
 gem 'sinatra'
 gem 'sinatra-linkeddata'
+
 gem 'equivalent-xml', :require => false
+
+platforms :ruby do
+  gem 'thin'
+end

data/README.md

@@ -1,10 +1,21 @@
 # sadi-rb
 
+### Installation
+`gem install sadi-rb`
+
+or clone the repository and run `rake install` for the latest version
+
+### Description
+
 Write [SADI] Services in Ruby, then host them as a Sinatra server
 
-Currently only supports synchronous services, and only a copy of the [demo service] has been implemented
+Currently only supports [synchronous] service have been implemented.
+
+### Usage
 
-To try it, run the specs, or run
+To test the server, use the gem's executable `sadi-rb`. This will start the server on [http://localhost:4567](http://localhost:4567), and load the [demo service].
+
+The server can also be run as part of a script using
 
 ```ruby
 require 'sadi-rb'
@@ -12,7 +23,37 @@ require 'sadi-rb'
 SADI::Server.run!
 ```
 
-to run an instance of the demo service, at 'localhost:4567/services/hello'
+### Writing your own services
+
+To create an asynchronous service, simply extend the `SADI::SynchronousService` module and implement the interface methods it requires;
+
+```ruby
+require 'sadi-rb'
+
+Class MyService
+    def service_name
+        "my_service_name"
+    end
+
+    def service_description
+        # an RDF::Graph of your service's description
+    end
+
+    def service_owl
+        # an RDF::Graph of your service's OWL classes
+    end
+
+    def process_object(input_graph, owl_object)
+        # Service logic goes here
+
+        # Should return an RDF::Graph of
+        #   the output for the resource specified by the URI owl_object,
+        #   from the RDF::Graph input_graph
+    end
+end
+```
+
+Although SADI can theoretically use any vocabulary for its service description, the gem internals currently require that you use the [mygrid ontology] in implementing your `service_description` method
 
 ## Contributing to sadi-rb
 
@@ -30,4 +71,5 @@ Copyright (c) 2013 Will Strinz. See LICENSE.txt for
 further details.
 
 [demo service]: http://sadiframework.org/content/how-sadi-works/synchronous-sadi-services/
-[SADI]: http://sadiframework.org
+[SADI]: http://sadiframework.org
+[mygrid ontology]: http://www.mygrid.org.uk/tools/service-management/mygrid-ontology/

data/Rakefile

@@ -20,8 +20,9 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Build and run SADI services with ruby-rdf and sinatra}
   gem.description = %Q{Build and run SADI services with ruby-rdf and sinatra}
   gem.email = "wstrinz@gmail.com"
+  # gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
   gem.authors = ["Will Strinz"]
-  gem.version = '0.0.1'
+  gem.version = '0.0.2'
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/bin/sadi-rb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/sadi-rb.rb'
+
+SADI::Server.run!

data/lib/sadi-rb/converter.rb

@@ -6,6 +6,7 @@ module SADI
         raise "Unknown input format #{mime_type}" unless format
         format = format.to_sym
       end
+
       RDF::Graph.new << RDF::Reader.for(format).new(string)
     end
   end

data/lib/sadi-rb/example_service.rb

@@ -1,6 +1,10 @@
 class ExampleService
   extend SADI::SynchronousService
   class << self
+    def service_name
+      "hello"
+    end
+
     def service_description
       str = <<-EOS
 @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@@ -71,7 +75,6 @@ foaf:name a owl:DatatypeProperty;
     def process_object(in_graph, object)
       out_graph = RDF::Graph.new
 
-      # obj = input_objects(in_graph).first
       name = RDF::Query.execute(in_graph) do
         pattern [object, RDF::FOAF.name, :name]
       end

data/lib/sadi-rb/server.rb

@@ -5,8 +5,13 @@ module SADI
   class Server < Sinatra::Base
     register Sinatra::LinkedData
 
-    get '/test' do
-      "test success"
+    configure do
+      enable :inline_templates
+    end
+
+    get '/' do
+      # "This is a SADI "
+      haml :index
     end
 
     get '/services/:service' do
@@ -27,14 +32,47 @@ module SADI
         repo
       end
 
-
       def handle_synchronous(service)
-        rdf_response ExampleService.process_input(request.body.read,request.content_type)
+        svc = SADI.service_for(service)
+        raise "no service exists with name '#{service}'" unless svc
+        rdf_response svc.process_input(request.body.read,request.content_type)
       end
 
       def get_description(service)
-        ExampleService.service_description
+        svc = SADI.service_for(service)
+        raise "no service exists with name '#{service}'" unless svc
+        svc.service_description
+      end
+
+      def service_list
+        SADI.services.keys.map{|k| "<a href=\"/services/#{k}\"> #{k} </a>"}.join("<br>")
+      end
+
+      def format_list
+        RDF::Format.each.to_a.uniq{|f| f.content_type}
+        .reject{|f| f.content_type.size == 0}
+        .map{|f| "#{f.content_type} (#{f.to_sym})"}
+        .join('<br>')
       end
     end
   end
-end
+end
+
+__END__
+
+@@ index
+%h1
+  This is a
+  %a{href: 'http://sadiframework.org'} SADI
+  Server
+
+%div
+  %strong Available services are: <br>
+  = service_list
+
+%br
+%br
+
+%div
+  %strong Valid RDF formats are: <br>
+  = "#{format_list}"

data/lib/sadi-rb/services.rb

@@ -0,0 +1,35 @@
+module SADI
+  class << self
+
+    def service_for(name)
+      services[name]
+    end
+
+    def register_service(name, object)
+      services[name] = object
+    end
+
+    def services
+      @@services ||= {}
+    end
+
+    def reload_services
+      @@services = {}
+
+      SADI::SynchronousService.classes.each do |service|
+        if service.respond_to? 'service_name'
+          name = service.service_name
+          puts "Warning: service #{@@services[name]} already using name '#{name}', overwriting" if @@services[name]
+          @@services[name] = service
+        elsif service.instance_methods.include? :service_name
+          service = service.new
+          name = service.service_name
+          puts "Warning: service #{@@services[name]} already using name '#{name}', overwriting" if @@services[name]
+          @@services[name] = service
+        else
+          raise "service #{service} does not define a proper interface"
+        end
+      end
+    end
+  end
+end

data/lib/sadi-rb/synchronous_service.rb

@@ -2,6 +2,20 @@ module SADI
   module SynchronousService
     include SADI::Converter
 
+    def self.included(base)
+      @classes ||= []
+      @classes << base
+    end
+
+    def self.extended(base)
+      @classes ||= []
+      @classes << base
+    end
+
+    def self.classes
+      @classes
+    end
+
     def process_input(input, format)
       gr = RDF::Graph.new
       in_graph = parse_string(input,format)
@@ -54,5 +68,9 @@ module SADI
     def process_object(owl_graph, object)
       raise "Must implement a #process_input that takes an RDF::Graph or Repository as input and returns a new one"
     end
+
+    def service_name
+      raise "Must define a service name"
+    end
   end
 end

data/lib/sadi-rb.rb

@@ -1,4 +1,8 @@
 require_relative 'sadi-rb/server.rb'
 require_relative 'sadi-rb/converter.rb'
 require_relative 'sadi-rb/synchronous_service.rb'
+require_relative 'sadi-rb/services.rb'
+
 require_relative 'sadi-rb/example_service.rb'
+
+SADI.reload_services

data/sadi-rb.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sadi-rb"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Will Strinz"]
+  s.date = "2013-10-15"
+  s.description = "Build and run SADI services with ruby-rdf and sinatra"
+  s.email = "wstrinz@gmail.com"
+  s.executables = ["sadi-rb"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/sadi-rb",
+    "lib/sadi-rb.rb",
+    "lib/sadi-rb/converter.rb",
+    "lib/sadi-rb/example_service.rb",
+    "lib/sadi-rb/server.rb",
+    "lib/sadi-rb/services.rb",
+    "lib/sadi-rb/synchronous_service.rb",
+    "sadi-rb.gemspec",
+    "spec/server_spec.rb"
+  ]
+  s.homepage = "http://github.com/wstrinz/sadi-rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Build and run SADI services with ruby-rdf and sinatra"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_runtime_dependency(%q<sinatra-linkeddata>, [">= 0"])
+      s.add_runtime_dependency(%q<equivalent-xml>, [">= 0"])
+      s.add_runtime_dependency(%q<thin>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<sinatra-linkeddata>, [">= 0"])
+      s.add_dependency(%q<equivalent-xml>, [">= 0"])
+      s.add_dependency(%q<thin>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<sinatra-linkeddata>, [">= 0"])
+    s.add_dependency(%q<equivalent-xml>, [">= 0"])
+    s.add_dependency(%q<thin>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sadi-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Will Strinz
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +166,8 @@ dependencies:
         version: '0'
 description: Build and run SADI services with ruby-rdf and sinatra
 email: wstrinz@gmail.com
-executables: []
+executables:
+- sadi-rb
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -163,11 +178,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/sadi-rb
 - lib/sadi-rb.rb
 - lib/sadi-rb/converter.rb
 - lib/sadi-rb/example_service.rb
 - lib/sadi-rb/server.rb
+- lib/sadi-rb/services.rb
 - lib/sadi-rb/synchronous_service.rb
+- sadi-rb.gemspec
 - spec/server_spec.rb
 homepage: http://github.com/wstrinz/sadi-rb
 licenses: