LuizaLabs Challenge

Objective

Create an API that collects user information from Facebook and provides those information through an service.

Structure

This is the structure of files and folders of this project

.
+-- api
|   +-- handlers
|   |   +-- person.py - All request types for /person
|   +-- helpers
|   |   +-- facebook.py - Helper to get user information from Facebook Graph API
|   +-- logs
|   |   +-- application.log - File with all application logs
|   +-- sqlite - Folder with the sqlite database
|   +-- __init__.py
|   +-- database.py - Database configs and connection
|   +-- main.py - Here is the routes and this is the file that you need to run with 'python' command
|   +-- models.py - SQLAlchemy user model
+-- .gitignore
+-- README.md
+-- dependences.txt - The dependences of this project it's listed here

Limitations

The challenge was to get:

- Facebook ID
- Name
- Username
- Gender

But there were some changes after Graph API v2.0:

* The /me/username field has been removed.

And to get user gender, the user needs to authenticate into an Facebook APP.

So that's why i just get the Facebook ID and Name.

How to run

Create an folder for this project and navigate into the folder

$ mkdir labs-api && cd labs-api

Now you can:

Clone this repository inside the folder that you just created

$ git clone https://github.com/guilherme-toti/desafio-luizalabs.git .

Or download this repository as ZIP file and extract it into the folder you created.

Now if you are using virtualenv, create a virtualenv and activate it, if you don't, just go to next step

$ virtualenv venv && source venv/bin/activate

Once you are inside virtualenv, you need to install the dependences:

$ pip install -r dependences.txt

When pip finish, you can navigate to "api" folder

$ cd api

And just run

$ python main.py

Now your API is running on: http://localhost:8888

How to use

Include User

There is two ways to include a user:

$ curl -X POST -F facebookId=<id_here> http://localhost:8888/person/

$ curl -X POST http://localhost:8888/person/<id_here>

List Users

To list users, you can get all with:

$ curl http://localhost:8888/person/

and you can limit with:

$ curl http://localhost:8888/person/?limit=<max_users>

$ curl http://localhost:8888/person/<max_users>

The response will be a JSON:

[ 
    { 
        "facebookId": "1234567", 
        "name": "Name Lastname", 
    } 
]

Delete User

To delete a user, you just need to:

$ curl -X DELETE http://localhost:8888/person/<id_here>

I would like to thanks God, Renato and Danillo for this opportunity!