Queue-RESTAPI-number-guesser

Web application tries to guess a number using a job in a queue many times by genereting a random number. It equals a genereted number and a number has configured. If number is not guessed the job returns to queue once again and it will be continued for a number of tries has configured. App uses RESTAPI to: direct it, input parameters, get result info, get log info. (Used docker configuration info from user 'sagar290', thanks to him)

Default configurations:  
    Backoff = 0
    Tries = 100
    Guess number = 50
    Range start = 0
    Range end = 100

Up the services

docker-compose up --build -d

Go to the container

docker exec -it queue-restapi-number-guesser-app-1 bash

Run inside the container

php artisan migrate
cp .env.example .env

HTTP requests to direct the app or them combinations:

• Start guessing a number which has configured by default with the others default configurations

GET http://localhost:80/api/start
Accept: application/json

###

• Start guessing a number which has configured in the request

GET http://localhost:80/api/start?guess_number=32
Accept: application/json

###

• Start guessing a number which has configured by default and using trial number's range from request

GET http://localhost:80/api/start?range[start]=0&range[end]=200
Accept: application/json

###

• Start guessing a number which has configured from request and trial number's range which has configured from request also

GET http://localhost:80/api/start?guess_number=32&range[start]=0&range[end]=200
Accept: application/json

###

• Start guessing a number which has configured from request and trial number's range which has configured from request also

GET http://localhost:80/api/start?guess_number=32&range[start]=0&range[end]=200
Accept: application/json

###

• Start guessing a number with tries, backoff, range which has configured and from request

GET http://localhost:80/api/start?tries=100&backoff=0&guess_number=32&range[start]=0&range[end]=200
Accept: application/json

###

• View the logs of all transactions

GET http://localhost:80/api/logs
Accept: application/json

###

• View the logs of tries for transaction 1652350657

GET http://localhost:80/api/logs?transaction=1652350657
Accept: application/json

###

• View the totals all transaction (Info about: was a number guessed or not, number of tries had made start, end time, spended time, used number's range, backoff and other params had inputed)

GET http://localhost:80/api/total
Accept: application/json

###

• Clear all the logs

GET http://localhost:80/api/logs/clear
Accept: application/json

###

Down services if you are exit

docker-compose down

Some demostration:

GET http://localhost:80/api/start

HTTP/1.1 200 OK
Server: nginx/1.21.6
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.0.2
Cache-Control: no-cache, private
Date: Sat, 14 May 2022 07:48:43 GMT
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
Access-Control-Allow-Origin: *

Started, transaction = 1652514523

Response code: 200 (OK); Time: 733ms; Content length: 33 bytes


GET http://localhost:80/api/total

HTTP/1.1 200 OK
Server: nginx/1.21.6
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/8.0.2
Cache-Control: no-cache, private
Date: Sat, 14 May 2022 07:50:07 GMT
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
Access-Control-Allow-Origin: *

[
  {
    "transaction": 1652514523,
    "guess number": 50,
    "status": "OK",
    "used tries": 45,
    "params": {
      "backoff": 0,
      "tries": 100,
      "guessNumber": 50,
      "range": {
        "start": 0,
        "end": 100
      }
    },
    "start date": "2022-05-14 07:48:43",
    "end date": "2022-05-14 07:48:47",
    "completion time": "00:00:04"
  }
]

Response code: 200 (OK); Time: 356ms; Content length: 255 bytes