Skip to content
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
25 changes: 25 additions & 0 deletions 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__)

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')

app.config['SQLALCHEMY_ECHO'] = True

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

from app.models.planet import Planet

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The blueprints import the models so we don't actually need the model import anymore.


from .routes import planets_bp
app.register_blueprint(planets_bp)

return app
8 changes: 8 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
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)
sign = db.Column(db.String)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Consider adding a helper function to turn instances into a dictionary

76 changes: 75 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,76 @@
from flask import Blueprint
from flask import Blueprint, jsonify, request
from app.models.planet import Planet
from app import db

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

@planets_bp.route("", methods = ["GET", "POST"])
def get_planets():
Comment on lines +7 to +8

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Consider separating each request method into its different functions. This makes testing the endpoints much easier to do.

if request.method == "GET":
planets = Planet.query.all()
planets_response = []
for planet in planets:
planets_response.append({
"id": planet.id,
"name": planet.name,
"description": planet.description,
"sign": planet.sign
})
Comment on lines +13 to +18

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

*See comment about helper function to turn instances into dictionaries. We could refactor this line from 5 lines to one by using a helper function

Suggested change
planets_response.append({
"id": planet.id,
"name": planet.name,
"description": planet.description,
"sign": planet.sign
})
planets_response.append({planet.to_dict()})

if not planets_response:
return jsonify("There are no planets yet! :O", 200)
Comment on lines +19 to +20

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nice custom check for empty lists

return jsonify(planets_response)
elif request.method == "POST":
request_body = request.get_json()
if "name" not in request_body or "description" not in request_body or "sign" not in request_body:
return jsonify("Invalid request", 400)

new_planet = Planet(
name = request_body["name"],
description = request_body["description"],
sign = request_body["sign"]
)

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

return f"Planet {new_planet.name} created.", 201

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Don't forget to jsonify your responses

Suggested change
return f"Planet {new_planet.name} created.", 201
return jsonify(f"Planet {new_planet.name} created."), 201



@planets_bp.route("/<planet_id>", methods = ["GET", "PUT", "DELETE"])

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

see comment on get/post request about putting each request method into separate functions

def get_planet(planet_id):
planet = Planet.query.get(planet_id)
if planet is None:
return jsonify(f"Planet with ID {planet_id} not found."), 404

if request.method == "GET":
return {
"name": planet.name,
"description": planet.description,
"sign": planet.sign
}
Comment on lines +46 to +50

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

to_dict() helper method would have been nice here as well :P


elif request.method == "PUT":
request_body = request.get_json()
planet.name = request_body["name"]
planet.description = request_body["description"]
planet.sign = request_body["sign"]

db.session.commit()

return jsonify(f"Planet nummber {planet.id} successfully updated!")

elif request.method == "DELETE":
db.session.delete(planet)
db.session.commit()

return jsonify(f"Planet {planet.name} successfully deleted! bye bitch")

Comment on lines +66 to +67

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🤣 this delete message

# for planet in planets:
# if planet.name.lower() == planet_name.lower():
# planet_response = {
# "id": planet.id,
# "name": planet.name,
# "description": planet.description,
# "sign": planet.sign
# }
# return planet_response
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/3f95ba4c789d_added_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""added Planet model

Revision ID: 3f95ba4c789d
Revises:
Create Date: 2021-10-22 11:09:58.752109

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '3f95ba4c789d'
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('sign', 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 ###
7 changes: 7 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
alembic==1.5.4
attrs==21.2.0
autopep8==1.5.5
certifi==2020.12.5
chardet==4.0.0
Expand All @@ -7,12 +8,18 @@ Flask==1.1.2
Flask-Migrate==2.6.0
Flask-SQLAlchemy==2.4.4
idna==2.10
iniconfig==1.1.1
itsdangerous==1.1.0
Jinja2==2.11.3
Mako==1.1.4
MarkupSafe==1.1.1
packaging==21.0
pluggy==1.0.0
psycopg2-binary==2.8.6
py==1.10.0
pycodestyle==2.6.0
pyparsing==3.0.3
pytest==6.2.5
python-dateutil==2.8.1
python-dotenv==0.15.0
python-editor==1.0.4
Expand Down
Empty file added tests/__init__.py
Empty file.
33 changes: 33 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
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 add_planet():
pluto = Planet(name="pluto", description="way out there", sign="Scorpio")
db.session.add(pluto)
db.session.commit()

@pytest.fixture
def add_three_planets():
pluto = Planet(name="pluto", description="way out there", sign="Scorpio")
mercury = Planet(name="mercury", description="messenger closest to sign", sign="Virgo")
saturn = Planet(name="saturn", description="forever hula hooping", sign="Capricorn")

db.session.add_all([pluto, mercury, saturn])
db.session.commit()
Comment on lines +27 to +33

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Consider returning [pluto, mercury, saturn ] after this line, so that tests can make use of the ids of the records, and anything else that's part of the record that might be useful in the test.

Loading