/messages-from-the-stars-demo-be

Primary LanguageRuby

README

Intro

This is the backend repository for Messages From the Stars, an application allowing users to 'attach' messages to satellites passing over their location, receive messages that other users have attached to satellites, and track the locations of their messages around the world.

Deployed Application

Frontend Repository

Contributors (in reverse alphabetical order):

@tig-o

@philmarcu

@mikekoul

@jonathanmpope

@alepbloyd

Database Design And Schema

image

API Endpoints

GET /api/v1/satellites/find_by_user_id?user_id={{user_id}}

Returns all satellites associated with provided user_id.

Example request

https://messages-from-the-stars-be.herokuapp.com/api/v1/satellites/find_by_user_id?user_id=1

Example response:

  {
    "data": [
        {
            "id": "117",
            "type": "satellite",
            "attributes": {
                "norad_id": 3597
            }
        },
        {
            "id": "123",
            "type": "satellite",
            "attributes": {
                "norad_id": 837
            }
        }
    ]
}

GET /api/v1/messages/find_by_sat_id?sat_id={{sat_id}}

Returns all messages associated with provided satellite database ID.

https://messages-from-the-stars-be.herokuapp.com/api/v1/messages/find_by_sat_id?sat_id=3

Example response:

  {
    "data": [
        {
            "id": "36",
            "type": "message",
            "attributes": {
                "satellite_id": 3,
                "start_lat": 25.72070389115322,
                "start_lng": -147.91088486228148,
                "content": "Rich gifts wax poor when givers prove unkind.",
                "created_at": "2021-11-29T13:20:35.000Z",
                "updated_at": "2022-09-14T05:20:30.000Z"
            }
        }
    ]
}

GET /api/v1/messages/find_by_norad_id?norad_id={{norad_id}}

Returns a count of all messages associated with given NORAD ID.

  • Example request:
https://messages-from-the-stars-be.herokuapp.com/api/v1/messages/find_by_norad_id?norad_id=27763
  • Example response:
[
    "27763",
    5
]

POST /api/v1/user_satellite/create_user_satellite?user_id={{user_id}}&sat_id={{sat_id}}

Creates a user_satellite instance, associating a user and a satellite object. This is triggered when a user creates a new message, adding that satellite to that user's list of 'tracked' satellites on their dashboard.

  • Example request:
https://messages-from-the-stars-be.herokuapp.com/api/v1/user_satellite/create_user_satellite?user_id=1&sat_id=217
  • Example response:
201 Success

GET /api/v1/find_or_create_user?username={{username/email}}&name={{name}}

Finds an existing user in the database, or creates a new user if not found. Used in tandem with OAuth on front-end, allowing User table to be stored in backend database with utilizing OAuth for user authentication.

  • Example request:
https://messages-from-the-stars-be.herokuapp.com/api/v1/users/find_or_create_user?name=Example+Name&username=ExampleEmail%40test.com
  • Example response:
{
    "data": {
        "id": "47",
        "type": "user",
        "attributes": {
            "name": "Example Name",
            "username": "ExampleEmail@test.com"
        }
    }
}

GET /api/v1/satellites/{{sat_id}}

Returns satellite object by database ID. Example request:

https://messages-from-the-stars-be.herokuapp.com/api/v1/satellites/120

Example response:

{
    "data": {
        "id": "120",
        "type": "satellite",
        "attributes": {
            "norad_id": 877
        }
    }
}

POST /api/v1/satellites?sat_id={{norad_id}}

Creates a new satellite instance in the database if it does not already exist. Example request:

https://messages-from-the-stars-be.herokuapp.com/api/v1/satellites?sat_id=877

Example response:

201 created
120

POST /api/v1/messages

Accepts application/json post request. Requires including all message params in the request.

Example request:

{
  "satellite_id": 120,
  "start_lat": 70.7,
  "start_lng": 80.8,
  "content": "test message"
}

Example response:

{
    "data": {
        "id": "132",
        "type": "message",
        "attributes": {
            "satellite_id": 120,
            "start_lat": 70.7,
            "start_lng": 80.8,
            "content": "test message",
            "created_at": "2022-09-22T03:18:26.082Z",
            "updated_at": "2022-09-22T03:18:26.082Z"
        }
    }
}

GET /api/v1/messages/{{message_id}}

  • Returns information about message associated with given ID, including message contents, satellite the message is associated with, and the location it was sent from.
  • Example request:
https://messages-from-the-stars-be.herokuapp.com/api/v1/messages/1
  • Example response:
{
    "data": {
        "id": "1",
        "type": "message",
        "attributes": {
            "satellite_id": 7,
            "start_lat": -6.700576759545427,
            "start_lng": 178.10153887995511,
            "content": "A little more than kin, and less than kind.",
            "created_at": "2022-04-18T20:32:53.000Z",
            "updated_at": "2022-01-31T16:42:06.000Z"
        }
    }
}