Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cedar: Rae Elwell & Khandice Schuhmann #8

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: gunicorn 'app:create_app()'
26 changes: 26 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_migrate import Migrate
import os
from dotenv import load_dotenv

db = SQLAlchemy()
migrate = Migrate()

load_dotenv()

def create_app(test_config=None):
app = Flask(__name__)
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False

if test_config is None:
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 import planets_bp
app.register_blueprint(planets_bp)

from app.models.planet import Planet

return app

Empty file added app/models/__init__.py
Empty file.
15 changes: 15 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -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)
description = db.Column(db.String)
matter = db.Column(db.String)

def make_dict(self):
return {
"id": self.id,
"name": self.name,
"description": self.description,
"matter": self.matter
}
85 changes: 84 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,85 @@
from flask import Blueprint
from app import db
from flask import Blueprint, jsonify, make_response, request
from app.models.planet import Planet

planets_bp = Blueprint("planets", __name__, url_prefix="/planets")

def make_input_valid(number):
try:
int(number)
except:
return make_response(f"{number} is not an int!", 400)

def is_parameter_valid(parameter_id):
if make_input_valid(parameter_id) is not None:
return make_input_valid(parameter_id)
Comment on lines +14 to +15

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Python allows to simplify this conditional to check for truthy values:

Suggested change
if make_input_valid(parameter_id) is not None:
return make_input_valid(parameter_id)
if make_input_valid(parameter_id):
return make_input_valid(parameter_id)

elif Planet.query.get(parameter_id) is None:
return make_response(f"{parameter_id} is not a valid id!", 404)

@planets_bp.route("", methods=["GET"])
def read_all_planets():
planets = Planet.query.all()
planet_list = []
for planet in planets:
planet_list.append(planet.make_dict())
return jsonify(planet_list)


@planets_bp.route("", methods=["POST"])
def post_new_planet():
request_body = request.get_json()
new_planet = Planet(name=request_body["name"],
description=request_body["description"],
matter=request_body["matter"])
Comment on lines +31 to +33

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a suggestion for some input handling. If the request body is missing one of the keys, this code will raise a KeyError exception. Consider handling this way:

Suggested change
new_planet = Planet(name=request_body["name"],
description=request_body["description"],
matter=request_body["matter"])
if "name" not in request_body or "description" not in request_body or "matter" not in request_body:
return {"error": "incomplete request body"}, 400
new_planet = Planet(name=request_body["name"],
description=request_body["description"],
matter=request_body["matter"])

db.session.add(new_planet)
db.session.commit()

return make_response(f"Planet {new_planet.name} successfully created!", 201)


@planets_bp.route("/<planet_id>", methods=["GET"])
def read_planet(planet_id):
if is_parameter_valid(planet_id) is not None:
return is_parameter_valid(planet_id)
Comment on lines +42 to +43

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor note: similar to above, we don't need the is not None

Suggested change
if is_parameter_valid(planet_id) is not None:
return is_parameter_valid(planet_id)
if is_parameter_valid(planet_id):
return is_parameter_valid(planet_id)

planet = Planet.query.get(planet_id)
return planet.make_dict()


@planets_bp.route("/<planet_id>", methods=["PUT"])
def update_planet(planet_id):

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work separating out PUT and PATCH.

For PUT, consider how you could handle an incomplete request body (similar to the suggestion in POST)

if is_parameter_valid(planet_id) is not None:
return is_parameter_valid(planet_id)
planet = Planet.query.get(planet_id)
form_data = request.get_json()
planet.name = form_data["name"]
planet.description = form_data["description"]
planet.matter = form_data["matter"]
db.session.commit()
return make_response(f"Planet {planet.name} successfully updated!", 200)

@planets_bp.route("/<planet_id>", methods=["PATCH"])
def update_planet_parameter(planet_id):
if is_parameter_valid(planet_id) is not None:
return is_parameter_valid(planet_id)
planet = Planet.query.get(planet_id)
form_data = request.get_json()
if "name" in form_data:
planet.name = form_data["name"]
if "description" in form_data:
planet.description = form_data["description"]
if "matter" in form_data:
planet.matter = form_data["matter"]
db.session.commit()
return make_response(f"Planet {planet.name} successfully updated!", 200)

@planets_bp.route("/<planet_id>", methods=["DELETE"])
def delete_planet(planet_id):
if is_parameter_valid(planet_id) is not None:
return is_parameter_valid(planet_id)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great use of this helper method throughout!

planet = Planet.query.get(planet_id)
db.session.delete(planet)
db.session.commit()
return make_response(f"Planet {planet.name} successfully deleted!", 200)



1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
45 changes: 45 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -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
96 changes: 96 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
@@ -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()
24 changes: 24 additions & 0 deletions migrations/script.py.mako
Original file line number Diff line number Diff line change
@@ -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"}
34 changes: 34 additions & 0 deletions migrations/versions/7681246a2f35_.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""empty message

Revision ID: 7681246a2f35
Revises:
Create Date: 2021-10-25 14:11:40.322891

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '7681246a2f35'
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(), nullable=True),
sa.Column('description', sa.String(), nullable=True),
sa.Column('matter', sa.String(), nullable=True),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('planet')
# ### end Alembic commands ###