Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jkongie/mobi

A Ruby way to read MOBI format metadata
https://github.com/jkongie/mobi

Last synced: about 1 month ago
JSON representation

A Ruby way to read MOBI format metadata

Host: GitHub
URL: https://github.com/jkongie/mobi
Owner: jkongie
License: mit
Created: 2011-04-09T07:10:50.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2023-01-09T22:20:25.000Z (almost 2 years ago)
Last Synced: 2024-10-30T17:48:30.344Z (about 1 month ago)
Language: Ruby
Homepage:
Size: 204 KB
Stars: 38
Watchers: 2
Forks: 5
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-ruby - Mobi - A Ruby way to read MOBI format metadata. (Ebook)

README

# mobi

A Ruby Gem that reads MOBI metadata.

## Ruby

Compatible up to ruby 2.0.0p0.

I haven't tested beyond that version, but it should work.

## Installation

`gem install mobi`

## Usage

Creating a Mobi::Metadata object

```ruby
Mobi::Metadata.new(File.open('/path/to/file.mobi'))
```

A handy convenience method to do the exact same thing

```ruby
Mobi.metadata File.open('/path/to/file.mobi')
```

Getting metadata information is as simple as:

```ruby
metadata = Mobi.metadata File.open('/path/to/fellowship_of_the_ring.mobi')
#=> #
metadata.author
#=> "J.R.R. Tolkien"
```

Supported metadata options are:

* asin
* author
* contributor
* description
* imprint
* isbn
* publisher
* published_at
* review
* rights
* source
* subject
* subject_code
* title
* type
* version

You can also drill down and get the PalmDOC and MOBI header details:

```ruby
palm_doc_header = metadata.palm_doc_header
#=> #
palm_doc_header.raw_compression_type
#=> 2
palm_doc_header.compression_type
#=> "PalmDOC"

mobi_header = metadata.mobi_header
#=> #
mobi_header.raw_mobi_type
#=> 2
mobi_header.mobi_type
#=> "MOBIpocket Book"
```

See the source for more methods.

## Thanks

* Calibre open source project. I ripped off the idea of a Stream Slicer and got a better understanding of MOBI files from their code base. Check them out at http://calibre-ebook.com

## Contributing to mobi

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.