diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..066ed31d9 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..faad546e2 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,36 @@ 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__) + from app.models.planet import Planet + from app.models.moon import Moon + + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + # if not test_config: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + # else: + # app.config["TESTING"] = True + # app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( "SQLALCHEMY_TEST_DATABASE_URI") + + db.init_app(app) + migrate.init_app(app, db) + + + from .routes.planet_routes import planet_bp + from .routes.moon_routes import moon_bp + + app.register_blueprint(planet_bp) + app.register_blueprint(moon_bp) + - return app + return app \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/moon.py b/app/models/moon.py new file mode 100644 index 000000000..1a7ea6946 --- /dev/null +++ b/app/models/moon.py @@ -0,0 +1,24 @@ +from app import db + +class Moon(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + planet_id = db.Column(db.Integer, db.ForeignKey('planet.id')) + planet = db.relationship("Planet", back_populates="planet_moons") + + def to_json(self): + return { + "id": self.id, + "name": self.name, + } + + def update(self, request_body): + self.name = request_body["name"] + self.planet_id = request_body["planet_id"] + + @classmethod + def create(cls, request_body): + return cls( + name=request_body["name"], + planet_id=request_body["planet_id"], + ) diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..9b8b24684 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,37 @@ +from app import db + +''' +Defined a Planet model with the attributes id, title, +and description, and moons. Created instance method, update, to update our model. +Class method, create, to create a new instance of planet. +''' + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String, nullable=False) + description = db.Column(db.String) + moons = db.Column(db.Boolean, nullable=False) + planet_moons = db.relationship("Moon", back_populates="planet") + + + def to_json(self): + return { + "id": self.id, + "title": self.title, + "description": self.description, + "moons": self.moons + } + + def update(self, request_body): + self.title = request_body["title"] + self.description = request_body["description"] + self.moons = request_body["moons"] + + @classmethod + def create(cls,request_body): + new_planet = cls( + title=request_body["title"], + description=request_body["description"], + moons = request_body["moons"] + ) + return new_planet diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 8e9dfe684..000000000 --- a/app/routes.py +++ /dev/null @@ -1,2 +0,0 @@ -from flask import Blueprint - diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/moon_helpers.py b/app/routes/moon_helpers.py new file mode 100644 index 000000000..e1f21ae56 --- /dev/null +++ b/app/routes/moon_helpers.py @@ -0,0 +1,14 @@ +from flask import Blueprint, jsonify, make_response, abort, request +from app.models.moon import Moon + +def validate_moon(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"moon {id} is invalid"}, 400)) + moon= Moon.query.get(id) + + if not moon: + return abort(make_response({"message": f"moon {id} is not found"}, 404)) + + return moon diff --git a/app/routes/moon_routes.py b/app/routes/moon_routes.py new file mode 100644 index 000000000..055482d2b --- /dev/null +++ b/app/routes/moon_routes.py @@ -0,0 +1,61 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request , abort +from app.models.moon import Moon +from .moon_helpers import validate_moon + + +moon_bp = Blueprint("moon_bp", __name__, url_prefix="/moons") + + +# CREATE Moon +@moon_bp.route("", methods=["POST"]) +def create_moon(): + request_body = request.get_json() + + new_moon = Moon.create(request_body) + + db.session.add(new_moon) + db.session.commit() + + return make_response(f"Moon {new_moon.name} has been successfully created!",201) + +# GET ALL Moons +@moon_bp.route("", methods=["GET"]) +def read_all_moons(): + name_query = request.args.get("name") + + if name_query: + moons = Moon.query.filter_by(name =name_query) + else: + moons = Moon.query.all() + + moons_response = [] + for moon in moons: + moons_response.append(moon.to_json()) + + return jsonify(moons_response), 200 + +# GET one Moon +@moon_bp.route("/", methods = ["GET"]) +def read_one_moon(id): + moon = validate_moon(id) + return jsonify(moon.to_json()), 200 + +@moon_bp.route("/", methods = ["PUT"]) +def update_one_moon(id): + moon = validate_moon(id) + request_body = request.get_json() + + moon.update(request_body) + + db.session.commit() + return make_response(f"Moon #{moon.id} successfully updated"), 200 + +@moon_bp.route("/", methods = ["DELETE"]) +def delete_one_moon(id): + moon = validate_moon(id) + db.session.delete(moon) + db.session.commit() + + return make_response(f"Moon #{moon.id} successfully deleted"), 200 diff --git a/app/routes/planet_helpers.py b/app/routes/planet_helpers.py new file mode 100644 index 000000000..23c28ab90 --- /dev/null +++ b/app/routes/planet_helpers.py @@ -0,0 +1,14 @@ +from flask import Blueprint, jsonify, make_response, abort, request +from app.models.planet import Planet + +def validate_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"planet {id} is invalid"}, 400)) + planet= Planet.query.get(id) + + if not planet: + return abort(make_response({"message": f"planet {id} is not found"}, 404)) + + return planet diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..60896646c --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,103 @@ +from flask import Blueprint, jsonify, make_response, abort, request +from app.models.planet import Planet +from app import db +from .planet_helpers import validate_planet + + + +planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") + +#Create planet +@planet_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet.create(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.title} successfully created", 201) + +#Get all planets +@planet_bp.route("", methods=["GET"]) +def read_all_planets(): + title_query = request.args.get("title") + if title_query: + planets = Planet.query.filter_by(title=title_query) + else: + planets = Planet.query.all() + + planets_response = [] + + for planet in planets: + planets_response.append( + { + "id": planet.id, + "title": planet.title, + "description": planet.description, + "moons": planet.moons + } + ) + + return jsonify(planets_response) + +''' +Created the following endpoint(s). This API can handle requests such as the following: + - to get one existing planet, so that I can see the id, name, description, and other data of the planet. + - such that trying to get one non-existing planet responds + with get a 404 response, so that I know the planet resource was not found. + - such that trying to get one planet with an invalid planet_id responds + with get a 400 response, so that I know the planet_id was invalid. +''' + +#Get one planet +@planet_bp.route("/", methods=["GET"]) +def read_one_planet(id): + planet = validate_planet(id) + + return jsonify(planet.to_json(), 200) + +#Update one planet +@planet_bp.route("/", methods = ["PUT"]) +def update_one_planet(id): + planet = validate_planet(id) + request_body = request.get_json() + planet.update(request_body) + db.session.commit() + + return make_response(jsonify(f"Planet # {planet.id} successfully updated"), 200) + +#Delete one planet +@planet_bp.route("/", methods = ["DELETE"]) +def delete_one_planet(id): + planet = validate_planet(id) + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet # {planet.id} successfully deleted"), 200 + + +# @planet_bp.route("//cats", methods=["POST"]) +# def create_moon(id): +# planet = validate_planet(id) + +# request_body = request.get_json() +# new_moon = Moon.create(request_body) + +# new_moon.planet = planet +# db.session.add(new_moon) +# db.session.commit() + +# return make_response(jsonify(f"Moon {new_moon.name} orbiting around \ +# {new_moon.planet.title} successfully created"), 201) + + +@planet_bp.route("//moons", methods=["GET"]) +def read_moons(id): + planet = validate_planet(id) + + moons_response = [] + for moon in planet.planet_moons: + moons_response.append(moon.to_json()) + + return jsonify(moons_response), 200 diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..826601d78 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,47 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + + +@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 two_saved_planets(app): + mercury_planet = Planet(title="Mercury", description="Best planet, grey", moons=False) + venus_planet = Planet(title="Venus", description="Hottest planet", moons=False) + + db.session.add_all([mercury_planet, venus_planet]) + db.session.commit() + +@pytest.fixture +def all_planets(app): + mercury_planet = Planet(title="Mercury", description="Best planet, grey", moons=False) + venus_planet = Planet(title="Venus", description="Hottest planet", moons=False) + earth_planet = Planet(title="Earth", description="Our planet", moons=True) + mars_planet = Planet(title="Mars", description="There's a Rover", moons=True) + jupiter_planet = Planet(title="Jupiter", description="Big", moons=True) + saturn_planet = Planet(title="Saturn", description="Has a ring", moons=True) + uranus_planet = Planet(title="Uranus", description="Far away", moons=True) + neptune_planet = Planet(title="Neptune", description="So lonely", moons=True) + + db.session.add_all([mercury_planet, venus_planet, earth_planet, mars_planet, jupiter_planet, saturn_planet, uranus_planet, neptune_planet]) + db.session.commit() diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..d732022ca --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,89 @@ +from flask import jsonify, make_response + +def test_get_all_planets_with_no_records(client): + #Act + response = client.get("/planets") + response_body = response.get_json() + + #Assert + assert response.status_code == 200 + assert response_body == [] + +''' +Create test fixtures and unit tests for the following test cases: + +GET /planets/1 returns a response body that matches our fixture DONE +GET /planets/1 with no data in test database (no fixture) returns a 404 DONE +GET /planets with valid test data (fixtures) returns a 200 with an array including appropriate test data +POST /planets with a JSON request body returns a 201 +''' +def test_get_one_planet_that_matches_our_fixture(client, two_saved_planets): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + + #Assert + assert response.status_code == 200 + assert response_body[0] == {"title": "Mercury", "id": 1, "moons": False, "description": "Best planet, grey"} + + +def test_get_one_planet_with_no_records(client): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + + #Assert + assert response.status_code == 404 + assert response_body == {'message': 'planet 1 is not found'} + +def test_get_all_planets_matching_our_fixture(client, all_planets): + #Act + response = client.get("/planets") + response_body = response.get_json() + + #Assert + assert response.status_code == 200 + assert response_body == [ + {"title": "Mercury", + "id": 1, + "moons": False, + "description": "Best planet, grey"}, + {"title": "Venus", + "id": 2, + "moons": False, + "description": "Hottest planet"}, + {"title": "Earth", + "id": 3, + "moons": True, + "description": "Our planet"}, + {"title": "Mars", + "id": 4, + "moons": True, + "description": "There's a Rover"}, + {"title": "Jupiter", + "id": 5, + "moons": True, + "description": "Big"}, + {"title": "Saturn", + "id": 6, + "moons": True, + "description": "Has a ring"}, + {"title": "Uranus", + "id": 7, + "moons": True, + "description": "Far away"}, + {"title": "Neptune", + "id": 8, + "moons": True, + "description": "So lonely"} + ] + +def test_post_first_planet(client): + response = client.post("/planets", json={ + "title": "Mercury", + "description": "NICE PLANET!!!!!", + "moons": False}) + response_body = response.get_json() + + return make_response(jsonify(f"Mercury successfully created"), 201) + 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/61d6d115d837_.py b/migrations/versions/61d6d115d837_.py new file mode 100644 index 000000000..64702147f --- /dev/null +++ b/migrations/versions/61d6d115d837_.py @@ -0,0 +1,42 @@ +"""empty message + +Revision ID: 61d6d115d837 +Revises: +Create Date: 2022-05-11 03:42:29.271519 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '61d6d115d837' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planet', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=True), + sa.Column('moons', sa.Boolean(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('moon', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.Column('planet_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['planet_id'], ['planet.id'], ), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('moon') + op.drop_table('planet') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index a506b4d12..37b7c1d29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,27 @@ alembic==1.5.4 +attrs==21.4.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==6.3.2 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.3 +pluggy==0.13.1 psycopg2-binary==2.8.6 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.8 pytest==6.2.3 pytest-cov==2.12.1 python-dateutil==2.8.1