README.md

Table of contents

1. Project Structure
2. Installing
3. Loading initial data
4. Running
5. API
6. Developing

Project structure

├── requirements
│   ├── dev_requirements.txt
│   └── requirements.txt
├── app
│   ├── decorators.py
│   ├── exceptions.py
│   ├── load_data.py
│   ├── models/
│   │   ├── fixtures/
│   ├── resources/
│   ├── run.py
│   ├── settings.py
│   ├── shell.py
│   └── usecase/
├── tests/
├── tox.ini
├── README.md

Installing

• Install python and pip

• Install virtualenv

    pip install virtualenv
  

• Create a virtualenv

    virtualenv venv
    source venv/bin/activate
  

• Install requirements

    pip install -r requirements/requirements.txt
  

You will also need to install mongodb. Here is some good documentation about mongo installation.

After the installation you will need to create a folder to mongo store the data, usually is in /data/db

   sudo mkdir -p /data/db # unix only

And Start mongo

   sudo mongod

If you don't have sudo permissions or don't want use sudo, you can specify the --dbpath to mongo

    mkdir -p data/db # in any directory you like
    mongod --dbpath data/db

Loading Data

If you have some initial data that you want to load, you can use load_data.py

Just save your fixture.json file inside models/fixtures and then do:

python app/load_data.py --fixture=<your_fixture_file.json>

Running

python app/run.py

API

Creates a new property

• URL

    /properties
  

• Method:

    POST
  

• Data Params

  Required:

    x=[integer],
    y=[integer],
    title=[string],
    price=[number],
    description=[string],
    beds=[int],
    baths=[int],
    squareMeters=[int]
  

• Success Response:

  * **Code:** 201 CREATED
  

• Error Response:

  * **Code:** 422 UNPROCESSABLE ENTRY
  * **Content:**
            {
                "message": "string"
            }
  
  OR
  
  * **Code:** 400 BAD REQUEST
  

• Sample Call:

    curl -H "Content-Type: application/json" -X POST -d '{"x": 222,"y": 444, "title": "Imóvel código 1, com 5 quartos e 4 banheiros","price": 1250000, "description": "Lorem ipsum","beds": 4,"baths": 3, "squareMeters": 200}' http://localhost:5000/properties
  

Get a property

• URL

    /properties/
  

• Method:

     GET
  

• URL Params

      id=[string]
   or
      ax=[string]
      bx=[string]
      ay=[string]
      by=[string]
  

• Success Response:

  * **Code:** 200 OK
  * **Content:**
  
        {
            "x": 222,
            "y": 444,
            "title": u"Imóvel código 1, com 5 quartos e 4 banheiros",
            "price": 1250000,
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
            "beds": 4,
            "baths": 3,
            "provinces": ["Ruja"]
        }
  

• Error Response:

  * **Code:** 400 BAD REQUEST
  * **Content:**
            {
                "message": "You must provide an id or a query string with 'ax', 'bx', 'ay', 'by."
            }
  
  OR
  
  * **Code:** 404 NOT FOUND
  * **Content:**
            {
                "message":  "property with id 4f4381f4e779897a2c000009 not found."
            }
  

• Sample Call:

    curl localhost:5000/properties/140223323232
    curl localhost:5000/properties/?ax=10&bx=20&ay=30&by=40
  
    {
        "foundProperties": 0,
        "properties": []
    }
  

Delete a property

• URL

    /properties
  

• Method:

    DELETE
  

• Params

  Required:

    id=[string],
  

• Success Response:

  * **Code:** 204 NO CONTENT
  

• Error Response:

  * **Code:** 404 NOT FOUND
  * **Content:**
            {
                "message": "string"
            }
  
  OR
  
  * **Code:** 400 BAD REQUEST
  

• Sample Call:

    curl -X DELETE http://localhost:5000/properties/432432342
  

Developing

• Install development requirements

    pip install -r requirements/dev_requirements.txt
  

• Run the tests and flake8

    tox