From 37fc84497804f9e56ae31c86f46cdf21f5bac9ad Mon Sep 17 00:00:00 2001 From: SF Date: Fri, 21 Apr 2023 15:11:49 -0700 Subject: [PATCH 01/15] part one complete not including RESTful part --- app/Planet.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 app/Planet.py diff --git a/app/Planet.py b/app/Planet.py new file mode 100644 index 000000000..e69de29bb From 589c749635efdd8f04a557b602a85cd8a5e953f3 Mon Sep 17 00:00:00 2001 From: Paige Date: Thu, 11 May 2023 19:07:33 -0400 Subject: [PATCH 02/15] created class Planets --- app/__init__.py | 3 +++ app/models/planets.py | 6 ++++++ app/routes.py | 17 ++++++++++++++++- 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 app/models/planets.py diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..4c4a58d67 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,4 +1,7 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy + +db = SQLAlchemy() def create_app(test_config=None): diff --git a/app/models/planets.py b/app/models/planets.py new file mode 100644 index 000000000..1a5ec1231 --- /dev/null +++ b/app/models/planets.py @@ -0,0 +1,6 @@ +from app import db + +class Planets(db.Model): + id = int + name = "Saturn" + description = "big planet" \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..f1ed75d81 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,17 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["POST"]) +def create_planets(): + request_body = request.get_json() + new_planet = + +@planets_bp.route("", methods=["GET"]) +def read_all_planets(): + planets_response = [] + + for planet in planets: + planets_response.append(planet.to_dict()) + return jsonify(planets_response) \ No newline at end of file From 7eb8338e9264d2be712ad5ad4f9fc7c56565dc52 Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 13:29:38 -0400 Subject: [PATCH 03/15] completed waves 01 and 02 --- app/__init__.py | 12 +++++++++++- app/models/__init__.py | 0 app/models/planets.py | 24 ++++++++++++++++++++---- app/routes.py | 32 ++++++++++++++++++++++---------- 4 files changed, 53 insertions(+), 15 deletions(-) create mode 100644 app/models/__init__.py diff --git a/app/__init__.py b/app/__init__.py index 4c4a58d67..8fbf848e1 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,10 +1,20 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate db = SQLAlchemy() - +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) + app.config['AQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + db.init_app(app) + migrate.init_app(app, db) + + from .routes import planets_bp + app.register_blueprint(planets_bp) + return app diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planets.py b/app/models/planets.py index 1a5ec1231..5c49814b6 100644 --- a/app/models/planets.py +++ b/app/models/planets.py @@ -1,6 +1,22 @@ from app import db -class Planets(db.Model): - id = int - name = "Saturn" - description = "big planet" \ No newline at end of file +class Planets(): + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + + def to_dict(self): + planet_as_dict = {} + planet_as_dict["id"] = self.id + planet_as_dict["name"] = self.name + planet_as_dict["description"] = self.description + + return planet_as_dict + + +# planets = [ +# Planets(1, "Saturn", "Gaseous planet with rings"), +# Planets(2, "Jupiter", "Strom planet"), +# Planets(3, "Venus", "Where girls come from") +# ] \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index f1ed75d81..58e5d8d63 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,17 +1,29 @@ from flask import Blueprint, jsonify, abort, make_response, request +from app.models.planets import * planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") -@planets_bp.route("", methods=["POST"]) -def create_planets(): - request_body = request.get_json() - new_planet = +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) + +# for planet in planets: +# if planet_id == planet.id: +# return planet +# abort(make_response({"message":f"planet {planet_id} not found"}, 404)) -@planets_bp.route("", methods=["GET"]) -def read_all_planets(): - planets_response = [] +# @planets_bp.route("", methods=["GET"]) +# def read_all_planets(): +# planets_response = [] +# # for planet in planets: +# # planets_response.append(planet.to_dict()) +# return jsonify(planets_response) + +# @planets_bp.route("/", methods=["GET"]) +# def read_one_planet(planet_id): +# planet = validate_planet(planet_id) +# return planet.to_dict() - for planet in planets: - planets_response.append(planet.to_dict()) - return jsonify(planets_response) \ No newline at end of file From 29b2fec893910b11c07d2198f201e530b54fa681 Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 16:33:08 -0400 Subject: [PATCH 04/15] wrote one create method --- app/__init__.py | 1 + app/models/planets.py | 10 +- app/routes.py | 12 +++ migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../701ca660174d_add_planets_model.py | 33 +++++++ 8 files changed, 217 insertions(+), 5 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/701ca660174d_add_planets_model.py diff --git a/app/__init__.py b/app/__init__.py index 8fbf848e1..516a0fec7 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -14,6 +14,7 @@ def create_app(test_config=None): db.init_app(app) migrate.init_app(app, db) + from app.models.planets import Planets from .routes import planets_bp app.register_blueprint(planets_bp) diff --git a/app/models/planets.py b/app/models/planets.py index 5c49814b6..bcd20584f 100644 --- a/app/models/planets.py +++ b/app/models/planets.py @@ -1,10 +1,10 @@ from app import db -class Planets(): - def __init__(self, id, name, description): - self.id = id - self.name = name - self.description = description +class Planets(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + def to_dict(self): planet_as_dict = {} diff --git a/app/routes.py b/app/routes.py index 58e5d8d63..d778fe976 100644 --- a/app/routes.py +++ b/app/routes.py @@ -15,6 +15,18 @@ # return planet # abort(make_response({"message":f"planet {planet_id} not found"}, 404)) +@planets_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planets(name=request_body["name"], + description=request_body["description"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.title} successfully created", 201) + + # @planets_bp.route("", methods=["GET"]) # def read_all_planets(): # planets_response = [] 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/701ca660174d_add_planets_model.py b/migrations/versions/701ca660174d_add_planets_model.py new file mode 100644 index 000000000..0a554929d --- /dev/null +++ b/migrations/versions/701ca660174d_add_planets_model.py @@ -0,0 +1,33 @@ +"""add Planets model + +Revision ID: 701ca660174d +Revises: +Create Date: 2023-05-12 16:03:34.384310 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '701ca660174d' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planets', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planets') + # ### end Alembic commands ### From 56a869437a1284282554fe27b027d589e3dc87c4 Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 16:34:02 -0400 Subject: [PATCH 05/15] working create method --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index d778fe976..8359a1955 100644 --- a/app/routes.py +++ b/app/routes.py @@ -24,7 +24,7 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.title} successfully created", 201) + return make_response(f"Planet {new_planet.name} successfully created", 201) # @planets_bp.route("", methods=["GET"]) From 08d9b8869acdcb2d4b9463e15cbe56279ea010cd Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 16:43:56 -0400 Subject: [PATCH 06/15] wrote a get mehthod with query --- app/routes.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/app/routes.py b/app/routes.py index 8359a1955..bb4c58c54 100644 --- a/app/routes.py +++ b/app/routes.py @@ -27,12 +27,13 @@ def create_planet(): return make_response(f"Planet {new_planet.name} successfully created", 201) -# @planets_bp.route("", methods=["GET"]) -# def read_all_planets(): -# planets_response = [] -# # for planet in planets: -# # planets_response.append(planet.to_dict()) -# return jsonify(planets_response) +@planets_bp.route("", methods=["GET"]) +def read_all_planets(): + planets = Planets.query.all() + planets_response = [] + for planet in planets: + planets_response.append(planet.to_dict()) + return jsonify(planets_response) # @planets_bp.route("/", methods=["GET"]) # def read_one_planet(planet_id): From 9ba530088eb8b6e697f79fd98062004e5f6454ba Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 16:50:24 -0400 Subject: [PATCH 07/15] used query when reading one planet --- app/routes.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index bb4c58c54..587f3b910 100644 --- a/app/routes.py +++ b/app/routes.py @@ -35,8 +35,9 @@ def read_all_planets(): planets_response.append(planet.to_dict()) return jsonify(planets_response) -# @planets_bp.route("/", methods=["GET"]) -# def read_one_planet(planet_id): -# planet = validate_planet(planet_id) -# return planet.to_dict() +@planets_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = Planets.query.get(planet_id) + # planet = validate_planet(planet_id) + return planet.to_dict() From 923c3d59e8d0791106ed051a855282e9c0a269c1 Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 16:52:52 -0400 Subject: [PATCH 08/15] refacetored validate fxn and read one planet --- app/routes.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/app/routes.py b/app/routes.py index 587f3b910..11cef0690 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,16 +4,17 @@ planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) -# for planet in planets: -# if planet_id == planet.id: -# return planet -# abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + planet = Planets.query.get(planet_id) + + if not planet: + abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + return planet @planets_bp.route("", methods=["POST"]) def create_planet(): @@ -37,7 +38,6 @@ def read_all_planets(): @planets_bp.route("/", methods=["GET"]) def read_one_planet(planet_id): - planet = Planets.query.get(planet_id) - # planet = validate_planet(planet_id) + planet = validate_planet(planet_id) return planet.to_dict() From e2c044f8792c54f17209246333ce67954c4d543a Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 16:58:29 -0400 Subject: [PATCH 09/15] created a PUT route --- app/routes.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/app/routes.py b/app/routes.py index 11cef0690..e32c5a91f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -41,3 +41,14 @@ def read_one_planet(planet_id): planet = validate_planet(planet_id) return planet.to_dict() + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated", 200) From e8120bb101f62504c1689c4f6273e1d388ac5c67 Mon Sep 17 00:00:00 2001 From: Paige Date: Fri, 12 May 2023 17:01:46 -0400 Subject: [PATCH 10/15] created a DELETE route --- app/routes.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/app/routes.py b/app/routes.py index e32c5a91f..43a5f6f36 100644 --- a/app/routes.py +++ b/app/routes.py @@ -52,3 +52,13 @@ def update_planet(planet_id): db.session.commit() return make_response(f"Planet #{planet.id} successfully updated", 200) + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully deleted!", 200) From ca677a5a879237458e2ba4dd67b82459aed0f276 Mon Sep 17 00:00:00 2001 From: Paige Date: Sat, 13 May 2023 17:46:36 -0400 Subject: [PATCH 11/15] wrote test to read all planets --- .gitignore | 4 ++- app/__init__.py | 13 +++++++-- tests/__init__.py | 0 tests/conftest.py | 43 +++++++++++++++++++++++++++++ tests/test_routes.py | 65 ++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 122 insertions(+), 3 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/.gitignore b/.gitignore index 4e9b18359..9e0fb41be 100644 --- a/.gitignore +++ b/.gitignore @@ -138,4 +138,6 @@ dmypy.json .pytype/ # Cython debug symbols -cython_debug/ \ No newline at end of file +cython_debug/ + +.env \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 516a0fec7..8a8170b0e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,15 +1,24 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +from dotenv import load_dotenv +import os db = SQLAlchemy() migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - app.config['AQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + if not test_config: + app.config['AQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") db.init_app(app) migrate.init_app(app, db) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 000000000..c5dead0f8 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,43 @@ +# 1. Create a test to check `GET` `/planets` returns `200` and an empty array. +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planets import Planets + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + with app.app_context(): + db.drop_all() + +@pytest.fixture +def client(app): + return app.test_client() + +@pytest.fixture +def create_one_planet(): + new_planet = Planets(name="Saturn", + description="Planet has rings.") + + db.session.add(new_planet) + db.session.commit() + +@pytest.fixture +def read_all_planets(): + saturn = Planets(name="Saturn", + description="Planet has rings.") + jupiter = Planets(name="Jupiter", + description="Planet has storms the size of earth!") + + db.session.add_all([saturn, jupiter]) + db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..3ab24b3c1 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,65 @@ + +def test_len_of_empty_list(client): + response = client.get("/planets") + + assert response.status_code == 200 + assert response.get_json() == [] + + +##1. `GET` `/planets/1` returns a response body that matches our fixture +def test_get_one_planet_by_id(client, create_one_planet): + # act + response = client.get("/planets/1") + response_body = response.get_json() + + # assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Saturn", + "description": "Planet has rings." + } + + + +##2. `GET` `/planets/1` with no data in test database (no fixture) returns a `404` +def test_get_one_planet_not_found(client): + # act + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == {"message": "planet 1 not found"} + + + + + +##3. `GET` `/planets` with valid test data (fixtures) returns a `200` with an array including appropriate test data +def test_read_all_planets_returns_ok(client, read_all_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert isinstance(response_body, list) + assert len(response_body) == 2 + + + + # assert response_body == [ + # { + # "description": "Planet has storms the size of earth!", + # "id": 2, + # "name": "Jupiter" + # }, + # { + # "description": "This planet has rings.", + # "id": 1, + # "name": "Saturn" + # } + # ] + + + + +##4. `POST` `/planets` with a JSON request body returns a `201` From c87ebf578496e42854e84949f9c38745b48258c2 Mon Sep 17 00:00:00 2001 From: Paige Date: Sat, 13 May 2023 18:10:59 -0400 Subject: [PATCH 12/15] created a test route to test post routes --- app/routes.py | 2 +- tests/conftest.py | 3 ++- tests/test_routes.py | 11 ++++++++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/app/routes.py b/app/routes.py index 43a5f6f36..729506762 100644 --- a/app/routes.py +++ b/app/routes.py @@ -25,7 +25,7 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} successfully created", 201) + return make_response(jsonify(f"Planet {new_planet.name} successfully created"), 201) @planets_bp.route("", methods=["GET"]) diff --git a/tests/conftest.py b/tests/conftest.py index c5dead0f8..87e4f85cb 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -25,7 +25,7 @@ def client(app): return app.test_client() @pytest.fixture -def create_one_planet(): +def get_one_planet(): new_planet = Planets(name="Saturn", description="Planet has rings.") @@ -41,3 +41,4 @@ def read_all_planets(): db.session.add_all([saturn, jupiter]) db.session.commit() + diff --git a/tests/test_routes.py b/tests/test_routes.py index 3ab24b3c1..0cf445923 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -7,7 +7,7 @@ def test_len_of_empty_list(client): ##1. `GET` `/planets/1` returns a response body that matches our fixture -def test_get_one_planet_by_id(client, create_one_planet): +def test_get_one_planet_by_id(client, get_one_planet): # act response = client.get("/planets/1") response_body = response.get_json() @@ -63,3 +63,12 @@ def test_read_all_planets_returns_ok(client, read_all_planets): ##4. `POST` `/planets` with a JSON request body returns a `201` +def test_post_one_book(client): + response = client.post("/planets", json={ + "name": "Venus", + "description": "Girls are made here!" + }) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Planet Venus successfully created" \ No newline at end of file From 421e1eac477b98d6c7fb2cf7eae9a51093546bf9 Mon Sep 17 00:00:00 2001 From: Paige Date: Sat, 13 May 2023 18:12:40 -0400 Subject: [PATCH 13/15] resolved merge conflict --- app/Planet.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 app/Planet.py diff --git a/app/Planet.py b/app/Planet.py deleted file mode 100644 index e69de29bb..000000000 From 6667439dcaeb3df79482d121270112c7d1a708c0 Mon Sep 17 00:00:00 2001 From: Paige Date: Sat, 13 May 2023 18:44:03 -0400 Subject: [PATCH 14/15] added query logic to read all planets route --- app/routes.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 729506762..b6a32533d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -30,7 +30,13 @@ def create_planet(): @planets_bp.route("", methods=["GET"]) def read_all_planets(): - planets = Planets.query.all() + # planets = Planets.query.all() + title_query = request.args.get("title") + if title_query: + planets = Planets.query.filter_by(title=title_query) + else: + planets = Planets.query.all() + planets_response = [] for planet in planets: planets_response.append(planet.to_dict()) From 91fc0999dea79323b87e33d168b89a0b28402a6c Mon Sep 17 00:00:00 2001 From: Paige Date: Sat, 13 May 2023 19:19:16 -0400 Subject: [PATCH 15/15] refactored validate model to be applicable to any models --- app/routes.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/app/routes.py b/app/routes.py index b6a32533d..39c59622f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,16 +4,16 @@ planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") -def validate_planet(planet_id): +def validate_model(cls, model_id): try: - planet_id = int(planet_id) + model_id = int(model_id) except: - abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) + abort(make_response({"message":f"planet {model_id} invalid"}, 400)) - planet = Planets.query.get(planet_id) + planet = cls.query.get(model_id) if not planet: - abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + abort(make_response({"message":f"planet {model_id} not found"}, 404)) return planet @planets_bp.route("", methods=["POST"]) @@ -44,13 +44,13 @@ def read_all_planets(): @planets_bp.route("/", methods=["GET"]) def read_one_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planets, planet_id) return planet.to_dict() @planets_bp.route("/", methods=["PUT"]) def update_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planets, planet_id) request_body = request.get_json() planet.name = request_body["name"] @@ -62,7 +62,7 @@ def update_planet(planet_id): @planets_bp.route("/", methods=["DELETE"]) def delete_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planets, planet_id) db.session.delete(planet) db.session.commit()