ramaze 2011.07.25 → 2011.10.23

data/examples/app/blog/model/user.rb

@@ -0,0 +1,105 @@
+##
+# The User model is user for retrieving and authenticating users. This
+# application uses bcrypt to hash the passwords. For more information on bcrypt
+# see the following pages:
+#
+# * http://codahale.com/how-to-safely-store-a-password/
+# * http://yorickpeterse.com/articles/use-bcrypt-fool/
+# * https://github.com/codahale/bcrypt-ruby
+#
+# @author Yorick Peterse
+# @since  26-09-2011
+#
+class User < Sequel::Model
+  # A user can have any number of posts and comments.
+  one_to_many :posts
+  one_to_many :comments
+
+  ##
+  # User.authenticate() is used to authenticate a user. Each request the User
+  # helper calls this method to see if the currently logged in user is a valid
+  # user. Once called this methods queries the database and returns a valid User
+  # object in case the specified details were correct or something that
+  # evaluates to false if this wasn't the case.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  # @param  [Hash] creds A hash containing the username and password of the
+  #  currently logged in user.
+  # @return [Users|FalseClass]
+  #
+  def self.authenticate(creds)
+    username, password = creds['username'], creds['password']
+
+    if creds['username'].nil? or creds['username'].empty?
+      return false
+    end
+
+    # Let's see if there is a user for the given username.
+    user = self[:username => username]
+
+    # Validate the user. Note that while it may seem that the password is
+    # compared as plain text this is not the case. The bcrypt class
+    # automatically converts the given password to a bcrypt hash. If these
+    # hashes are the same the specified password is correct.
+    if !user.nil? or user.password == password
+      return user
+    else
+      return false
+    end
+  end
+
+  ##
+  # In order to properly use bcrypt we have to override the password=() and
+  # password() methods to return a correct bcrypt hash/object rather than
+  # whatever was stored in the database as a String instance.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  # @param  [String] password The new password of a user.
+  #
+  def password=(password)
+    # Passing an empty password to the BCrypt class triggers errors.
+    if password.nil? or password.empty?
+      return
+    end
+
+    # Generates a new bcrypt password using a cost of 10. In my opinion a cost
+    # higher than 10 makes a web based application too slow.
+    password = BCrypt::Password.create(password, :cost => 10)
+
+    super(password)
+  end
+
+  ##
+  # Because the password=() is overwritten with a custom one we also have to
+  # define a matching getter. Without this you'd get an instance of String
+  # containing the bcrypt hash and thus wouldn't be able to properly compare it
+  # to other passwords.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  # @return [BCrypt::Password|NilClass]
+  #
+  def password
+    password = super
+
+    if !password.nil?
+      return BCrypt::Password.new(password)
+    else
+      return nil
+    end
+  end
+
+  ##
+  # Validates an instance of this model. See Post#validate() for some extra
+  # details on how this works.
+  #
+  # @author Yorick Peterse
+  # @since  26-09-2011
+  #
+  def validate
+    validates_presence(:username)
+    validates_presence(:password) if new?
+  end
+end # User

data/examples/app/blog/public/.htaccess

@@ -0,0 +1,24 @@
+# General Apache options
+Options +FollowSymLinks +ExecCGI
+AddHandler cgi-script cgi rb
+<IfModule mod_fastcgi.c>
+ AddHandler fastcgi-script fcgi
+</IfModule>
+<IfModule mod_fcgid.c>
+ AddHandler fcgid-script fcgi
+</IfModule>
+
+# Redirect all requests not available on the filesystem to Ramaze.
+
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+
+# In case Ramaze experiences terminal errors.
+# Instead of displaying this message you can supply a
+# file here which will be rendered instead.
+#
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Ramaze failed to start properly"

data/examples/app/blog/public/css/grid.css

