Initial commit

Author: ThomasKranitsas

README.md

@@ -0,0 +1,49 @@
+# Python Mongodb Starter Pack
+
+## Prerequisites
+1. Python 3.x
+2. Mongodb
+3. docker & docker-compose
+
+## Configuration
+
+Located under the yaml file.
+
+- **MONGODB_URL** Mongodb connection url
+
+the config value can be set through environment variable **MONGODB_URL**.
+
+## Local Running
+
+Go to app folder.
+
+Install requirements:
+
+```bash
+pip install -r requirements.txt
+```
+
+Run application
+
+```bash
+python app.py
+```
+
+or override with environment variable
+
+```bash
+MONGODB_URL=xxx python app.py
+```
+
+
+## Docker compose Running
+
+Run:
+```bash
+docker-compose up --build
+```
+
+
+## Test and Verification
+
+Import the postman collection in docs folder to test and verify.

app/Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3
+
+
+# Copy app
+COPY . /app
+
+WORKDIR /app
+
+
+# Install dependenceis
+RUN pip install -r requirements.txt
+
+# Expose port 5000
+EXPOSE 5000
+
+# Run the server when container is launched
+CMD ["python", "app.py"]

app/app.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+from config import app
+from controllers.user_controller import api
+
+# register the api
+app.register_blueprint(api)
+
+if __name__ == '__main__':
+    ''' run application '''
+    app.run(host='0.0.0.0', port=5000)

app/config.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+import os
+import yaml
+from flask import Flask
+from flask_mongoengine import MongoEngine
+
+app = Flask(__name__)
+
+config_obj = yaml.load(open('config.yaml'), Loader=yaml.Loader)
+
+db_host = os.getenv('MONGODB_URL')
+
+app.config['MONGODB_SETTINGS'] = {
+    'host': config_obj['MONGODB_URL'] if db_host is None else db_host,
+    }
+
+
+db = MongoEngine()
+
+db.init_app(app)
+

app/config.yaml

@@ -0,0 +1 @@
+MONGODB_URL: 'mongodb://admin:[email protected]:27018/admin'

app/controllers/user_controller.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+from flask import Blueprint, jsonify, request
+import services.user_service as user_service
+from models.user import User
+from werkzeug.exceptions import HTTPException
+import json
+
+api = Blueprint('users', 'users')
+
+@api.route('/users', methods=['GET'])
+def api_get():
+    ''' Get all entities'''
+    users = user_service.get()
+    return jsonify([user.as_dict() for user in users])
+
+@api.route('/users', methods=['POST'])
+def api_post():
+    ''' Create entity'''
+    user = user_service.post(request.json)
+    return jsonify(user.as_dict())
+
+@api.route('/users/<string:id>', methods=['PUT'])
+def api_put(id):
+    ''' Update entity by id'''
+    body = request.json
+    body['id'] = id
+    res = user_service.put(body)
+    return jsonify(res.as_dict()) if isinstance(res, User) else jsonify(res)
+
+@api.route('/users/<string:id>', methods=['DELETE'])
+def api_delete(id):
+    ''' Delete entity by id'''
+    res = user_service.delete(id)
+    return jsonify(res)
+
+@api.errorhandler(HTTPException)
+def handle_exception(e):
+    """Return JSON format for HTTP errors."""
+    # start with the correct headers and status code from the error
+    response = e.get_response()
+    # replace the body with JSON
+    response.data = json.dumps({
+        'success': False,
+        "message": e.description
+    })
+    response.content_type = "application/json"
+    return response

app/models/user.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+from config import db
+from bson.json_util import dumps
+import json
+
+class User(db.Document):
+    ''' The data model'''
+    handle = db.StringField(required=True)
+    def as_dict(self):
+        return {'id': json.loads(dumps(getattr(self,'pk')))['$oid'], 'handle': getattr(self, 'handle')}

app/requirements.txt

@@ -0,0 +1,3 @@
+PyYAML==5.1.2
+Flask==1.1.1
+flask-mongoengine==0.9.5

