Merge pull request #6 from gitgik/develop

Develop

Author: gitgik

README.md

@@ -1,80 +1,104 @@
 # flask-rest-api [![Build Status](https://travis-ci.org/gitgik/flask-rest-api.svg?branch=master)](https://travis-ci.org/gitgik/flask-rest-api)
-A flask-driven restful API for Bucketlist interactions
 
+A flask-driven restful API for Bucketlist interactions
 
 ## Technologies used
+
 * **[Python3](https://www.python.org/downloads/)** - A programming language that lets you work more quickly (The universe loves speed!).
 * **[Flask](flask.pocoo.org/)** - A microframework for Python based on Werkzeug, Jinja 2 and good intentions
 * **[Virtualenv](https://virtualenv.pypa.io/en/stable/)** - A tool to create isolated virtual environments
 * **[PostgreSQL](https://www.postgresql.org/download/)** – Postgres database offers many [advantages](https://www.postgresql.org/about/advantages/) over others.
 * Minor dependencies can be found in the requirements.txt file on the root folder.
 
-
 ## Installation / Usage
+
 * If you wish to run your own build, first ensure you have python3 globally installed in your computer. If not, you can get python3 [here](https://www.python.org).
 * After this, ensure you have installed virtualenv globally as well. If not, run this:
+
+    ```bash
+    pip install virtualenv
     ```
-        $ pip install virtualenv
-    ```
-* Git clone this repo to your PC
-    ```
-        $ git clone git@github.com:gitgik/flask-rest-api.git
+
+* Git clone this repo
+
+    ```bash
+    git clone git@github.com:gitgik/flask-rest-api.git
     ```
 
+* ### Dependencies
 
-* #### Dependencies
-    1. Cd into your the cloned repo as such:
-        ```
-        $ cd flask-rest-api
-        ```
+    1. Cd into your the cloned repo:
 
-    2. Create and fire up your virtual environment in python3:
+        ```bash
+        cd flask-rest-api
         ```
-        $ virtualenv -p python3 venv
-        $ pip install autoenv
+
+    2. Create and get into your virtual environment:
+
+        ```bash
+        virtualenv -p python3 venv
+        source venv/bin/activate
         ```
 
-* #### Environment Variables
-    Create a .env file and add the following:
-    ```
-    source venv/bin/activate
-    export SECRET="some-very-long-string-of-random-characters-CHANGE-TO-YOUR-LIKING"
-    export APP_SETTINGS="development"
-    export DATABASE_URL="postgresql://localhost/flask_api"
+* ### Environment Variables
+
+    Install [Dotenv](https://pypi.org/project/python-dotenv/) as follows:
+
+    ```bash
+    pip install python-dotenv
     ```
 
-    Save the file. CD out of the directory and back in. `Autoenv` will automagically set the variables.
-    We've now kept sensitive info from the outside world! 😄
+    Create a .env file and add the following:
 
-* #### Install your requirements
+    ```bash
+    SECRET="some-very-long-string-of-random-characters-CHANGE-TO-YOUR-LIKING"
+    APP_SETTINGS="development"
+    DATABASE_URL="postgresql://localhost/flask_api"
     ```
+
+    Dotenv will load your environment variables by reading the key-value pairs from the .env file.
+
+* ### Install your requirements
+  
+    ```bash
     (venv)$ pip install -r requirements.txt
     ```
 
-* #### Migrations
-    On your psql console, create your database:
-    ```
+* ### Database Migrations
+
+    Make sure your postgresql server is running. Then, on your psql console, create your database:
+
+    ```bash
+    $ psql -U postgres
     > CREATE DATABASE flask_api;
     ```
-    Then, make and apply your Migrations
-    ```
-    (venv)$ python manage.py db init
 
-    (venv)$ python manage.py db migrate
-    ```
+    In the project directory, make and apply your Migrations
+
+    ```bash
+    (venv)$ flask db init
 
-    And finally, migrate your migrations to persist on the DB
+    (venv)$ flask db migrate
     ```
-    (venv)$ python manage.py db upgrade
+
+    And finally, migrate to persist them on the database
+
+    ```bash
+    (venv)$ flask db upgrade
     ```
 
-* #### Running It
+* ### Running the Server
+
     On your terminal, run the server using this one simple command:
-    ```
+
+    ```bash
     (venv)$ flask run
     ```
+
     You can now access the app on your local browser by using
-    ```
+
+    ```bash
     http://localhost:5000/bucketlists/
     ```
+
     Or test creating bucketlists using Postman

app/__init__.py

@@ -9,6 +9,8 @@
 
 from instance.config import app_config
 
+from flask_migrate import Migrate, migrate
+
 # For password hashing
 from flask_bcrypt import Bcrypt
 
@@ -27,6 +29,8 @@ def create_app(config_name):
     app.config.from_object(app_config[config_name])
     app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
     db.init_app(app)
+    migrate = Migrate(db, app)
+    migrate.init_app(app, db)
 
     @app.route('/bucketlists/', methods=['POST', 'GET'])
     def bucketlists():

app/auth/views.py

@@ -52,7 +52,7 @@ def post(self):
                 if access_token:
                     response = {
                         'message': 'You logged in successfully.',
-                        'access_token': access_token.decode()
+                        'access_token': access_token
                     }
                     return make_response(jsonify(response)), 200
             else:

app/models.py

@@ -61,7 +61,8 @@ def generate_token(self, user_id):
     def decode_token(token):
         """Decode the access token from the Authorization header."""
         try:
-            payload = jwt.decode(token, current_app.config.get('SECRET'))
+            payload = jwt.decode(token, current_app.config.get(
+                'SECRET'), algorithms=["HS256"])
             return payload['sub']
         except jwt.ExpiredSignatureError:
             return "Expired token. Please log in to get a new token"

habitat/instance/__init__.py

@@ -1,4 +1,8 @@
 import os
+from dotenv import load_dotenv
+
+# Load environment variables
+load_dotenv()
 
 
 class Config(object):
@@ -12,6 +16,7 @@ class Config(object):
 class DevelopmentConfig(Config):
     """Configurations for Development."""
     DEBUG = True
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
 
 
 class TestingConfig(Config):

habitat/instance/config.py

@@ -2,22 +2,18 @@
 import unittest
 # class for handling a set of commands
 from flask_script import Manager
-from flask_migrate import Migrate, MigrateCommand
 from app import db, create_app
 
 # initialize the app with all its configurations
 app = create_app(config_name=os.getenv('APP_SETTINGS'))
-migrate = Migrate(app, db)
+
 # create an instance of class that will handle our commands
 manager = Manager(app)
 
-# Define the migration command to always be preceded by the word "db"
-# Example usage: python manage.py db init
-manager.add_command('db', MigrateCommand)
-
-
 # define our command for testing called "test"
 # Usage: python manage.py test
+
+
 @manager.command
 def test():
     """Runs the unit tests without test coverage."""

instance/config.py

@@ -1,29 +1,39 @@
-alembic==0.9.1
-autoenv==1.0.0
-bcrypt==3.1.7
-certifi==2019.9.11
-cffi==1.13.2
-Click==7.0
-coverage==4.5.4
-Flask==1.1.1
-Flask-API==1.1
-Flask-Bcrypt==0.7.1
-Flask-Migrate==2.5.2
-Flask-Script==2.0.6
-Flask-SQLAlchemy==2.4.1
-itsdangerous==1.1.0
-Jinja2==2.10.3
-Mako==1.0.6
-Markdown==3.1.1
-MarkupSafe==1.0
-psycopg2==2.8.4
-pycparser==2.17
-PyJWT==1.7.1
-python-coveralls==2.9.3
-python-editor==1.0.3
-PyYAML==5.1.2
-requests==2.22.0
-six==1.13.0
-SQLAlchemy==1.3.11
-Werkzeug==0.16.0
-
+alembic~=1.7.5
+autoenv~=1.0.0
+autopep8~=1.6.0
+bcrypt~=3.2.0
+certifi~=2021.10.8
+cffi~=1.15.0
+charset-normalizer~=2.0.10
+click~=7.1.2
+coverage~=6.2
+Flask~=1.1.2
+Flask-API~=1.1
+Flask-Bcrypt~=0.7.1
+Flask-Migrate~=3.1.0
+Flask-Script~=2.0.6
+Flask-SQLAlchemy~=2.5.1
+greenlet~=1.1.2
+idna~=3.3
+importlib-metadata~=4.10.1
+importlib-resources~=5.4.0
+itsdangerous~=1.1.0
+Jinja2~=2.11.3
+Mako~=1.1.6
+Markdown~=3.3.6
+MarkupSafe~=2.0.1
+psycopg2~=2.9.3
+pycodestyle~=2.8.0
+pycparser~=2.21
+PyJWT~=2.3.0
+python-coveralls~=2.9.3
+python-dotenv~=0.19.2
+python-editor~=1.0.4
+PyYAML~=6.0
+requests~=2.27.1
+six~=1.16.0
+SQLAlchemy~=1.4.31
+toml~=0.10.2
+urllib3~=1.26.8
+Werkzeug~=1.0.1
+zipp~=3.7.0