About

This is the back-end repo of a SPA that lets users have a CRUDable database of their gear and projects.

I took two approaches for this project. This is because I had to balance all the tools at my disposal and the fact that I only had less than a week to meet all the requirements.

I first deployed my app without a framework and used JQuery and AJAX instead. Since I had done this before I knew it would be quick with no major hurdles and it seemed promising within 2 days.

With 4 days left, I took on the challenge of implementing Ember as the frontend framework. After making no progress after 2 days, I decided to go back to the other version and improve it: adding a second resource to the backend, great visuals, slick functionality, and overcoming hurdles.

One of the tougher challenges, was users being able to see a previous user's resources for a second before the handlebars injected the current user's resources. I overcame this after many different approaches. However, the last, which was the most simple, was successful. I created an empty handlebar which would be inserted (and replace the past handlebar) when a user signed out. Therefore, old data is not 'hidden' behind other divs, but is removed totaly from the browser.

Dependencies

Bundle install

Technologies used

The API is deployed using Heroku with the relational database of PostgreSQL. The code is developed using Ruby and Ruby-on-Rails. The resource my_gears was scaffolded and related to user before scaffolding projects and then creating the relationship to user.

ERD

Links

• Front-end repo: https://github.com/doremaxime/gear-frontend
• Heroku: https://capstone-project-gear.herokuapp.com
• Website: https://doremaxime.github.io/gear-frontend/

ROUTES

User Authorization

Verb	URI Pattern	Controller#Action
POST	/sign-up	users#signup
POST	/sign-in	users#signin
PATCH	/change-password/:id	users#changepw
DELETE	/sign-out/:id	users#signout

POST / sign-up

EMAIL="m" PASSWORD="m" PASSWORD_CONFIRMATION="m" sh scripts/sign-up.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/sign-up"
curl "${API}${URL_PATH}" \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "'"${EMAIL}"'",
      "password": "'"${PASSWORD}"'",
      "password_confirmation": "'"${PASSWORD}"'"
    }
  }'

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{"user":{"id":1,"email":"m"}}

POST / sign-in

EMAIL="m" PASSWORD="m" PASSWORD_CONFIRMATION="m" sh scripts/sign-in.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/sign-in"
curl "${API}${URL_PATH}" \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "credentials": {
      "email": "'"${EMAIL}"'",
      "password": "'"${PASSWORD}"'",
      "password_confirmation": "'"${PASSWORD}"'"
    }
  }'

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"user":{"id":1,"email":"m","token":"BAhJIiVjYjE3OTEyNmU2MmRiZWJiZGMxYzVjYjRmM2Q2YTA1ZAY6BkVG--33bf2e33670b0c1e457bdd3fd14d475119486e48"}}

PATCH / change-password

ID=1 TOKEN="BAhJIiVjYjE3OTEyNmU2MmRiZWJiZGMxYzVjYjRmM2Q2YTA1ZAY6BkVG--33bf2e33670b0c1e457bdd3fd14d475119486e48" OLDPW="m" NEWPW="o" sh scripts/change-password.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/change-password"
curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request PATCH \
  --header "Authorization: Token token=${TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "passwords": {
      "old": "'"${OLDPW}"'",
      "new": "'"${NEWPW}"'"
    }
  }'

HTTP/1.1 204 No Content

DELETE / sign-out

ID=1 TOKEN="BAhJIiVjYjE3OTEyNmU2MmRiZWJiZGMxYzVjYjRmM2Q2YTA1ZAY6BkVG--33bf2e33670b0c1e457bdd3fd14d475119486e48" sh scripts/sign-out.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/sign-out"
curl "${API}${URL_PATH}/${ID}" \
  --include \
  --request DELETE \
  --header "Content-Type: application/json" \
  --header "Authorization: Token token=$TOKEN"

HTTP/1.1 204 No Content

My_gear

Verb	URI Pattern	Controller#Action
POST	/my_gears	my_gear#create
GET	/my_gears	my_gears#index
PATCH	/my_gears/:id	my_gears#update
DELETE	/my_gears/:id	my_gears#destroy

POST / create

