From afa7ed923a22d8b85cc03b6da542298a59024988 Mon Sep 17 00:00:00 2001 From: Neida Date: Thu, 3 Nov 2022 21:31:56 -0400 Subject: [PATCH 01/14] creates PUT request to create new task --- app/__init__.py | 2 + app/models/task.py | 35 +++++++++- app/routes.py | 21 +++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/36ef713bcadb_.py | 39 +++++++++++ tests/test_wave_01.py | 1 - 9 files changed, 261 insertions(+), 3 deletions(-) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/36ef713bcadb_.py diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..845c61776 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,5 +30,7 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + from .routes import task_bp + app.register_blueprint(task_bp) return app diff --git a/app/models/task.py b/app/models/task.py index c91ab281f..2ccd3b370 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,38 @@ from app import db +from flask import make_response, abort class Task(db.Model): - task_id = db.Column(db.Integer, primary_key=True) + task_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + description = db.Column(db.String) + completed_at = db.Column(db.DateTime, nullable=True, default=None) + + def to_json(self): + if self.completed_at: + is_complete = True + else: + is_complete = False + + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": is_complete + } + + @classmethod + def from_json(cls, request_body): + return cls( + title=request_body["title"], + description=request_body["description"], + # completed_at=request_body["completed_at"] # Why do I havce to comment this out? + ) + + def update(self,request_body): + try: + self.title = request_body["title"] + self.completed_at = request_body["completed_at"] + self.description = request_body["description"] + except KeyError as error: + abort(make_response({'message': f"Missing attribute: {error}"})) diff --git a/app/routes.py b/app/routes.py index 3aae38d49..b3dd16d9b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1 +1,20 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.task import Task +import os, requests + + +task_bp = Blueprint("tasks", __name__, url_prefix="/tasks") + +# ================================ +# Create One Task +# ================================ +@task_bp.route("", methods=["POST"]) +def create_task(): + request_body = request.get_json() + new_task = Task.from_json(request_body) + + db.session.add(new_task) + db.session.commit() + + return jsonify({"task": new_task.to_json()}), 201 \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/36ef713bcadb_.py b/migrations/versions/36ef713bcadb_.py new file mode 100644 index 000000000..526192ad3 --- /dev/null +++ b/migrations/versions/36ef713bcadb_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 36ef713bcadb +Revises: +Create Date: 2022-11-03 16:56:48.349503 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '36ef713bcadb' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('goal_id', sa.Integer(), nullable=False), + sa.PrimaryKeyConstraint('goal_id') + ) + op.create_table('task', + sa.Column('task_id', sa.Integer(), nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('task_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ### diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..09dc0ac9b 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -66,7 +66,6 @@ def test_get_task_not_found(client): # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ From 0e711925c8da1ae73f15307b15f519cc8103e35d Mon Sep 17 00:00:00 2001 From: Neida Date: Fri, 4 Nov 2022 23:09:32 -0400 Subject: [PATCH 02/14] completed wave one tests, added GET, PUT routes --- app/routes.py | 52 +++++++++++++++++++++++++++++++++++++++++-- tests/test_wave_01.py | 43 ++++++++++++++--------------------- 2 files changed, 67 insertions(+), 28 deletions(-) diff --git a/app/routes.py b/app/routes.py index b3dd16d9b..f48fd0934 100644 --- a/app/routes.py +++ b/app/routes.py @@ -7,7 +7,7 @@ task_bp = Blueprint("tasks", __name__, url_prefix="/tasks") # ================================ -# Create One Task +# Create one task # ================================ @task_bp.route("", methods=["POST"]) def create_task(): @@ -17,4 +17,52 @@ def create_task(): db.session.add(new_task) db.session.commit() - return jsonify({"task": new_task.to_json()}), 201 \ No newline at end of file + return jsonify({"task": new_task.to_json()}), 201 + +# ================================== +# Get all tasks +# ================================== +@task_bp.route("", methods=["GET"]) +def get_all_tasks(): + results_list = [] + all_tasks = Task.query.all() + for task in all_tasks: + results_list.append(task.to_json()) + return jsonify(results_list), 200 + +# ================================== +# Get one task by id number +# ================================== +@task_bp.route("/", methods=["GET"]) +def get_one_task(task_id): + return jsonify({"task": validate_id(Task, task_id).to_json()}), 200 + +# ================================== +# Update one task +# ================================== +@task_bp.route("/", methods=["PUT"]) +def update_one_task(task_id): + request_body = request.get_json() + task = validate_id(Task, task_id) + task.update(request_body) + + db.session.commit() + return jsonify({"task": task.to_json()}), 200 + + + + +# ================================== +# Helper function to validate id +# ================================== +def validate_id(class_name,id): + try: + id = int(id) + except: + abort(make_response({"message":f"Id {id} is an invalid id"}, 400)) + + query_result = class_name.query.get(id) + if not query_result: + abort(make_response({"message":f"Id {id} not found"}, 404)) + + return query_result \ No newline at end of file diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 09dc0ac9b..fb35c7d1f 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -2,7 +2,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_tasks_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -13,7 +13,7 @@ def test_get_tasks_no_saved_tasks(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_tasks_one_saved_tasks(client, one_task): # Act response = client.get("/tasks") @@ -32,7 +32,7 @@ def test_get_tasks_one_saved_tasks(client, one_task): ] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_task(client, one_task): # Act response = client.get("/tasks/1") @@ -51,7 +51,7 @@ def test_get_task(client, one_task): } -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_task_not_found(client): # Act response = client.get("/tasks/1") @@ -59,11 +59,9 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == { + "message":"Id 1 not found" + } def test_create_task(client): @@ -92,7 +90,7 @@ def test_create_task(client): assert new_task.completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") + def test_update_task(client, one_task): # Act response = client.put("/tasks/1", json={ @@ -118,7 +116,7 @@ def test_update_task(client, one_task): assert task.completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") + def test_update_task_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -129,14 +127,11 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == { + "message":"Id 1 not found" + } -@pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -151,7 +146,6 @@ def test_delete_task(client, one_task): assert Task.query.get(1) == None -@pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -159,16 +153,13 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - + assert response_body == { + "message":"Id 1 not found" + } assert Task.query.all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_create_task_must_contain_title(client): # Act response = client.post("/tasks", json={ @@ -185,7 +176,7 @@ def test_create_task_must_contain_title(client): assert Task.query.all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_create_task_must_contain_description(client): # Act response = client.post("/tasks", json={ From b07180d578baf6fb2c5d58fceae00737eee13db6 Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 6 Nov 2022 00:14:23 -0400 Subject: [PATCH 03/14] completed wave 1 --- app/models/task.py | 14 +++++++++++++- app/routes.py | 21 ++++++++++++++++++--- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 2ccd3b370..b7eccadaa 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -32,7 +32,19 @@ def from_json(cls, request_body): def update(self,request_body): try: self.title = request_body["title"] - self.completed_at = request_body["completed_at"] + # self.completed_at = request_body["completed_at"] # why does this need to be commented out to pass test_update_task ???? self.description = request_body["description"] except KeyError as error: abort(make_response({'message': f"Missing attribute: {error}"})) + + @classmethod + def create(cls, request_body): + new_task = cls( + title = request_body["title"], + description = request_body["description"], + # completed_at = request_body["completed_at"] + ) + + return new_task + + diff --git a/app/routes.py b/app/routes.py index f48fd0934..24b5abf88 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,11 +8,18 @@ # ================================ # Create one task +# TODO: handle cases with missing titles/completed_at/description # ================================ @task_bp.route("", methods=["POST"]) def create_task(): request_body = request.get_json() - new_task = Task.from_json(request_body) + + try: + new_task = Task.create(request_body) + except KeyError as error: + return make_response({"details": "Invalid data"}, 400) + + db.session.add(new_task) db.session.commit() @@ -39,6 +46,7 @@ def get_one_task(task_id): # ================================== # Update one task +# TODO: fix tests for this # ================================== @task_bp.route("/", methods=["PUT"]) def update_one_task(task_id): @@ -49,8 +57,15 @@ def update_one_task(task_id): db.session.commit() return jsonify({"task": task.to_json()}), 200 - - +# ================================== +# Delete one task by id +# ================================== +@task_bp.route("/", methods=["DELETE"]) +def delete_one_task(task_id): + task = validate_id(Task, task_id) + db.session.delete(task) + db.session.commit() + return make_response({"details":f'Task {task.task_id} "{task.title}" successfully deleted'}, 200) # ================================== # Helper function to validate id From a973e17e48a4e10e66f5d0f213b28104c6deb00c Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 6 Nov 2022 00:58:12 -0400 Subject: [PATCH 04/14] completed wave 2 --- app/routes.py | 17 ++++++++++++----- tests/test_wave_02.py | 4 ++-- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/app/routes.py b/app/routes.py index 24b5abf88..e8c97bf89 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,7 +8,6 @@ # ================================ # Create one task -# TODO: handle cases with missing titles/completed_at/description # ================================ @task_bp.route("", methods=["POST"]) def create_task(): @@ -19,8 +18,6 @@ def create_task(): except KeyError as error: return make_response({"details": "Invalid data"}, 400) - - db.session.add(new_task) db.session.commit() @@ -31,10 +28,18 @@ def create_task(): # ================================== @task_bp.route("", methods=["GET"]) def get_all_tasks(): + sort_query = request.args.get("sort") + if sort_query == 'asc': + all_tasks = Task.query.order_by(Task.title) + elif sort_query == 'desc': + all_tasks = Task.query.order_by(Task.title.desc()) + else: + all_tasks = Task.query.all() + results_list = [] - all_tasks = Task.query.all() for task in all_tasks: results_list.append(task.to_json()) + return jsonify(results_list), 200 # ================================== @@ -46,7 +51,6 @@ def get_one_task(task_id): # ================================== # Update one task -# TODO: fix tests for this # ================================== @task_bp.route("/", methods=["PUT"]) def update_one_task(task_id): @@ -55,6 +59,7 @@ def update_one_task(task_id): task.update(request_body) db.session.commit() + return jsonify({"task": task.to_json()}), 200 # ================================== @@ -63,8 +68,10 @@ def update_one_task(task_id): @task_bp.route("/", methods=["DELETE"]) def delete_one_task(task_id): task = validate_id(Task, task_id) + db.session.delete(task) db.session.commit() + return make_response({"details":f'Task {task.task_id} "{task.title}" successfully deleted'}, 200) # ================================== diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..41f3eccde 100644 --- a/tests/test_wave_02.py +++ b/tests/test_wave_02.py @@ -1,7 +1,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_tasks_sorted_asc(client, three_tasks): # Act response = client.get("/tasks?sort=asc") @@ -29,7 +29,7 @@ def test_get_tasks_sorted_asc(client, three_tasks): ] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_tasks_sorted_desc(client, three_tasks): # Act response = client.get("/tasks?sort=desc") From b31d5a77809e0ee2d4221cbb67d638d1ffb1ba36 Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 6 Nov 2022 22:13:38 -0500 Subject: [PATCH 05/14] added completion marking patch route, passed wave 3 tests --- app/models/task.py | 2 +- app/routes.py | 21 +++++++++++++++++++-- tests/test_wave_03.py | 26 +++++++++++--------------- 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index b7eccadaa..821686b0d 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -42,7 +42,7 @@ def create(cls, request_body): new_task = cls( title = request_body["title"], description = request_body["description"], - # completed_at = request_body["completed_at"] + completed_at = request_body["completed_at"] ) return new_task diff --git a/app/routes.py b/app/routes.py index e8c97bf89..1007e0d50 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,7 +1,8 @@ from flask import Blueprint, jsonify, abort, make_response, request from app import db from app.models.task import Task -import os, requests +from datetime import datetime + task_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -30,7 +31,7 @@ def create_task(): def get_all_tasks(): sort_query = request.args.get("sort") if sort_query == 'asc': - all_tasks = Task.query.order_by(Task.title) + all_tasks = Task.query.order_by(Task.title.asc()) elif sort_query == 'desc': all_tasks = Task.query.order_by(Task.title.desc()) else: @@ -74,6 +75,22 @@ def delete_one_task(task_id): return make_response({"details":f'Task {task.task_id} "{task.title}" successfully deleted'}, 200) +# ================================== +# update one task's completeness +# ================================== +@task_bp.route("//", methods=["PATCH"]) +def mark_tasks_complete_or_incomplete(task_id, mark): + task = validate_id(Task, task_id) + if mark == "mark_complete": + task.completed_at = datetime.now() + db.session.commit() + return jsonify({"task": task.to_json()}), 200 + elif mark == "mark_incomplete": + task.completed_at = None + db.session.commit() + return jsonify({"task": task.to_json()}), 200 + + # ================================== # Helper function to validate id # ================================== diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..5d944add4 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -5,7 +5,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") + def test_mark_complete_on_incomplete_task(client, one_task): # Arrange """ @@ -42,7 +42,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert Task.query.get(1).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") + def test_mark_incomplete_on_complete_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -62,7 +62,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert Task.query.get(1).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") + def test_mark_complete_on_completed_task(client, completed_task): # Arrange """ @@ -99,7 +99,7 @@ def test_mark_complete_on_completed_task(client, completed_task): assert Task.query.get(1).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") + def test_mark_incomplete_on_incomplete_task(client, one_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -119,7 +119,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert Task.query.get(1).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") + def test_mark_complete_missing_task(client): # Act response = client.patch("/tasks/1/mark_complete") @@ -127,14 +127,12 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == { + "message": "Id 1 not found" + } - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_missing_task(client): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -142,8 +140,6 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == { + "message": "Id 1 not found" + } From bdb8dcb752810c6a6d173bfafec4d4683a760426 Mon Sep 17 00:00:00 2001 From: Neida Date: Sat, 12 Nov 2022 18:44:54 -0500 Subject: [PATCH 06/14] added slack API integration --- ada-project-docs/wave_04.md | 7 +++++++ app/models/task.py | 4 ++-- app/routes.py | 28 +++++++++++++++++++++++++--- 3 files changed, 34 insertions(+), 5 deletions(-) diff --git a/ada-project-docs/wave_04.md b/ada-project-docs/wave_04.md index 079ce6485..4e509447e 100644 --- a/ada-project-docs/wave_04.md +++ b/ada-project-docs/wave_04.md @@ -98,9 +98,13 @@ Visit https://api.slack.com/methods/chat.postMessage to read about the Slack API Answer the following questions. These questions will help you become familiar with the API, and make working with it easier. - What is the responsibility of this endpoint? +This endpoint posts a message to a channel. - What is the URL and HTTP method for this endpoint? +POST https://slack.com/api/chat.postMessage - What are the _two_ _required_ arguments for this endpoint? +token and channel (string) - How does this endpoint relate to the Slackbot API key (token) we just created? +The token we just made is one of the arguments we have to pass in to the endpoint Now, visit https://api.slack.com/methods/chat.postMessage/test. @@ -119,8 +123,11 @@ Press the "Test Method" button! Scroll down to see the HTTP response. Answer the following questions: - Did we get a success message? If so, did we see the message in our actual Slack workspace? +The actual text I put in the test did show up as a message in the slack workspace. There was also a response that came back on the test webpage that said the message had been successful. - Did we get an error emssage? If so, why? +I did not get an error message. - What is the shape of this JSON? Is it a JSON object or array? What keys and values are there? +The JSON is an object enclosed in {} and has many key value pairs such as "ok" : true and "deleted": false. ### Verify with Postman diff --git a/app/models/task.py b/app/models/task.py index 821686b0d..caf5ff444 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -26,7 +26,7 @@ def from_json(cls, request_body): return cls( title=request_body["title"], description=request_body["description"], - # completed_at=request_body["completed_at"] # Why do I havce to comment this out? + # completed_at=request_body["completed_at"] # Why do I have to comment this out? ) def update(self,request_body): @@ -42,7 +42,7 @@ def create(cls, request_body): new_task = cls( title = request_body["title"], description = request_body["description"], - completed_at = request_body["completed_at"] + # completed_at = request_body["completed_at"] ) return new_task diff --git a/app/routes.py b/app/routes.py index 1007e0d50..b32f1511f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,8 +1,12 @@ from flask import Blueprint, jsonify, abort, make_response, request + from app import db from app.models.task import Task from datetime import datetime - +import logging +import os +from slack_sdk import WebClient +from slack_sdk.errors import SlackApiError task_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -82,6 +86,7 @@ def delete_one_task(task_id): def mark_tasks_complete_or_incomplete(task_id, mark): task = validate_id(Task, task_id) if mark == "mark_complete": + send_to_slack(task.title, "task-notifications") task.completed_at = datetime.now() db.session.commit() return jsonify({"task": task.to_json()}), 200 @@ -89,7 +94,7 @@ def mark_tasks_complete_or_incomplete(task_id, mark): task.completed_at = None db.session.commit() return jsonify({"task": task.to_json()}), 200 - +# can combine this into one expression - ternary https://www.geeksforgeeks.org/ternary-operator-in-python/ # ================================== # Helper function to validate id @@ -104,4 +109,21 @@ def validate_id(class_name,id): if not query_result: abort(make_response({"message":f"Id {id} not found"}, 404)) - return query_result \ No newline at end of file + return query_result + +# ================================== +# Helper function to send message to slack +# ================================== +def send_to_slack(title, channel_name): + client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) + logger = logging.getLogger(__name__) + try: + # Call the chat.postMessage method using the WebClient + result = client.chat_postMessage( + channel=channel_name, + text= f"Someone just completed the task '{title}'" + ) + logger.info(result) + + except SlackApiError as e: + logger.error(f"Error posting message: {e}") \ No newline at end of file From bad0ca293d2506d8308706acb17da5b35bcaf8b4 Mon Sep 17 00:00:00 2001 From: Neida Date: Sat, 12 Nov 2022 23:52:11 -0500 Subject: [PATCH 07/14] added goal model, goal routes, and wave 5 tests --- app/__init__.py | 4 +- app/models/goal.py | 21 ++++++ app/models/task.py | 4 -- app/routes/goal_routes.py | 66 ++++++++++++++++++ app/{routes.py => routes/task_routes.py} | 1 - migrations/versions/795dd0861e0d_.py | 28 ++++++++ tests/test_wave_05.py | 87 +++++++++++++----------- 7 files changed, 166 insertions(+), 45 deletions(-) create mode 100644 app/routes/goal_routes.py rename app/{routes.py => routes/task_routes.py} (99%) create mode 100644 migrations/versions/795dd0861e0d_.py diff --git a/app/__init__.py b/app/__init__.py index 845c61776..6af1d3626 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,7 +30,9 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here - from .routes import task_bp + from .routes.task_routes import task_bp + from .routes.goal_routes import goal_bp app.register_blueprint(task_bp) + app.register_blueprint(goal_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index b0ed11dd8..dd7a09739 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,26 @@ from app import db +from flask import abort, make_response class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) + title = db.Column(db.String) + + @classmethod + def create(cls, request_body): + new_goal = cls( + title = request_body["title"], + ) + return new_goal + + def update(self,request_body): + try: + self.title = request_body["title"] + except KeyError as error: + abort(make_response({'message': f"Missing attribute: {error}"})) + + def to_json(self): + return { + "id": self.goal_id, + "title": self.title, + } diff --git a/app/models/task.py b/app/models/task.py index caf5ff444..16bf7f3dd 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -26,13 +26,11 @@ def from_json(cls, request_body): return cls( title=request_body["title"], description=request_body["description"], - # completed_at=request_body["completed_at"] # Why do I have to comment this out? ) def update(self,request_body): try: self.title = request_body["title"] - # self.completed_at = request_body["completed_at"] # why does this need to be commented out to pass test_update_task ???? self.description = request_body["description"] except KeyError as error: abort(make_response({'message': f"Missing attribute: {error}"})) @@ -42,9 +40,7 @@ def create(cls, request_body): new_task = cls( title = request_body["title"], description = request_body["description"], - # completed_at = request_body["completed_at"] ) - return new_task diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py new file mode 100644 index 000000000..31b80f722 --- /dev/null +++ b/app/routes/goal_routes.py @@ -0,0 +1,66 @@ +from app import db +from app.models.goal import Goal +from flask import Blueprint, request, jsonify, make_response +from app.routes.task_routes import validate_id + +goal_bp = Blueprint("goals", __name__, url_prefix="/goals") + +# ================================ +# Create one goal +# ================================ + +@goal_bp.route("", methods=["POST"]) +def create_goal(): + request_body = request.get_json() + + try: + new_goal = Goal.create(request_body) + except KeyError: + return make_response({"details": "Invalid data"}, 400) + + db.session.add(new_goal) + db.session.commit() + + return jsonify({"goal": new_goal.to_json()}), 201 + +# ================================== +# Get all goals +# ================================== + +@goal_bp.route("", methods=["GET"]) +def get_all_goals(): + all_goals = Goal.query.all() + results_list = [] + for goal in all_goals: + results_list.append(goal.to_json()) + return jsonify(results_list), 200 + +# ================================== +# Get one goal by id number +# ================================== +@goal_bp.route("/", methods=["GET"]) +def get_one_goal(goal_id): + return jsonify({"goal": validate_id(Goal, goal_id).to_json()}), 200 + +# ================================== +# Update one goal +# ================================== +@goal_bp.route("/", methods=["PUT"]) +def update_one_goal(goal_id): + request_body = request.get_json() + goal = validate_id(Goal, goal_id) + goal.update(request_body) + db.session.commit() + return jsonify({"goal": goal.to_json()}), 200 + +# ================================== +# Delete one goal by id +# ================================== +@goal_bp.route("/", methods=["DELETE"]) +def delete_one_goal(goal_id): + goal = validate_id(Goal, goal_id) + + db.session.delete(goal) + db.session.commit() + + return make_response({"details":f'Goal {goal.goal_id} "{goal.title}" successfully deleted'}, 200) diff --git a/app/routes.py b/app/routes/task_routes.py similarity index 99% rename from app/routes.py rename to app/routes/task_routes.py index b32f1511f..bf302fc25 100644 --- a/app/routes.py +++ b/app/routes/task_routes.py @@ -1,5 +1,4 @@ from flask import Blueprint, jsonify, abort, make_response, request - from app import db from app.models.task import Task from datetime import datetime diff --git a/migrations/versions/795dd0861e0d_.py b/migrations/versions/795dd0861e0d_.py new file mode 100644 index 000000000..444d8d571 --- /dev/null +++ b/migrations/versions/795dd0861e0d_.py @@ -0,0 +1,28 @@ +"""empty message + +Revision ID: 795dd0861e0d +Revises: 36ef713bcadb +Create Date: 2022-11-12 23:13:59.208095 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '795dd0861e0d' +down_revision = '36ef713bcadb' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('goal', sa.Column('title', sa.String(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('goal', 'title') + # ### end Alembic commands ### diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index aee7c52a1..e31cc8c09 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,8 @@ import pytest +from app.models.goal import Goal + -@pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +13,7 @@ def test_get_goals_no_saved_goals(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_goals_one_saved_goal(client, one_goal): # Act response = client.get("/goals") @@ -29,7 +30,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -46,22 +47,22 @@ def test_get_goal(client, one_goal): } -@pytest.mark.skip(reason="test to be completed by student") + def test_get_goal_not_found(client): pass # Act response = client.get("/goals/1") response_body = response.get_json() - raise Exception("Complete test") + # Assert - # ---- Complete Test ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Test ---- + assert response.status_code == 404 + assert response_body == { + "message":"Id 1 not found" + } + -@pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -80,34 +81,43 @@ def test_create_goal(client): } -@pytest.mark.skip(reason="test to be completed by student") + def test_update_goal(client, one_goal): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal Title", + }) + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 200 + assert "goal" in response_body + assert response_body == { + "goal": { + "id": 1, + "title": "Updated Goal Title", + } + } + goal = Goal.query.get(1) + assert goal.title == "Updated Goal Title" + -@pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal Title", + }) + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == { + "message":"Id 1 not found" + } + -@pytest.mark.skip(reason="No way to test this feature yet") def test_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -122,29 +132,28 @@ def test_delete_goal(client, one_goal): # Check that the goal was deleted response = client.get("/goals/1") + response_body = response.get_json() assert response.status_code == 404 + assert response_body == { + "message": "Id 1 not found" + } - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** -@pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") - # Act - # ---- Complete Act Here ---- + response = client.delete("/tasks/1") + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == { + "message":"Id 1 not found" + } + assert Goal.query.all() == [] + -@pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal_missing_title(client): # Act response = client.post("/goals", json={}) From f43af8467f3bbdccc080319572b4281ff31585f0 Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 13 Nov 2022 15:39:12 -0500 Subject: [PATCH 08/14] added one to many relationship between goals and tasks, passed wave 6 --- app/models/goal.py | 8 +------ app/models/task.py | 30 +++++++++++++++----------- app/routes/goal_routes.py | 32 +++++++++++++++++++++++++++- app/routes/task_routes.py | 2 +- migrations/versions/a3cd8afc3256_.py | 30 ++++++++++++++++++++++++++ tests/test_wave_06.py | 18 +++++++--------- 6 files changed, 88 insertions(+), 32 deletions(-) create mode 100644 migrations/versions/a3cd8afc3256_.py diff --git a/app/models/goal.py b/app/models/goal.py index dd7a09739..9eb28c046 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -5,13 +5,7 @@ class Goal(db.Model): goal_id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String) - - @classmethod - def create(cls, request_body): - new_goal = cls( - title = request_body["title"], - ) - return new_goal + tasks = db.relationship("Task", back_populates="goal", lazy=True) def update(self,request_body): try: diff --git a/app/models/task.py b/app/models/task.py index 16bf7f3dd..4a32c1d1a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -7,6 +7,8 @@ class Task(db.Model): title = db.Column(db.String) description = db.Column(db.String) completed_at = db.Column(db.DateTime, nullable=True, default=None) + goal = db.relationship("Goal", back_populates="tasks") + goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id"), nullable=True) def to_json(self): if self.completed_at: @@ -14,19 +16,21 @@ def to_json(self): else: is_complete = False - return { - "id": self.task_id, - "title": self.title, - "description": self.description, - "is_complete": is_complete - } - - @classmethod - def from_json(cls, request_body): - return cls( - title=request_body["title"], - description=request_body["description"], - ) + if self.goal_id: + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": is_complete, + "goal_id": self.goal_id + } + else: + return { + "id": self.task_id, + "title": self.title, + "description": self.description, + "is_complete": is_complete + } def update(self,request_body): try: diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 31b80f722..c184fbb7d 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,5 +1,6 @@ from app import db from app.models.goal import Goal +from app.models.task import Task from flask import Blueprint, request, jsonify, make_response from app.routes.task_routes import validate_id @@ -14,7 +15,7 @@ def create_goal(): request_body = request.get_json() try: - new_goal = Goal.create(request_body) + new_goal = Goal(title=request_body["title"]) except KeyError: return make_response({"details": "Invalid data"}, 400) @@ -38,6 +39,7 @@ def get_all_goals(): # ================================== # Get one goal by id number # ================================== + @goal_bp.route("/", methods=["GET"]) def get_one_goal(goal_id): return jsonify({"goal": validate_id(Goal, goal_id).to_json()}), 200 @@ -45,6 +47,7 @@ def get_one_goal(goal_id): # ================================== # Update one goal # ================================== + @goal_bp.route("/", methods=["PUT"]) def update_one_goal(goal_id): request_body = request.get_json() @@ -56,6 +59,7 @@ def update_one_goal(goal_id): # ================================== # Delete one goal by id # ================================== + @goal_bp.route("/", methods=["DELETE"]) def delete_one_goal(goal_id): goal = validate_id(Goal, goal_id) @@ -64,3 +68,29 @@ def delete_one_goal(goal_id): db.session.commit() return make_response({"details":f'Goal {goal.goal_id} "{goal.title}" successfully deleted'}, 200) + +# ====================================== +# Get all tasks that are under one goal +# ====================================== +@goal_bp.route("//tasks", methods=["GET"]) +def get_all_tasks_for_one_goal(goal_id): + goal = validate_id(Goal, goal_id) + all_goal_tasks = [] + for task in goal.tasks: + all_goal_tasks.append(Task.to_json(task)) + return make_response({"id": goal.goal_id, "title": goal.title, "tasks": all_goal_tasks}, 200) + +# ====================================== +# Post tasks to one goal +# ====================================== +@goal_bp.route("//tasks", methods=["POST"]) +def associate_tasks_with_one_goal(goal_id): + request_body = request.get_json() + goal = validate_id(Goal,goal_id) + task_list = request_body["task_ids"] + for task_number in task_list: + task = validate_id(Task, task_number) + if task not in goal.tasks: + goal.tasks.append(task) + db.session.commit() + return make_response({"id": goal.goal_id, "task_ids": task_list}, 200) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index bf302fc25..33993fc65 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -19,7 +19,7 @@ def create_task(): try: new_task = Task.create(request_body) - except KeyError as error: + except KeyError: return make_response({"details": "Invalid data"}, 400) db.session.add(new_task) diff --git a/migrations/versions/a3cd8afc3256_.py b/migrations/versions/a3cd8afc3256_.py new file mode 100644 index 000000000..a80288b01 --- /dev/null +++ b/migrations/versions/a3cd8afc3256_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: a3cd8afc3256 +Revises: 795dd0861e0d +Create Date: 2022-11-13 14:26:46.958053 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a3cd8afc3256' +down_revision = '795dd0861e0d' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('task', sa.Column('goal_id', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'task', 'goal', ['goal_id'], ['goal_id']) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint(None, 'task', type_='foreignkey') + op.drop_column('task', 'goal_id') + # ### end Alembic commands ### diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..8e0eb2a96 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -2,7 +2,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") + def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -23,7 +23,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(Goal.query.get(1).tasks) == 3 -@pytest.mark.skip(reason="No way to test this feature yet") + def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -42,7 +42,7 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on assert len(Goal.query.get(1).tasks) == 2 -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_tasks_for_specific_goal_no_goal(client): # Act response = client.get("/goals/1/tasks") @@ -50,14 +50,12 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 + assert response_body == { + "message":"Id 1 not found" + } - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** -@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -74,7 +72,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -99,7 +97,7 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") + def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json() From 3017091dc6d19071399de561b34cbcb16fab45ad Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 13 Nov 2022 18:36:12 -0500 Subject: [PATCH 09/14] added procfile --- Procfile | 1 + 1 file changed, 1 insertion(+) create mode 100644 Procfile diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file From 2d97165b04e14969e229e4272581be15de54a772 Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 13 Nov 2022 19:01:21 -0500 Subject: [PATCH 10/14] updated requirements --- requirements.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/requirements.txt b/requirements.txt index cacdbc36e..7b34a36f8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,6 +5,7 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==6.5.0 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 @@ -28,7 +29,9 @@ python-dotenv==0.15.0 python-editor==1.0.4 requests==2.25.1 six==1.15.0 +slack-sdk==3.19.3 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.5 Werkzeug==1.0.1 From 341a47c29b13dd280b33ef6c179ca0caf1873eaf Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 13 Nov 2022 19:31:55 -0500 Subject: [PATCH 11/14] refactoring mark complete route --- app/routes/task_routes.py | 51 ++++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 33993fc65..597c319ec 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -84,16 +84,20 @@ def delete_one_task(task_id): @task_bp.route("//", methods=["PATCH"]) def mark_tasks_complete_or_incomplete(task_id, mark): task = validate_id(Task, task_id) - if mark == "mark_complete": - send_to_slack(task.title, "task-notifications") - task.completed_at = datetime.now() - db.session.commit() - return jsonify({"task": task.to_json()}), 200 - elif mark == "mark_incomplete": - task.completed_at = None - db.session.commit() - return jsonify({"task": task.to_json()}), 200 -# can combine this into one expression - ternary https://www.geeksforgeeks.org/ternary-operator-in-python/ + task.completed_at = datetime.now() if mark == "mark_complete" else None + send_to_slack(task.title, "task-notifications", mark) + db.session.commit() + return jsonify({"task": task.to_json()}), 200 + + # if mark == "mark_complete": + # send_to_slack(task.title, "task-notifications") + # task.completed_at = datetime.now() + # db.session.commit() + # return jsonify({"task": task.to_json()}), 200 + # elif mark == "mark_incomplete": + # task.completed_at = None + # db.session.commit() + # return jsonify({"task": task.to_json()}), 200 # ================================== # Helper function to validate id @@ -113,16 +117,19 @@ def validate_id(class_name,id): # ================================== # Helper function to send message to slack # ================================== -def send_to_slack(title, channel_name): - client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) - logger = logging.getLogger(__name__) - try: +def send_to_slack(title, channel_name, mark): + if mark == "mark_complete": + client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) + logger = logging.getLogger(__name__) + try: # Call the chat.postMessage method using the WebClient - result = client.chat_postMessage( - channel=channel_name, - text= f"Someone just completed the task '{title}'" - ) - logger.info(result) - - except SlackApiError as e: - logger.error(f"Error posting message: {e}") \ No newline at end of file + result = client.chat_postMessage( + channel=channel_name, + text= f"Someone just completed the task '{title}'" + ) + logger.info(result) + + except SlackApiError as e: + logger.error(f"Error posting message: {e}") + else: + pass \ No newline at end of file From a998ec8d9abae33e729091b9d6cd6b38217d6d8a Mon Sep 17 00:00:00 2001 From: Neida Date: Sun, 13 Nov 2022 19:34:53 -0500 Subject: [PATCH 12/14] spacing --- app/routes/task_routes.py | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 597c319ec..aa00ea541 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -89,16 +89,6 @@ def mark_tasks_complete_or_incomplete(task_id, mark): db.session.commit() return jsonify({"task": task.to_json()}), 200 - # if mark == "mark_complete": - # send_to_slack(task.title, "task-notifications") - # task.completed_at = datetime.now() - # db.session.commit() - # return jsonify({"task": task.to_json()}), 200 - # elif mark == "mark_incomplete": - # task.completed_at = None - # db.session.commit() - # return jsonify({"task": task.to_json()}), 200 - # ================================== # Helper function to validate id # ================================== From dcb5b638a82ebcd2ce79e9ac1ff948c745550f07 Mon Sep 17 00:00:00 2001 From: Neida Date: Fri, 18 Nov 2022 23:39:05 -0500 Subject: [PATCH 13/14] refactored Slack API call method --- app/routes/task_routes.py | 48 +++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index aa00ea541..eea4ca868 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,11 +2,8 @@ from app import db from app.models.task import Task from datetime import datetime -import logging import os -from slack_sdk import WebClient -from slack_sdk.errors import SlackApiError - +import requests task_bp = Blueprint("tasks", __name__, url_prefix="/tasks") @@ -108,18 +105,31 @@ def validate_id(class_name,id): # Helper function to send message to slack # ================================== def send_to_slack(title, channel_name, mark): - if mark == "mark_complete": - client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) - logger = logging.getLogger(__name__) - try: - # Call the chat.postMessage method using the WebClient - result = client.chat_postMessage( - channel=channel_name, - text= f"Someone just completed the task '{title}'" - ) - logger.info(result) - - except SlackApiError as e: - logger.error(f"Error posting message: {e}") - else: - pass \ No newline at end of file + header_data = {'Authorization': f"Bearer {os.environ.get('SLACK_BOT_TOKEN')}"} + message_data = {'channel': channel_name, 'text': f"Someone just completed the task {title}"} + if mark == 'mark_complete': + requests.post('https://slack.com/api/chat.postMessage', params=message_data, headers=header_data) + + + + +# original implementation using slack_sdk to make calls to slack API + +# import logging +# from slack_sdk import WebClient +# from slack_sdk.errors import SlackApiError + +# def send_to_slack(title, channel_name, mark): +# if mark == "mark_complete": +# client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) +# logger = logging.getLogger(__name__) +# try: +# # Call the chat.postMessage method using the WebClient +# result = client.chat_postMessage( +# channel=channel_name, +# text= f"Someone just completed the task '{title}'" +# ) +# logger.info(result) + +# except SlackApiError as e: +# logger.error(f"Error posting message: {e}") \ No newline at end of file From 629df2409686501c2d8fbf3f0e3b2dda2a57c819 Mon Sep 17 00:00:00 2001 From: Neida Date: Fri, 18 Nov 2022 23:42:06 -0500 Subject: [PATCH 14/14] switched request argument from params to data --- app/routes/task_routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index eea4ca868..dda2c9197 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -108,7 +108,7 @@ def send_to_slack(title, channel_name, mark): header_data = {'Authorization': f"Bearer {os.environ.get('SLACK_BOT_TOKEN')}"} message_data = {'channel': channel_name, 'text': f"Someone just completed the task {title}"} if mark == 'mark_complete': - requests.post('https://slack.com/api/chat.postMessage', params=message_data, headers=header_data) + requests.post('https://slack.com/api/chat.postMessage', data=message_data, headers=header_data)