README

UFOMG_BE

Table of Contents

• What it does
• Contributors
• Schema
• Virtual Environment Setup
• Dependencies
• Database Setup
• Testing
• API Endpoints

What it does

This repository is part of a service-oriented architecture application that allows users to report indivdual experiences with unidentified flying objects and/or extraterrestrial beings. Serving as the backend to the ufomg-fe repository, ufomg_be takes user input and creates unique instances of encounter reports. In the spirit of the project's theme, there is no account registration or account login...users may remain annonymous. Users also have the ability to leave comments on individual sightings.

To view the front-end production site, please visit the UFOMG link.

To view the other components of the application please visit the Github Project Organization.

Contributors

• Austin Aspaas Github | LinkedIn
• Hanna Davis Github | LinkedIn
• Philip DeFraties Github | LinkedIn
• Todd Estes Github | LinkedIn

Schema

Virtual Environment Setup

For usage on your local machine follow the instructions listed below:

git clone [email protected]:UFOMG/ufomg_be.git
cd ufomg_be

# build a virtual environment to install your Python packages
python3 -m venv ./venv

# 'activate' the virtual environment for your project
# do this every time you start a new terminal and enter your project folder
source venv/bin/activate

# install your Python packages
pip3 install -r requirements.txt

To shut off your virtual environment, run deactivate at a terminal where you have an active virtual environment.

Dependencies

Flask==1.1.2
Flask-RESTful==0.3.8
Flask-SQLAlchemy==2.4.4
psycopg2-binary==2.8.6
SQLAlchemy==1.3.19
flask_migrate==2.5.3
flask-script==2.0.6
Flask-Cors==3.0.9
bleach==3.2.1
pytest==6.1.0
coverage==5.3
gunicorn==20.0.4
pep8==1.7.1
pycodestyle==2.6.0

Database Setup

createdb ufomg_dev
createdb ufomg_test

export DATABASE_URL=postgresql://localhost:5432/ufomg_dev

# examine any database models you have set up
python3 manage.py db migrate

# "upgrade" your database schema to use the changes you've made in your models
python3 manage.py db upgrade

# then apply the same for your test database:
export DATABASE_URL=postgresql://localhost:5432/ufomg_test
python3 manage.py db upgrade

Testing

export DATABASE_URL=postgresql://localhost:5432/ufomg_test
pytest

There should be 44 passing tests with 100% test coverage.

API Endpoints

To send requests to your local server:

export DATABASE_URL=postgresql://localhost:5432/ufomg_dev
python3 run.py

The request URL will be http://localhost:5000

To send requests to the production API: The request URL will be https://ancient-mesa-60922.herokuapp.com/

Create New Report

POST /api/v1/reports
Required Request Body:

{
    "name": "Alien_Lover",
    "lat": 34.022003,
    "long": -84.361549,
    "description": "I saw a glowing orange saucer!",
    "event_type": "sighting",
    "image": "https://www.sacbee.com/latest-news/aygydt/picture240363531/alternates/LANDSCAPE_1140/cloudufo.jpg",
    "city": "Roswell",
    "state": "NM"
}

Response Body:

{
    "id": 1,
    "name": "Alien_Lover",
    "lat": 34.022003,
    "long": -84.36155,
    "event_type": "sighting",
    "description": "I saw a glowing orange saucer!",
    "image": "https://www.sacbee.com/latest-news/aygydt/picture240363531/alternates/LANDSCAPE_1140/cloudufo.jpg",
    "comments": [],
    "city": "Roswell",
    "state": "NM",
    "created_at": "03/04/2021, 03:56:40",
    "links": {
        "get": "/api/v1/reports/1",
        "delete": "/api/v1/reports/1",
        "index": "/api/v1/reports",
        "patch": "/api/v1/reports/1"
    },
    "success": true
}

Create New Comment

POST /api/v1/reports
Required Request Body:

{
    "text":"That's obviously a cloud...",
    "report_id":1
}

Response Body:

{
    "text": "That's obviously a cloud...",
    "report_id": 1,
    "created_at": "03/04/2021, 04:40:30",
    "success": true
}

Get All Reports

GET /api/v1/reports
Required Request Body:
none
Response Body:

{
    "success": true,
    "results": [
        {
            "id": 1,
            "name": "Alien_Lover",
            "lat": 34.022003,
            "long": -84.36155,
            "event_type": "sighting",
            "description": "I saw a glowing orange saucer!",
            "image": "https://www.sacbee.com/latest-news/aygydt/picture240363531/alternates/LANDSCAPE_1140/cloudufo.jpg",
            "city": "Roswell",
            "state": "NM",
            "created_at": "03/04/2021, 03:56:40",
            "links": {
                "get": "/api/v1/reports/1",
                "delete": "/api/v1/reports/1",
                "index": "/api/v1/reports",
                "patch": "/api/v1/reports/1"
            }
        },
        {
            "id": 2,
            "name": "Believer123",
            "lat": 37.2431,
            "long": -115.793,
            "event_type": "encounter",
            "description": "I found a dead body. Any idea what this could be?",
            "image": "https://i.insider.com/5ab52763d0965921008b46b8?width=1136&format=jpeg",
            "city": "Rachel",
            "state": "NV",
            "created_at": "03/04/2021, 04:34:35",
            "links": {
                "get": "/api/v1/reports/2",
                "delete": "/api/v1/reports/2",
                "index": "/api/v1/reports",
                "patch": "/api/v1/reports/2"
            }
        }
    ]
}

Get One Report by ID

GET /api/v1/reports/1
Append the id number at the end of the URI
Required Request Body:
none
Response Body:

{
    "id": 1,
    "name": "Alien_Lover",
    "lat": 34.022003,
    "long": -84.36155,
    "event_type": "sighting",
    "description": "I saw a glowing orange saucer!",
    "image": "https://www.sacbee.com/latest-news/aygydt/picture240363531/alternates/LANDSCAPE_1140/cloudufo.jpg",
    "comments": [
        "That's obviously a cloud..."
    ],
    "city": "Roswell",
    "state": "NM",
    "created_at": "03/04/2021, 03:56:40",
    "links": {
        "get": "/api/v1/reports/1",
        "delete": "/api/v1/reports/1",
        "index": "/api/v1/reports",
        "patch": "/api/v1/reports/1"
    },
    "success": true
}

{
    "text":"They have my ship at area 51",
    "report_id":1
}