Research Object Bundle Ruby Library

Authors

Robert Haines

Contact

support@mygrid.org.uk

Homepage

mygrid.github.io/ruby-ro-bundle

Source code

github.com/myGrid/ruby-ro-bundle

Licence

BSD (See Licence file or www.opensource.org/licenses/bsd-license.php)

Copyright

© 2014 The University of Manchester, UK

Gem Version Build Status Coverage Status

Synopsis

This is a Ruby library for working with Research Object Bundle files. See the Research Object Bundle specification for more details.

This library is a work in progress! Until we release version 1.0.0 you can expect the API to change in incompatible ways, although we will try to keep this to an absolute minimum. Once version 1.0.0 is released we will be following the principles of Semantic Versioning for our version numbering scheme.

Usage

Most of this library’s API is provided by two underlying gems. Please consult their documentation in addition to this:

There are some examples of how to use the library provided in the bin directory:

See the contents of the tests directory for even more example usage.

What this library cannot do yet

The RO Bundle specification is largely implemented but there are notable gaps at present, including: