The hotel-parser from mohamedhafezqo

mohamedhafezqo / hotel-parser Goto Github PK

View Code? Open in Web Editor NEW

A REST API application to get rooms from multiple hotel-providers with criteria

Dockerfile 0.97% PHP 95.39% Makefile 0.52% Shell 3.12%

hotel-parser's Introduction

Sequence diagram

End point to search in rooms

A REST API application to parse hotels rooms from multiple provider/advertiser with criteria
GET http://localhost:8001/api/rooms
Response

{
  "rooms": [
    {
      "code": "DBL-TWN",
      "name": null,
      "net_price": "140.00",
      "total_price": "152.00",
      "taxes": [
        {
          "amount": "12.00",
          "currency": "EUR",
          "type": "TAXESANDFEES"
        }
      ],
      "hotel": {
        "name": "Hotel A",
        "stars": 4,
        "rooms": null
      }
    },
    {
      "code": "HF-BD",
      "name": null,
      "net_price": "133.00",
      "total_price": "142.00",
      "taxes": [
        {
          "amount": "13.00",
          "currency": "EUR",
          "type": "TAXESANDFEES"
        }
      ],
      "hotel": {
        "name": "Hotel A",
        "stars": 4,
        "rooms": null
      }
    }
  ]
}

Assumptions:

I set timeout for each API request to .8 to keep my service live.
I relayed on filesystem as a fallback s1-response.json, s2-response.json in case the APIs down or exceed the timeout limit, so the system can switch between fetching the data from the APIs to filesystem on runtime based on APIs' availabilities and timeout limit constrains.
I used Symfony Service Tag to automatically inject advertisers who implement AdvertiserInterface. But if we have a lot of advertisers we can list them in DB.

Criteria/Filters Examples:

example http://localhost:8001/api/rooms?sortByPrice=asc&maxPrice=160&minPrice=150
minPrice /api/rooms?minPrice=150 requirements="\d+"
maxPrice /api/rooms?minPrice=167 requirements="\d+"
sortByPrice /api/rooms?sortByPrice=asc requirements="[a-z]+"
code /api/rooms?code=FUBOD requirements="[a-z]+"