RubyGems - readernaut - Versions diffs - 0.1.2 → 0.2.0 - Mend

readernaut 0.1.2 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/README.markdown +44 -0
data/VERSION +1 -1
data/changelog.markdown +9 -0
data/lib/readernaut.rb +34 -1
data/readernaut.gemspec +6 -4
data/test/fixtures/books_currently_reading.json +262 -0
data/test/test_readernaut.rb +9 -0
metadata +6 -4
data/README.rdoc +0 -18

data/README.markdown ADDED

@@ -0,0 +1,44 @@
+# Readernaut
+Wrapper for [Readernaut](http://readernaut.com) API, the social book site.
+## Installation
+  sudo gem install gemcutter
+  gem tumble
+  sudo gem install readernaut
+## Usage
+  # get a list of books for a user
+  books = Readernaut.books('pengwynn')
+  books.reader_books.first.book_edition.title
+  => 'Crush it!'
+  # get a list of notes for a user
+  notes = Readernaut.notes('pengwynn')
+  # get a list of contacts for a user
+  contacts = Readernaut.contacts('pengwynn').contacts
+  contacts.last.user.username
+  => "blankenship"
+  # paginate, ordering
+  books = Readernaut.books('pengwynn', :page => 3, :order_by => "modified")
+  # descending
+  books = Readernaut.books('pengwynn', :page => 3, :order_by => "-modified")
+## Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+## Copyright
+Copyright (c) 2009 [Wynn Netherland](http://wynnnetherland.com). See LICENSE for details.

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.1.2
1	+ 0.2.0

data/changelog.markdown ADDED

@@ -0,0 +1,9 @@
+# Changelog
+## 0.2.0 - November 17, 2009
+  * Support for finished, reading, plan-to-read and other lists, thanks [rizwanreza](http://github.com/rizwanreza)
+## 0.1.0 - November 15, 2009
+  * Initial version

data/lib/readernaut.rb CHANGED

@@ -12,9 +12,42 @@ class Readernaut
   format :json
   def self.books(username, options={})
-    Mash.new self.get("/#{username}/books/", :query => options)
+    path = "/#{username}/books/"
+    list = options.delete(:list)
+    path += "#{list}/" unless list.blank?
+    Mash.new self.get(path, :query => options)
+  end
+  def self.books_finished(username, options={})
+    opts = options.merge({:list => 'finished'})
+    self.books(username, opts)
+  end
+  def self.books_reading(username, options={})
+    opts = options.merge({:list => 'reading'})
+    self.books(username, opts)
+  end
+  def self.books_plan_to_read(username, options={})
+    opts = options.merge({:list => 'plan-to-read'})
+    self.books(username, opts)
   end
+  def self.books_reference(username, options={})
+    opts = options.merge({:list => 'reference'})
+    self.books(username, opts)
+  end
+  def self.books_wishlist(username, options={})
+    opts = options.merge({:list => 'wishlist'})
+    self.books(username, opts)
+  end
+  def self.books_abandoned(username, options={})
+    opts = options.merge({:list => 'abandoned'})
+    self.books(username, opts)
+  end
   def self.notes(username, options={})
     Mash.new self.get("/#{username}/notes/", :query => options)
   end

data/readernaut.gemspec CHANGED

@@ -5,27 +5,29 @@
 Gem::Specification.new do |s|
   s.name = %q{readernaut}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wynn Netherland"]
-  s.date = %q{2009-11-14}
+  s.date = %q{2009-11-17}
   s.description = %q{Wrapper for Readernaut, the best book social network around}
   s.email = %q{wynn.netherland@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
+     "changelog.markdown",
      "lib/readernaut.rb",
      "readernaut.gemspec",
      "test/fixtures/books.json",
+     "test/fixtures/books_currently_reading.json",
      "test/fixtures/contacts.json",
      "test/fixtures/notes.json",
      "test/helper.rb",

data/test/fixtures/books_currently_reading.json ADDED

@@ -0,0 +1,262 @@
+{
+    "version": "1.0",
+    "page": 1,
+  "total_pages": 2,
+    "reader_books": [
+      {
+        "reader_book_id": 176505,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "Towards a New Architecture",
+          "subtitle": "",
+          "authors": {
+            "author": "Le Corbusier"
+          },
+          "isbn": "0486250237",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0486250237_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0486250237_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0486250237_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0486250237/towards-a-new-architecture/"
+        },
+        "created": "2009-09-23 1:35 CDT",
+        "modified": "2009-10-28 0:34 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0486250237/towards-a-new-architecture/"
+      },
+      {
+        "reader_book_id": 171886,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "From Cliche to Archetype",
+          "subtitle": "",
+          "authors": {
+            "author": "Marshall McLuhan",
+            "author": "Wilfred Watson"
+          },
+          "isbn": "B0028GH156",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/B0028GH156__t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/B0028GH156__t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/B0028GH156__t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/B0028GH156/from-cliche-to-archetype/"
+        },
+        "created": "2009-09-13 12:25 CDT",
+        "modified": "2009-11-14 11:22 CST",
+        "permalink": "http://readernaut.com/nathan/books/B0028GH156/from-cliche-to-archetype/"
+      },
+      {
+        "reader_book_id": 169152,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "Frank Lloyd Wright",
+          "subtitle": "Essential Texts",
+          "authors": {
+          },
+          "isbn": "0393732614",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0393732614_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0393732614_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0393732614_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0393732614/frank-lloyd-wright/"
+        },
+        "created": "2009-09-06 20:35 CDT",
+        "modified": "2009-09-06 20:38 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0393732614/frank-lloyd-wright/"
+      },
+      {
+        "reader_book_id": 156197,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "Utopia",
+          "subtitle": "Thomas More",
+          "authors": {
+            "author": "Sir",
+            "author": "Thomas",
+            "author": "Saint More"
+          },
+          "isbn": "0300084293",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0300084293_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0300084293_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0300084293_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0300084293/utopia/"
+        },
+        "created": "2009-08-06 0:18 CDT",
+        "modified": "2009-08-15 10:12 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0300084293/utopia/"
+      },
+      {
+        "reader_book_id": 138377,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "The Pleasures and Sorrows of Work",
+          "subtitle": "",
+          "authors": {
+            "author": "Alain De Botton"
+          },
+          "isbn": "037542444X",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/037542444X_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/037542444X_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/037542444X_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/037542444X/the-pleasures-and-sorrows-of-work/"
+        },
+        "created": "2009-06-17 22:31 CDT",
+        "modified": "2009-08-24 1:34 CDT",
+        "permalink": "http://readernaut.com/nathan/books/037542444X/the-pleasures-and-sorrows-of-work/"
+      },
+      {
+        "reader_book_id": 39162,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "1776",
+          "subtitle": "",
+          "authors": {
+            "author": "David McCullough"
+          },
+          "isbn": "0743226720",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0743226720_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0743226720_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0743226720_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0743226720/1776/"
+        },
+        "created": "2008-12-03 21:11 CST",
+        "modified": "2009-08-31 1:08 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0743226720/1776/"
+      },
+      {
+        "reader_book_id": 27953,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "The Adams\x2DJefferson Letters",
+          "subtitle": "The Complete Correspondence Between Thomas Jefferson and Abigail and John Adams",
+          "authors": {
+            "author": "John Adams",
+            "author": "Lester J. Cappon"
+          },
+          "isbn": "0807842303",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0807842303_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0807842303_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0807842303_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0807842303/the-adams-jefferson-letters/"
+        },
+        "created": "2008-10-05 1:34 CDT",
+        "modified": "2009-05-08 10:57 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0807842303/the-adams-jefferson-letters/"
+      },
+      {
+        "reader_book_id": 4640,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "Programming Collective Intelligence",
+          "subtitle": "Building Smart Web 2.0 Applications",
+          "authors": {
+            "author": "Toby Segaran"
+          },
+          "isbn": "0596529325",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0596529325_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0596529325_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0596529325_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0596529325/programming-collective-intelligence/"
+        },
+        "created": "2008-08-16 1:19 CDT",
+        "modified": "2009-05-08 10:56 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0596529325/programming-collective-intelligence/"
+      },
+      {
+        "reader_book_id": 1976,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "Infinite Jest",
+          "subtitle": "",
+          "authors": {
+            "author": "David Foster Wallace"
+          },
+          "isbn": "0316066524",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0316066524_t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0316066524_t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0316066524_t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0316066524/infinite-jest/"
+        },
+        "created": "2008-08-11 1:53 CDT",
+        "modified": "2009-07-26 8:48 CDT",
+        "permalink": "http://readernaut.com/nathan/books/0316066524/infinite-jest/"
+      },
+      {
+        "reader_book_id": 1975,
+        "user": {
+          "user_id": 1,
+          "username": "nathan"
+        },
+        "book_edition": {
+          "title": "Sketching User Experiences",
+          "subtitle": "Getting the Design Right and the Right Design",
+          "authors": {
+            "author": "Bill Buxton"
+          },
+          "isbn": "0123740371",
+          "covers": {
+            "cover_small": "http://media.readernaut.com/book_covers/0123740371__t50.jpg",
+            "cover_medium": "http://media.readernaut.com/book_covers/0123740371__t100.jpg",
+            "cover_large": "http://media.readernaut.com/book_covers/0123740371__t150.jpg"
+          },
+          "permalink": "http://readernaut.com/nathan/books/0123740371/sketching-user-experiences/"
+        },
+        "created": "2008-08-11 1:53 CDT",
+        "modified": "2009-11-05 0:32 CST",
+        "permalink": "http://readernaut.com/nathan/books/0123740371/sketching-user-experiences/"
+      }
+    ]
+}

