Task Distributer

How to start

This application is hosted by Heroku and uses a Postgres database.

Tools

It is recommended to have the Heroku CLI installed which would allow you to run locally or on your own dyno. However, this application is running on a dyno, https://ancient-mountain-96195.herokuapp.com/.
The tool that was used to view the Postgres data base is pgAdmin
For testing curl and or Postman was used.

Initializing

Clone the repo
Log into Heroku
Go to the task-distributer directory
Run heroku create

There should be a new git remote heroku

Run heroku addons:create heroku-postgresql:hobby-dev
If you wish to run locally, you would need to use the database url

Run heroku config:get DATABASE_URL -s >> .env.test

Running On Heroku

Run git push heroku master

Running Locally

Go to the task-distributer directory
Run go install
Run heroku local -e .env.test This will run the application using the Postgres database on port 5000. Please note, the before testing you may need to make sure that all of the tasks are completed.

Limitations

There are some limitations that should be noted:

Unit Tests
- Testing was done via curl and postman, however testing was limited due to mocking of the database (go-sqlmock was being considered but was unable to get it to work properly)
Additional APIs
- It might be nice to have a task API which would return all of the tasks from a status and start date range.
Code structure
- I was attempting to structure the code for a good coding user experience. However, I think that there are some short comings to this.

Database Schema

Skills

The skills table contains all of the skills which an agent can possess.

Field	Type	Required	Description
skill	VARCHAR(100)	yes	The primary key and the skill.
description	TEXT	yes	A description of the skill.

Agents

The agents table contains all of the agents that can be assigned a task.

Field	Type	Required	Description
id	VARCHAR(10)	yes	The primary key, like an agent number.
firstname	VARCHAR(100)	yes	The first name of the agent, like John.
lastname	VARCAHR(100)	yes	The last name of the agent, like Doe.

Agent Skills

The agentskills table is a juntion object which links a skill(s) to an agent.

Field	Type	Required	Description
id	VARCHAR(10)	yes	The primary key for the table.
skill	VARCHAR(100)	yes	The reference to the skill.skill field.
agent	VARCAHR(10)	yes	The reference to the agent.id field.

Priorities

The priorities table defines the priority name and the associated level.

Field	Type	Required	Description
priority	VARCHAR(100)	yes	The primary key for the table and the name of the priority like low.
priority_level	INT	yes	The level as a number. If the priority is high, the number will be higher. For example, level 2 is higher than level 1.

Tasks

The tasks table defines the task that was assigned.

Field	Type	Required	Description
id	VARCHAR(100)	yes	The primary key for the table.
createdate	TIMESTAMP	yes	The date and time when the task was assigned.
name	TEXT	yes	The name of the task, like 'My Cool Task'
skills	TEXT[]		The skills that are associated with the task.
priority	VARCHAR(100)	yes	The priority of the task which reference priorities.priority
status	VARCHAR(100)	yes	The status of the task, like 'Assigned'
completedate	TIMESTAMP		The date and time of when the task was completed by the agent
agent	VARCHAR(10)	yes	The reference, agent.id, to the agent assigned the task

APIs

The following are the APIs that are currently supported.

Create Task

This API will accept a task and attempt to distribute it to an available agent.

URI

/v1/task/create

Content Type

JSON

HTTP Method

POST

Parameters

None.

Request Body

Field	Required	Type	Description
name	yes	string	The name of the task
skills	yes	array of strings	An array of skills required by the task. Accepted skills are skill1, skill2, and skill3
priority	yes	string	The priority of the task. Accepted priorities are low and high.

{
	"name": "Test Name",
	"skills": ["skill1"],
	"priority": "high"
}

Response Body

Field	Type	Description
success	bool	If the application was successfully distributed to an agent.
task	object	Description of the task with the assigned agent. Only present if success is true
error_message	string	A description of the error that occured. Only present if sucess is false

Task

Field	Type	Description
id	string	UUID of the task. Can be used to access the status and setting of parameters.
name	string	The name of the task
skills	array of strings	An array of skills required by the task.
priority	string	The priority of the task.
start_time	Date and time	The date and time of when the task has been distributed to an agent
status	string	The status of the task, currently set to assigned.
complete_time	Date and time	The date and time of when the task was completed by the agent
agent	string	The UUID of the agent assigned to the task

Examples

curl -d '{"name": "Task Test","skills": ["skill1"],"priority": "low"}' -H "Content-Type: application/json" -X POST https://ancient-mountain-96195.herokuapp.com/v1/task/create

Success

{
    "success": true,
    "task": {
        "id": "bj7rmmrk7c874r7vb8ng",
        "name": "Test Name",
        "skills": [
            "skill1"
        ],
        "priority": "high",
        "status": "Assigned",
        "start_time": "2019-05-06T04:43:07.143378962Z",
        "complete_time": "0001-01-01T00:00:00Z",
        "assigned_agent": "1000"
    }
}

Errors

{
    "success":false,
    "error_message":"unable to find an agent to assign the task"
}

{
    "success":false,
    "error_message":"Invalid priority task priority is not supported zzz"
}

{
    "success":false,
    "error_message":"Required field missing name field must be present"
}

Task Status

This API will return the current status of a task.

URI

/v1/task/<task id>

Content Type

JSON

HTTP Method

GET

Parameters

None.

Reuest Body

None.

Response Body

Field	Type	Description
success	bool	If the application was successfully distributed to an agent.
task	object	Description of the task with the assigned agent. Only present if success is true
error_message	string	A description of the error that occured. Only present if sucess is false

Task

