No commit activity in last 3 years
No release in over 3 years
ruby lib to access OPDS feeds
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.2.9

Runtime

 Project Readme

OPDS Parsing library

This gem provides a parsing library for OPDS Catalogs.

It also has the ability to discover catalogs in html feeds.

Installation

gem install opds

Usage

Parsing a feed is simply done.

require "opds"
OPDS.access("http://catalog.com/catalog.atom")

This method will return an instance of the Feed or Entry classes. Each Atom element is accessible directly via a dedicated method (ex: feed.title). Entry also provides a method to directly access any embeded Dublin Core metadata (dcmeta). The raw_doc attribute gives access to the Nokogiri parsed source.

API documentation can be found on rdoc.info

Complete atom entries

Complete atom entries are available if detected as another instance of the Entry class. Just call entry.complete on the partial entry to access it.

Links

Every links are automatically parsed in feeds and entries. They are made available in a collection called links. Relative links should be transformed in their absolute equivalent. On each link there is a navigate method which will proxy a call to OPDS::Feed.parse_url.