opds 0.2.0

data/samples/entry.txt

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:dcterms="http://purl.org/dc/terms/" xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0">
+<title>War and Peace</title>
+<id>http://www.feedbooks.com/book/83</id>
+<author>
+  <name>Lev Nikolayevich Tolstoy</name>
+  <uri>http://www.feedbooks.com/author/28</uri>
+</author>
+<updated>2010-06-13T12:06:51Z</updated>
+<dcterms:language>en</dcterms:language>
+<dcterms:issued>1869</dcterms:issued>
+<category term="FBFIC000000" label="Fiction"/>
+<category term="FBFIC014000" label="Historical"/>
+<category term="FBFIC032000" label="War"/>
+<summary>War and Peace is a novel by Leo Tolstoy, first published from 1865 to 1869 in Russkii Vestnik, which tells the story of Russian society during the Napoleonic Era. It is usually described as one of Tolstoy's two major masterpieces (the other being Anna Karenina) as well as one of the world's greatest novels.
+War and Peace offered a new kind of fiction, with a great many characters caught up in a plot that covered nothing less than the grand subjects indicated by the title, combined with the equally large topics of youth, marriage, age, and death. Though it is often called a novel today, it broke so many conventions of the form that it was not considered a novel in its time. Indeed, Tolstoy himself considered Anna Karenina (1878) to be his first attempt at a novel in the European sense.</summary>
+<dcterms:extent>561,304 words</dcterms:extent>
+<dcterms:source>Wikisource</dcterms:source>
+<link type="text/html" href="http://www.feedbooks.com/book/83" rel="alternate" title="View on Feedbooks"/>
+<link type="application/epub+zip" href="http://www.feedbooks.com/book/83.epub" rel="http://opds-spec.org/acquisition"/>
+<link type="application/x-mobipocket-ebook" href="http://www.feedbooks.com/book/83.mobi" rel="http://opds-spec.org/acquisition"/>
+<link type="application/pdf" href="http://www.feedbooks.com/book/83.pdf" rel="http://opds-spec.org/acquisition"/>
+<link type="image/jpeg" href="http://covers.feedbooks.net/book/83.jpg?t=1276430811" rel="http://opds-spec.org/cover"/>
+<link type="image/jpeg" href="http://covers.feedbooks.net/book/83.jpg?size=thumbnail&amp;t=1276430811" rel="http://opds-spec.org/thumbnail"/>
+<link type="application/atom+xml" href="http://www.feedbooks.com/author/28/books/top.atom" rel="related" title="Other books from the same author"/>
+<link type="application/atom+xml" href="http://www.feedbooks.com/book/83/similar.atom" rel="related" title="People also downloaded..."/>
+<link type="application/atom+xml" href="http://www.feedbooks.com/book/83/lists.atom" rel="related" title="Reading lists for this book"/>
+<link type="application/atom+xml" href="http://www.feedbooks.com/book/83/categories.atom" rel="related" title="Categories for this book"/>
+<link type="application/atom+xml" href="http://www.feedbooks.com/book/83/comments.atom" rel="replies" title="Comments for this book (0)" thr:count="0" thr:updated="2009-08-18T01:17:01Z"/>
+<link type="text/html" href="http://www.goodreads.com/mobile/book/isbn/067003469X" rel="related" title="View on Goodreads"/>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/book/83/contents.atom" rel="contents"/>
+</entry>