Field	Type	Description
id	string	UUID of the task. Can be used to access the status and setting of parameters.
name	string	The name of the task
skills	array of strings	An array of skills required by the task.
priority	string	The priority of the task.
start_time	Date and time	The date and time of when the task has been distributed to an agent
status	string	The status of the task, currently set to assigned.
complete_time	Date and time	The date and time of when the task was completed by the agent
agent	string	The UUID of the agent assigned to the task

Examples

curl https://ancient-mountain-96195.herokuapp.com/v1/task/bj7rmmrk7c874r7vb8ng

Success

{
    "success": true,
    "task": {
        "id": "bj7rmmrk7c874r7vb8ng",
        "name": "Test Name",
        "skills": [
            "skill1"
        ],
        "priority": "high",
        "status": "Assigned",
        "start_time": "2019-05-06T04:43:07.143378962Z",
        "complete_time": "0001-01-01T00:00:00Z",
        "assigned_agent": "1000"
    }
}

Errors

{
    "success":false,
    "error_message":"Task bj7s9crv2l7ljuu409u01aaa is not present"
}

Task Complete

This API will set the task status as complete and the completion date.

URI

v1/task/complete/<task id>

Content Type

JSON

HTTP Method

GET

Parameters

None.

Reuest Body

None.

Response Body

Field	Type	Description
success	bool	If the application was successfully distributed to an agent.
error_message	string	A description of the error that occured. Only present if sucess is false

Examples

curl https://ancient-mountain-96195.herokuapp.com/v1/task/complete/bj7rmmrk7c874r7vb8ng

Success

{
    "success": true
}

Errors

{
    "success":false,
    "error_message":"Task bj7s9crv2l7ljuu409u01aaa is not present"
}

Agent List

This API returns the current agents and all assigned tasks.

URI

v1/agent/list

Content Type

JSON

HTTP Method

GET

Parameters

None.

Reuest Body

None.

Response Body

Field	Type	Description
success	bool	If the application was successfully distributed to an agent.
agent_tasks	[]object	The list of agents and the tasks. Only present if success is true
error_message	string	A description of the error that occured. Only present if sucess is false

Agent Tasks

Field	Type	Description
id	string	UUID of the agent.
first_name	string	The first name of the agent.
last_name	string	The last name of the agent.
tasks	[]task	A list of task assigned to the agent.

Task

Field	Type	Description
id	string	UUID of the task. Can be used to access the status and setting of parameters.
name	string	The name of the task
skills	array of strings	An array of skills required by the task.
priority	string	The priority of the task.
start_time	Date and time	The date and time of when the task has been distributed to an agent
status	string	The status of the task, currently set to assigned.
complete_time	Date and time	The date and time of when the task was completed by the agent
agent	string	The UUID of the agent assigned to the task

Example

curl https://ancient-mountain-96195.herokuapp.com/v1/agent/list

Success

{
    "success": true,
    "agent_tasks": [
        {
            "id": "1003",
            "first_name": "Jazz",
            "last_name": "Hands",
            "tasks": [
                {
                    "id": "bj7rmijk7c874r7vb8mg",
                    "name": "Test Name",
                    "skills": [
                        "skill1"
                    ],
                    "priority": "low",
                    "status": "Assigned",
                    "start_time": "2019-05-06T04:42:50.893529Z",
                    "complete_time": "0001-01-01T00:00:00Z",
                    "assigned_agent": "1003"
                },
                {
                    "id": "bj7rmmbk7c874r7vb8n0",
                    "name": "Test Name",
                    "skills": [
                        "skill1"
                    ],
                    "priority": "high",
                    "status": "Assigned",
                    "start_time": "2019-05-06T04:43:05.237697Z",
                    "complete_time": "0001-01-01T00:00:00Z",
                    "assigned_agent": "1003"
                }
            ]
        },
        {
            "id": "1000",
            "first_name": "Bighead",
            "last_name": "Burton",
            "tasks": [
                {
                    "id": "bj7rmmrk7c874r7vb8ng",
                    "name": "Test Name",
                    "skills": [
                        "skill1"
                    ],
                    "priority": "high",
                    "status": "Assigned",
                    "start_time": "2019-05-06T04:43:07.143836Z",
                    "complete_time": "0001-01-01T00:00:00Z",
                    "assigned_agent": "1000"
                }
            ]
        },
        {
            "id": "1001",
            "first_name": "Ovaltine",
            "last_name": "Jenkins"
        },
        {
            "id": "1002",
            "first_name": "Ground",
            "last_name": "Control"
        }
    ]
}

Name		Name	Last commit message	Last commit date
Latest commit History 18 Commits
vendor		vendor
.env.test		.env.test
Procfile		Procfile
README.md		README.md
agent.go		agent.go
handlers.go		handlers.go
init.sql		init.sql
server.go		server.go
sql.go		sql.go
task.go		task.go
task_test.go		task_test.go

g8rswimmer/task-distributer

Folders and files

Latest commit

History

Repository files navigation

Task Distributer

How to start

Tools

Initializing

Running On Heroku

Running Locally

Limitations

Database Schema

Skills

Agents

Agent Skills

Priorities

Tasks

APIs

Create Task

URI

Content Type

HTTP Method

Parameters

Request Body

Response Body

Task

Examples

Success

Errors

Task Status

URI

Content Type

HTTP Method

Parameters

Reuest Body

Response Body

Task

Examples

Success

Errors

Task Complete

URI

Content Type

HTTP Method

Parameters

Reuest Body

Response Body

Examples

Success

Errors

Agent List

URI

Content Type

HTTP Method

Parameters

Reuest Body

Response Body

Agent Tasks

Task

Example

Success

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages