rss-opds

RSS::OPDS

OPDS parser and maker. OPDS(Open Publication Distribution System) is feed which syndicates information about ebooks.

Why "RSS" rather than "Atom"? Because class for Atom bundled with Ruby uses RSS namespace.

Installation

Add this line to your application's Gemfile:

gem 'rss-opds'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rss-opds

Usage

Parsing OPDS

require 'open-uri'
require 'rss/opds'

opds = RSS::Parser.parse open(uri)
opds.entries.each do |entry|
  price_elem = entry.links.select {|link| link.opds_price}.first
  puts price_elem
end

If you need performance, install rss-nokogiri gem and write require 'rss/nokogiri' before calling RSS::Parser.parse.

Making OPDS

You may make OPDS feeds as well as normal Atom feeds.

require 'rss/opds'

recent = RSS::Maker.make('atom') do |maker|
  maker.channel.about = 'http://example.net/'
  maker.channel.title = 'Example New Catalog'
  maker.channel.description = 'New books in this site'
  maker.channel.links.new_link do |link|
    link.href = 'http://example.net/new.opds'
    link.rel = 'self'
    link.type = RSS::OPDS::TYPES['acquisition']
  end
  maker.channel.links.new_link do |link|
    link.href = 'http://example.net/root.opds'
    link.rel = RSS::OPDS::RELATIONS['start']
    link.type = RSS::OPDS::TYPES['navigation']
  end
  maker.channel.updated = '2012-08-14T04:23:00'
  maker.channel.author = 'KITAITI Makoto'

  new_books.each do |book|
    maker.items.new_item do |entry|
      entry.title = book.title
      entry.updated = book.updated
      entry.summary = book.summary
      entry.link = book.link
    end
  end
end
puts recent # => output OPDS feed

And now, this library provides utility methods which help you make OPDS navigation feeds.

root = RSS::Maker.make('atom') {|maker|
  maker.channel.about = ...

  maker.items.add_relation recent, RSS::OPDS::RELATIONS['new']
  # or just:
  # maker.items.add_new recent
  # 
  # these are equivalent to:
  # maker.items.new_item do |item|
  #   item.id = recent.id
  #   item.title = recent.title
  #   # ...
  # end
}
puts root # => output XML including entry with 'new' sorting relation

Examples

For more examples, see files in examples directory.

Changelog

0.0.3

• Add sample script 'examples/build-catalog-from-epub.rb' which build OPDS catalog feed using specified EPUB files
• Add sample server 'examples/opds_server.ru' for Rack
• Remove Money from dependencies
• [BUG FIX]Add element component to XPath

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Added some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Merge Request

Development Plan

• Parser for OPDS catalogs[DONE]
• Validation as OPDS
• Utility methods like, for example, #buy(gets link element with rel="acquisition/buy"), #price(opds:price element) and so on
• Maker for OPDS feeds and entries[DONE]

References

• RSS library documentation
• OPDS specification
• Japanese translation for OPDS version 1.0. That helped me very well, thank you!
• OPDS validator