data/samples/navigation.txt

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns:dcterms="http://purl.org/dc/terms/" xmlns:opds="http://opds-spec.org/2010/catalog" xml:lang="en" xmlns:thr="http://purl.org/syndication/thread/1.0" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:app="http://www.w3.org/2007/app" xmlns="http://www.w3.org/2005/Atom" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <id>http://www.feedbooks.com/catalog.atom</id>
+  <link type="text/html" href="http://www.feedbooks.com/site/catalog" rel="alternate"/>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/catalog.atom" rel="self"/>
+  <title>Feedbooks | OPDS Catalog</title>
+  <updated>2010-08-08T13:44:22Z</updated>
+  <icon>http://www.feedbooks.com/favicon.ico</icon>
+  <author>
+    <name>Feedbooks</name>
+    <uri>http://www.feedbooks.com</uri>
+    <email>support@feedbooks.com</email>
+  </author>
+  <link type="application/atom+xml" href="/catalog.atom" rel="start" title="OPDS Catalog"/>
+  <link type="application/opensearchdescription+xml" href="/opensearch.xml" rel="search" title="Search on Feedbooks"/>
+  <link type="application/atom+xml" href="https://www.feedbooks.com/user/bookshelf.atom" rel="http://opds-spec.org/shelf" title="Bookshelf"/>
+  <link type="application/atom+xml" href="https://www.feedbooks.com/user/subscriptions.atom" rel="http://opds-spec.org/subscriptions" title="Subscriptions"/>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/books/recent.atom" rel="http://opds-spec.org/sort/new" title="New Public Domain Books"/>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/books/top.atom?range=month" rel="http://opds-spec.org/sort/popular" title="Top Public Domain Books"/>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/userbooks/recent.atom" rel="http://opds-spec.org/sort/new" title="New Original Books"/>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/userbooks/top.atom?range=month" rel="http://opds-spec.org/sort/popular" title="Top Original Books"/>
+<entry>
+  <title>Public Domain Books</title>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/publicdomain/catalog.atom"/>
+  <updated>2010-08-08T13:44:22Z</updated>
+  <id>http://www.feedbooks.com/publicdomain/catalog.atom</id>
+  <link type="image/png" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIASURBVDjLpVPPaxNREJ6Vt01caH4oWk1T0ZKlGIo9RG+BUsEK4kEP/Q8qPXnpqRdPBf8A8Wahhx7FQ0GF9FJ6UksqwfTSBDGyB5HkkphC9tfb7jfbtyQQTx142byZ75v5ZnZWC4KALmICPy+2DkvKIX2f/POz83LxCL7nrz+WPNcll49DrhM9v7xdO9JW330DuXrrqkFSgig5iR2Cfv3t3gNxOnv5BwU+eZ5HuON5/PMPJZKJ+yKQfpW0S7TxdC6WJaWkyvff1LDaFRAeLZj05MHsiPTS6hua0PUqtwC5sHq9zv9RYWl+nu5cETcnJ1M0M5WlWq3GsX6/T+VymRzHDluZiGYAAsw0TQahV8uyyGq1qFgskm0bHIO/1+sx1rFtchJhArwEyIQ1Gg2WD2A6nWawHQJVDIWgIJfLhQowTIeE9D0mKAU8qPC0220afsWFQoH93W6X7yCDJ+DEBeBmsxnPIJVKxWQVUwry+XyUwBlKMKwA8jqdDhOVCqVAzQDVvXAXhOdGBFgymYwrGoZBmUyGjxCCdF0fSahaFdgoTHRxfTveMCXvWfkuE3Y+f40qhgT/nMitupzApdvT18bu+YeDQwY9Xl4aG9/d/URiMBhQq/dvZMeVghtT17lSZW9/rAKsvPa/r9Fc2dw+Pe0/xI6kM9mT5vtXy+Nw2kU/5zOGRpvuMIu0YAAAAABJRU5ErkJggg==" rel="http://opds-spec.org/thumbnail"/>
+  <content type="text">Free classics and CC-licensed books</content>
+</entry>
+<entry>
+  <title>Original Books</title>
+  <link type="application/atom+xml" href="http://www.feedbooks.com/original/catalog.atom"/>
+  <updated>2010-08-08T13:44:22Z</updated>
+  <id>http://www.feedbooks.com/original/catalog.atom</id>
+  <link type="image/png" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAIASURBVDjLpVPPaxNREJ6Vt01caH4oWk1T0ZKlGIo9RG+BUsEK4kEP/Q8qPXnpqRdPBf8A8Wahhx7FQ0GF9FJ6UksqwfTSBDGyB5HkkphC9tfb7jfbtyQQTx142byZ75v5ZnZWC4KALmICPy+2DkvKIX2f/POz83LxCL7nrz+WPNcll49DrhM9v7xdO9JW330DuXrrqkFSgig5iR2Cfv3t3gNxOnv5BwU+eZ5HuON5/PMPJZKJ+yKQfpW0S7TxdC6WJaWkyvff1LDaFRAeLZj05MHsiPTS6hua0PUqtwC5sHq9zv9RYWl+nu5cETcnJ1M0M5WlWq3GsX6/T+VymRzHDluZiGYAAsw0TQahV8uyyGq1qFgskm0bHIO/1+sx1rFtchJhArwEyIQ1Gg2WD2A6nWawHQJVDIWgIJfLhQowTIeE9D0mKAU8qPC0220afsWFQoH93W6X7yCDJ+DEBeBmsxnPIJVKxWQVUwry+XyUwBlKMKwA8jqdDhOVCqVAzQDVvXAXhOdGBFgymYwrGoZBmUyGjxCCdF0fSahaFdgoTHRxfTveMCXvWfkuE3Y+f40qhgT/nMitupzApdvT18bu+YeDQwY9Xl4aG9/d/URiMBhQq/dvZMeVghtT17lSZW9/rAKsvPa/r9Fc2dw+Pe0/xI6kM9mT5vtXy+Nw2kU/5zOGRpvuMIu0YAAAAABJRU5ErkJggg==" rel="http://opds-spec.org/thumbnail"/>
+  <content type="text">Self-Published on Feedbooks</content>
+</entry>
+<entry>
+  <title>Profile</title>
+  <link type="application/atom+xml" href="https://www.feedbooks.com/user/profile.atom"/>
+  <updated>2010-08-08T13:44:22Z</updated>
+  <id>https://www.feedbooks.com/user/profile.atom</id>
+  <link type="image/png" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAJ3SURBVDjLpZNtSNNRFIcNKunF1rZWBMJqKaSiX9RP1dClsjldA42slW0q5oxZiuHrlqllLayoaJa2jbm1Lc3QUZpKFmmaTMsaRp+kMgjBheSmTL2//kqMBJlFHx44XM7vOfdyuH4A/P6HFQ9zo7cpa/mM6RvCrVDzaVDy6C5JJKv6rwSnIhlFd0R0Up/GwF2KWyl01CTSkM/dQoQRzAurCjRCGnRUUE2FaoSL0HExiYVzsQwcj6RNrSqo4W5Gh6Yc4+1qDDTkIy+GhYK4nTgdz0H2PrrHUJzs71NQn86enPn+CVN9GnzruoYR63mMPbkC59gQzDl7pt7rc9f7FNyUhPY6Bx9gwt4E9zszhWWpdg6ZcS8j3O7zCTuEpnXB+3MNZkUUZu0NmHE8XsL91oSWwiiEc3MeseLrN6woYCWa/Zl8ozyQ3w3Hl2lYy0SwlCUvsVi/Gv2JwITnYPDun2Hy6jYuEzAF1jUBCVYpO6kXo+NuGMeBAgcgfwNkvgBOPgUqXgKvP7rBFvRhE1crp8Vq1noFYSlacVyqGk0D86gbART9BDk9BFnPCNJbCY5aCFL1Cyhtp0RWAp74MsKSrkq9guHyvfMTtmLc1togpZoyqYmyNoITzVTYRJCiXYBIQ3CwFqi83o3JDhX6C0M8XsGIMoQ4OyuRlq1DdZcLkmbgGDX1iIEKNxAcbgTEOqC4ZRaJ6Ub86K7CYFEo8Qo+GBQlQyXBczLZpbloaQ9k1NUz/kD2myBBKxRZpa5hVcQslalatoUxizxAVVrN3CW21bFj9F858Q9dnIRmDyeuybM71uxmH9BNBB1q6zybV7H9s1Ue4PM3/gu/AEbfqfWy2twsAAAAAElFTkSuQmCC" rel="http://opds-spec.org/thumbnail"/>
+  <content type="text">Your personal content</content>
+</entry>
+</feed>

