restbooks 0.1.4

data/README

@@ -0,0 +1,39 @@
+WARNING !
+I will not guaranty API consistency until 0.5 release!
+
+Main Features :
+- API mapping for "books", "authors", "lists" and "categories" using atom format
+- ETag support (the same instance fetch only ones)
+
+Roadmap :
+- Atom pub
+- User Books API
+
+INSTALL :
+
+gem install tchak-restbooks
+
+DOC :
+http://restbooks.tchak.net
+
+HOWTO :
+
+require 'rubygems'
+require 'restbooks'
+
+client = RestBooks::Client.new( :log => 'stdout' )
+
+m_books = client.books.all
+m_authors = client.authors.all( { :letter => 'A' } )
+m_authors = client.authors.all( { :page => 2 } )
+
+m_author = client.authors.top.first
+m_book = client.authors.books( m_author ).first
+p m_book.title
+p m_book.description
+
+m_comments = client.books.comments( m_book )
+m_comments.each do |comment|
+  p comment.title
+  p comment.body
+end

data/lib/restbooks.rb

@@ -0,0 +1,104 @@
+# 
+#  restbooks.rb
+#  restbooks
+#  
+#  Created by Paul Chavard on 2009-09-12.
+#  Copyright 2009
+#
+#  This file is part of RestBooks.
+#
+#  RestBooks is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  RestBooks is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with RestBooks.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+# Gems
+require 'rubygems'
+require 'rest_client'
+#require 'json'
+
+# StdLib
+require 'rexml/document'
+require 'cgi'
+require 'digest/md5'
+require 'date'
+
+# Lib
+require 'uri/uri'
+require 'restbooks/mixins/api'
+require 'restbooks/mixins/model'
+require 'restbooks/models/author'
+require 'restbooks/models/book'
+require 'restbooks/models/comment'
+require 'restbooks/models/list'
+require 'restbooks/models/category'
+require 'restbooks/authors'
+require 'restbooks/books'
+require 'restbooks/lists'
+require 'restbooks/categories'
+
+module RestBooks
+  class Client
+    attr_reader :uri, :user_agent
+
+    def initialize( options={} )
+      # Set host
+      host = options.has_key?( :host ) ? options.delete(:host) : 'http://feedbooks.com'
+      
+      # Set user-agent
+      @user_agent = options.has_key?( :user_agent ) ? options.delete( :user_agent ) : "RestBooks 0.1"
+
+      # Set service URI
+      @uri = URI.parse( host )
+
+      # Set authentification
+      if options.has_key?( :user ) && options.has_key?( :password )
+        @uri.user = options.delete( :user )
+        @uri.password = Digest::MD5.hexdigest( options.delete( :password ) )
+      end
+
+      # Set logger output
+      RestClient.log = options.delete( :log ) if options.has_key?( :log )
+
+      # Init services
+      @books = false
+      @authors = false
+      @lists = false
+      @categories = false
+    end
+    
+    # Use this object to acess books resource
+    def books
+      @books = Books.new( self ) if !@books
+      return @books
+    end
+    
+    # Use this object to acess authors resource
+    def authors
+      @authors = Authors.new( self ) if !@authors
+      return @authors
+    end
+    
+    # Use this object to acess lists resource
+    def lists
+      @lists = Lists.new( self ) if !@lists
+      return @lists
+    end
+    
+    # Use this object to acess categories resource
+    def categories
+      @categories = Categories.new( self ) if !@categories
+      return @categories
+    end
+
+  end
+end

data/lib/restbooks/authors.rb

