reststop 0.1.0 → 0.2.0

data/Manifest.txt

@@ -1,9 +1,12 @@
-Rakefile
-README.txt
 CHANGELOG.txt
 LICENSE.txt
 Manifest.txt
-setup.rb
+README.txt
+Rakefile
+examples/blog.rb
+lib/restr.rb
 lib/reststop.rb
-test/test_helper.rb
+lib/reststop/version.rb
+setup.rb
 test/reststop_test.rb
+test/test_helper.rb

data/README.txt

@@ -14,9 +14,12 @@ You can contact the author at:
 <b>Reststop makes it easy to write RESTful[http://en.wikipedia.org/wiki/Representational_State_Transfer] 
 applications in Camping[http://camping.rubyforge.org/files/README.html].</b>
 
-Reststop essentially gives you two things:
+For an example of a complete Reststop-based Camping app, have a look at 
+http://reststop.rubyforge.org/svn/trunk/examples/blog.rb
 
-<b>Camping controllers that respond to the standard REST verbs:</b>
+Reststop essentially gives you three things:
+
+<b>1. Camping controllers that respond to the standard REST verbs:</b>
 
 * create (POST)
 * read (GET)
@@ -24,9 +27,9 @@ Reststop essentially gives you two things:
 * destroy (DELETE)
 * list (GET)
 
-See the Camping::Controllers#REST method documentation for usage info.
+Custom actions are also possible. See the Camping::Controllers#REST method documentation for usage info.
 
-<b>Camping views grouped by output format:</b>
+<b>2. Camping views grouped by output format:</b>
 
 Your views module:
 
@@ -51,14 +54,55 @@ Your render call:
 
   render(:foo, :XML)
   
-See the render() method documentation for usage info.
+See the Camping#render method documentation for usage info.
+
+<b>3. Nice URLs to bring it all together:</b>
+
+For example a list of kittens in the default format (HTML) is available at:
+
+  /kittens
+
+The list, in RSS format:
+
+  /kittens.rss
+  
+Kitten with id 1, in XML format:
+  
+  /kittens/1.xml
+  
+Using custom action 'meow' on kitten with id 1:
+
+  /kittens/1/meow
+
+In other words, say you have a "kittens" resource; you can make a GET
+request to http://yourapp.com/kittens.xml and get a list of kittens
+through your Kittens controller's <tt>list</tt>, formatted using your
+<tt>XML</tt> view module. 
+
+
+<b>BONUS: A simple REST client</b>
+
+Reststop also comes with a very simple REST client called Restr.
+Restr is basically a wrapper around Ruby's Net::HTTP, offering
+a more RESTfully meaningful interface.
+
+See the Restr documentation for more info, but here's a simple
+example of RESTful interaction with Restr:
+
+  require 'restr'
+  kitten = Restr.get('http://example.com/kittens/1.xml')
+  puts kitten['name']
+  puts kitten['colour']
+  
+  kitten['colour'] = 'black'
+  kitten = Restr.put('http://example.com/kittens/1.xml', kitten)
 
 
 ----
 
 Reststop 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
+it under the terms of the GNU Lesser General Public License as published 
+by the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.
 
 Reststop is distributed in the hope that it will be useful,
@@ -66,5 +110,5 @@ 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
+You should have received a copy of the GNU Lesser General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -20,10 +20,11 @@ HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 
 
 NAME = "reststop"
-REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+REV = nil
+#REV = `svn info`[/Revision: (\d+)/, 1] rescue nil
 VERS = ENV['VERSION'] || (Reststop::VERSION::STRING + (REV ? ".#{REV}" : ""))
                           CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "reststop documentation",
+RDOC_OPTS = ['--quiet', '--title', "#{NAME} #{VERS} documentation",
     "--opname", "index.html",
     "--line-numbers", 
     "--main", "README",

data/examples/blog.rb

@@ -0,0 +1,345 @@
+#!/usr/bin/env ruby
+
+#
+# This is a RESTful version of the Camping-based Blog application.
+#
+# The original version can be found here: 
+# http://code.whytheluckystiff.net/camping/browser/trunk/examples/blog.rb
+#
+
+require 'rubygems'
+
+gem 'camping', '~> 1.5'
+gem 'reststop', '~> 0.2'
+
+require 'camping'
+require 'camping/db'
+require 'camping/session'
+
+begin
+  # try to use local copy of library
+  require '../lib/reststop'
+rescue LoadError
+  # ... otherwise default to rubygem
+  require 'reststop'
+end
+  
+Camping.goes :Blog
+
+module Blog
+    include Camping::Session
+end
+
+module Blog::Models
+    class Post < Base
+        belongs_to :user
+        has_many :comments
+    end
+    class Comment < Base
+        belongs_to :user
+    end
+    class User < Base; end
+
+    class CreateTheBasics < V 1.0
+      def self.up
+        create_table :blog_posts do |t|
+          t.column :user_id,  :integer, :null => false
+          t.column :title,    :string,  :limit => 255
+          t.column :body,     :text
+        end
+        create_table :blog_users do |t|
+          t.column :username, :string
+          t.column :password, :string
+        end
+        create_table :blog_comments do |t|
+          t.column :post_id,  :integer, :null => false
+          t.column :username, :string
+          t.column :body,     :text
+        end
+        User.create :username => 'admin', :password => 'camping'
+      end
+      def self.down
+        drop_table :blog_posts
+        drop_table :blog_users
+        drop_table :blog_comments
+      end
+    end
+end
+
+module Blog::Controllers
+    class Posts < REST 'posts'      
+
+        # POST /posts
+        def create
+            unless @state.user_id.blank?
+                post = Post.create :title => input.post_title, :body => input.post_body,
+                                   :user_id => @state.user_id
+                redirect R(Posts)
+            else
+              _error("Unauthorized", 401)
+            end
+        end
+
+        # GET /posts/1
+        # GET /posts/1.xml
+        def read(post_id) 
+            @post = Post.find post_id
+            @comments = Models::Comment.find :all, :conditions => ['post_id = ?', post_id]
+            render :view
+        end
+
+        # PUT /posts/1
+        def update(post_id)
+            unless @state.user_id.blank?
+                @post = Post.find post_id
+                @post.update_attributes :title => input.post_title, :body => input.post_body
+                redirect R(@post)
+            else
+              _error("Unauthorized", 401)
+            end
+        end
+
+        # DELETE /posts/1
+        def delete(post_id)
+            unless @state.user_id.blank?
+                @post = Post.find post_id
+                
+                if @post.destroy
+                  redirect R(Posts)
+                else
+                  _error("Unable to delete post #{@post.id}", 500)
+                end
+            else
+              _error("Unauthorized", 401)
+            end
+        end
+
+        # GET /posts
+        # GET /posts.xml
+        def list
+            @posts = Post.find :all
+            render :index
+        end
+        
+        
+        # GET /posts/new
+        def new
+            unless @state.user_id.blank?
+                @user = User.find @state.user_id
+                @post = Post.new
+            end
+            render :add
+        end
+
+        # GET /posts/1/edit
+        def edit(post_id) 
+            unless @state.user_id.blank?
+                @user = User.find @state.user_id
+            end
+            @post = Post.find post_id
+            render :edit
+        end
+        
+        # GET /posts/info
+        def info
+            div do
+                code args.inspect; br; br
+                code @env.inspect; br
+                code "Link: #{R(Info, 1, 2)}"
+            end
+        end
+    end
+     
+    class Comments < REST 'comments'
+        # POST /comments
+        def create
+            Models::Comment.create(:username => input.post_username,
+                       :body => input.post_body, :post_id => input.post_id)
+            redirect R(Posts, input.post_id)
+        end
+    end
+    
+    class Sessions < REST 'sessions'
+        # POST /sessions
+        def create
+            @user = User.find :first, :conditions => ['username = ? AND password = ?', input.username, input.password]
+     
+            if @user
+                @login = 'login success !'
+                @state.user_id = @user.id
+            else
+                @login = 'wrong user name or password'
+            end
+            render :login
+        end   
+
+        # DELETE /sessions
+        def delete
+            @state.user_id = nil
+            render :logout
+        end
+    end
+    
+    # You can use old-fashioned Camping controllers too!
+    class Style < R '/styles.css'
+        def get
+            @headers["Content-Type"] = "text/css; charset=utf-8"
+            @body = %{
+                body {
+                    font-family: Utopia, Georga, serif;
+                }
+                h1.header {
+                    background-color: #fef;
+                    margin: 0; padding: 10px;
+                }
+                div.content {
+                    padding: 10px;
+                }
+            }
+        end
+    end
+end
+
+
+Markaby::Builder.set(:indent, 2)
+
+module Blog::Views
+    module HTML
+        include Blog::Controllers 
+      
+        def layout
+          html do
+            head do
+              title 'blog'
+              link :rel => 'stylesheet', :type => 'text/css', 
+                   :href => self/'/styles.css', :media => 'screen'
+            end
+            body do
+              h1.header { a 'blog', :href => R(Posts) }
+              div.content do
+                self << yield
+              end
+            end
+          end
+        end
+    
+        def index
+          if @posts.empty?
+            p 'No posts found.'
+          else
+            for post in @posts
+              _post(post)
+            end
+          end
+          p { a 'Add', :href => R(Posts, 'new') }
+        end
+    
+        def login
+          p { b @login }
+          p { a 'Continue', :href => R(Posts, 'new') }
+        end
+    
+        def logout
+          p "You have been logged out."
+          p { a 'Continue', :href => R(Posts) }
+        end
+    
+        def add
+          if @user
+            _form(@post, :action => R(Posts))
+          else
+            _login
+          end
+        end
+    
+        def edit
+          if @user
+            _form(@post, :action => R(@post), :method => :put)
+          else
+            _login
+          end
+        end
+    
+        def view
+            _post(@post)
+    
+            p "Comment for this post:"
+            for c in @comments
+              h1 c.username
+              p c.body
+            end
+    
+            form :action => R(Comments), :method => 'post' do
+              label 'Name', :for => 'post_username'; br
+              input :name => 'post_username', :type => 'text'; br
+              label 'Comment', :for => 'post_body'; br
+              textarea :name => 'post_body' do; end; br
+              input :type => 'hidden', :name => 'post_id', :value => @post.id
+              input :type => 'submit'
+            end
+        end
+    
+        # partials
+        def _login
+          form :action => R(Sessions), :method => 'post' do
+            label 'Username', :for => 'username'; br
+            input :name => 'username', :type => 'text'; br
+    
+            label 'Password', :for => 'password'; br
+            input :name => 'password', :type => 'text'; br
+    
+            input :type => 'submit', :name => 'login', :value => 'Login'
+          end
+        end
+    
+        def _post(post)
+          h1 post.title
+          p post.body
+          p do
+            [a("Edit", :href => R(Posts, post.id, 'edit')), a("View", :href => R(Posts, post.id, 'edit'))].join " | "
+          end
+        end
+    
+        def _form(post, opts)
+          form(:action => R(Sessions), :method => 'delete') do
+          p do 
+            span "You are logged in as #{@user.username}"
+            span " | "
+            button(:type => 'submit') {'Logout'}
+          end
+          end
+          form({:method => 'post'}.merge(opts)) do
+            label 'Title', :for => 'post_title'; br
+            input :name => 'post_title', :type => 'text', 
+                  :value => post.title; br
+    
+            label 'Body', :for => 'post_body'; br
+            textarea post.body, :name => 'post_body'; br
+    
+            input :type => 'hidden', :name => 'post_id', :value => post.id
+            input :type => 'submit'
+          end
+        end
+    end
+    default_format :HTML
+
+    module XML
+      def layout
+        yield
+      end
+      
+      def index
+        @posts.to_xml(:root => 'blog')
+      end
+      
+      def view
+        @post.to_xml(:root => 'post')
+      end
+    end
+end
+ 
+def Blog.create
+    Camping::Models::Session.create_schema
+    Blog::Models.create_schema :assume => (Blog::Models::Post.table_exists? ? 1.0 : 0.0)
+end
+