Ha Nguyen Chitter Solo Project

.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
-
+rvm:
+  - 3.0.0
+  - jruby
 services:
   - postgresql
 

Gemfile

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

Gemfile.lock

@@ -3,11 +3,37 @@ GEM
   specs:
     ansi (1.5.0)
     ast (2.4.2)
+    bcrypt (3.1.18)
+    date (3.3.3)
     diff-lcs (1.4.4)
     docile (1.4.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    mini_mime (1.1.2)
+    multi_json (1.15.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pg (1.5.3)
+    rack (2.2.7)
+    rack-protection (3.0.6)
+      rack
+    rack-test (2.1.0)
+      rack (>= 1.3)
     rainbow (3.0.0)
     regexp_parser (2.1.1)
     rexml (3.2.5)
@@ -36,6 +62,7 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -46,21 +73,43 @@ GEM
       terminal-table
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
+    sinatra (3.0.6)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.0.6)
+      tilt (~> 2.0)
+    sinatra-contrib (3.0.6)
+      multi_json
+      mustermann (~> 3.0)
+      rack-protection (= 3.0.6)
+      sinatra (= 3.0.6)
+      tilt (~> 2.0)
     terminal-table (3.0.1)
       unicode-display_width (>= 1.1.1, < 3)
+    tilt (2.1.0)
+    timeout (0.3.2)
     unicode-display_width (2.0.0)
+    webrick (1.8.1)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
+  bcrypt
+  mail (~> 2.8)
+  pg (~> 1.5)
+  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.12

README.md

@@ -1,30 +1,106 @@
-Chitter Challenge
-=================
+# Ha Nguyen - Chitter Challenge Readme
 
-* 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
+# Approach
 
-Challenge:
--------
+- Ruby Sinatra
+- PostgreSQL database
+- Two tables: users, peeps and corresponding models. One foreign key.
+- TDD: Design a Class system and Test drive a class system, Unit testing classes
+  ....
+
+# Set Up App
+
+```
+# Install gems for the project
+
+bundle install
+# Create a chitter-development postgresql database
+# Migrate tables and columns to database
+# Seed database
+# Rackup!
+rackup
+
+```
+
+# Test
+
+```
+# Rspec tests included run:
+rspec
+
+![Screenshot](test coverage.png)
+```
+
+# Features
+
+- Sign in and sign out
+- Sign up
+- See all peeps with time and author name, in reverse chronological order
+- Create a peep
+- 'bcrypt' gem used for password protection when stored in database
+
+# User Story
+
+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
+
+---
+
+# Original Brief from Makers Academy: Chitter Challenge
+
+# Chitter Challenge
+
+- 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
+
+## 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:
--------
+## Features:
 
 ```
 STRAIGHT UP
 
 As a Maker
-So that I can let people know what I am doing  
+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  
+So that I can see what others are saying
 I want to see all peeps in reverse chronological order
 
 As a Maker
@@ -52,8 +128,7 @@ 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:
------
+## Technical Approach:
 
 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.
 
@@ -63,47 +138,45 @@ If you'd like more technical challenge now, try using an [Object Relational Mapp
 
 Some useful resources:
 **Ruby Object Mapper**
+
 - [ROM](https://rom-rb.org/)
 
 **ActiveRecord**
+
 - [ActiveRecord ORM](https://guides.rubyonrails.org/active_record_basics.html)
 - [Sinatra & ActiveRecord setup](https://learn.co/lessons/sinatra-activerecord-setup)
 
-Notes on functionality:
-------
+## Notes on functionality:
 
-* 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.
+- 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.
 
-Bonus:
------
+## 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.
+- 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.
+- Work on the CSS to make it look good.
 
 Good luck and let the chitter begin!
 
-Code Review
------------
+## Code Review
 
 In code review we'll be hoping to see:
 
-* 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.
+- 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.
 
-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.
+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.
 
-Notes on test coverage
-----------------------
+## Notes on test coverage
 
 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: