iankisali / airbnb_clone

A duo project to create a Console Storage Engine for AirBnB clone project.

AirBnB_clone - The Console

Description

This is a team project that is part of ALX Full-stack Software Engineering Program. It is the first step towards building our first full web application - AirBnB clone. In this repo we are creating the Console which is a Storage Engine i.e a Command Interpreter that can manipulate data without visual interface, like a Shell.

Below is a pictorial reprsentation of steps taken to build the AirBnB clone:

This repository contains the Storage Engine as shown above.

Usage

The console works both in interactive mode and non-interactive mode, much like a Unix shell. It prints a prompt (hbnb) and waits for the user for input.

Interactive Mode

In Intercative mode the shell works as follows:

$ ./console.py
(hbnb) help

Documented commands (type help <topic>):
========================================
EOF  all  count  create  destroy  help  quit  show  update

(hbnb) help all
Prints all string representation of all instances.

(hbnb) help create
Creates an instance.

(hbnb) help update
Updates an instance by adding or updating attribute.

(hbnb) quit
$

Non-interactive Mode

In Non-Intercative mode the shell works as follows:

$ echo "help" | ./console.py
(hbnb)
Documented commands (type help <topic>):
========================================
EOF  all  count  create  destroy  help  quit  show  update

(hbnb)

$
$ cat test_help
help
$
$ cat test_help | ./console.py
(hbnb)

Documented commands (type help <topic>):
========================================
EOF  all  count  create  destroy  help  quit  show  update
(hbnb) 
$

Commands

Command	Example
Run the console	./console.py
Quit the console	(hbnb) quit
Display the help for a command	(hbnb) help <command>
Create an object (prints its id)	(hbnb) create <class>
Show an object	(hbnb) show <class> <id> or (hbnb) <class>.show(<id>)
Destroy an object	(hbnb) destroy <class> <id> or (hbnb) <class>.destroy(<id>)
Show all objects, or all instances of a class	(hbnb) all or (hbnb) all <class>
Update an attribute of an object	(hbnb) update <class> <id> <attribute name> "<attribute value>" or (hbnb) <class>.update(<id>, <attribute name>, "<attribute value>")

Models

The folder models contains ass classes used in the project.

File	Description	Attributes
base_model.py	BaseModel class for all the other classes	id, created_at, updated_at
user.py	User class for future user information	email, password, first_name, last_name
amenity.py	Amenity class for future amenity information	name
city.py	City class for future city location information	state_id, name
state.py	State class for future location information	name
place.py	Place class for future accomodation information	city_id, user_id, name, description, number_rooms, number_bathrooms, max_guest, price_by_night, latitude, longitude, amenity_ids
review.py	Review class for future user/host review information	place_id, user_id, text

File storage

The folder engine in models folder manages the serialization and deserialization of all the data using JSON format.

A FileStorage class is defined in file_storage.py with methods to follow this flow: <object> -> to_dict() -> <dictionary> -> JSON dump -> <json string> -> FILE -> <json string> -> JSON load -> <dictionary> -> <object>

The init.py file contains the instantiation of the FileStorage class called storage, followed by a call to the method reload() on that instance. This allows the storage to be reloaded automatically at initialization, which recovers the serialized data.

Tests

All the code is tested with the unittest module. The test for the classes are in the test_models folder.

Authors

Ian Kisali

• Github
• Twitter
• E-mail

Eric Kabira

• Github