@@ -0,0 +1,107 @@
+@charset "UTF-8";
+
+/**
+ * Modified version of the CSS grid (aka 1140 CSS) that can be found at http://cssgrid.net
+ * 
+ * This modified version has some extra enhancements to make it a bit easier to work with
+ * the grid. Along with these minor fixes I also renamed all grid classes to the names
+ * used by the 960 grid system as I find "grid_6" easier to write than "sixcol".
+ */
+.container
+{
+    overflow:      hidden;
+    padding-left:  1%;
+    padding-right: 1%;
+}
+
+.row
+{
+    max-width: 96%;
+    margin:    0 auto;
+    overflow:  hidden;
+    width:     100%;
+}
+
+.grid_1, .grid_2, .grid_3, .grid_4, .grid_5, .grid_6, .grid_7, .grid_8, .grid_9, 
+.grid_10, .grid_11
+{
+    float:        left;
+    margin-right: 3.8%;
+    min-height:   1px;
+}
+
+.row .grid_1
+{
+    width: 4.85%;
+}
+
+.row .grid_2
+{
+    width: 13.45%;
+}
+
+.row .grid_3
+{
+    width: 22.05%;
+}
+
+.row .grid_4
+{
+    width: 30.75%;
+}
+
+.row .grid_5
+{
+    width: 39.45%;
+}
+
+.row .grid_6
+{
+    width: 48%;
+}
+
+.row .grid_7
+{
+    width: 56.75%;
+}
+
+.row .grid_8
+{
+    width: 65.4%;
+}
+
+.row .grid_9
+{
+    width: 74.05%;
+}
+
+.row .grid_10
+{
+    width: 82.7%;
+}
+
+.row .grid_11
+{
+    width: 91.35%;
+}
+
+.row .grid_12
+{
+    float: left;
+    width: 100%;
+}
+
+.last, .row > *:last-child
+{
+    margin-right: 0px;
+}
+
+img, object, embed
+{
+    max-width: 100%;
+}
+
+img
+{
+	height: auto;
+}

data/examples/app/blog/public/css/layout.css

@@ -0,0 +1,203 @@
+/**
+ * Stylesheet used for the layout of most elements.
+ *
+ * @author Yorick Peterse
+ * @link   http://yorickpeterse.com/
+ */
+#container
+{
+    margin:  20px auto;
+    width:   940px;
+}
+
+#content
+{
+    background:    #fff;
+    border:        1px solid #ddd;
+    padding:       20px;
+    width:         898px;
+}
+
+/* Top part of the website, contains the title and the navigation menu */
+#top
+{
+    background:    #E33F1E;
+    height:        70px;
+    margin-bottom: 20px;
+    padding:       0px 10px;
+}
+
+    #top header h1
+    {
+        color:       #fff;
+        font-size:   38px;
+        margin:      10px 0px 0px 0px;
+        padding:     0px;
+    }
+
+    #top nav ul
+    {
+        float:        right;
+        margin-right: 15px;
+    }
+
+        #top nav ul li
+        {
+            float:           left;
+            font-size:       16px;
+            list-style-type: none;
+            margin-right:    10px;
+        }
+
+        #top nav ul li:last-child
+        {
+            margin-right: 0px;
+        }
+
+            #top nav ul li a
+            {
+                color:           #fff;
+                display:         block;
+                height:          45px;
+                padding:         25px 10px 0px 10px;
+                text-decoration: none;
+            }
+
+            #top nav ul li a:hover
+            {
+                background: #D43919;
+            }
+
+/* Footer at the bottom of the page */
+#footer
+{
+    text-align: center;
+}
+
+    #footer p
+    {
+        font-size:     13px;
+        margin-bottom: 10px;
+    }
+
+form label
+{
+    display: block;
+}
+
+    form label span.error
+    {
+        color: #E33F1E;
+    }
+
+form input[type="text"], form textarea, form input[type="password"]
+{
+    border:    1px solid #ccc;
+    font-size: 14px;
+    padding:   5px;
+    width:     300px;
+}
+
+form textarea
+{
+    width: auto;
+}
+
+form input[type="submit"]
+{
+    background: #fff;
+    border:     1px solid #ccc;
+    font-size:  14px;
+    padding:    3px 5px;
+}
+
+form input[type="submit"]:hover
+{
+    background: #eee;
+}
+
+/* Comments */
+#comments > h1
+{
+    margin-bottom: 10px;
+}
+
+#comments article header h1
+{
+    font-size: 16px;
+}
+
+#comments article header .meta
+{
+    margin-bottom: 10px;
+}
+
+/* Notifications */
+.message
+{
+    margin-bottom: 20px;
+    text-align:    center;
+}
+
+    .message p
+    {
+        margin-bottom: 0px;
+        padding:       5px;
+    }
+
+.message.success
+{
+    background: #DAEDA6;
+    color:      #000;
+}
+
+.message.error
+{
+    background: #E33F1E;
+    color:      #fff;
+}
+
+/* Pagination system */
+.pager span
+{
+    display: none;
+}
+
+.pager a
+{
+    border:          1px solid #ccc;
+    display:         inline-block;
+    margin-right:    8px;
+    min-width:       20px;
+    padding:         5px;
+    text-decoration: none;
+    text-align:      center;
+}
+
+    .pager a:hover, .pager a.current
+    {
+        background: #eee;
+        color:      #000;
+    }
+
+table
+{
+    margin-bottom: 10px;
+    text-align:    left;
+}
+
+    table thead tr th
+    {
+        border-bottom: 2px solid #ccc!important;
+    }
+
+    table thead tr th, table tbody tr td
+    {
+        border-bottom: 1px solid #ccc;
+        padding:       8px 3px;
+    }
+
+    table tbody tr:last-child td
+    {
+        border-bottom: none;
+    }