data/test/test_readernaut.rb CHANGED

@@ -26,6 +26,15 @@ class TestReadernaut < Test::Unit::TestCase
       results.page.should == 2
       results.contacts.first.user.username.should == 'spacecowboyian'
     end
+    should "retrieve a list of books being read for a user" do
+      stub_get "http://readernaut.com/api/v1/json/nathan/books/reading/", "books_currently_reading.json"
+      results = Readernaut.books_reading('nathan')
+      edition = results.reader_books.first.book_edition
+      edition.title.should == "Towards a New Architecture"
+      edition.isbn.should == '0486250237'
+      edition.covers.cover_large.should == 'http://media.readernaut.com/book_covers/0486250237_t150.jpg'
+    end
   end
 end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: readernaut
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-14 00:00:00 -06:00
+date: 2009-11-17 00:00:00 -06:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -80,17 +80,19 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.markdown
 files:
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
+- changelog.markdown
 - lib/readernaut.rb
 - readernaut.gemspec
 - test/fixtures/books.json
+- test/fixtures/books_currently_reading.json
 - test/fixtures/contacts.json
 - test/fixtures/notes.json
 - test/helper.rb

data/README.rdoc DELETED

@@ -1,18 +0,0 @@
-= readernaut
-Description goes here.
-== Note on Patches/Pull Requests
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-== Copyright
-Copyright (c) 2009 Wynn Netherland. See LICENSE for details.