TOKEN="BAhJIiU3NTY5NDNiZTE5YzQ4NzdkM2E4Y2ZlYzA5NjI0OGY5YQY6BkVG--c537229f3e5ec10043b000ed934f0221acc17d76" NAME="rope" QUANTITY=2 sh scripts/my_gears/create.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/my_gears"
curl "${API}${URL_PATH}" \
  --include \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{
    "my_gear": {
      "name": "'"${NAME}"'",
      "quantity": "'"${QUANTITY}"'"
      }
    }' \
  --header "Authorization: Token token=$TOKEN"

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{"my_gear":{"id":1,"name":"rope","quantity":2}}

GET / index

TOKEN="BAhJIiU3NTY5NDNiZTE5YzQ4NzdkM2E4Y2ZlYzA5NjI0OGY5YQY6BkVG--c537229f3e5ec10043b000ed934f0221acc17d76" sh scripts/my_gears/index.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/my_gears"
curl "${API}${URL_PATH}" \
  --include \
  --request GET \
  --header "Authorization: Token token=$TOKEN"
echo

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"my_gears":[{"id":1,"name":"rope","quantity":2},{"id":2,"name":"cams","quantity":10}]}

PATCH / update

ID=2 TOKEN="BAhJIiU3NTY5NDNiZTE5YzQ4NzdkM2E4Y2ZlYzA5NjI0OGY5YQY6BkVG--c537229f3e5ec10043b000ed934f0221acc17d76" NAME="cams" QUANTITY=3 sh scripts/my_gears/update.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/my_gears/${ID}"
curl "${API}${URL_PATH}" \
  --include \
  --request PATCH \
  --header "Content-Type: application/json" \
  --data '{
    "my_gear": {
      "name": "'"${NAME}"'",
      "quantity": "'"${QUANTITY}"'"
      }
    }' \
  --header "Authorization: Token token=$TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"my_gear":{"id":2,"name":"cams","quantity":3}}

DELETE / destroy

ID=2 TOKEN="BAhJIiU3NTY5NDNiZTE5YzQ4NzdkM2E4Y2ZlYzA5NjI0OGY5YQY6BkVG--c537229f3e5ec10043b000ed934f0221acc17d76" sh scripts/my_gears/destroy.sh

API="${API_ORIGIN:-http://localhost:4741}"
URL_PATH="/my_gears/${ID}"
curl "${API}${URL_PATH}" \
  --include \
  --request DELETE \
  --header "Authorization: Token token=$TOKEN"

HTTP/1.1 204 No Content

Projects

Verb	URI Pattern	Controller#Action
POST	/projects	project#create
GET	/projects	projects#index
PATCH	/projects/:id	projects#update
DELETE	/projects/:id	projects#destroy

POST / create

TOKEN="BAhJIiU1YWYzMTJhZjU0YjBhNjlmODlhYmJmZWJmOGYxZmNjOAY6BkVG--5f22f05bd96584b35dd7c7830524a7994521e0dd" COMMENT="gonna clib half dome" sh scripts/projects/create.sh

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{"project":{"id":2,"comment":"gonna clib half dome"}}

GET / Index

TOKEN="BAhJIiU1YWYzMTJhZjU0YjBhNjlmODlhYmJmZWJmOGYxZmNjOAY6BkVG--5f22f05bd96584b35dd7c7830524a7994521e0dd" sh scripts/projects/index.sh

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"projects":[{"id":1,"comment":"project infor asjfiosgjiog"},{"id":2,"comment":"gonna clib half dome"},{"id":3,"comment":"will need to climb in NC"}]}

PATCH / Update

ID=3 TOKEN="BAhJIiU1YWYzMTJhZjU0YjBhNjlmODlhYmJmZWJmOGYxZmNjOAY6BkVG--5f22f05bd96584b35dd7c7830524a7994521e0dd" COMMENT="will need to climb in australia" sh scripts/projects/update.sh

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"project":{"id":3,"comment":"will need to climb in australia"}}

DELETE / Destroy

ID=3 TOKEN="BAhJIiU1YWYzMTJhZjU0YjBhNjlmODlhYmJmZWJmOGYxZmNjOAY6BkVG--5f22f05bd96584b35dd7c7830524a7994521e0dd" sh scripts/projects/destroy.sh

HTTP/1.1 204 No Content