diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..3c78af1bc 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,27 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate + +db = SQLAlchemy() +migrate = Migrate() + +DATABASE_CONNECTION_STRING = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' def create_app(test_config=None): app = Flask(__name__) + # Step 2: Configure SQLAlchemy + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = DATABASE_CONNECTION_STRING + + # Step 3: hook up Flask to SQLAlchemy + db.init_app(app) + migrate.init_app(app, db) + + from .routes import planets_bp #importing from routes + app.register_blueprint(planets_bp) #registering the route + 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 new file mode 100644 index 000000000..693e626f4 --- /dev/null +++ b/app/models/planets.py @@ -0,0 +1,15 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String(64)) + description = db.Column(db.String(64)) + num_moons = db.Column(db.Integer) + + def to_dict(self): + return ({ + "id" : self.id, + "name" : self.name, + "description" : self.description, + "num_moons" : self.num_moons + }) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..a59a36fcb 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,58 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, request +from app.models.planets import Planet +from app import db + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) +def get_planets(): + planets_response = [] + planets = Planet.query.all() + + for planet in planets: + planets_response.append(planet.to_dict()) + return jsonify(planets_response), 200 + +@planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_planet(planet_id): + planet_id = int(planet_id) + planet = Planet.query.get(planet_id) + + if not planet: + return {"Error": f"Planet {planet_id} was not found"}, 404 + + if request.method == "GET": + return planet.to_dict(), 200 + elif request.method == "PUT": + input_data = request.get_json() + if "name" in input_data: + planet.name = input_data["name"] + if "description" in input_data: + planet.description = input_data["description"] + if "num_moons" in input_data: + planet.num_moons = input_data["num_moons"] + db.session.commit() + + return planet.to_dict(), 200 + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + + return (f"Planet {planet.id} successfully updated"), 200 + + +@planets_bp.route("", methods=["POST"]) +def create_new_planet(): + request_body = request.get_json() + + try: + new_planet = Planet(name = request_body["name"], description = request_body["description"], num_moons = request_body["num_moons"]) + + except KeyError: + return ("Error! Must include data for all fields."), 400 + + db.session.add(new_planet) + db.session.commit() + + return f"{new_planet.name} 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/e23adda65626_.py b/migrations/versions/e23adda65626_.py new file mode 100644 index 000000000..74f3413e4 --- /dev/null +++ b/migrations/versions/e23adda65626_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: e23adda65626 +Revises: +Create Date: 2021-10-26 12:04:09.038498 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e23adda65626' +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('name', sa.String(length=64), nullable=True), + sa.Column('description', sa.String(length=64), nullable=True), + sa.Column('num_moons', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ###