© 2013, 2014 The University of Manchester, UK
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.
There are some examples of how to use the library provided in the examples directory. See the contents of the tests directory for even more.
The UCF specification requires that files in the
META-INF directory are validated against a schema if they are present. If
the nokogiri gem is
available then this library will use it to validate the contents of the
manifest.xml files. This
functionality is not enforced on the user in case they are not using the
META-INF directory and so would not need the extra dependency on nokogiri.
The UCF::Container class is deprecated in favour of UCF::File. These classes are functionally identical; it is just a change of name. The new name brings this API into closer alignment with the underlying zip-container API (ZipContainer::File).
UCF::Container is not available from version 1.0.0 onwards.
The basic requirements of a UCF document are all implemented but there are a number of optional features that are not yet provided.
Validation of all file contents in the META-INF directory. The
manifest.xml files are
validated but others are not yet.
Digital signatures (this feature has been deferred until a future revision of the UCF specification. It will be supported by this gem when it is added to the specification).
Encryption (this feature has been deferred until a future revision of the UCF specification. It will be supported by this gem when it is added to the specification).