README

Hotelzz App

This application:

• handles guests API requests to check hotel availability from hotels registered at Hotelzz app.
• handles hotel managers (authenticated) API requests to update hotel room type prices
• Allows guests to create (via authenticated API request) a booking which makes a Stripe credit card payment in case the room is available for selected dates
• Provides an Admin Panel to check status of all current records of the database like hotels, room types, guests, etc.

Runs on:

• Rails 5.2.3

• Ruby 2.4.0

• PostgreSQL database

Use of external gems:

• RSpec for automated testing together with Fabricator

• Devise for AdminPanel authentication

• Grape for internal API

• JWT for API authentication

• Stripe for credit card payments

• ActiveAdmin for admin panel

Running the project locally:

# clone the project
git clone https://github.com/dantgn/hotelzz.git

# create database with sample data provided in seeds.rb
rake db:create
rake db:migrate
rake db:setup

# start the server
rails s

API request examples

Hotels availability

Request single hotel availability

# Request hotel#1 availability for minimum 1 guest room
curl -X GET -H "Content-type: application/json" "localhost:3000/api/v1/hotels/1/availability?check_in=2020-01-01&check_out=2020-02-01&guests=1"

# response => status 200: OK
[
  {
    "name": "Single bed with private bath",
    "totalRooms": 4,
    "availableRooms": 4,
    "rent": "1200.0 usd"
  },
  {
    "name": "1 Queen-size bed with private bath",
    "totalRooms": 2,
    "availableRooms": 2,
    "rent": "1200.0 usd"
  },
  {
    "name": "2 King-size bed with private bath",
    "totalRooms": 1,
    "availableRooms": 1,
    "rent": "1200.0 usd"
  }
]

Request hotels availability

# Request hotels availability for minimum 2 guests room
curl -X GET -H "Content-type: application/json" "localhost:3000/api/v1/hotels/availability?check_in=2020-01-01&check_out=2020-02-01&guests=2"

# response => status 200: OK
[
  {
    "hotelName": "The Grand Hotel Budapest",
    "roomTypes": [
      {
        "name": "1 Queen-size bed with private bath",
        "totalRooms": 2,
        "availableRooms": 2,
        "rent": "1200.0 usd"
      },
      {
        "name": "2 King-size bed with private bath",
        "totalRooms": 1,
        "availableRooms": 1,
        "rent": "1200.0 usd"
      }
    ]
  },
  {
    "hotelName": "Tarraco Hotel",
    "roomTypes": [
      {
        "name": "1 Queen-size bed with private bath",
        "totalRooms": 2,
        "availableRooms": 2,
        "rent": "1200.0 usd"
      },
      {
        "name": "2 King-size bed with private bath",
        "totalRooms": 1,
        "availableRooms": 1,
        "rent": "1200.0 usd"
      }
    ]
  }
]

Room type booking

Request room type booking (unauthorized)

# Request hotels availability for minimum 2 guests room
curl -X POST -H "Content-type: application/json" "localhost:3000/api/v1/bookings?check_in=2020-01-01&check_out=2020-02-01&room_type_id=1"

# response => status 401: Unauthorized
{
  "error": "401 Unauthorized"
}

Request room type booking (authorized)

# Request hotels availability for minimum 2 guests room
curl -X POST -H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1NTU4NjA2Njh9.jFeIPdX62LVGfPrNZRGOYguBBBb9gBeU54vheRDkGhs" -H "Content-type: application/json" "localhost:3000/api/v1/bookings?check_in=2020-01-01&check_out=2020-02-01&room_type_id=1"

# response for valid payment => status 201: Created
{
  "id": 6,
  "guest": {
      "id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "email": "guest@example.com"
  },
  "room_type": {
      "id": 1,
      "name": "Single bed with private bath",
      "occupancy_limit": 1,
      "hotel_id": 1
  },
  "check_in": "2020-01-01",
  "check_out": "2020-02-01"
}

# response for unavailable rooms => status 422: Unprocessable Entity
{
  "error": "Room Type not available for booking on selected dates"
}

# response for payment failed => status 422: Unprocessable Entity
{
  "error": "Payment transaction failed!"
}

Room type price update

Request room type price update (unauthorized)

# Request udpdate room_type#1 
curl -X PUT -H "Content-type: application/json" "localhost:3000/api/v1/room_types/1/prices?amount=2500&month=1"

# response => status 401: Unauthorized
{
  "error": "401 Unauthorized"
}

Request room type price update (authorized)

# Request udpdate room_type#1 
curl -X PUT -H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE1NTU4NTQwOTN9.0bTt4KShDjn8gGkXjSw8TDZaDGLoxWgGueFJ1Bqv2NQ" -H "Content-type: application/json" "localhost:3000/api/v1/room_types/1/prices?amount=2500&month=1"

# response => status 200: OK
{
  "id": 1,
  "room_type_id": 1,
  "amount": "2500.0",
  "currency": "usd"
}