Karla's Chitter Challenge

Gemfile

@@ -1,8 +1,13 @@
 source 'https://rubygems.org'
 
 group :test do
+  gem 'bcrypt'
+  gem 'capybara'
+  gem 'pg'
   gem 'rspec'
   gem 'rubocop', '0.71.0'
   gem 'simplecov', require: false
   gem 'simplecov-console', require: false
+  gem 'sinatra'
+  gem 'sinatra-flash'
 end

Gemfile.lock

@@ -1,16 +1,41 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     ast (2.4.0)
+    bcrypt (3.1.13)
+    capybara (3.31.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
     diff-lcs (1.3)
     docile (1.3.2)
     jaro_winkler (1.5.3)
     json (2.2.0)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
     parallel (1.18.0)
     parser (2.6.5.0)
       ast (~> 2.4.0)
+    pg (1.2.2)
+    public_suffix (4.0.3)
+    rack (2.2.2)
+    rack-protection (2.0.8.1)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
     rainbow (3.0.0)
+    regexp_parser (1.7.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -32,6 +57,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -41,18 +67,33 @@ GEM
       simplecov
       terminal-table
     simplecov-html (0.10.2)
+    sinatra (2.0.8.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.8.1)
+      tilt (~> 2.0)
+    sinatra-flash (0.3.0)
+      sinatra (>= 1.0.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
+    tilt (2.0.10)
     unicode-display_width (1.6.0)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bcrypt
+  capybara
+  pg
   rspec
   rubocop (= 0.71.0)
   simplecov
   simplecov-console
+  sinatra
+  sinatra-flash
 
 BUNDLED WITH
    1.17.3

README.md

@@ -1,133 +1,92 @@
 Chitter Challenge
 =================
 
-* Challenge time: rest of the day and weekend, until Monday 9am
-* Feel free to use Google, your notes, books, etc. but work on your own
-* If you refer to the solution of another coach or student, please put a link to that in your README
-* If you have a partial solution, **still check in a partial solution**
-* You must submit a pull request to this repo with your code by 9am Monday morning
-
-Challenge:
--------
-
-As usual please start by forking this repo.
-
-We are going to write a small Twitter clone that will allow the users to post messages to a public stream.
-
-Features:
--------
+Quick start
+___
+Need to add steps here for setting up the database etc.
 
+User Stories
+___
 ```
-STRAIGHT UP
-
-As a Maker
-So that I can let people know what I am doing  
-I want to post a message (peep) to chitter
-
-As a maker
-So that I can see what others are saying  
-I want to see all peeps in reverse chronological order
-
-As a Maker
-So that I can better appreciate the context of a peep
-I want to see the time at which it was made
-
 As a Maker
 So that I can post messages on Chitter as me
 I want to sign up for Chitter
+```
+To sign up, users press the 'Sign up' button on the peeps
+(add screenshot). This takes them to a registration page (route /users/new), with a form to fill in. Users enter their name, email and password and press the Sign up button.
+
+This is routed to post /users where a new User is created in the .create method in the User class and the user_id is saved to the session.
 
-HARDER
+The .create method in the User class encrypts the password entered by the user using BCrypt, and inserts into the user table. It returns the user as a class instance.
 
+```
 As a Maker
 So that only I can post messages on Chitter as me
 I want to log in to Chitter
-
-As a Maker
-So that I can avoid others posting messages on Chitter as me
-I want to log out of Chitter
-
-ADVANCED
-
-As a Maker
-So that I can stay constantly tapped in to the shouty box of Chitter
-I want to receive an email if I am tagged in a Peep
 ```
+An existing user can log in by pressing the 'Log in' button on the peeps. This takes them to a log in form (route sessions/new). Users enter their email address and password.
 
-Technical Approach:
------
-
-This week you integrated a database into Bookmark Manager using the `PG` gem and `SQL` queries. You can continue to use this approach when building Chitter Challenge.
-
-If you'd like more technical challenge this weekend, try using an [Object Relational Mapper](https://en.wikipedia.org/wiki/Object-relational_mapping) as the database interface.
-
-Some useful resources:
-**DataMapper**
-- [DataMapper ORM](https://datamapper.org/)
-- [Sinatra, PostgreSQL & DataMapper recipe](http://recipes.sinatrarb.com/p/databases/postgresql-datamapper)
-
-**ActiveRecord**
-- [ActiveRecord ORM](https://guides.rubyonrails.org/active_record_basics.html)
-- [Sinatra, PostgreSQL & ActiveRecord recipe](http://recipes.sinatrarb.com/p/databases/postgresql-activerecord?#article)
-
-Notes on functionality:
-------
+This is routed to post /sessions where the authenticate method is called on the User class to verify if the correct username and password have been entered.
 
-* You don't have to be logged in to see the peeps.
-* Makers sign up to chitter with their email, password, name and a username (e.g. [email protected], password123, Sam Morgan, sjmog).
-* The username and email are unique.
-* Peeps (posts to chitter) have the name of the maker and their user handle.
-* Your README should indicate the technologies used, and give instructions on how to install and run the tests.
+If the email does not exist in the database, or the password doesn't match (unhappy paths) then the user is given the message: 'Please check your email or password.'
 
-Bonus:
------
+The authenticate method queries the database for users with the email address entered. If the email is found in the database then the password entered is checked against the password entered (using BCrypt). If this matches then a user instance is created and returned (happy path).
 
-If you have time you can implement the following:
+If a users is authenticated their user id (the primary key from the database) is stored in the sessions hash.
 
-* In order to start a conversation as a maker I want to reply to a peep from another maker.
-
-And/Or:
-
-* Work on the CSS to make it look good.
-
-Good luck and let the chitter begin!
-
-Code Review
------------
-
-In code review we'll be hoping to see:
-
-* All tests passing
-* High [Test coverage](https://github.com/makersacademy/course/blob/master/pills/test_coverage.md) (>95% is good)
-* The code is elegant: every class has a clear responsibility, methods are short etc.
-
-Reviewers will potentially be using this [code review rubric](docs/review.md).  Referring to this rubric in advance may make the challenge somewhat easier.  You should be the judge of how much challenge you want this weekend.
-
-Automated Tests:
------
-
-Opening a pull request against this repository will will trigger Travis CI to perform a build of your application and run your full suite of RSpec tests. If any of your tests rely on a connection with your database - and they should - this is likely to cause a problem. The build of your application created by has no connection to the local database you will have created on your machine, so when your tests try to interact with it they'll be unable to do so and will fail.
-
-If you want a green tick against your pull request you'll need to configure Travis' build process by adding the necessary steps for creating your database to the `.travis.yml` file.
+```
+As a Maker
+So that I can avoid others posting messages on Chitter as me
+I want to log out of Chitter
+```
+To log out of Chitter the user presses the 'Log out' button on the peeps screen.
 
-- [Travis Basics](https://docs.travis-ci.com/user/tutorial/)
-- [Travis - Setting up Databases](https://docs.travis-ci.com/user/database-setup/)
+This routes to /sessions/destroy which clears the user id from the sessions hash and serves a message to the page: "You have logged out."
 
-Notes on test coverage
-----------------------
+```
+As a Maker
+So that I can let people know what I am doing  
+I want to post a message (peep) to chitter
+```
+Once the user has logged in, a form is available to them to type messages and press the Peep button.
 
-Please ensure you have the following **AT THE TOP** of your spec_helper.rb in order to have test coverage stats generated
-on your pull request:
+When they type out a Peep this routes to /peeps/new which calls the .create method on the Peep class. This method takes the peep text from the form and the user id from the session. This method then inserts this into the peeps table in the database, and the database automatically generates an id and timestamp, which is returned.
 
-```ruby
-require 'simplecov'
-require 'simplecov-console'
+This method also finds the user using the method .find on the User class in order to return the users name. The .find method queries the user table using a WHERE clause to access the users information then stores this in an instance of a user class.
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::Console,
-  # Want a nice code coverage website? Uncomment this next line!
-  # SimpleCov::Formatter::HTMLFormatter
-])
-SimpleCov.start
 ```
+As a maker
+So that I can see what others are saying  
+I want to see all peeps in reverse chronological order
+```
+The method .all in the Peeps class queries the database using a left join query to return the peep, date and username and an ORDER BY date desc to achieve reverse chronological order. This is then converted into an array of Peep instances.
 
-You can see your test coverage when you run your tests. If you want this in a graphical form, uncomment the `HTMLFormatter` line and see what happens!
+The app.rb stores the result of Peep.all in an instance variable so the view can access this. The view then loops around this array, inserting each peep into a html list, displaying the user name (in bold), and date (in format dd mmm yyyy hh:mm) and tweet below.
+```
+As a Maker
+So that I can better appreciate the context of a peep
+I want to see the time at which it was made
+```
+As part of displaying the peeps in reverse chronological order, the date is also accessed from each Peep instance and displayed in the browser
+```
+As a Maker
+So that I can stay constantly tapped in to the shouty box of Chitter
+I want to receive an email if I am tagged in a Peep
+```
+Haven't implemented this one yet
+
+Known issues:
+---
+1. There are currently no checks in place to ensure a user trying to sign up doesn't already exist. Need to add a guard clause for this with a useful message to the user.
+
+Future developments
+---
+1. Add some more buttons to assist with navigating:
+  - On register page add a back button
+  - On log in page add a sign up button (or maybe as a link)
+2. Allow customers to delete their own peeps
+3. Add capability to heart peeps you like
+4. Add capability to reply to peeps and start a thread
+5. Be able to load pictures / gifs and videos
+5. Add CSS
+6. Tests could be refactored - currently there's a lot of repetition

app.rb

@@ -0,0 +1,57 @@
+require 'sinatra/base'
+require 'sinatra/flash'
+require 'uri'
+require './database_connection_setup'
+require './lib/user'
+require './lib/peep'
+
+class Chitter < Sinatra::Base
+
+  enable :sessions
+  register Sinatra::Flash
+
+  get '/peeps' do
+    @user = User.find(session[:user_id])
+    @peeps = Peep.all
+    erb :index
+  end
+
+  get '/peeps/new' do
+    Peep.create(peep: params[:peep], user_id: session[:user_id])
+    redirect '/peeps'
+  end
+
+  get '/users/new' do
+    erb :"users/new"
+  end
+
+  post '/users' do
+    user = User.create(name: params[:name], handle: params[:handle], email: params[:email], password: params[:password])
+    session[:user_id] = user.id
+    redirect '/peeps'
+  end
+
+  get '/sessions/new' do
+    erb :"sessions/new"
+  end
+
+  post '/sessions' do
+    user = User.authenticate(email: params[:email], password: params[:password])
+
+    if user
+      session[:user_id] = user.id
+      redirect '/peeps'
+    else
+      flash[:notice] = 'Please check your email or password.'
+      redirect '/sessions/new'
+    end
+  end
+
+  post '/sessions/destroy' do
+    session.clear
+    flash[:notice] = "You have logged out."
+    redirect '/peeps'
+  end
+
+  run! if app_file == $0
+end