{"id":16547542,"url":"https://github.com/hainesr/ruby-zip-container","last_synced_at":"2026-06-07T00:32:19.384Z","repository":{"id":8606482,"uuid":"10245463","full_name":"hainesr/ruby-zip-container","owner":"hainesr","description":"A Ruby library for working with ZIP Container documents such as EPUB (ODF, UCF).","archived":false,"fork":false,"pushed_at":"2024-02-24T15:39:04.000Z","size":1003,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-12-06T19:25:34.245Z","etag":null,"topics":["epub","odf","ruby","ucf","zip","zip-container"],"latest_commit_sha":null,"homepage":"http://hainesr.github.io/ruby-zip-container/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hainesr.png","metadata":{"files":{"readme":"ReadMe.rdoc","changelog":"Changes.rdoc","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-05-23T14:21:57.000Z","updated_at":"2023-05-01T11:07:19.000Z","dependencies_parsed_at":"2024-02-23T13:41:46.267Z","dependency_job_id":"70955161-70bc-430f-9ab7-50323eca0e47","html_url":"https://github.com/hainesr/ruby-zip-container","commit_stats":null,"previous_names":["mygrid/ruby-zip-container"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hainesr%2Fruby-zip-container","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hainesr%2Fruby-zip-container/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hainesr%2Fruby-zip-container/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hainesr%2Fruby-zip-container/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hainesr","download_url":"https://codeload.github.com/hainesr/ruby-zip-container/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241844286,"owners_count":20029611,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["epub","odf","ruby","ucf","zip","zip-container"],"created_at":"2024-10-11T19:14:39.597Z","updated_at":"2026-06-07T00:32:19.350Z","avatar_url":"https://github.com/hainesr.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"= ZIP Container Format Ruby Library\n\nAuthors::     Robert Haines\nContact::     mailto:support@mygrid.org.uk\nHomepage::    http://mygrid.github.io/ruby-zip-container\nSource code:: https://github.com/myGrid/ruby-zip-container\nLicence::     BSD (See Licence file or http://www.opensource.org/licenses/bsd-license.php)\nCopyright::   (c) 2013-2015 The University of Manchester, UK\n\n{\u003cimg src=\"https://badge.fury.io/rb/zip-container.svg\" alt=\"Gem Version\" /\u003e}[http://badge.fury.io/rb/zip-container]\n{\u003cimg src=\"https://codeclimate.com/github/myGrid/ruby-zip-container.svg\" /\u003e}[https://codeclimate.com/github/myGrid/ruby-zip-container]\n{\u003cimg src=\"https://travis-ci.org/myGrid/ruby-zip-container.svg?branch=master\" alt=\"Build Status\" /\u003e}[https://travis-ci.org/myGrid/ruby-zip-container]\n{\u003cimg src=\"https://coveralls.io/repos/myGrid/ruby-zip-container/badge.svg?branch=master\" alt=\"Coverage Status\" /\u003e}[https://coveralls.io/r/myGrid/ruby-zip-container?branch=master]\n\n== Synopsis\n\nThis is a Ruby library for working with ZIP Container files. See the\n{ODF}[http://www.idpf.org/epub/30/spec/epub30-ocf.html] and\n{UDF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]\nspecifications for more details.\n\nWe follow the principles of {Semantic Versioning}[http://semver.org/] for our\nreleases.\n\n== Backwards incompatibility warnings!\n\n=== ZipContainer\n\nThe ZipContainer::Container class is now a common superclass of\nZipContainer::Dir and ZipContainer::File. You can use ZipContainer::File as a\ndirect replacement for ZipContainer::Container as the functionality is\npreserved. The new names bring this API into closer alignment with the\nunderlying rubyzip API (Zip::File) and allows this library to work with\n\"exploded\" or unpacked containers directly.\n\nZipContainer::Container should not be used directly from version 2.0.0\nonwards.\n\n=== ContainerError\n\nThis class has been renamed in version 3.0.0. It is now simply called Error so\nthat its fully qualified name is the more sensible ZipContainer::Error.\n\n=== Rubyzip\n\nVersion 1.0.0 and up of this gem uses version 1.0.0 and up of the\n{rubyzip}[https://rubygems.org/gems/rubyzip] library. This has a backwards\nincompatible API that may clash with other gems that you are using. Please see\nthe {important note}[https://github.com/rubyzip/rubyzip/blob/master/README.md#important-note]\nin the rubyzip readme for a workaround.\n\n== Usage\n\nThis library has two entry points.\n\nThe main ZipContainer::File class largely mimics the rubyzip\n{Zip::File}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/File] and\n{Zip::FileSystem}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/FileSystem]\nAPIs so much of what you can do with them are supported for ZIP Containers.\nThere is also {API documentation}[http://mygrid.github.io/ruby-zip-container/]\nwith much more detail and any differences explained.\n\nThe ZipContainer::Dir class mimics, where possible, the core ruby\n{Dir API}[http://ruby-doc.org/core-1.9.3/Dir.html].\n\nThere are some examples of how to use the library provided in the examples\ndirectory. See the contents of the tests directory for even more.\n\n== What this library can not do yet\n\nThe basic requirements of a ZIP Container are all implemented but memory\nresident ZIP Container files are not yet supported. Presently all operations\nare performed on files that are resident on disk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhainesr%2Fruby-zip-container","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhainesr%2Fruby-zip-container","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhainesr%2Fruby-zip-container/lists"}