Initial commit

Author: dannycrief

.circleci/config.yml

@@ -0,0 +1,21 @@
+version: 2.1
+
+orbs:
+  python: circleci/[email protected]
+jobs:
+  working_directory: ~/basic_todo_list
+  build-and-test:
+    executor: python/default
+    steps:
+      - checkout
+      - python/load-cache
+      - python/install-deps
+      - python/save-cache
+      - run: 
+          command: "python -m pytest"
+          name: Test
+
+workflows:
+  main:
+    jobs:
+      - build-and-test

.coverage

@@ -0,0 +1,2 @@
+[run]
+omit = *venv*

.coveragerc

@@ -0,0 +1,6 @@
+venv
+.idea
+
+venv/
+.idea/
+

.gitignore

@@ -0,0 +1,10 @@
+language: python
+python:
+  - "3.7"
+before-install: 
+  - "export PYTHONPATH=$PYTHONPATH:$(pwd)"
+install:
+  - pip install -r requirements.txt
+# command to run tests
+script:
+  - pytest

.travis.yml

@@ -0,0 +1,40 @@
+# basic_todo_list
+[![Travis][build-badge]][build]
+
+
+[build-badge]: https://img.shields.io/travis/tomasmor42/basic_todo_list/master.png?style=flat-square
+[build]: https://travis-ci.org/tomasmor42/basic_todo_list
+
+Basic Flask-Based to-do application. 
+How to start:
+* clone this repo;
+* Go to the repo folder basic_todo_list;
+* Create a virtual environment `python -m venv venv`;
+* Activate it `source venv/bin/activate` (or `virtualenv venv`)
+* Install the `requirements pip install -r requirements.txt`;
+* Set PYTHONPATH with current directory: `export PYTHONPATH=current_folder`
+* You can start an app with python app.py. It will start at `http://127.0.0.1:5000/`
+* This application has following endpoint: 
+  * GET: tasks: gives all stored tasks;
+  * GET: /tasks/<int:task_id>: gives text of the task by id
+  * POST: /tasks/post: create a task. Takes task date (suppose to be in the future) and text in request arguments. 
+* To run tests you can run `pytest tests/test_pytest.py`
+
+
+
+Это небольшое приложение на Flask, которое представляет собой простйший todo-лист. 
+Как начать: 
+* склонировать этот репозиторий;
+* перейти в папку с ним; 
+* создать виртуальное окружение `python -m venv venv`;
+* активировать его `source venv/bin/activate` (или `virtualenv venv`)
+* установить зависимости `requirements pip install -r requirements.txt`;
+* переменную окружения сделать равно текущей директории (текущую директорию можно узнать выполнив команду `pwd`) PYTHONPATH: `export PYTHONPATH=current_folder` (или `set PYTHONPATH=current_folder`)
+* Запустить приложение можно с помощью команды `python app.py`. Оно запустится по адресу `http://127.0.0.1:5000/`
+* У этого приложения есть следующие эндпоинты: 
+  * GET: tasks: возвращает все существующие задачи;
+  * GET: /tasks/<int:task_id>: возвращает задачу с заданным id; 
+  * POST: /tasks/post: создает задачу. Принимает дату задачи (которая должна быть в будущем) и текст в параметрах запроса. 
+  * Запустить тесты можно с помощью команды `pytest tests/test_pytest.py`
+
+

README.md

@@ -0,0 +1,97 @@
+from datetime import datetime
+from flask import Flask, jsonify, request
+
+app = Flask(__name__)
+
+from service import get_task, get_all_tasks, create_task, update_task_by_id
+
+
+class APIException(Exception):
+    status_code = 404
+
+    def __init__(self, message, status_code=None, payload=None):
+        Exception.__init__(self)
+        self.message = message
+        if status_code is not None:
+            self.status_code = status_code
+        self.payload = payload
+
+    def to_dict(self):
+        rv = dict(self.payload or ())
+        rv['message'] = self.message
+        return rv
+
+
+@app.errorhandler(APIException)
+def handle_invalid_usage(error):
+    response = jsonify(error.to_dict())
+    response.status_code = error.status_code
+    return response
+
+
+@app.route("/tasks", methods=['GET'])
+def tasks_list():
+    tasks = get_all_tasks()
+    return jsonify(tasks=tasks)
+
+
+@app.route("/tasks/<int:task_id>", methods=['GET'])
+def task_by_id(task_id):
+    task = get_task(task_id)
+    if not task:
+        raise APIException("Task doesn't exist")
+    return jsonify(task=task)
+
+
+@app.route("/tasks/<int:task_id>", methods=['PUT'])
+def task_update_by_id(task_id):
+    text = request.args.get('text')
+    update_task_by_id(task_id, text)
+    if not task_id:
+        raise APIException("Task doesn't exist")
+
+    return jsonify({'task_id': task_id})
+
+
+from uuid import uuid4
+from collections import namedtuple
+
+TASKS = {}
+Task = namedtuple('Task', ['date', 'text'])
+
+
+def get_parameters_for_task_creation(args):
+    text = args.get('text')
+    date = args.get('date')
+    return text, date
+
+
+def format_date(date):
+    try:
+        date_format = datetime.strptime(date, '%Y-%m-%d %H:%M')
+        if date_format > datetime.now():
+            return date_format
+    except ValueError:
+        return None
+
+
+@app.route("/tasks", methods=['POST'])
+def task_post():
+    text, date = get_parameters_for_task_creation(request.args)
+    if not (text and date):
+        APIException(status_code=412, message='Text and date should not be empty')
+
+    date_format = format_date(date)
+    if not date_format:
+        raise APIException(
+            status_code=412, message='Date should be in the future in format %Y-%m-%d %H:%M')
+    task_id = str(uuid4())
+    TASKS[task_id] = Task(date=date_format, text=text)
+
+    if task_id:
+        return jsonify({'task_id': task_id})
+    raise APIException(status_code=412, message='Date should be in the future')
+
+
+if __name__ == '__main__':
+    app.run()