data/spec/browser_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe OPDS::Support::Browser do
+  it "should be able to access google.com" do
+  lambda {  subject.go_to("http://www.google.com") }.should_not raise_error
+  subject.should be_ok
+
+  end
+
+  it "should not find an empty body on google.com" do 
+	   subject.go_to("http://www.google.com")
+	   subject.body.should_not ==""
+  end
+
+
+  it "should not be able to access http://foo.bar" do 
+  lambda {  subject.go_to("http://foo.bar") }.should raise_error
+  subject.should_not be_ok
+  end
+
+end

data/spec/entry_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+def sample(type)
+	File.open( File.expand_path(File.dirname(__FILE__) + "/../samples/#{type}.txt"))
+end
+
+describe OPDS::Entry do
+
+
+	subject do 
+		 OPDS::Entry.from_nokogiri(Nokogiri::XML(sample(:entry)))
+	end
+
+	it "should have a title "do
+			subject.title.size.should_not be(0)
+	end
+
+	it "should have an id"do
+			subject.id.size.should_not be(0)
+	end
+	
+	it "should have a summary "do
+			subject.summary.size.should_not be(0)
+	end
+	
+	it "should have a update date "do
+			subject.updated.day.should be(13)
+	end
+	
+	it "should have an author "do
+			subject.author.size.should_not be(0)
+	end
+	
+	it "should have  links "do
+			subject.links.size.should_not be(0)
+	end
+
+	it "should have dc:meta" do
+
+			subject.dcmetas.size.should_not be(0)
+	end
+	
+	it "should have categories" do
+
+			subject.categories.size.should_not be(0)
+	end
+	
+	it "should not be partial" do
+			subject.should_not be_partial()
+	end
+end

