restbooks 0.1.4

data/lib/restbooks/mixins/api.rb

@@ -0,0 +1,129 @@
+# 
+#  api.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
+  module Api
+    
+    BOOK_PARAMETERS = [ :letter, :year, :lang, :page ]
+    AUTHOR_PARAMETERS = [ :letter, :born, :death, :lang, :page ]
+    LIST_PARAMETERS = [ :order, :page ]
+    ORDERED_BOOK_PARAMETERS = BOOK_PARAMETERS + [ :order ]
+    RANGED_BOOK_PARAMETERS = BOOK_PARAMETERS + [ :range ]
+    ORDERED_AUTHOR_PARAMETERS = AUTHOR_PARAMETERS + [ :order ]
+    RANGED_AUTHOR_PARAMETERS = AUTHOR_PARAMETERS + [ :range ]
+
+  private
+    
+    def initialize( client )
+      @user_agent = client.user_agent
+      @uri = client.uri
+      @etags = []
+    end
+    
+    def create_url( path, options, valid_keys )
+      format = :atom
+      options_str = []
+      options.each do |key,value|
+        if key == :format
+          format = options.delete(:format)
+        elsif !valid_keys.include?(key)
+          options.delete( key )
+        else
+          options_str << "#{key.to_s}=#{value}"
+        end
+      end
+      options = (options_str.length > 0 ? options_str.join('&') : nil)
+      @uri.path = "#{path}.#{format.to_s}"
+      @uri.query = options
+    end
+    
+    def do_request(type, format = :atom)
+      etag, saved_data = get_etag(@uri.to_s)
+      if etag
+        begin
+          data = RestClient.get(@uri.to_s, {'If-None-Match' => etag, 'User-Agent' => @user_agent})
+          etag = data.headers[:etag]
+          save_etag(@uri.to_s, etag, data.body)
+        rescue RestClient::NotModified
+          data = saved_data
+        end
+      else
+        data = RestClient.get(@uri.to_s, {'User-Agent' => @user_agent})
+        etag = data.headers[:etag]
+        save_etag(@uri.to_s, etag, data.body)
+      end
+      
+      case format
+      when :atom
+        return process_atom_responce(type, data.body)
+      # when :json
+      #   #return JSON.parse( data )
+      else
+        return data
+      end
+    end
+    
+    def process_atom_responce( type, response )
+      result = []
+      doc = REXML::Document.new( response )
+      REXML::XPath.each( doc, '//entry' ) do |element|
+        result << eval( "Models::#{type.to_s.capitalize}.new( element )" )
+      end
+      return result
+    end
+    
+    def get_etag( path )
+      arr = @etags.assoc( path )
+      etag = data = nil
+      if arr
+        etag = arr[1]
+        data = arr[2]
+        if arr != @etags.first
+          @etags.delete(arr)
+          @etags.unshift( arr )
+        end
+      end
+      return etag, data
+    end
+    
+    def save_etag( path, etag, data )
+      @etags.unshift( [path,etag,data] )
+      @etags.pop if @etags.length > 99
+    end
+    
+    def update_etag( path, etag, data )
+      arr = @etags.assoc( path )
+      if arr
+        if arr == @etags.first
+          @etags[0] = [path,etag,data]
+        else
+          @etags.delete(arr)
+          @etags.unshift( [path,etag,data] )
+        end
+      else
+        @etags.unshift( [path,etag,data] )
+      end
+    end
+
+  end
+end

data/lib/restbooks/mixins/model.rb

@@ -0,0 +1,41 @@
+# 
+#  model.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
+  module Model
+
+    def to_s
+      return @element.to_s
+    end
+    
+    def to_entry
+      return @element
+    end
+
+    # def to_json
+    #   model = self.class.to_s.split('::').last.downcase.to_sym
+    #   return JSON.generate( { model => self.to_hash } )
+    # end
+
+  end
+end

data/lib/restbooks/models/author.rb

@@ -0,0 +1,63 @@
+# 
+#  author.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
+  module Models
+    class Author
+      include RestBooks::Model
+      attr_reader :title, :id, :updated, :born, :death
+      
+      def initialize( element )
+        if element
+          @element = element
+          @element.elements.each do |tag|
+            case tag.name
+            when 'title'
+              @title = tag.text
+            when 'id'
+              @id = tag.text.scan(/author\/(\d+)\/books/).to_s
+              @id = @id.split(':').last if @id.split(':').length > 1
+            when 'updated'
+              @updated = Date.parse( tag.text )
+            when 'content'
+              dates = tag.text.strip.split(' - ')
+              @born = dates.first
+              @death = dates.last
+            end
+          end
+        else
+          @element = REXML::Element.new( 'entry' )
+        end
+      end
+
+      def to_hash
+        return { :title => @title,
+          :id => @id,
+          :updated => @updated,
+          :born => @date,
+          :death => @subject }
+      end
+
+    end
+  end
+end

