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

Sea Turtles - Adriana & Olive - Solar System #26

Open
wants to merge 19 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()'
27 changes: 26 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -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__)

return app
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

Choose a reason for hiding this comment

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

The line app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False is duplicated in both parts of the if/else. We could move that line to either above or below the if/else, so it only needs to be written once.

app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get(
"SQLALCHEMY_TEST_DATABASE_URI")

db.init_app(app)
migrate.init_app(app, db)

from app.models.planet import Planet

from .routes.routes import planets_bp
app.register_blueprint(planets_bp)

return app
Empty file added app/models/__init__.py
Empty file.
29 changes: 29 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
from app import db

class Planet(db.Model):
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String, nullable=False)
description = db.Column(db.String, nullable=False)
gravity = db.Column(db.Float, nullable=False)

def to_dict(self):
planet_dict = dict(
id = self.id,
name = self.name,
description = self.description,
gravity = self.gravity
)
return planet_dict
Comment on lines +10 to +16

Choose a reason for hiding this comment

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

This is perfectly valid, but we could also return the dictionary without storing it in a variable like in from_dict below.


@classmethod
def from_dict(cls, data_dict):
return cls(
name = data_dict["name"],
description = data_dict["description"],
gravity = data_dict["gravity"]
)

def replace_details(self, data_dict):
self.name = data_dict["name"]
self.description = data_dict["description"]
self.gravity = data_dict["gravity"]
2 changes: 0 additions & 2 deletions app/routes.py

This file was deleted.

107 changes: 107 additions & 0 deletions app/routes/routes.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
from app import db
from app.models.planet import Planet
from flask import Blueprint, jsonify, abort, make_response, request
from .routes_helper import error_message

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

def make_planet_safely(data_dict):
try:
return Planet.from_dict(data_dict)
except KeyError as err:
error_message(f"Missing key: {err}", 400)

def replace_planet_safely(planet, data_dict):

Choose a reason for hiding this comment

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

Love the helper functions ^_^

try:
planet.replace_details(data_dict)
except KeyError as err:
error_message(f"Missing key: {err}", 400)

def get_planet_record_by_id(id):
try:
id = int(id)
except ValueError:
error_message(f"Invalid id {id}", 400)

planet = Planet.query.get(id)

if planet:
return planet

error_message(f"No planet with id {id} found", 404)

# GET /planets
@planets_bp.route("", methods = ["GET"])
def read_all_planets():
name_param = request.args.get("name")

if name_param:
planets = Planet.query.filter_by(name=name_param.capitalize())

else:
planets = Planet.query.all()

result_list = [planet.to_dict() for planet in planets]

if not result_list:
return jsonify("No planets found with that name.")
Comment on lines +46 to +47

Choose a reason for hiding this comment

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

Hmm, what happens if you try to get all planets, but there are no planets stored in the db yet? It looks like result_list would be an empty list after line 44, so we'd enter the if-block on line 46 and print the error "No planets found with that name." even though it doesn't quite apply. How could we make sure that message is only returned when relevant?

return jsonify(result_list)


# CREATE /planets
@planets_bp.route("", methods=["POST"])
def create_planet():
request_body = request.get_json()

planet = make_planet_safely(request_body)

db.session.add(planet)
db.session.commit()

return jsonify(f"Planet {planet.name} successfully created"), 201


# GET /planets/id
@planets_bp.route("/<id>", methods=("GET",))
def read_planet_by_id(id):
planet = get_planet_record_by_id(id)
return jsonify(planet.to_dict())

# UPDATE /planets/id
@planets_bp.route("/<id>", methods=["PUT"])
def replace_planet_by_id(id):
planet = get_planet_record_by_id(id)
request_body = request.get_json()

replace_planet_safely(planet, request_body)

db.session.commit()

return jsonify(f"Planet #{planet.id} successfully updated. \
Planet: {planet.to_dict()}")

@planets_bp.route("/<id>", methods = ["DELETE"])
def delete_planet_by_id(id):
planet = get_planet_record_by_id(id)

db.session.delete(planet)
db.session.commit()

return jsonify(f"Planet #{planet.id} successfully deleted.")

@planets_bp.route("/<id>", methods = ["PATCH"])
def update_planet_with_id(id):

Choose a reason for hiding this comment

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

Nice patch function!

planet = get_planet_record_by_id(id)
request_body = request.get_json()
planet_keys = request_body.keys()

if "name" in planet_keys:
planet.name = request_body["name"]
if "description" in planet_keys:
planet.description = request_body["description"]
if "gravity" in planet_keys:
planet.gravity = request_body["gravity"]

db.session.commit()
return jsonify(planet.to_dict())

4 changes: 4 additions & 0 deletions app/routes/routes_helper.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from flask import jsonify, abort, make_response

def error_message(message, status_code):
abort(make_response(jsonify(dict(details=message)), status_code))
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/047ba3167dcc_adds_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""adds Planet model

Revision ID: 047ba3167dcc
Revises:
Create Date: 2022-05-03 13:52:22.875338

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '047ba3167dcc'
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=False),
sa.Column('description', sa.String(), nullable=False),
sa.Column('gravity', sa.Float(), nullable=False),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


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