Sidra Version Of Chitter Challenge

Gemfile

@@ -11,3 +11,12 @@ end
 group :development, :test do
   gem 'rubocop', '1.20'
 end
+
+gem "pg", "~> 1.4"
+
+gem "sinatra", "~> 3.0"
+gem "sinatra-contrib", "~> 3.0"
+gem "webrick", "~> 1.8"
+gem "rack-test", "~> 2.1"
+gem 'bcrypt', '~> 3.1.7'
+

Gemfile.lock

@@ -3,27 +3,37 @@ GEM
   specs:
     ansi (1.5.0)
     ast (2.4.2)
-    diff-lcs (1.4.4)
+    bcrypt (3.1.18)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    multi_json (1.15.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    parallel (1.22.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    regexp_parser (2.1.1)
+    pg (1.4.6)
+    rack (2.2.6.4)
+    rack-protection (3.0.5)
+      rack
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubocop (1.20.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -33,10 +43,11 @@ GEM
       rubocop-ast (>= 1.9.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -45,22 +56,42 @@ GEM
       simplecov
       terminal-table
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    terminal-table (3.0.1)
+    simplecov_json_formatter (0.1.4)
+    sinatra (3.0.5)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.0.5)
+      tilt (~> 2.0)
+    sinatra-contrib (3.0.5)
+      multi_json
+      mustermann (~> 3.0)
+      rack-protection (= 3.0.5)
+      sinatra (= 3.0.5)
+      tilt (~> 2.0)
+    terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.0.0)
+    tilt (2.1.0)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
+  bcrypt (~> 3.1.7)
+  pg (~> 1.4)
+  rack-test (~> 2.1)
   rspec
   rubocop (= 1.20)
   simplecov
   simplecov-console
+  sinatra (~> 3.0)
+  sinatra-contrib (~> 3.0)
+  webrick (~> 1.8)
 
 RUBY VERSION
    ruby 3.0.2p107
 
 BUNDLED WITH
-   2.2.26
+   2.4.10

README.md

@@ -1,73 +1,36 @@
-Chitter Challenge
-=================
+<a name="readme-top"></a>
 
-* 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 10am Monday morning
+# _Chitter Challenge_
 
-Challenge:
--------
+#### By _**Sidra Iqbal, adapted from Makers Academy**_
 
-As usual please start by forking this repo.
+Technologies Used
+-----
 
-We are going to write a small Twitter clone that will allow the users to post messages to a public stream.
+* Ruby
+* CSS
+* HTML
+* Postgresql
+* Sinatra
 
-Features:
+Description:
 -------
 
-```
-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
-
-HARDER
-
-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
-```
-
-Technical Approach:
------
+This project is designed to mimic the popular 'Twitter' app for Makers student use. Chitter will have basic functionality like: creating peeps, viewing peeps (including the time of peep in chronological order), as well as login, sign-up and logout capabilities. 
 
-In the last two weeks, you integrated a database using the `pg` gem and Repository classes. You also implemented small web applications using Sinatra, RSpec, HTML and ERB views to make dynamic webpages. You can continue to use this approach when building Chitter Challenge.
+The user should have visibility to the login and register links when they are not logged in and similarly only have visibility to the sign-out link when they are logged in, to give a positive user experience. 
 
-You can refer to the [guidance on Modelling and Planning a web application](https://github.com/makersacademy/web-applications/blob/main/pills/modelling_and_planning_web_application.md), to help you in planning the different web pages you will need to implement this challenge. If you'd like to deploy your app to Heroku so other people can use it, [you can follow this guidance](https://github.com/makersacademy/web-applications/blob/main/html_challenges/07_deploying.md).
+[![Screenshot of main page](https://i.imgur.com/g3bzkKR.png)](https://chitter-app-59gf.onrender.com/)
 
-If you'd like more technical challenge now, try using an [Object Relational Mapper](https://en.wikipedia.org/wiki/Object-relational_mapping) as the database interface, instead of implementing your own Repository classes.
 
-Some useful resources:
-**Ruby Object Mapper**
-- [ROM](https://rom-rb.org/)
+Features:
+-------
 
-**ActiveRecord**
-- [ActiveRecord ORM](https://guides.rubyonrails.org/active_record_basics.html)
-- [Sinatra & ActiveRecord setup](https://learn.co/lessons/sinatra-activerecord-setup)
+* Register: User can register to Chitter with their email and create an account with a username and password. 
+* Login: User can login to their account from the homepage by entering their email address and password.
+* Logout: User can logout from the homepage by clicking on the logout link. 
+* New Peep: Logged in user can have the option to create a new peep by clicking the new peep link on the homepage, where they are directed to the /new_peep page and can submit a peep
+* View Peeps: Irrespective of logged in status, peeps will be shown on the homepage in order of the most recent peep first. The peep contents and time are shown on the homepage.
 
 Notes on functionality:
 ------
@@ -76,48 +39,33 @@ Notes on functionality:
 * 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.
-
-Bonus:
------
-
-If you have time you can implement the following:
-
-* 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
------------
+Installation & Requirements
+------
 
-In code review we'll be hoping to see:
+Clone the repo and add the relevant gems:
 
-* All tests passing
-* High [Test coverage](https://github.com/makersacademy/course/blob/main/pills/test_coverage.md) (>95% is good)
-* The code is elegant: every class has a clear responsibility, methods are short etc.
+```
+git clone https://github.com/siqbal181/chitter-challenge.git
+gem install sinatra -v '~> 3.0'
+gem install sinatra-contrib -v '~> 3.0'
+gem install webrick -v '~> 1.8'
+gem install rack-test -v '~> 2.1'
+gem install bcrypt -v '~> 3.1.7'
+gem install pg -v '~> 1.4'
+```
 
-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 at this moment.
+Testing:
+```ruby
+gem 'rspec'
+gem 'simplecov', require: false
+gem 'simplecov-console', require: false
+```
 
-Notes on test coverage
-----------------------
+## Contact
 
-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:
+Sidra Iqbal 
 
-```ruby
-require 'simplecov'
-require 'simplecov-console'
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::Console,
-  # Want a nice code coverage website? Uncomment this next line!
-  # SimpleCov::Formatter::HTMLFormatter
-])
-SimpleCov.start
-```
+Project Link: [https://github.com/siqbal181/chitter-challenge](https://github.com/siqbal181/chitter-challenge)
 
-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!
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

app.rb

@@ -0,0 +1,99 @@
+require 'sinatra'
+require "sinatra/reloader"
+require_relative 'lib/database_connection'
+require_relative 'lib/peep_repository'
+require_relative 'lib/user_repository'
+require 'date'
+
+DatabaseConnection.connect('chitter_database')
+
+class Application < Sinatra::Base
+  configure :development do
+    register Sinatra::Reloader
+  end
+
+  enable :sessions
+
+  get '/' do
+    repo = PeepRepository.new
+    @peeps = repo.all
+
+    if session[:email_address]
+      user_repo = UserRepository.new
+      @user = user_repo.find_by_email(session[:email_address])
+    end
+
+    return erb(:homepage)
+  end  
+
+  get '/register' do
+    return erb(:register)
+  end
+
+  post '/register' do # once user has registered
+    unless params[:email_address].include?('@')
+      status 400
+      return ''
+    end
+
+    repo = UserRepository.new
+    user = User.new
+    user.email_address = params['email_address']
+    user.username = params['username']
+    user.password = params['password']
+    repo.create(user)
+
+    redirect '/'
+  end
+
+  get '/login' do
+    return erb(:login)
+  end
+
+  post '/login' do
+    email_address = params[:email_address]
+    password = params[:password]
+
+    user = UserRepository.new.find_by_email(email_address)
+
+    if user && user.password == password
+      session[:email_address] = user.email_address
+
+      peep_repo = PeepRepository.new
+      @peeps = peep_repo.all
+      @user = user
+      erb(:homepage)
+    else
+      @error = true
+      erb(:login)
+    end
+  end  
+
+  get '/logout' do
+    session.clear
+    redirect '/'
+  end
+
+  get '/new_peep' do
+    return erb(:new_peep)
+  end
+
+  post '/new_peep' do
+    contents = params[:contents]
+
+    if session[:email_address]
+      @user = UserRepository.new.find_by_email(session[:email_address])
+    end
+
+    peep_repo = PeepRepository.new
+    new_peep = Peep.new
+    new_peep.contents = contents
+    new_peep.time = Time.now.strftime("%d/%m/%Y %H:%M")
+    new_peep.user_id = @user.id
+    new_peep.username = @user.username
+    peep_repo.create_peep(new_peep)
+    @peeps = peep_repo.all
+
+    return erb(:homepage)
+  end
+end

config.ru

@@ -0,0 +1,3 @@
+# file: config.ru
+require './app'
+run Application