jobqueueapi

The jobqueueapi can return the best Jobs for your Agents from your jobRequests.

After receive the JSON body containing Jobs, Agents and JobRequest, the API will verify the keys and get the values for each one and turns into three lists.
Doing this, they match the agents id specified in the JobRequest objects list with the id of the Agents list objects, getting a new list that contains just the Agents that have a JobRequest.
Now, they just receive the new list of agents and will filter the Jobs list. The filter have some decisions and prioritys that involves the primary key, secondary key and the urgent flag in the objects of Jobs list and will return a new list of agents with a new key called job that contains the best job for it!
This result will be formatted for a simples response and the API finally returns a JSON with the expected result.

Prerequisites

You will need [Leiningen][] 2.0.0 or above installed.

If your environment is the popular double Visual Code + Windows, you can see how to prepair everything in my article "Starting with Clojure + Windows + Visual Code":

https://medium.com/@vini.raanch/starting-with-clojure-windows-visual-code-2ac11add749c

It's your choice the tool to use for consume the API. My suggestion is Postman.

Running

Before starting the web server, run:

lein deps

This will install all the dependencies needed for the project to run. The dependencies are listed on project.clj

To start a web server for the application, run:

lein ring server

First Try

With the tool choosed by you:

Select the type of the request as POST
In the header "content-type" as "application/json"
Set the route as http://localhost:port/api/dequeue
Specify the JSON body
Send the Request

And you see the best Jobs for you Agents!

Sample Input

[ 
  { 
    "new_agent": { 
      "id": "8ab86c18-3fae-4804-bfd9-c3d6e8f66260", 
      "name": "Monkey D. Luffy", 
      "primary_skillset": ["bills-questions"], 
      "secondary_skillset": [] 
    } 
  }, 
  { 
    "new_job": {
      "id": "f26e890b-df8e-422e-a39c-7762aa0bac36",
      "type": "rewards-question",
      "urgent": false
    }
  },
  {
    "new_agent": {
      "id": "ed0e23ef-6c2b-430c-9b90-cd4f1ff74c88",
      "name": "Portgas D. Ace",
      "primary_skillset": ["rewards-question"],
      "secondary_skillset": ["bills-questions"]
    }
  },
  {
    "new_job": {
      "id": "690de6bc-163c-4345-bf6f-25dd0c58e864",
      "type": "bills-questions",
      "urgent": false
    }
  },
  {
    "new_job": {
      "id": "c0033410-981c-428a-954a-35dec05ef1d2",
      "type": "bills-questions",
      "urgent": true
    }
  },
  {
    "job_request": {
      "agent_id": "8ab86c18-3fae-4804-bfd9-c3d6e8f66260"
    }
  },
  {
    "job_request": {
      "agent_id": "ed0e23ef-6c2b-430c-9b90-cd4f1ff74c88"
    }
  }
]

Sample Output

[
  {
    "job_assigned": {
      "job_id": "c0033410-981c-428a-954a-35dec05ef1d2",
      "agent_id": "8ab86c18-3fae-4804-bfd9-c3d6e8f66260"
    }
  },
  {
    "job_assigned": {
      "job_id": "f26e890b-df8e-422e-a39c-7762aa0bac36",
      "agent_id": "ed0e23ef-6c2b-430c-9b90-cd4f1ff74c88"
    }
  }
]

Tests

And you can run the application tests with the command:

lein test

vlsouza / jobqueue-api