data/examples/app/blog/public/css/reset.css

@@ -0,0 +1,123 @@
+@charset "UTF-8";
+
+/** 
+ * http://meyerweb.com/eric/tools/css/reset/ 
+ * v2.0 | 20110126
+ * License: none (public domain)
+ */
+html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, 
+strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, 
+form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, 
+canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, 
+ruby, section, summary, time, mark, audio, video 
+{
+    border:         0;
+    font-size:      100%;
+    font:           inherit;
+    margin:         0;
+    padding:        0;
+    vertical-align: baseline;
+}
+
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure, footer, header, hgroup, menu, nav, section 
+{
+    display: block;
+}
+
+body 
+{
+    line-height: 1.3;
+}
+
+ol, ul, ol li, ul li
+{
+    list-style-type: none;
+    margin:          0px;
+    padding:         0px;
+}
+
+blockquote, q 
+{
+    quotes: none;
+}
+
+blockquote:before, blockquote:after, q:before, q:after 
+{
+    content: '';
+    content: none;
+}
+
+table 
+{
+    /**
+     * Instead of "collapse" I'm using "separate" as that allows me to give table cells
+     * a border without having to go through a lot of trouble
+     */
+    border-collapse: separate;
+    border-spacing:  0;
+    width:           100%;
+}
+
+    table th
+    {
+        font-weight: bold;
+    }
+
+pre, code
+{
+    font-size:   13px;
+    font-family: monospace;
+}
+
+/**
+ * These form elements usually don't trigger any special cursor and thus can confuse
+ * users when these elements have custom styles (e.g. a background image). 
+ */
+input[type="submit"], input[type="button"], input[type="checkbox"], input[type="radio"],
+button, select
+{
+    cursor: pointer;
+}
+
+*[disabled], *[disabled="disabled"]
+{
+    cursor: not-allowed;
+}
+
+textarea
+{
+    overflow: auto;
+}
+
+acronym, abbr
+{
+    cursor: help;
+}
+
+/* Some typography related styles */
+body
+{
+    font-size: 16px;
+}
+
+h1, h2, h3, h4, h5, h6
+{
+    font-weight: bold;
+}
+
+a:hover, a:active
+{
+    outline: none;
+}
+
+strong
+{
+    font-weight: bold;
+}
+
+small
+{
+    font-size: 11px;
+}