Merge branch 'develop' into routes

# Conflicts:
#	Pipfile
#	Pipfile.lock
#	README.md
#	src/api/controllers/userController.py
#	src/api/views/__init__.py
#	src/api/views/userView.py

Author: petak5

.circleci/config.yml

@@ -0,0 +1,46 @@
+version: 2.1
+
+jobs:
+  docker-build:
+   machine: true
+   steps:
+     - checkout
+     # Build the application image to make sure it works
+     - run:
+          command: docker build -t programmingbuddies/programmingbuddies-api .
+          name: Build docker image
+
+  docker-push:
+    machine: true
+    steps:
+      - checkout
+      # Log into dockerhub using docker cli.
+      # Credentials are stored in the UI using env variables (They are kept secret don't worry)
+      # https://circleci.com/docs/2.0/env-vars/#secrets-masking
+      - run: 
+          command: echo "$DOCKER_PASS" | docker login --username $DOCKER_USER --password-stdin
+          name: Dockerhub login
+
+      # Build the image.
+      # We could use something like $CIRCLE_BRANCH to correctly tag images,
+      # but latest is probably fine for now.
+      - run:
+           command: docker build -t programmingbuddies/programmingbuddies-api:latest .
+           name: Build docker image
+
+      # Push the built image to the dockerhub organization
+      - run:
+           command: docker push programmingbuddies/programmingbuddies-api:latest
+           name: Push image to registry
+
+workflows:
+  main:
+    jobs:
+      - docker-build
+      - docker-push:
+          filters:
+            branches:
+              only:
+                - develop
+          requires:
+            - docker-build

.gitignore

@@ -347,4 +347,8 @@ healthchecksdb
 
 # Visual Studio Code
 .vscode/
-*.pem
+*.pem
+
+
+# Sqlite
+db.sqlite3

Pipfile

@@ -16,6 +16,9 @@ pyopenssl = "*"
 flask-swagger = "*"
 flask-swagger-ui = "*"
 pytest = "*"
+flask-cors = "*"
+flask-login = "*"
+blinker = "*"
 
 [requires]
 python_version = "3.7"

Pipfile.lock

@@ -1,42 +1,40 @@
 # Programming Buddies API
-API backend for Programming Buddies (projects management)
 
