Grateful Together API

Description:

This is the Backend API for the Grateful Together App. Grateful Together is an application that allows groups of people to keep a central, easy to use, daily gratitude journal. This was a collaborative capstone fullstack project for Mod 4 of Turing School of Software and Design.

Application Links:

Grateful Together App

Front End Repo

Back End API (Deployed via Heroku)

Tech Stack

• Ruby, Rails, WebSockets, ActiveRecord, PostgreSQL, Action-Cable-Testing, SimpleCov, RSpec, CI/CD with CircleCI

Usage

Installation Instructions

In order to run this application on your local machine, you'll need to have Ruby version 3.2.2, Rails 7.0.2.2 and PostgreSQL 14.

1. Clone this repo by executing:

git clone [email protected]:GratefulTogether/gratefultogether-api.git 

2. Install Gems:

bundle install 

3. Create and seed the development database:

rails db:{create,migrate,seed} 

Endpoints

Returns all gratitude entries for today:

GET /api/v1/wins

If no entries have yet been recorded, this endpoint will return an empty array, thus:

{
  data: []
}

Returns all gratitude entries for a specific date (add the date in query parameters):

GET /api/v1/wins?date=2023-08-31

If no entries are recorded for a day, this endpoint will return an empty array, thus:

{
  data: []
}

Post a new gratitude entry:

POST /api/v1/wins

If a POST request contains an invalid date or no entry, this will throw an "unprocessable_entity" error.

JSON Contract

Request all wins for today:

GET {{domain}}/api/v1/wins

Example response:

{
    "data": [
        {
            "id": 1,
            "type": "win", 
            "attributes": {
                "user_name": "Neato",
                "entry": "slept well",
                "created_at": "2023-08-24"
            }
        }, 
        {
            "id": 2,
            "type": "win", 
            "attributes": {
                "user_name": "Circe",
                "entry": "love my cats",
                "created_at": "2023-08-24"
            }
        }  
    ]
}

---

Request wins for a single date:

GET {{domain}}/api/v1/wins?date=2023-08-24

Example response:

{
    "data": [
        {
            "id": 1,
            "type": "win", 
            "attributes": {
                "user_name": "Wolfie",
                "entry": "slept well",
                "created_at": "2023-08-24"
            }
        }, 
        {
            "id": 2,
            "type": "win", 
            "attributes": {
                "user_name": "Squeaky",
                "entry": "love my cats",
                "created_at": "2023-08-24"
            }
        }, 
        {
            "id": 3,
            "type": "win", 
            "attributes": {
                "user_name": "Maggie",
                "entry": "smelled some rain",
                "created_at": "2023-08-24"
            }
        }, 
        {
            "id": 4,
            "type": "win", 
            "attributes": {
                "user_name": "Ink-Jet Printer",
                "entry": "grateful for coffee",
                "created_at": "2023-08-24"
            }
        } 
    ]
}

---

Request to post a new win

POST {{domain}}/api/v1/wins

JSON Body:

{
    "user_id": 1, 
    "message": "I fed the feral cat tuna, and it made me happy this morning."
}

Response:

{
    "data": {
        "id": "42",
        "type": "win",
        "attributes": {
            "user_name": "Wolfie",
            "entry": "I fed the feral cat tuna, and it made me happy this morning.",
            "created_at": "2023-08-29T19:16:04.580Z"
        }
    }
}

Learning Goals:

Develop a fullstack application in collaboration with a frontend team. Specifically, the backend team was tasked with creating a RESTful API service for the Grateful Together application, implementing at least one new technology. Our team also learned and executed an agile process from planning to development, through production, as well as a CI/CD process using CircleCI.

New Technologies implemented:

• ActionCable
• WebSockets
• Action-Cable-Testing
• CI/CD with CircleCI

---

Contributors

Kailey Kaes: Github, LinkedIn

Jesse Sorman: Github, LinkedIn

K.D. Hubbard: Github, LinkedIn

Steven Stackhouse: Github, LinkedIn