data/lib/restbooks/models/book.rb

@@ -0,0 +1,85 @@
+# 
+#  book.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
+  module Models
+    class Book
+      include RestBooks::Model
+      attr_reader :title, :id, :author, :updated, :language, :date, :subject, :description, :rights
+      
+      def initialize( element=nil )
+        @updated = Time.now
+        @subject = []
+        if element
+          @element = element
+          @element.elements.each do |tag|
+            case tag.name
+            when 'title'
+              @title = tag.text
+            when 'id'
+              @id = tag.text.split('/').last
+              @id = @id.split(':').last if @id.split(':').length > 1
+            when 'updated'
+              @updated = Date.parse( tag.text )
+            when 'author'
+              @author = tag.elements['name'].text
+              @author_id = tag.elements['uri'].text.split('/').last
+            when 'language' 
+              @language = tag.text
+            when 'date'
+              @date = tag.text
+            when 'subject'
+              @subject << tag.text
+            when 'description'
+              @description = tag.text.strip()
+            when 'rights'
+              @rights = tag.text
+            when 'content'
+              @html = tag.text if tag.attributes['type'] == "xhtml"  
+            end
+          end
+        else
+          @element = REXML::Element.new( 'entry' )
+        end
+      end
+
+      def to_html
+        return @html
+      end
+
+      def to_hash
+        return { :title => @title,
+          :id => @id,
+          :author => @author,
+          :author_id => @author_id,
+          :updated => @updated,
+          :language => @language,
+          :date => @date,
+          :subject => @subject,
+          :description => @description,
+          :rights => @rights }
+      end
+
+    end
+  end
+end

data/lib/restbooks/models/category.rb

@@ -0,0 +1,55 @@
+# 
+#  category.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
+  module Models
+    class Category
+      include RestBooks::Model
+      attr_reader :title, :id, :updated, :description
+      
+      def initialize( element )
+        if element
+          @element = element
+          @element.elements.each do |tag|
+            case tag.name
+            when 'title'
+              @title = tag.text.strip()
+              @id = CGI.escape( @title )
+            when 'updated'
+              @updated = Date.parse( tag.text )
+            end
+          end
+        else
+          @element = REXML::Element.new( 'entry' )
+        end
+      end
+
+      def to_hash
+        return { :title => @title,
+          :id => @id,
+          :updated => @updated }
+      end
+
+    end
+  end
+end

data/lib/restbooks/models/comment.rb

@@ -0,0 +1,65 @@
+# 
+#  comment.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
+  module Models
+    class Comment
+      include RestBooks::Model
+      attr_reader :title, :id, :author, :published, :updated, :body
+      
+      def initialize( element )
+        if element
+          @element = element
+          @element.elements.each do |tag|
+            case tag.name
+            when 'title'
+              @title = tag.text
+            when 'id'
+              @id = tag.text.split('#').last
+            when 'author'
+              @author = tag.elements['name'].text
+            when 'published'
+              @published = Date.parse( tag.text )
+            when 'updated'
+              @updated = Date.parse( tag.text )
+            when 'content'
+              @body = tag.text.strip()
+            end
+          end
+        else
+          @element = REXML::Element.new( 'entry' )
+        end
+      end
+
+      def to_hash
+        return { :title => @title,
+          :id => @id,
+          :author => @author,
+          :published => @published,
+          :updated => @updated,
+          :body => @date }
+      end
+
+    end
+  end
+end

data/lib/restbooks/models/list.rb

@@ -0,0 +1,60 @@
+# 
+#  list.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
+  module Models
+    class List
+      include RestBooks::Model
+      attr_reader :title, :id, :updated, :description
+      
+      def initialize( element )
+        if element
+          @element = element
+          @element.elements.each do |tag|
+            case tag.name
+            when 'title'
+              @title = tag.text.strip()
+            when 'id'
+              @id = tag.text.split('/').last
+              @id = @id.split(':').last if @id.split(':').length > 1
+            when 'updated'
+              @updated = Date.parse( tag.text )
+            when 'content'
+              @description = tag.text.strip()
+            end
+          end
+        else
+          @element = REXML::Element.new( 'entry' )
+        end
+      end
+
+      def to_hash
+        return { :title => @title,
+          :id => @id,
+          :updated => @updated,
+          :description => @description }
+      end
+
+    end
+  end
+end