ZIP Container Format Ruby Library


Robert Haines



Source code


BSD (See Licence file or


© 2013, 2014 The University of Manchester, UK

Gem Version Build Status Coverage Status


This is a Ruby library for working with ZIP Container files. See the ODF and UDF specifications for more details.

Backwards incompatibility warnings!


The ZipContainer::Container class is deprecated in favour of ZipContainer::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 rubyzip API (Zip::File).

ZipContainer::Container is unavailable from version 2.0.0 onwards.


Version 1.0.0 and up of this gem uses version 1.0.0 and up of the rubyzip library. This has a backwards incompatible API that may clash with other gems that you are using. Please see the important note in the rubyzip readme for a workaround.


This library largely mimics the rubyzip Zip::File API so much of what you can do with that is supported for ZIP Containers. There is also API documentation with much more detail and any differences explained.

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.

What this library can not do yet

The basic requirements of a ZIP Container are all implemented but memory resident ZIP Container files are not yet supported. Presently all operations are performed on files that are resident on disk.