diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 19 insertions, 8 deletions
@@ -12,7 +12,7 @@ then access [localhost:3000/swagger-ui](http://localhost:3000/swagger-ui/index.h ## Stack -I chose [luminus](http://www.luminusweb.net/) for my stack as it made the initial setup way easier since it provide a wide range option of configuration for a lot of technologies. +I chose [luminus](http://www.luminusweb.net/) for my stack as it makes the initial setup way easier since it provide a wide range option of configuration for a bunch of technologies. To bootstrap the project I used `lein new luminus queue-api +swagger +service +kibit` plus datascrypt, which by default doesn't come with Luminus. ### +Swagger @@ -31,7 +31,7 @@ I added because it gives some insight how to make you code more idiomatic. I chose [datascript](https://github.com/tonsky/datascript) for its easy setup, after little to no effort I had it working. Even though it was meant to run on browser it fit nicely in the project, and because it works pretty much like Datomic it has [powerful query system](https://docs.datomic.com/on-prem/query.html) and works seamlessly with clojure. -Additionally it had an okay [non-documentation](https://github.com/tonsky/datascript/wiki/Getting-started) with some [samples](https://github.com/kristianmandrup/datascript-tutorial) and if I couldn't find for Datascript I would search for a Datomic seeing that query system of both are compatible. +Additionally it had an okay [non-documentation](https://github.com/tonsky/datascript/wiki/Getting-started) with some [samples](https://github.com/kristianmandrup/datascript-tutorial) and if I couldn't find for Datascript I'd search for a Datomic seeing that query system of both are compatible. ## Solution @@ -53,6 +53,8 @@ Project has two models: * `:completed` it has been done with. * `:job/agent` reference a job that is processing this job or had processed it. it is nil when `:unassigned` * `:job/type` type of the job that it can perform + * `:job/date` date time when job has entered into the system. + * `:job/urgent` urgent flag that tell when a job has priority over other not urgent ones Those models wrap up in schema: @@ -71,20 +73,29 @@ After all luminus file there is actually two files that have the core logic of t For `services.clj` it holds all code for endpoint definition and model validation and considering the exercise requirements we gonna need 5 endpoints: * Endpoint to add agent is a`:put` at `/agent` -* Endpoint to get how many jobs of each type this agent has performed is a `:post` at `/agent`. Note: usually since it is a method that doesn't modify anything I would have used `:get` and pass the agent id via path (`/agent/:id`) but one of the requirement is "*All endpoints should accept and return JSON content type payloads*" I worked with POST PUT. +* Endpoint to get how many jobs of each type this agent has performed is a `:post` at `/agent`. Note: usually since it is a method that doesn't modify anything I'd have used `:get` and pass the agent id via path (`/agent/:id`) but one of the requirement is "*All endpoints should accept and return JSON content type payloads*" I worked with POST PUT. * Endpoint to add a job is `:put` at `/job` * Endpoint to request a job is `:post` at `/job` * Endpoint to get current queue state is `:get` at `/job` -For model detail access swagger-ui. +For model and validation details access swagger-ui. ### db/core.clj -To be continued... - - +Core.clj holds all logic to interact with Datascrip therefore all the code to manage with the queue. +The idea behind it is actually simpler than part 1 since Datascrip handle all data storing process. +For example, to store jobs and agents I'd simply `transact!` the entire object and we good to go. +```clojure + (d/transact! queue-api.db.core/conn + [{:job/id "319ce5e6-6ed6-4931-8e29-550052b02409" + :job/type "bills-request" + :job/urgent false + :job/date (time/now) + :job/status :unassigned}]) +``` +## Testing +To be continued... - |