kwipper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5274064f603e0f05b4a350a54d02ca0daffe742
+  data.tar.gz: 254cb60d948a74f41e1cbd58d5206f31ba1d4ef8
+SHA512:
+  metadata.gz: ca2c1888f7ed78138981511db0853b1ca00b638e6070a7d27c80c8e3b2800f6d3fd1428edb94cb6ecdc448bffc0c8857eb2805aa7a55e9368aac6974ab9aad70
+  data.tar.gz: d094eba7c7f0e6b6a10dd1cc6830dd9251a9bde863cb25e31ff2259f7b4ff856f5c4c25fb58fd6dc40c5e17ca5c483fa3520e4d493bd2000c3c2df78deae1862

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+db/*.db
+*.db

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kwipper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Diego Salazar
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Kwipper
+
+Kwipper is the reference example app for the Kwipper Programming Challenge. See more information on the live app [demo](#soon).
+
+## Installation
+
+    $ git clone git@github.com:DiegoSalazar/kwipper_challenge.git
+
+## Usage
+
+Create yourself a user by starting the console:
+
+    $ irb -r ./lib/kwipper -r ./app/models/user
+
+And running:
+
+```ruby
+User.create 'username' => 'a username', 'email' => 'optional@mail.com', 'hashed_password' => '123'
+```
+
+Start the server:
+
+    $ ruby lib/kwipper.rb
+
+Open the app in a browser at [http://localhost:7335](http://localhost:7335).
+
+## Contributing
+
+1. Fork it ( https://github.com/DiegoSalazar/kwipper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/comments_controller.rb

@@ -0,0 +1,32 @@
+module Kwipper
+  class CommentsController < Controller
+    add_routes({
+      [:GET, '/kwips/comments/new']     => :new,
+      [:POST, '/kwips/comments/create'] => :create
+    })
+
+    def new
+      require_login!
+      @post = Post.find params['id']
+      render :new_comment
+    end
+
+    def create
+      require_login!
+
+      post = Post.find params['id']
+      comment = Comment.new({
+        'user_id'    => current_user.id,
+        'post_id'    => post.id,
+        'created_at' => Time.now.httpdate,
+        'content'    => params['content']
+      })
+
+      if comment.save
+        redirect "/kwips/show?id=#{post.id}"
+      else
+        redirect "/kwips/comments/new?id=#{post.id}", :bad_request
+      end
+    end
+  end
+end

data/app/controllers/post_favorites_controller.rb

@@ -0,0 +1,17 @@
+module Kwipper
+  class PostFavoritesController < Controller
+    add_routes [:POST, '/favorites/create'] => :create
+
+    def create
+      require_login!
+      
+      post = Post.find params['id']
+      fave = PostFavorite.create({
+        'user_id' => current_user.id,
+        'post_id' => post.id
+      })
+
+      redirect "/kwips/show?id=#{post.id}"
+    end
+  end
+end

data/app/controllers/posts_controller.rb

@@ -0,0 +1,41 @@
+module Kwipper
+  class PostsController < Controller
+    add_routes({
+      [:GET, '/kwips']         => :posts,
+      [:GET, '/kwips/show']    => :show,
+      [:GET, '/kwips/new']     => :new,
+      [:POST, '/kwips/create'] => :create
+    })
+
+    def posts
+      @paginator = Paginator.new Post, page: params['page'], per: 10, path: '/kwips'
+      @posts = @paginator.get "SELECT * FROM posts ORDER BY created_at DESC"
+      render :posts
+    end
+
+    def show
+      @post = Post.find params['id']
+      @comments = @post.comments
+      render :show_post
+    end
+
+    def new
+      require_login!
+      render :new_post
+    end
+
+    def create
+      require_login!
+      post = Post.new params.merge({
+        'user_id'    => current_user.id,
+        'created_at' => Time.now.httpdate
+      })
+
+      if post.save
+        redirect '/kwips'
+      else
+        redirect '/kwips/new', :bad_request
+      end
+    end
+  end
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,32 @@
+module Kwipper
+  class SessionsController < Controller
+    add_routes({
+      [:POST, '/sessions/create']  => :create,
+      [:GET, '/logout'] => :destroy
+    })
+
+    def create
+      @user = User.authenticate params['username'], params['password']
+
+      if @user
+        Session.create({
+          'id'         => response.session_cookie_value,
+          'user_id'    => @user.id,
+          'created_at' => Time.now.httpdate
+        })
+
+        redirect '/users'
+      else
+        redirect '/users/login', :bad_request
+      end
+    end
+
+    def destroy
+      if current_session
+        current_session.destroy
+        response.remove_session_cookie
+      end
+      redirect '/'
+    end
+  end
+end

data/app/controllers/users_controller.rb

@@ -0,0 +1,70 @@
+module Kwipper
+  class UsersController < Controller
+    add_routes({
+      [:GET, '/users']          => :users,
+      [:GET, '/users/show']     => :show,
+      [:GET, '/users/new']      => :new,
+      [:POST, '/users/create']  => :create,
+      [:GET, '/users/edit']     => :edit,
+      [:POST, '/users/update']  => :update,
+      [:POST, '/users/destroy'] => :destroy,
+      [:GET, '/login']          => :login
+    })
+
+    def users
+      require_login!
+      @users = User.all
+      render :users
+    end
+
+    def show
+      @user = User.find params['id']
+      @posts = @user.posts
+      render :show_user
+    end
+
+    def new
+      require_login!
+      render :new_user
+    end
+
+    def create
+      require_login!
+      user = User.new params
+
+      if user.save
+        redirect '/users'
+      else
+        redirect '/users/new', :bad_request
+      end
+    end
+
+    def edit
+      require_login!
+      @user = User.find params['id']
+      render :edit_user
+    end
+
+    def update
+      require_login!
+      user = User.find params['id']
+
+      if user.update params
+        redirect '/users'
+      else
+        redirect '/users/new', :bad_request
+      end
+    end
+
+    def destroy
+      require_login!
+      user = User.find params['id']
+      user.destroy
+      redirect '/users'
+    end
+
+    def login
+      render :login_user
+    end
+  end
+end

data/app/models/comment.rb

@@ -0,0 +1,20 @@
+module Kwipper
+  class Comment < Model
+    column 'user_id', :to_i
+    column 'post_id', :to_i
+    column 'content', :to_s
+    column 'created_at', :to_s
+
+    def user
+      @user ||= User.find user_id
+    end
+
+    def username
+      user.username
+    end
+
+    def post
+      @post ||= Post.find post_id
+    end    
+  end
+end

data/app/models/post.rb

@@ -0,0 +1,31 @@
+module Kwipper
+  class Post < Model
+    column 'user_id', :to_i
+    column 'content', :to_s
+    column 'created_at', :to_s
+
+    def self.recent(statement = "SELECT * FROM posts")
+      all(statement).sort_by { |post| Time.parse post.created_at }.reverse
+    end
+
+    def user
+      @user ||= User.find user_id
+    end
+
+    def username
+      user.username
+    end
+
+    def comments
+      Comment.all "SELECT * FROM comments WHERE post_id = #{id}"
+    end
+
+    def comments_count
+      Model.count "SELECT COUNT(id) FROM comments WHERE post_id = #{id}"
+    end
+
+    def faves_count
+      Model.count "SELECT COUNT(id) FROM post_favorites WHERE post_id = #{id}"
+    end
+  end
+end

data/app/models/post_favorite.rb

@@ -0,0 +1,6 @@
+module Kwipper
+  class PostFavorite < Model
+    column 'user_id', :to_i
+    column 'post_id', :to_i
+  end
+end

data/app/models/session.rb

@@ -0,0 +1,12 @@
+module Kwipper
+  class Session < Model
+    column 'id', :to_s
+    column 'user_id', :to_i
+    column 'created_at', :to_s
+
+
+    def destroy
+      super self.class.normalize_value_for_db(id, :to_s)
+    end
+  end
+end

data/app/models/user.rb

@@ -0,0 +1,21 @@
+module Kwipper
+  class User < Model
+    column 'username', :to_s
+    column 'email', :to_s
+    column 'hashed_password', :to_s
+
+    def self.authenticate(username, password)
+      user = where(username: username).first
+      user && user.hashed_password == password && user
+    end
+
+    def favorite?(post)
+      result = sql("SELECT COUNT(id) FROM post_favorites WHERE user_id = #{id} AND post_id = #{post.id} LIMIT 1").first
+      result.first && result.first > 0
+    end
+
+    def posts
+      Post.recent "SELECT * FROM posts WHERE user_id = #{id}"
+    end
+  end
+end

data/app/views/edit_user.erb

@@ -0,0 +1,26 @@
+<h1>Edit User</h1>
+
+<div class="row">
+  <div class="col-sm-12">
+    <form action="/users/update?id=<%= @user.id %>" method="post">
+      <div class="form-group">
+        <label>Username</label>
+        <input value="<%= @user.username %>" type="text" name="username" class="form-control">
+      </div>
+
+      <div class="form-group">
+        <label>Email</label>
+        <input value="<%= @user.email %>" type="text" name="email" class="form-control">
+      </div>
+
+      <div class="form-group">
+        <label>Password</label>
+        <input value="<%= @user.hashed_password %>" type="text" name="hashed_password" class="form-control">
+      </div>
+
+      <div class="form-group">
+        <input type="submit" value="Update" class="btn btn-primary">
+      </div>
+    </form>
+  </div>
+</div>

data/app/views/fave_button.erb

@@ -0,0 +1,8 @@
+<% faved = current_user && current_user.favorite?(@post) %>
+<form action="/favorites/create?id=<%= @post.id %>" method="post" class="pull-left">
+  <span class="fa fa-thumb-o-up">&nbsp;</span>
+  <button type="submit" class="btn btn-xs btn-<%= faved ? 'success' : 'default' %>"<%= faved ? ' disabled="disabled"' : nil %>>
+    <span class="fa fa-thumbs-<%= faved ? 'up' : 'o-up' %>">&nbsp;</span>
+    <%= faved ? "Fave'd" : 'Fave' %>
+  </button
+</form>

data/app/views/home.erb

@@ -0,0 +1,126 @@
+<div class="jumbotron">
+  <h1>Kwipper</h1>
+  
+  <p>
+    This web app is a Twitter clone that was created as a reference example for a programming challenge designed to teach the fundamentals of web development in Ruby. Kwipper is a self contained app that uses no web application frameworks, ORMs or Active gems, and no third party server. 
+    <a href="#rules">Read more</a> about the challenge below.
+  </p>
+</div>
+
+<p class="alert alert-info">
+  <span class="fa fa-github fa-lg">&nbsp;</span>
+  You can see the complete source code for this app on 
+  <a href="https://github.com/DiegoSalazar/kwipper_challenge">Github</a>.
+</p>
+
+<h2>Components that were built from scratch:</h2>
+
+<ul>
+  <li>[HTTP Server](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/http_server.rb): using Ruby's TCPServer class</li>
+  <li>[HTTP Parser](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/http_parser.rb): plain old Ruby</li>
+  <li>[Request class](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/request.rb): represents the parsed HTTP request and headers</li>
+  <li>[Response class](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/response.rb): holds response headers and renders HTTP responses to the socket. Sets the session.</li>
+  <li>[View Rendering module](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/renders_views.rb): using ERB</li>
+  <li>[Model base class](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/model.rb): The most complex class, it implements interaction with SQLite and defines ORM-like methods.</li>
+  <li>[Controller base class](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/controller.rb): implements routing and authentication</li>
+  <li>[App micro framework](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/application.rb): app directory with views, models and controllers that are automatically loaded on startup</li>
+  <li>[Paginator class](https://github.com/DiegoSalazar/kwipper_challenge/blob/master/lib/kwipper/paginator.rb): SQL based pagination</li>
+</ul>
+
+<hr>
+
+<h2 id="rules">Challenge Rules</h2>
+
+<div class="well">
+  <h3>Write a Twitter clone without using any frameworks or Active* gems. </h3>
+
+  <p>
+    The purpose of this challenge is to increase your knowledge of the fundamentals of web development and to understand what happens “under the hood” of the frameworks we use such as Rack and Rails. How you build the app is not important, just that it satisfies the Required Features and follows the Rules. This challenge was designed to encourage you to learn the fundamental concepts that a web developer should know. Once these ideas are grokked you will be closer to obtaining the skills necessary to freely move between web-based technologies. 
+  </p>
+
+  <p>
+    Our trade evolves at an exponentially increasing rate. So too, must we constantly increase our understanding of our tools and techniques in order to keep up with the pace of advancement and innovation. By reaching for the forefront of our craft we can better hope to contribute our own innovations.
+  </p>
+
+  <p>The challenge will be divided into two phases, which are described in the phase sections below.</p>
+
+  <h3>Things To Learn:</h3>
+  <ul>
+    <li>Write a basic HTTP server (for example: using Ruby’s TCPServer class)</li>
+    <li>Parse the HTTP protocol (similar to how CSV is parsed but more complex)</li>
+    <li>Handle HTTP headers to set cookies and manage sessions</li>
+    <li>Handle GET and POST data in requests</li>
+    <li>Abstract away the HTTP layer so your app can focus on its own domain logic</li>
+    <li>Connect to a database without using ActiveRecord</li>
+    <li>Write SQL statements to perform CRUD operations</li>
+    <li>Manually validate and sanitize user input before inserting into the database</li>
+    <li>Generate HTML with dynamic content</li>
+  </ul>
+
+  <h2>Kwipper: A witty Twitter Clone</h2>
+
+  <h3>Required Features</h3>
+  <ul>
+    <li>User sign up, login, and logout using cookie based sessions</li>
+    <li>User can create, edit, delete their own text Posts</li>
+    <li>Index page displays timeline of Posts by all Users</li>
+    <li>Pagination of timeline</li>
+    <li>Server logs requests to STDOUT</li>
+  </ul>
+
+  <h3>Rules</h3>
+
+  <ul>
+    <li>The App must be run by executing `ruby app.rb`</li>
+    <li>The App logs requests to STDOUT (the console)</li>
+    <li>The App must be plain Ruby and HTML</li>
+    <li>Must not use any app frameworks (e.g. Rack, Rails, Sinatra)</li>
+    <li>Must not use any of the Active* gems (e.g. ActiveRecord, ActiveSupport)</li>
+  </ul>
+
+  <h3>Phase 1</h3>
+  <p>
+    Complete the HTTP server, database connection, and user signup, login and logout. These basic features form the foundation of every web application and require knowledge of HTTP, SQL, HTTP headers and the concept of session management.
+  </p>
+
+  <h3>Phase 2</h3>
+  <p>Complete the app to meet the required features.</p>
+
+  <h3>Bonus Features</h3>
+  <p>If you’re looking for more of a challenge you can optionally add:</p>
+
+  <ul>
+    <li>Users can comment on posts</li>
+    <li>Users can tag posts</li>
+    <li>Users can favorite posts</li>
+    <li>Add a tag cloud to the homepage</li>
+    <li>Make it look good on mobile</li>
+  </ul>
+
+  <h3>Deeper Concepts to Learn</h3>
+  <p>
+    Through completing the challenge you’ll maybe come to understand deeper concepts underlying what you’re building and the technology and protocols you’ll be using. Take these points as a source of motivation for further learning.
+  </p>
+
+  <p>In diving deeper into the ideas touched on by the points in the Things To Learn section:</p>
+
+  <ul>
+    <li>
+      The difference between TCP and HTTP and how they fit together. Why was a text protocol chosen for HTTP but a binary protocol for TCP? What exactly is TCP? What is HTTP?
+    </li>
+    <li>
+      What are sessions? What are cookies? Why are they necessary? How are they stored in memory on the server? How does the server know which users correspond with which sessions?
+    </li>
+    <li>
+      What are the differences between GET and POST data? When it is appropriate to use each and why do we get the “resubmit form data” warning in some apps?
+    </li>
+    <li>
+      What is the point of ActiveRecord? Why doesn’t it cover all use cases? What is the difference between modeling data, a data model, and a Model?
+      Where should validation be implemented? Why should we sanitize input? Why was this an important point?
+    </li>
+    <li>
+      How can we generate dynamic content without templating frameworks like ERB or HAML? At what point does a web page become a web app? What is HTML and what does it do?
+    </li>
+  </ul>
+
+</div>