app/services/user_service.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+from models.user import User
+from config import db
+from werkzeug.exceptions import NotFound
+
+def get():
+    '''
+    Get all entities
+    :returns: all entity
+    '''
+    return User.objects()
+
+def post(body):
+    '''
+    Create entity with body
+    :param body: request body
+    :returns: the created entity
+    '''
+    user = User(**body).save()
+    return user
+
+def put(body):
+    '''
+    Update entity by id
+    :param body: request body
+    :returns: the updated entity
+    '''
+    user = User.objects(pk=body['id']).first()
+    if user:
+        user.update(**body)
+        return User(**body)
+    raise NotFound('no such entity found with id=' + str(body['id']))
+
+def delete(id):
+    '''
+    Delete entity by id
+    :param id: the entity id
+    :returns: the response
+    '''
+    user = User.objects(pk=id).first()
+    if user:
+        user.delete()
+        return {'success': True}
+    raise NotFound('no such entity found with id=' + str(id))
+
+

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '2'
+services:
+  database:
+    image: mongo:3.4
+    restart: always
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: admin
+      MONGO_INITDB_ROOT_PASSWORD: password
+  app:
+    build: app
+    depends_on: [database]
+    links:
+      - database
+    ports:
+      - "5000:5000"
+    environment:
+      MONGODB_URL: 'mongodb://admin:password@database:27017/admin'

docs/Python-Starter.postman_collection.json

@@ -0,0 +1,125 @@
+{
+	"info": {
+		"_postman_id": "857b96cd-b4ab-42e2-9068-58c20297baf0",
+		"name": "Python-Starter",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "Get",
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "{{url}}/users",
+					"host": [
+						"{{url}}"
+					],
+					"path": [
+						"users"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Create",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"id": "565d2574-1a1d-462e-a215-2069c432cbd8",
+						"exec": [
+							"var jsonData = pm.response.json();",
+							"if (jsonData.id){",
+							"    pm.environment.set(\"id\", jsonData.id);",
+							"}"
+						],
+						"type": "text/javascript"
+					}
+				}
+			],
+			"request": {
+				"method": "POST",
+				"header": [
+					{
+						"key": "Content-Type",
+						"value": "application/json"
+					}
+				],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"handle\": \"tom\"\n}"
+				},
+				"url": {
+					"raw": "{{url}}/users",
+					"host": [
+						"{{url}}"
+					],
+					"path": [
+						"users"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "PUT",
+			"request": {
+				"method": "PUT",
+				"header": [
+					{
+						"key": "Content-Type",
+						"value": "application/json"
+					}
+				],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n\t\"handle\": \"john7\"\n}"
+				},
+				"url": {
+					"raw": "{{url}}/users/:id",
+					"host": [
+						"{{url}}"
+					],
+					"path": [
+						"users",
+						":id"
+					],
+					"variable": [
+						{
+							"key": "id",
+							"value": "{{id}}"
+						}
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Delete",
+			"request": {
+				"method": "DELETE",
+				"header": [],
+				"url": {
+					"raw": "{{url}}/users/:id",
+					"host": [
+						"{{url}}"
+					],
+					"path": [
+						"users",
+						":id"
+					],
+					"variable": [
+						{
+							"key": "id",
+							"value": "{{id}}"
+						}
+					]
+				}
+			},
+			"response": []
+		}
+	],
+	"protocolProfileBehavior": {}
+}

docs/Python-Starter.postman_environment.json

@@ -0,0 +1,14 @@
+{
+	"id": "61b87801-4312-499b-afc6-92211a98e462",
+	"name": "Python-Starter",
+	"values": [
+		{
+			"key": "url",
+			"value": "localhost:5000",
+			"enabled": true
+		}
+	],
+	"_postman_variable_scope": "environment",
+	"_postman_exported_at": "2019-10-20T10:42:47.301Z",
+	"_postman_exported_using": "Postman/7.9.0"
+}