-## Tech Stack
-- Python 3.7
-- Flask
-- MySql
-- pyOpenSSL
+API backend for [Programming Buddies](https://github.com/ProgrammingBuddies/programmingbuddies-ui) (projects management)
 
-## Set up guide
-- Download and install MySQL Community Server from `https://dev.mysql.com/downloads/mysql/`
-- `git clone https://github.com/ProgrammingBuddies/programmingbuddies-api.git`
+## Set up guide: The simple way
 
-### The simple way
+- Set up your [environment](#environment)
+- Install [docker-compose](https://docs.docker.com/compose/install/) and do `docker-compose up`
 
-Install docker-compose and do `docker-compose up`. Don't forget to setup your
-.env file.
+## Set up guide: The 'bothersome' way
 
-### Pipenv
-- run `python -m pip install pipenv` to install pipenv
-- run `pipenv install` inside the repository
-- - if you have multiple Python versions installed you might need to specify which one to use `pipenv install --python=python3.7`
+Requirements:
 
-### SSL
-- On Mac or linux install the openssl tool and run `openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365` inside the repository
-- On windows ... explanation will follow.
+- Set up your [environment](#environment)
+- [MySQL Community Server](`https://dev.mysql.com/downloads/mysql/`)
+    - Add line `CONNECT=mysql+pymysql://<user>:<password>@localhost:3306/<database name>` to your [`.env` file](#environment) to specify connection parameters
+- Pipenv
+    1. Run `python -m pip install pipenv` to install pipenv
+    2. Run `pipenv install` inside the repository
+        - If you have multiple Python versions installed you might need to specify which one to use `pipenv install --python=python3.7`
+- SSL
+    1. On Mac or Linux install the openssl tool and run `openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365` inside the repository
+    2. On Windows ... explanation will follow.
 
-### Environment
-- create a file `.env`
-- - `.env` in this case is the full filename and not just the extension. `app.env` for example would not be loaded automatically by pipenv
-- - add line `FLASK_ENV=development` to have the server automatically restart on file changes
-- - add line `CONNECT=mysql+pymysql://<user>:<password>@localhost:3306/<database name>` to specify connection parameters
+Run the server:
 - `pipenv run python src/runserver.py`
-- - run with flag `--reset-db` to recreate all tables on start
-- add line `APP_SECRET=somepassword` as app secret. This is used to sign sessions among other things and is required
-- Optain credentials for Github
-- - Under your github account Settings go to Developer Settings and OAuth Apps
-- - create a new one and set the homepage url to `https://localhost:5001/` and Authorization callback to `https://localhost:5001/login/github/authorized`
-- - Copy the Client Id and Client Secret from that site and save them in `.env`as `GITHUB_ID` and `GITHUB_SECRET` respectively
+    - Run with flag `--reset-db` to drop and recreate all tables on start
+
+## Environment
+
+1. Create a file named `.env`
+    - Add line `FLASK_ENV=development` to have the server automatically restart on file changes
+2. Add line `APP_SECRET=somepassword` as app secret. This is used to sign sessions among other things and is required
+3. Obtain credentials for GitHub OAuth
+    - Under your GitHub account Settings go to Developer settings and OAuth Apps
+    - Create a new one and set the homepage url to `https://localhost:5001/` and Authorization callback to `https://localhost:5001/login/github/authorized`
+    - Copy the Client Id and Client Secret from that site and save them in `.env` as `GITHUB_ID` and `GITHUB_SECRET` respectively
 
 Your `.env` file should now look something like [example.env](https://github.com/ProgrammingBuddies/programmingbuddies-api/blob/develop/example.env)
 
@@ -50,3 +48,9 @@ Your `.env` file should now look something like [example.env](https://github.com
 - [ ] build DB and endpoints with basic CRUD
 - [ ] add security for app (ie - bots, and non-human actors/clients)
 - [ ] add users and profile stores as well as registration/management API endpoints for users
+## Tech stack:
+
+- Python
+- Flask
+- MySQL
+- pyOpenSSL

README.md

@@ -3,7 +3,11 @@
 """
 
 from flask import Flask
+from flask_cors import CORS
+
+
 app = Flask(__name__)
+cors = CORS(app, origins="*", supports_credentials=True)
 # Disable sorting of the jsonified data
 app.config['JSON_SORT_KEYS'] = False
 

src/api/__init__.py

@@ -31,6 +31,19 @@ def update_project(self, id, **kwargs):
 
         return project
 
+    def update_project(self, id, **kwargs):
+        project = Project.query.filter_by(id=id).first()
+
+        if project == None:
+            return project
+
+        for key, value in kwargs.items():
+            setattr(project, key, value)
+
+        db.session.commit()
+
+        return project
+
     def get_project(self, **kwargs):
         project = Project.query.filter_by(**kwargs).first()
 

src/api/controllers/projectController.py

@@ -1,8 +1,13 @@
 from api.models import db, User, UserHasProject, UserLink, UserFeedback
+from flask_login import LoginManager
+from api import app
 
 class UserController:
     session = db.session()
 
+    login_manager = LoginManager()
+    login_manager.init_app(app)
+
     # User
     def create_user(self, **kwargs):
         try:
@@ -32,6 +37,20 @@ def update_user(self, id, **kwargs):
 
         return user
 
+    def update_user(self, id, **kwargs):
+        user = User.query.filter_by(id=id).first()
+
+        if user == None:
+            return user
+
+        for key, value in kwargs.items():
+            setattr(user, key, value)
+
+        db.session.commit()
+
+        return user
+
+    @login_manager.user_loader
     def get_user(self, **kwargs):
         user = User.query.filter_by(**kwargs).first()