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

Tigers - Mica + Reyna Solar System API Parts 1 + 2 #31

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
79db9c6
"adds wave 01 class + list"
reynamdiaz Oct 24, 2022
51d85d0
"wave 01 created RESTful endpoint, registered bp"
reynamdiaz Oct 24, 2022
8c7d6b2
"wave 01 added handle_planets() funct"
reynamdiaz Oct 24, 2022
c20d81b
Wave 02 added validate_planet and
mc-dev99 Oct 25, 2022
f05cdb2
created planet.py & __init__.py SQLAlchemy setup
mc-dev99 Nov 1, 2022
06a9613
created Planet model
mc-dev99 Nov 1, 2022
4bdb3e5
flask db init & initial migration
mc-dev99 Nov 1, 2022
a4d794d
correctly imported app.models.planet Planet
mc-dev99 Nov 1, 2022
f6b3203
"added create_planet and read_all_planet routes"
reynamdiaz Nov 1, 2022
e9f1eb8
refactored validate_planet + added read_one_planet
mc-dev99 Nov 1, 2022
2abef4f
added update_planet route
mc-dev99 Nov 1, 2022
3f3472d
"added delete_planet route"
reynamdiaz Nov 1, 2022
c0c2645
"read_one+read_all funct refactor, adds to_dict()"
reynamdiaz Nov 2, 2022
6abc230
refactored routes, made helper funcs
mc-dev99 Nov 2, 2022
17711c7
refactored validate_planet to validate_model
mc-dev99 Nov 3, 2022
7220329
modified create_app to handle test mode
mc-dev99 Nov 3, 2022
09bd957
created tests folder, set up conftest.py
mc-dev99 Nov 3, 2022
79eed88
"adds test get_all_planets"
reynamdiaz Nov 3, 2022
c56d26f
"fixture two_planets + test_by_id + id_not_found"
reynamdiaz Nov 3, 2022
e72a913
added test for get all planets with records &
mc-dev99 Nov 3, 2022
af6508d
removed redundant if from create_planet route
mc-dev99 Nov 7, 2022
a31c194
pip installed gunicorn
mc-dev99 Nov 7, 2022
da2cb7f
touched Procfile and configured it
mc-dev99 Nov 7, 2022
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()'
24 changes: 24 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,31 @@
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__)

app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

if not test_config:
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 app.models.planet import Planet

from .routes import planets_bp
app.register_blueprint(planets_bp)

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


@classmethod
def from_dict(cls, planet_data):
new_planet = Planet(name=planet_data["name"],
description=planet_data["description"],
moons=planet_data["moons"])
return new_planet

def to_dict(self):
return {
"id": self.id,
"name": self.name,
"description": self.description,
"moons": self.moons
}
Comment on lines +10 to +23

Choose a reason for hiding this comment

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

Great helper methods!

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

# class Planet:

# def __init__(self, id, name, description, moons):
# self.id = id
# self.name = name
# self.description = description
# self.moons = moons

# planets = [
# Planet(1, "Earth", "our home", 1),
# Planet(2, "Mars", "red planet", 2),
# Planet(3, "Pluto", "is a planet", 5)
# ]

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

@planets_bp.route("", methods=["POST"])
def create_planet():
request_body = request.get_json()
if ("name" not in request_body or "description" not in request_body
or "moons" not in request_body):
return make_response(f"Invalid Request", 400)
Comment on lines +25 to +27

Choose a reason for hiding this comment

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

Great validation, could this be abstracted in to a helper method and used in the update action as well?


new_planet = Planet.from_dict(request_body)

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

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

@planets_bp.route("", methods=["GET"])
def read_all_planets():
planets_response = []
planets = Planet.query.all()
for planet in planets:
# planets_response.append({
# "id": planet.id,
# "name": planet.name,
# "description": planet.description,
# "moons": planet.moons
# })
planets_response.append(planet.to_dict())
return jsonify(planets_response)

def validate_model(cls, model_id):

Choose a reason for hiding this comment

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

👍 Great helper function

try:
model_id = int(model_id)
except:
abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400))

model = cls.query.get(model_id)

if not model:
abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404))

return model

@planets_bp.route("/<planet_id>", methods=["GET"])
def read_one_planet(planet_id):
planet = validate_model(Planet, planet_id)
return planet.to_dict()
# return {
# "id": planet.id,
# "name": planet.name,
# "description": planet.description,
# "moons": planet.moons,
# }

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

request_body = request.get_json()

planet.name = request_body["name"]
planet.description = request_body["description"]
planet.moons = request_body["moons"]

Comment on lines +82 to +85

Choose a reason for hiding this comment

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

Some validation here would be good

db.session.commit()

return make_response(f"Planet #{planet.id} successfully updated")

@planets_bp.route("/<planet_id>", methods=["DELETE"])
def delete_planet(planet_id):
planet = validate_model(Planet, planet_id)

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

return make_response(f"Planet #{planet.id} successfully deleted")
Comment on lines +77 to +97

Choose a reason for hiding this comment

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

Just noting the delete and update actions are untested.

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/861a80c043e6_adds_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""adds Planet model

Revision ID: 861a80c043e6
Revises:
Create Date: 2022-11-01 15:41:37.575877

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '861a80c043e6'
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('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 ###
Loading