__pycache__/app.cpython-38.pyc

@@ -0,0 +1,5 @@
+Flask==1.1.2
+pytest==5.4.3
+mock==4.0.2
+allure-pytest==2.8.16
+pytest-cov==2.10.0

__pycache__/service.cpython-38.pyc

@@ -0,0 +1,30 @@
+from collections import namedtuple
+from datetime import datetime
+from uuid import uuid4
+
+Task = namedtuple('Task', ['date', 'text'])
+
+TASKS = {}
+
+
+def get_task(_id):
+    if _id in TASKS:
+        return TASKS[_id]
+
+
+def get_all_tasks():
+    return TASKS
+
+
+def create_task(date, text):
+    date_format = datetime.strptime(date, '%Y-%m-%d %H:%M')
+    if date_format > datetime.now():
+        task_id = str(uuid4())
+        TASKS[task_id] = Task(date=date_format, text=text)
+        return task_id
+
+
+def update_task_by_id(task_id, text):
+    if not task_id in TASKS:
+        return
+    TASKS[task_id] = text

app.py

@@ -0,0 +1,17 @@
+import pytest
+
+import service
+
+TASK_ID = 1
+TASK_TEXT = "text text"
+TASKS = {TASK_ID: TASK_TEXT}
+
+
+@pytest.fixture()
+def tasks():
+    service.TASKS = TASKS
+
+
+@pytest.fixture()
+def tasks_empty():
+    service.TASKS = TASKS

requirements.txt

@@ -0,0 +1,33 @@
+import time
+import pytest
+
+
+@pytest.mark.xfail()
+def test_xfail():
+    assert False
+
+
+@pytest.mark.xfail()
+def test_xpass():
+    assert False
+
+
+def test_unexpected_fail():
+    assert False
+
+
+@pytest.mark.parametrize('param1', [0, 1, 2])
+@pytest.mark.parametrize('param2', ['a', 'b', 'c'])
+def test_parametrized(param1, param2):
+    assert param1
+    assert param2
+
+
+@pytest.mark.skip()
+def test_skip():
+    assert True
+
+
+def test_long_test():
+    time.sleep(3)
+    assert True

service.py

@@ -0,0 +1,81 @@
+import datetime
+from mock import MagicMock
+
+from app import get_parameters_for_task_creation, format_date
+
+import pytest
+
+import service
+
+TASK_ID = 1
+TASK_TEXT = "text text"
+TASKS = {TASK_ID: TASK_TEXT}
+
+
+def test_get_task_id_exists(tasks):
+    result_task = service.get_task(TASK_ID)
+    assert result_task == TASK_TEXT
+
+
+def test_get_task_doesnt_exist(tasks):
+    result_task = service.get_task(2)
+    assert result_task is None
+
+
+def test_get_all_tasks_empty(tasks_empty):
+    service.TASKS = {}
+    all_tasks = service.get_all_tasks()
+    assert all_tasks == {}
+    service.TASKS = TASKS
+
+
+def test_get_all_tasks_not_empty(tasks):
+    all_tasks = service.get_all_tasks()
+    assert all_tasks == TASKS
+
+
+def test_create_task_success():
+    date = (
+            datetime.datetime.now() +
+            datetime.timedelta(days=1)).strftime("%Y-%m-%d %H:%M")
+    task = service.create_task(date, TASK_TEXT)
+    assert task
+
+
+def test_create_task_in_the_past():
+    date = (
+            datetime.datetime.now() -
+            datetime.timedelta(days=1)).strftime("%Y-%m-%d %H:%M")
+
+    task = service.create_task(date, TASK_TEXT)
+    assert task is None
+
+
+def test_get_parameters_ok():
+    args = MagicMock(date="date", text="text")
+    text, date = get_parameters_for_task_creation(args)
+    assert text == text
+    assert date == date
+
+
+def test_get_parameters_invalid():
+    args = MagicMock()
+    args.get.side_effect = ['text', None]
+    text, date = get_parameters_for_task_creation(args)
+    assert date is None
+    assert text == text
+
+
+def test_format_date_valid():
+    date = '2102-01-01 12:12'
+    res = format_date(date)
+    assert res == datetime.datetime(2102, 1, 1, 12, 12)
+
+
+@pytest.mark.parametrize('invalid_date', ['2012-01-01 12:12', '2102-01-01'])
+def test_format_date_invalid(invalid_date):
+    res = format_date(invalid_date)
+    assert res is None
+
+
+# ===================================================================