seen-task

seen-task

Seen-task is the implementation of REST service. It allows to provide information about video recipients and corresponding events. Additionally it supports creation of new recipients and events.

Table of Contents

1. Getting Started
2. Dependencies
3. Environment variables
4. Secrets
5. Database
6. Run the server
7. Authentication
8. Testing

Getting started

• Install golang, git, docker and docker-compose.

Dependencies

To fetch dependencies, run:

$ go mod download

If things start getting messy, run:

$ go mod tidy

Environment variables

Secrets

The following secret variables are stored in the secrets.env file which is typically should be excluded from the repo (here is just for the demo):

• db_user
• db_password
• auth_user
• auth_password

This will overwrite environment variables.

Database

PostgreSql is used for storing data. Gorm is used to perform queries and map database records to structures.

You can run database in the container by typing the following command in the terminal:

$ docker-compose up

Database will use the port 5432.

You can open a admin interface of the db by going to the Admin Interface.

Login credentials:

• System: PostgreSQL
• Server: postgre
• Username: root
• Password: root
• Database: seen

Run the server

To run the server, open the second terminal and run:

$ go run main.go

It will be running at http://localhost:8080

Endpoints

Get all recipients (any query argument will be used for searching in the database):

GET api/recipients?name=&email=&phone=

Get specific recipient by id:

GET api/recipients/:id

Create new recipient:

POST api/recipients

Create new event:

POST api/events

Authentication

Basic auth is used for authentication. Use basic auth with username: seen and password: pass. Or simply pass this token c2VlbjpwYXNz to the Authentication header when sending requests to the server.

Testing

To test everything, run:

$ go test ./...

To test everything with coverage info, run:

$ go test ./... -cover