data/spec/linkset_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe OPDS::Support::LinkSet do 
+	before(:each) do 
+		subject.push('root','http://feedbooks.com','Racine','application/atom+xml')
+		subject.push('subsection','http://feedbooks.com/publicdomain','Domaine pub','application/atom+xml')
+		subject.push('subsection','http://feedbooks.com/original','Original','application/atom+xml')
+		subject.push('subsection','http://feedbooks.com/feed','feeds')
+		subject.push('http://opds-spec.org/shelf','http://feedbooks.com/shelf','shelf')
+		subject.push('related','http://feedbooks.com/shelf',nil)
+	end
+
+	it do
+		subject.size.should be(6)
+	end
+	
+	it do
+		subject.map(&:first).size.should be(6)
+	end
+
+	it "should find 3 subsection" do
+		subject['subsection'].size.should be(3)
+		subject.by(:rel)['subsection'].size.should be(3)
+	end
+
+	it "should give root url" do
+		subject.link_url(:rel => 'root').should == ('http://feedbooks.com')
+		subject.by(:rel)['root'].first[1].should == ('http://feedbooks.com')
+	end
+
+	it "get all text values" do
+		subject.texts.size.should be(6)
+	end
+end

data/spec/opdsparser_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+def sample(type)
+	File.open( File.expand_path(File.dirname(__FILE__) + "/../samples/#{type}.txt"))
+end
+
+describe OPDS::OPDSParser do
+
+	[:entry, :acquisition, :navigation].each do |feed_type|
+		it "should parse entry without error" do
+			lambda { subject.parse(sample(feed_type)) }.should_not raise_error
+		end
+
+		it "should sniff entry" do
+			subject.parse(sample(feed_type))
+			subject.sniffed_type.should be(feed_type)
+		end
+		
+		it "should return an instance of the correct class " do
+			subject.parse(sample(feed_type)).class.should be({:entry => OPDS::Entry, :navigation => OPDS::NavigationFeed,:acquisition => OPDS::AcquisitionFeed}[feed_type])
+		end
+	end
+	
+	[ :acquisition, :navigation].each do |feed_type|
+		it "should have a feed title" do 
+			subject.parse(sample(feed_type)).title.size.should_not be(0)
+		end
+
+		it "should have a feed icon" do 
+			subject.parse(sample(feed_type)).icon.size.should_not be(0)
+		end
+		
+		it "should have feed links" do 
+			subject.parse(sample(feed_type)).links.size.should_not be(0)
+		end
+		
+		it "should have feed id" do 
+			subject.parse(sample(feed_type)).id.size.should_not be(0)
+		end
+		it "should have a feed author" do 
+			auth=subject.parse(sample(feed_type)).author
+			auth[:name].should == ('Feedbooks')
+			auth[:uri].should == ('http://www.feedbooks.com')
+			auth[:email].should == ('support@feedbooks.com')
+		end
+		
+		it "should have entries" do 
+			subject.parse(sample(feed_type)).entries.size.should_not be(0)
+		end
+		
+
+		
+	end
+		
+		it do
+			subject.parse(sample(:acquisition)).should be_paginated()
+		end
+		
+		it do
+			subject.parse(sample(:acquisition)).should be_first_page()
+		end
+		
+		it "should have partial entries" do 
+			subject.parse(sample(:acquisition)).entries.any?(&:partial?).should be()
+		end
+		
+		it do
+			feed=nil
+			lambda { feed=subject.parse(sample(:acquisition)).next_page  }.should_not raise_error
+
+			feed.class.should be(OPDS::AcquisitionFeed)
+		end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'opds'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: opds
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Benoit Larroque
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-31 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: ruby lib to access OPDS feeds
+email: benoit dot larroque at feedbooks dot com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/opds.rb
+- lib/opds/acquisition_feed.rb
+- lib/opds/entry.rb
+- lib/opds/feed.rb
+- lib/opds/navigation_feed.rb
+- lib/opds/opds.rb
+- lib/opds/parser.rb
+- lib/opds/support/browser.rb
+- lib/opds/support/linkset.rb
+- lib/opds/support/logging.rb
+- opds.gemspec
+- samples/acquisition.txt
+- samples/entry.txt
+- samples/navigation.txt
+- spec/browser_spec.rb
+- spec/entry_spec.rb
+- spec/linkset_spec.rb
+- spec/opdsparser_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/zetaben/opds
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ruby lib to read OPDS feeds
+test_files: 
+- spec/spec_helper.rb
+- spec/entry_spec.rb
+- spec/browser_spec.rb
+- spec/linkset_spec.rb
+- spec/opdsparser_spec.rb