fernandoalmeida/epub-reader

EPUB Reader is a Ruby library which helps you to parse EPUB files conforming as much as possible the specification from IDPF.

Overview

EPUB Reader is a Ruby library which helps you to parse EPUB files conforming as much as possible the specification from IDPF.

Installation

The recommended installation method is via Rubygems.

gem install epub-reader

Usage

Begin by creating a Epub::Reader instance that points to a EPUB file. Document level information (metadata, toc, page count, etc) is available via this object.

reader = Epub::Reader.open("/path/to/ebook.epub")
puts reader.epub_version
puts reader.title
puts reader.author
puts reader.publication_date
puts reader.language
reader.pages.each do |page|
  puts page.title
  puts page.content
end

Exceptions

There are two key exceptions that you will need to watch out for when processing a EPUB file:

FileNotFoundError - The argument passed to Epub::Reader.open('/path/to/ebook.epub') is a file path. If the file does not exist the FileNotFoundError is thrown.

MalformedEpubError - The EPUB appears to be corrupt in some way. If you believe the file should be valid, or that a corrupt file didn't raise an exception, please forward a copy of the file to the maintainers using the Bitbucket issue tracker and we will attempt to improve the code.

MalformedEpubError has some subclasses if you want to detect finer grained issues. If you don't, 'rescue MalformedEpubError' will catch all the subclassed errors as well.

Any other exceptions should be considered bugs in either Epub::Reader (please report it!).

Mantainers

• Fernando Almeida [email protected]

Licensing

This is a open source library released under the MIT license.

References

What is EPUB 3?

EPUB Publications Specifications

EPUB Content Documents Specifications

EPUB Open Container Formats Specifications

Shared Workspace for Emerging Specifications and Schemas for EPUB 3

epub-reader's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.