API used for the virtual study room application. The API should allow users to register, login, logout and list or add necessary information regarding rooms, questions and answers.

• Getting Started
• API Documentation
  • Users
  • Events
  • Tickets
  • Guests
• Running the tests
• Deployment
• Built with
• Contributing
• Versioning
• Authors
• License

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

The API is built using a small python-based framework called Flask, therefore will require python to be installed.

Once python is installed, a virtual environment can be used for development.

These steps can be used to install a virtual environment:

1. Install a virtual environment (Mac OS X): sudo easy_install virtualenv

2. Activate the environment by running: venv/Scripts/activate

Creating a virtual environment for each application ensures that applications have access to only the packages that they use.

You can create a user by sending a json request with an email and password. The password must be at least four(4) characters.

• Request (application/json)

    {
        "email": "example@gmail.com",
        "password": "123456"
    }
  

• Response 201 (application/json)

    {
        "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MDM0ODQ5OTYsImlhdCI6MTUwMzM5ODU4Niwic3ViIjo1fQ.GC6IEOohdo_xrz9__UeugIlir0qtJdKbEzBtLgqjt5A",
        "message": "Successfully registered",
        "status": "success"
    }
  

• Response 400 (application/json)

    {
        "message": "Missing or wrong email format or password length",
        "status": "failed"
    }
  

• Response 400 (application/json)

    {
        "message": "Failed, User already exists, Please sign In",
        "status": "failed"
    }
  

• Response 400 (application/json)

    {
      "message": "Content-type must be json",
      "status": "failed"
    }
  

You can login a user by sending their email and password. Please take note of the auth token for you will need it for all user requests.

• Request (application/json)

    {
        "email": "example@gmail.com",
        "password": "123456"
    }
  

• Response 201 (application/json)

    {
        "auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MDM0ODQ5OTYsImlhdCI6MTUwMzM5ODU4Niwic3ViIjo1fQ.GC6IEOohdo_xrz9__UeugIlir0qtJdKbEzBtLgqjt5A",
        "message": "Successfully registered",
        "status": "success"
    }
  

• Response 400 (application/json)

    {
      "message": "Content-type must be json",
      "status": "failed"
    }
  

• Response 401 (application/json)

    {
      "message": "Missing or wrong email format or password is less than four characters",
      "status": "failed"
    }
  

• Response 401 (application/json)

    {
      "message": "User does not exist or password is incorrect",
      "status": "failed"
    }
  

You can log out a user by sending a request with their email and address. The auth token will then be invalidated (blacklisted).

• Request (application/json)

  • Headers

      Authorization: Bearer JWT Token
    

• Response 200 (application/json)

    {
        "message": "Successfully logged out",
        "status": "success"
    }
  

• Response 403 (application/json)

    {
      "message": "Provide a valid auth token",
      "status": "failed"
    }
  

• Response 403 (application/json)

    {
      "message": "Provide an authorization header",
      "status": "failed"
    }
  

• Response 401 (application/json)

    {
      "message": "Signature expired, Please sign in again",
      "status": "failed"
    }
  

• Response 401 (application/json)

    {
      "message": "Invalid token. Please sign in again",
      "status": "failed"
    }
  

API documentation will be available soon. However, the endpoints were implemented.

API documentation will be available soon. However, the endpoints were implemented.

API documentation will be available soon. However, the endpoints were implemented.

Before running the application tests, update your env variables.

export  APP_SETTINGS=app.config.TestingConfig
export DATABASE_URL_TEST=<postgres database url>

Run this command from terminal

python manage.py test

Run this command from terminal

nosetests --with-coverage --cover-package=app

Not ready for deployment yet.

Frameworks used are listed in the requirements.txt file

Decisions has not been made yet on who can contribute to this repository.

Thinking of using semantic versioning, but decision has not been made yet.

• Aury Rukazana - Initial work

This project is licensed under the MIT License.