0.0
No commit activity in last 3 years
No release in over 3 years
epub_reader is a gem to parse epub file, including it's htmls and images
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.3
>= 0
>= 0

Runtime

 Project Readme

EpubReader

EpubReader is a gem to parse epub file, including it's htmls and images

Installation

Add this line to your application's Gemfile:

gem 'epub_reader'

And then execute:

$ bundle

Or install it yourself as:

$ gem install epub_reader

Usage

epub = EpubReader::Epub.new('/the/epub/path.epub')
epub.entries.each do |entry|
  entry.html_text #=> html text
  entry.title #=> entry title
  entry.images.each do |image|
    image.path #=> image file path
  end
end

API Documentation:

EpubReader::Epub

  • ::new(epub_file_path): returns an epub instance
  • #entries: returns an array of EpubReader::Entry

EpubReader::Entry

  • #title: returns entry title
  • #html_text: returns html text of the entry
  • #imags: returns array of EpubReader::Image

EpubReader::Image

  • #path: returns the file path of the image

Tests:

    $ rake test

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request