sadi-rb

gem install sadi-rb

or clone the repository and run rake install for the latest version

Write SADI Services in Ruby, using ruby-rdf, then host them in a Sinatra application.

Currently only support for synchronous services are fully supported, although an experimental asynchronous class is available.

To test the server, use the gem's executable sadi-rb. This will start the server on http://localhost:4567, and load the demo service, which is based on the service at http://sadiframework.org/examples/hello.

The server can also be run as part of a script using

require 'sadi-rb'

SADI::Server.run!

To create a synchronous service, simply extend the SADI::SynchronousService module and implement the interface methods it requires;

require 'sadi-rb'

class MyService
  extend SADI::SynchronousService

  def self.service_name
    "my_service_name" # => service will be accessible at "/services/my_service_name"
  end

  def self.service_description
    # an RDF::Graph of your service's description
  end

  def self.service_owl
    # an RDF::Graph of your service's OWL classes
  end

  def self.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.

You also have access to the parse_string(string, format) method, inherited from SADI::Converter through SADI::SynchronousService, which can be used create a RDF::Graph from a serialized string. The format argument should be a symbol for an RDF::Format class, for example :ttl or :rdfxml.

SADI also supports asynchronous services, which can be polled repeatedly until their results are available. To make a service asynchronous, you can simply extend the SADI::AsynchronousService module, and implement your service the same way you would a synchronous service. However beware that the implementation of asynchronous services is currently not thread safe or very well tested, so it may not work well unless you're using MRI and Thin.

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
• Fork the project.
• Start a feature/bugfix branch.
• Commit and push until you are happy with your contribution.
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright (c) 2013 Will Strinz. See LICENSE.txt for further details.