From b48115bd1f0b84a589926be00e54b1c9d965e003 Mon Sep 17 00:00:00 2001 From: Kayla Huddleston Date: Mon, 18 Oct 2021 15:01:17 -0700 Subject: [PATCH 1/9] Solar System Part 1: Complete --- app/__init__.py | 3 +++ app/routes.py | 42 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..2059fb616 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,10 @@ +#create app function and registering blueprints from flask import Flask def create_app(test_config=None): app = Flask(__name__) + from .routes import planets_bp #importing from routes + app.register_blueprint(planets_bp) #registering the route return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..b084ae925 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,42 @@ -from flask import Blueprint +#define our class and make bluprints +from flask import Blueprint, jsonify +#class are capitalized +class Planet: + def __init__(self, id, name, description, num_moons): + self.id = id + self.name = name + self.description = description + self.num_moons = num_moons + +planets = [ + Planet(1, "Earth", "Green and Blue", 1), + Planet(2, "Mars", "Red and Orange", 2), + Planet(3, "Jupiter", "Gray and Brown", 79) +] + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) #decorator communicates with flask +def get_planets(): #function does the work + planets_response = [] + for planet in planets: + planets_response.append({ + "id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "num_moons" : planet.num_moons + }) + return jsonify(planets_response) + +@planets_bp.route("/", methods=["GET"]) +def get_planet(planet_id): + for planet in planets: + if planet.id == int(planet_id): + response = { + "id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "num_moons" : planet.num_moons + } + return jsonify(response) \ No newline at end of file From bc401c3a537c5ffda7be575680bf9a44cdb5605a Mon Sep 17 00:00:00 2001 From: Mariah Rosman Date: Mon, 18 Oct 2021 17:46:46 -0700 Subject: [PATCH 2/9] refactors get_planet() to handle 404 error --- app/routes.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index b084ae925..d3460c075 100644 --- a/app/routes.py +++ b/app/routes.py @@ -39,4 +39,6 @@ def get_planet(planet_id): "description" : planet.description, "num_moons" : planet.num_moons } - return jsonify(response) \ No newline at end of file + return jsonify(response) + + return 'Planet ID not found', 404 From 667d83b6442d6ff7bbc3fbc7bdd8bfadffbbe8fe Mon Sep 17 00:00:00 2001 From: Mariah Rosman Date: Mon, 25 Oct 2021 14:31:45 -0700 Subject: [PATCH 3/9] sets up SAQLAlchemy and Migrate in __init__.py --- app/__init__.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 2059fb616..006eada6d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,10 +1,29 @@ #create app function and registering blueprints +# Step 1: import and initialize 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@localhost5432/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 + + From 07b1d1cf432935cd91e53444d356b8c4abf26ede Mon Sep 17 00:00:00 2001 From: Mariah Rosman Date: Mon, 25 Oct 2021 14:33:26 -0700 Subject: [PATCH 4/9] creates models package including planets.py which defines the Planet model --- app/models/__init__.py | 0 app/models/planets.py | 8 ++++++++ 2 files changed, 8 insertions(+) create mode 100644 app/models/__init__.py create mode 100644 app/models/planets.py 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..75a91cda8 --- /dev/null +++ b/app/models/planets.py @@ -0,0 +1,8 @@ +# attribuites: id, name, description + 1 +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) \ No newline at end of file From 7a79290acd0b2e3b0349988337ffed96d6a49dca Mon Sep 17 00:00:00 2001 From: Mariah Rosman Date: Mon, 25 Oct 2021 14:34:55 -0700 Subject: [PATCH 5/9] refactors routes.py to query data from the solar_system_development database and refactors get_planets and get_planet routes accordingly --- app/routes.py | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/app/routes.py b/app/routes.py index d3460c075..42a0a68a2 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,25 +1,30 @@ #define our class and make bluprints from flask import Blueprint, jsonify +from app.models.planets import Planet +from app import db #class are capitalized -class Planet: - def __init__(self, id, name, description, num_moons): - self.id = id - self.name = name - self.description = description - self.num_moons = num_moons +# class Planet: +# def __init__(self, id, name, description, num_moons): +# self.id = id +# self.name = name +# self.description = description +# self.num_moons = num_moons -planets = [ - Planet(1, "Earth", "Green and Blue", 1), - Planet(2, "Mars", "Red and Orange", 2), - Planet(3, "Jupiter", "Gray and Brown", 79) -] +# planets = [ +# Planet(1, "Earth", "Green and Blue", 1), +# Planet(2, "Mars", "Red and Orange", 2), +# Planet(3, "Jupiter", "Gray and Brown", 79) +# ] planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + @planets_bp.route("", methods=["GET"]) #decorator communicates with flask def get_planets(): #function does the work planets_response = [] + planets = Planet.query.all() + for planet in planets: planets_response.append({ "id" : planet.id, @@ -27,18 +32,19 @@ def get_planets(): #function does the work "description" : planet.description, "num_moons" : planet.num_moons }) - return jsonify(planets_response) + return jsonify(planets_response), 200 @planets_bp.route("/", methods=["GET"]) def get_planet(planet_id): - for planet in planets: - if planet.id == int(planet_id): - response = { + planet_id = int(planet_id) + planet = Planet.query.all(planet_id) + + if planet: + return { "id" : planet.id, "name" : planet.name, "description" : planet.description, "num_moons" : planet.num_moons - } - return jsonify(response) + }, 200 - return 'Planet ID not found', 404 + return f'Planet {planet_id} not found', 404 From 07c641ca5a4ad0b50ad7886bb238a876842f7af6 Mon Sep 17 00:00:00 2001 From: Kayla Huddleston Date: Tue, 26 Oct 2021 12:17:17 -0700 Subject: [PATCH 6/9] New planet blueprint added --- app/__init__.py | 2 +- app/routes.py | 13 +++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/e23adda65626_.py | 34 ++++++++++ 7 files changed, 213 insertions(+), 2 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/e23adda65626_.py diff --git a/app/__init__.py b/app/__init__.py index 006eada6d..4148e1abc 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -7,7 +7,7 @@ db = SQLAlchemy() migrate = Migrate() -DATABASE_CONNECTION_STRING = 'postgresql+psycopg2://postgres:postgres@localhost5432/solar_system_development' +DATABASE_CONNECTION_STRING = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' def create_app(test_config=None): diff --git a/app/routes.py b/app/routes.py index 42a0a68a2..d4b0dbe8d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,8 +1,9 @@ #define our class and make bluprints -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, request from app.models.planets import Planet from app import db + #class are capitalized # class Planet: # def __init__(self, id, name, description, num_moons): @@ -48,3 +49,13 @@ def get_planet(planet_id): }, 200 return f'Planet {planet_id} not found', 404 + +@planets_bp.route("", methods=["POST"]) +def create_new_planet(): + request_body = request.get_json() + new_planet = Planet(name = request_body["name"], description = request_body["description"], num_moons = request_body["num_moons"]) + + db.session.add(new_planet) + db.session.commit() + + return f"{new_planet.name} Successfully Created", 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/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 ### From 0592a4e510950acdba0df5f47641a73cc9ec0cbe Mon Sep 17 00:00:00 2001 From: Mariah Rosman Date: Wed, 27 Oct 2021 12:09:14 -0700 Subject: [PATCH 7/9] adds to_dict() function to Planet Model --- app/models/planets.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/app/models/planets.py b/app/models/planets.py index 75a91cda8..3d60702a2 100644 --- a/app/models/planets.py +++ b/app/models/planets.py @@ -5,4 +5,12 @@ 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) \ No newline at end of file + 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 + }) From 5dc0a1045b8c0c6a886b3b53b4bd24c434aeb221 Mon Sep 17 00:00:00 2001 From: Mariah Rosman Date: Wed, 27 Oct 2021 12:09:42 -0700 Subject: [PATCH 8/9] adds Put and Delete methods to handle_planet function --- app/routes.py | 48 +++++++++++++++++++++++++++++------------------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/app/routes.py b/app/routes.py index d4b0dbe8d..149b24255 100644 --- a/app/routes.py +++ b/app/routes.py @@ -27,35 +27,45 @@ def get_planets(): #function does the work planets = Planet.query.all() for planet in planets: - planets_response.append({ - "id" : planet.id, - "name" : planet.name, - "description" : planet.description, - "num_moons" : planet.num_moons - }) + planets_response.append(planet.to_dict()) return jsonify(planets_response), 200 -@planets_bp.route("/", methods=["GET"]) -def get_planet(planet_id): +@planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_planet(planet_id): planet_id = int(planet_id) - planet = Planet.query.all(planet_id) + planet = Planet.query.get(planet_id) - if planet: - return { - "id" : planet.id, - "name" : planet.name, - "description" : planet.description, - "num_moons" : planet.num_moons - }, 200 - - return f'Planet {planet_id} not found', 404 + 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() + # if statement for 400 new_planet = Planet(name = request_body["name"], description = request_body["description"], num_moons = request_body["num_moons"]) db.session.add(new_planet) db.session.commit() - return f"{new_planet.name} Successfully Created", 201 \ No newline at end of file + return f"{new_planet.name} Successfully Created", 201 + From 3bd30651c524924c72629c66b3177ec7f0fef309 Mon Sep 17 00:00:00 2001 From: Kayla Huddleston Date: Thu, 28 Oct 2021 11:15:19 -0700 Subject: [PATCH 9/9] Solar System API Complete --- app/__init__.py | 2 -- app/models/planets.py | 1 - app/routes.py | 31 +++++++++---------------------- 3 files changed, 9 insertions(+), 25 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 4148e1abc..3c78af1bc 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,5 +1,3 @@ -#create app function and registering blueprints -# Step 1: import and initialize from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate diff --git a/app/models/planets.py b/app/models/planets.py index 3d60702a2..693e626f4 100644 --- a/app/models/planets.py +++ b/app/models/planets.py @@ -1,4 +1,3 @@ -# attribuites: id, name, description + 1 from app import db class Planet(db.Model): diff --git a/app/routes.py b/app/routes.py index 149b24255..a59a36fcb 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,28 +1,11 @@ -#define our class and make bluprints from flask import Blueprint, jsonify, request from app.models.planets import Planet from app import db - -#class are capitalized -# class Planet: -# def __init__(self, id, name, description, num_moons): -# self.id = id -# self.name = name -# self.description = description -# self.num_moons = num_moons - -# planets = [ -# Planet(1, "Earth", "Green and Blue", 1), -# Planet(2, "Mars", "Red and Orange", 2), -# Planet(3, "Jupiter", "Gray and Brown", 79) -# ] - planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") - -@planets_bp.route("", methods=["GET"]) #decorator communicates with flask -def get_planets(): #function does the work +@planets_bp.route("", methods=["GET"]) +def get_planets(): planets_response = [] planets = Planet.query.all() @@ -36,7 +19,7 @@ def handle_planet(planet_id): planet = Planet.query.get(planet_id) if not planet: - return {"error": f"Planet {planet_id} was not found"}, 404 + return {"Error": f"Planet {planet_id} was not found"}, 404 if request.method == "GET": return planet.to_dict(), 200 @@ -61,8 +44,12 @@ def handle_planet(planet_id): @planets_bp.route("", methods=["POST"]) def create_new_planet(): request_body = request.get_json() - # if statement for 400 - new_planet = Planet(name = request_body["name"], description = request_body["description"], num_moons = request_body["num_moons"]) + + 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()