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 diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..a7e95367e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,32 @@ 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__) + if not test_config: + app.config['SQLALCHEMY_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") + + from app.models.planet import Planet + + 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/planet.py b/app/models/planet.py new file mode 100644 index 000000000..74efb7b27 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,16 @@ +from app import db + +class Planet(db.Model): + __tablename__ = "Planets" + id = db.Column(db.Integer,primary_key=True,autoincrement = True) + name = db.Column(db.String) + diameter = db.Column(db.String) + moons = db.Column(db.Boolean) + picture = db.Column(db.String) + + def to_dict(self): + return ({"id": self.id, + "name": self.name, + "diameter": self.diameter, + "moons": self.moons, + "picture": self.picture}) \ No newline at end of file diff --git a/app/models/planet_info.txt b/app/models/planet_info.txt new file mode 100644 index 000000000..d3f729275 --- /dev/null +++ b/app/models/planet_info.txt @@ -0,0 +1,55 @@ +{ + "name": "Mercury", + "diameter":"Diameter: 3,031 miles (4,878 km)", + "moons": false, + "picture":"https://cdn.mos.cms.futurecdn.net/oU94fqcyf9HzQc59wJyaHN-970-80.jpg" +} + +{ + "name": "Venus", + "diameter": "Diameter: 7,521 miles (12,104 km)", + "moons": false, + "picture": "https://cdn.mos.cms.futurecdn.net/KhHofvaDG73pypCEzyLuab-970-80.png" +} + +{ + "name": "Earth", + "diameter": "Diameter: 7,926 miles (12,760 km)", + "moons": true, + "picture": "https://cdn.mos.cms.futurecdn.net/4aeTmiqCqpRKuFc8tkDcmm-970-80.jpg" +} + +{ + "name": "Mars", + "diameter": "Diameter: 4,217 miles (6,787 km)", + "moons": true, + "picture": "https://cdn.mos.cms.futurecdn.net/tQUhJUq9GXqMfZXjGYdw8c-970-80.jpg" +} + +{ + "name": "Jupiter", + "diameter":"Diameter: 86,881 miles (139,822 km)", + "moons": true, + "picture":"https://cdn.mos.cms.futurecdn.net/WyxFYsiUAQAgU4peSSoBNZ-970-80.png" +} + +{ + "name": "Saturn", + "diameter":"Diameter: 74,900 miles (120,500 km)", + "moons": true, + "picture":"https://cdn.mos.cms.futurecdn.net/bDVqRSjnbY9jMyVPmStUBY-970-80.png" +} + +{ + "name": "Uranus", + "diameter":"Diameter: 31,763 miles (51,120 km)", + "moons": true, + "picture":"https://cdn.mos.cms.futurecdn.net/kZXxHS85dDgVEAviQrM2KW-970-80.jpg" +} + +{ + "name": "Neptune", + "diameter":"Diameter: 30,775 miles (49,530 km)", + "moons": true, + "picture":"https://cdn.mos.cms.futurecdn.net/KW2AU72GRriUXQvsn5jAbg-970-80.jpg" +} \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..012bd056d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,137 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, render_template, make_response, request, abort +from app import db +from app.models.planet import Planet + +planets_bp = Blueprint("planets_bp", __name__,url_prefix="/planets") + + +@planets_bp.route("", methods = ["GET"]) +def handle_planets(): + planets_response = [] + + if request.args.get("name"): + planets = Planet.query.filter_by(name=request.args.get("name")) + + elif request.args.get("has_moons"): + planets = Planet.query.filter(Planet.moons == request.args.get("has_moons")) + + elif request.args.get("order_by") == "name": + planets = Planet.query.order_by(Planet.name) + + else: + planets = Planet.query.all() + for planet in planets: + planets_response.append(planet.to_dict()) + + return jsonify(planets_response), 200 + + +@planets_bp.route("/", methods=["GET", "PATCH", "PUT", "DELETE"]) +def handle_planet(planet_id): + if not planet_id.isnumeric(): + return { "Error": f"{planet_id} must be numeric."}, 404 + planet_id = int(planet_id) + planet = Planet.query.get(planet_id) + if not planet: + return { "Error": f"Planet {planet_id} was not found"}, 404 + + elif request.method == "GET": + return (planet.to_dict()),200 + + elif request.method == "PATCH": + form_data = request.get_json() + sanitize_data(form_data) + if 'name' in form_data: + planet.name = request.json['name'] + if 'diameter' in form_data: + planet.diameter = request.json['diameter'] + if 'moons' in form_data: + planet.moons = request.json['moons'] + if 'picture' in form_data: + planet.picture = request.json['picture'] + + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully updated") + + elif request.method == "PUT": + form_data = request.get_json() + sanitize_data(form_data) + planet.name = form_data["name"] + planet.diameter = form_data["diameter"] + planet.moons = form_data["moons"] + planet.picture = form_data["picture"] + + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully updated") + + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + + return { + "message": f"Planet with title {planet.name} has been deleted" + }, 200 + + +@planets_bp.route("", methods=["POST"]) +def create_planet(): + request_data = request.get_json() + sanitize_data(request_data) + + if "name" not in request_data or "moons" not in request_data \ + or "diameter" not in request_data or "picture" not in request_data: + + return jsonify({"message": "Missing data"}), 400 + + new_planet = Planet(name=request_data["name"], diameter=request_data["diameter"], + moons=request_data["moons"], picture=request_data["picture"]) + + db.session.add(new_planet) + db.session.commit() + + return f"Planet {new_planet.name} created", 201 + +@planets_bp.route("/picturesummary", methods=["GET"]) +def handle_planet_summary_params(): + if request.args.get("name"): + planets = Planet.query.filter_by(name=request.args.get("name")) + for planet in planets: + if planet.moons == True: + moon = "Yes" + else: + moon = "No" + return render_template('planet_summary.html', + url=planet.picture, + title=planet.name, + diameter=planet.diameter, + moon=moon) + +@planets_bp.route("/picturesummary/", methods=["GET"]) +def handle_planet_summary(planet_id): + planet = Planet.query.get(planet_id) + if planet.moons == True: + moon = "Yes" + else: + moon = "No" + + return render_template('planet_summary.html', + url=planet.picture, + title=planet.name, + diameter=planet.diameter, + moon=moon) + + +def sanitize_data(input_data): + data_types = {"name":str, "diameter":str, "moons":bool, "picture":str} + for name, val_type in data_types.items(): + try: + assert val_type==type(input_data[name]) + print(name,type(input_data[name])) + + except Exception as e: + print(e) + abort(400, "Bad Data") + return input_data \ No newline at end of file diff --git a/app/templates/planet_picture.html b/app/templates/planet_picture.html new file mode 100644 index 000000000..d1b9ee572 --- /dev/null +++ b/app/templates/planet_picture.html @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/app/templates/planet_summary.html b/app/templates/planet_summary.html new file mode 100644 index 000000000..7d6881cfc --- /dev/null +++ b/app/templates/planet_summary.html @@ -0,0 +1,15 @@ + + + + + +

{{title}}

+
+ {{diameter}} +
+ Moon: {{moon}} +
+ + + + \ 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/c1bef2046609_.py b/migrations/versions/c1bef2046609_.py new file mode 100644 index 000000000..5fceeffdc --- /dev/null +++ b/migrations/versions/c1bef2046609_.py @@ -0,0 +1,35 @@ +"""empty message + +Revision ID: c1bef2046609 +Revises: +Create Date: 2021-11-03 11:13:41.073025 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c1bef2046609' +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('diameter', sa.String(), nullable=True), + sa.Column('moons', sa.Boolean(), nullable=True), + sa.Column('picture', 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 ### diff --git a/requirements.txt b/requirements.txt index fd90fffa8..a32d6a7c5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==21.2.0 autopep8==1.5.5 certifi==2020.12.5 chardet==4.0.0 @@ -6,13 +7,16 @@ click==7.1.2 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 itsdangerous==1.1.0 Jinja2==2.11.3 +jsonschema==4.1.2 Mako==1.1.4 MarkupSafe==1.1.1 psycopg2-binary==2.8.6 pycodestyle==2.6.0 +pyrsistent==0.18.0 python-dateutil==2.8.1 python-dotenv==0.15.0 python-editor==1.0.4 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..6469ea727 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest +from app import create_app +from app import db +from app.models.planet import Planet + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + 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): + jupiter_planet = Planet( + name="Jupiter", + diameter="Diameter: 86,881 miles (139,822 km)", + moons=True, + picture="https://cdn.mos.cms.futurecdn.net/WyxFYsiUAQAgU4peSSoBNZ-970-80.png" +) + saturn_planet = Planet(name="Saturn", + diameter="Diameter: 74,900 miles (120,500 km)", + moons=True, + picture="https://cdn.mos.cms.futurecdn.net/bDVqRSjnbY9jMyVPmStUBY-970-80.png" +) + + db.session.add_all([jupiter_planet, saturn_planet]) + + db.session.commit() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..f16170cb6 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,63 @@ + +from flask import json +from flask.globals import request +from flask.wrappers import Response + + +def test_get_all_planets_with_no_records(client): + response = client.get('/planets') + response_body = response.get_json() + + assert response.status_code ==200 + assert response_body == [] + +def test_get_planet_by_id(client,two_saved_planets): + response = client.get('/planets/1') + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id":1, + "name": "Jupiter", + "diameter":"Diameter: 86,881 miles (139,822 km)", + "moons": True, + "picture":"https://cdn.mos.cms.futurecdn.net/WyxFYsiUAQAgU4peSSoBNZ-970-80.png" +} + +def test_get_by_id_without_data(client): + response = client.get('/planets/1') + response_body = response.get_json() + + assert response.status_code == 404 + +def test_get_all_planets_with_data(client,two_saved_planets): + response = client.get('/planets') + response_body = response.get_json() + saturn = { + "id":2, + "name": "Saturn", + "diameter":"Diameter: 74,900 miles (120,500 km)", + "moons": True, + "picture":"https://cdn.mos.cms.futurecdn.net/bDVqRSjnbY9jMyVPmStUBY-970-80.png" +} + jupiter = { + "id":1, + "name": "Jupiter", + "diameter":"Diameter: 86,881 miles (139,822 km)", + "moons": True, + "picture":"https://cdn.mos.cms.futurecdn.net/WyxFYsiUAQAgU4peSSoBNZ-970-80.png" +} + assert response.status_code ==200 + assert saturn in response_body + assert jupiter in response_body + +def test_post_one_planet(client): + response = client.post('/planets',json= {"id":1, + "name": "Jupiter", + "diameter":"Diameter: 86,881 miles (139,822 km)", + "moons": True, + "picture":"https://cdn.mos.cms.futurecdn.net/WyxFYsiUAQAgU4peSSoBNZ-970-80.png"} +) + response_body = response.get_json() + + assert response.status_code ==201 \ No newline at end of file