@@ -0,0 +1,100 @@
+# 
+#  authors.rb
+#  restbooks
+#  
+#  Created by Paul Chavard on 2009-09-12.
+#  Copyright 2009
+#
+#  This file is part of RestBooks.
+#
+#  RestBooks is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  RestBooks is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with RestBooks.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestBooks
+  class Authors
+    include RestBooks::Api
+
+    # Endpoint: /authors
+    #  Formats: Atom
+    #  Description: List all authors (20 items)
+    #  Parameters:
+    #     * letter: display the authors with ... as the first letter of their name
+    #     * born: authors born in ...
+    #     * death: author who dies in ...
+    #     * lang: language of the author
+    #     * order: normally from A to Z, use desc to reverse order
+    def all( options={} )
+      create_url( "/authors", options, ORDERED_AUTHOR_PARAMETERS )
+      return do_request( :author )
+    end
+
+    # Endpoint: /authors/top
+    #  Formats: Atom
+    #  Description: List top authors (20 items)
+    #  Parameters:
+    #     * letter: display the authors with ... as the first letter of their name
+    #     * born: authors born in ...
+    #     * death: author who dies in ...
+    #     * lang: language of the author
+    #     * range: normally overall, week will display the most popular for the previous week and month for the last 4 weeks
+    def top( options={} )
+      create_url( "/authors/top", options, RANGED_AUTHOR_PARAMETERS )
+      return do_request( :author )
+    end
+
+    # Endpoint: /authors/recent
+    #  Formats: Atom
+    #  Description: List recent authors (20 items)
+    #  Parameters:
+    #     * letter: display the authors with ... as the first letter of their name
+    #     * born: authors born in ...
+    #     * death: author who dies in ...
+    #     * lang: language of the author
+    def recent( options={} )
+      create_url( "/authors/recent", options, AUTHOR_PARAMETERS )
+      return do_request( :author )
+    end
+
+    # Endpoint: /author/:id/books
+    #  Formats: Atom
+    #  Description: List all books for an author (id)
+    #  Parameters: Same as /books
+    def books( author_id, options={} )
+      author_id = author_id.id if author_id.kind_of? RestBooks::Models::Author
+      create_url( "/author/#{author_id}/books", options, ORDERED_BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+    # Endpoint: /author/:id/books/top
+    #  Formats: Atom
+    #  Description: List top books for an author (id)
+    #  Parameters: Same as /books/top
+    def top_books( author_id, options={} )
+      author_id = author_id.id if author_id.kind_of? RestBooks::Models::Author
+      create_url( "/author/#{author_id}/books/top", options, RANGED_BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+    # Endpoint: /author/:id/books/recent
+    #  Formats: Atom, RSS
+    #  Description: List recent books for an author (id)
+    #  Parameters: Same as /books/recent
+    def recent_books( author_id, options={} )
+      author_id = author_id.id if author_id.kind_of? RestBooks::Models::Author
+      create_url( "/author/#{author_id}/books/recent", options, BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+  end
+end

data/lib/restbooks/books.rb

@@ -0,0 +1,124 @@
+# 
+#  books.rb
+#  restbooks
+#  
+#  Created by Paul Chavard on 2009-09-12.
+#  Copyright 2009
+#
+#  This file is part of RestBooks.
+#
+#  RestBooks is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  RestBooks is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with RestBooks.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestBooks
+  class Books
+    include RestBooks::Api
+    
+    # Endpoint: /books
+    #  Formats: Atom
+    #  Description: List all books (20 items)
+    #  Parameters:
+    #     * letter: display the books with ... as the first letter of their name
+    #     * year: book released in ...
+    #     * lang: language of the book
+    #     * order: normally from A to Z, use desc to reverse order or year to sort them by release date
+    def all( options={} )
+      create_url( "/books", options, ORDERED_BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+    # Endpoint: /books/top
+    #  Formats: Atom
+    #  Description: List top books (20 items)
+    #  Parameters:
+    #     * letter: display the books with ... as the first letter of their name
+    #     * year: book released in ...
+    #     * lang: language of the book
+    #     * range: normally overall, week will display the most popular for the previous week and month for the last 4 weeks
+    def top( options={} )
+      create_url( "/books/top", options, RANGED_BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+    # Endpoint: /books/recent
+    #  Formats: Atom, RSS
+    #  Description: List recent books (20 items)
+    #  Parameters:
+    #     * letter: display the books with ... as the first letter of their name
+    #     * year: book released in ...
+    #     * lang: language of the book
+    def recent( options={} )
+      create_url( "/books/recent", options, BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+    # Endpoint: /books/search
+    #  Formats: Atom
+    #  Description: Search for a book
+    #  Parameters:
+    #     * query: you can use advanced queries too (for example "type:Horror AND Lovecraft")
+    def search( query, options={} )
+      options[:query] = query
+      create_url( "/books/search", options, [:query] )
+      return do_request( :book )
+    end
+
+    # Endpoint: /book/:id/similar
+    #  Formats: Atom
+    #  Description: List similar books for a given book
+    #  Parameters: none
+    def similar( book_id, options={} )
+      book_id = book_id.id if book_id.kind_of? RestBooks::Models::Book
+      create_url( "/book/#{book_id}/similar", options, [:page] )
+      return do_request( :book )
+    end
+
+    # Endpoint: /book/:id/lists
+    #  Formats: Atom
+    #  Description: View in which list a book is included
+    #  Parameters:
+    #     * order: normally the order is based on the number of favorites, use asc or desc to switch this to alphabetical order
+    def lists
+      book_id = book_id.id if book_id.kind_of? RestBooks::Models::Book
+      create_url( "/book/#{book_id}/lists", options, LIST_PARAMETERS )
+      return do_request( :list )
+    end
+    
+    # Endpoint: /book/:id/comments
+    #  Formats: Atom
+    def comments( book_id, options={} )
+      book_id = book_id.id if book_id.kind_of? RestBooks::Models::Book
+      create_url( "/book/#{book_id}/comments", options, [:page] )
+      return do_request( :comment )
+    end
+
+    # Endpoint: /book/:id/comments
+    #  Formats: Atom, EPub, Mobipocket, PDF, png
+    #  Description: Get the book, information or cover
+    #  Parameters:
+    #     * size: for png cover you can use smaller
+    def get( book_id, options={} )
+      book_id = book_id.id if book_id.kind_of? RestBooks::Models::Book
+      options.delete(:size) if options[:format] != :png
+      create_url( "/book/#{book_id}", options, [:size] )
+      if @uri.format.to_sym == :atom
+        return do_request( :book )
+      elsif [ :epub, :mobi, :pdf, :atom, :png ].include?( @uri.format.to_sym )
+        responce = RestClient::Request.execute(:method => :get, :url => @uri.to_s, :headers => {}, :raw_response => true)
+        return { :content_type => responce.headers[:content_type], :path => responce.file.path }
+      end
+    end
+
+  end
+end

data/lib/restbooks/categories.rb

@@ -0,0 +1,68 @@
+# 
+#  categories.rb
+#  restbooks
+#  
+#  Created by Paul Chavard on 2009-09-12.
+#  Copyright 2009
+#
+#  This file is part of RestBooks.
+#
+#  RestBooks is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  RestBooks is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with RestBooks.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestBooks
+  class Categories
+    include RestBooks::Api
+    
+    # Endpoint: /types
+    #  Formats: Atom
+    #  Description: View the categories, use pagination
+    #  Parameters:
+    #    * order: normally based on the number of favorites, use comments to order them by most discussed lists
+    def all( options={} )
+      create_url( "/types", options, LIST_PARAMETERS )
+      return do_request( :category )
+    end
+    
+    # Endpoint: /type/:id/books
+    #  Formats: Atom
+    #  Description: List all books from given category, use pagination
+    def books( category_id, options={} )
+      category_id = category_id.id if category_id.kind_of? RestBooks::Models::Category
+      create_url( "/type/#{category_id}/books", options, ORDERED_BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+    
+    # Endpoint: /type/:id/books/top
+    #  Formats: Atom
+    #  Description: List top books for a category (id)
+    #  Parameters: Same as /books/top
+    def top_books( category_id, options={} )
+      category_id = category_id.id if category_id.kind_of? RestBooks::Models::Category
+      create_url( "/type/#{category_id}/books/top", options, RANGED_BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+    # Endpoint: /type/:id/books/recent
+    #  Formats: Atom, RSS
+    #  Description: List recent books for a category (id)
+    #  Parameters: Same as /books/recent
+    def recent_books( category_id, options={} )
+      category_id = category_id.id if category_id.kind_of? RestBooks::Models::Category
+      fcreate_url( "/type/#{category_id}/books/recent", options, BOOK_PARAMETERS )
+      return do_request( :book )
+    end
+
+  end
+end

data/lib/restbooks/lists.rb

@@ -0,0 +1,49 @@
+# 
+#  lists.rb
+#  restbooks
+#  
+#  Created by Paul Chavard on 2009-09-12.
+#  Copyright 2009
+#
+#  This file is part of RestBooks.
+#
+#  RestBooks is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  RestBooks is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with RestBooks.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module RestBooks
+  class Lists
+    include RestBooks::Api
+    
+    # Endpoint: /lists
+    #  Formats: Atom
+    #  Description: View the lists, use pagination
+    #  Parameters:
+    #    * favorites: normally, only the lists with at least 2 favorites are displayed. You can change the minimum value using this parameter.
+    #    * order: normally based on the number of favorites, use comments to order them by most discussed lists
+    def all( options={} )
+      create_url( "/lists", options, LIST_PARAMETERS )
+      return do_request( :list )
+    end
+    
+    # Endpoint: /list/:id
+    #  Formats: Atom
+    #  Description: View the books on the lists, use pagination
+    def books( list_id, options={} )
+      list_id = list_id.id if list_id.kind_of? RestBooks::Models::List
+      create_url( "/list/#{list_id}", options, LIST_PARAMETERS )
+      return do_request( :book )
+    end
+
+  end
+end