Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
f5c115d
'Created Planet Class and instance'
datateur Oct 21, 2022
0ff2e16
Created and registered blueprint and handle_planets
datateur Oct 21, 2022
145fd49
'Created handle_planets route'
datateur Oct 21, 2022
16f3825
Completed wave 02
datateur Oct 24, 2022
f0aea40
Refactored abort statement
datateur Oct 25, 2022
694d1c5
Created planet model and post route
datateur Oct 28, 2022
ec8d9b4
Created post endpoint
datateur Oct 28, 2022
fdb034c
migration complete
sorindevops Oct 30, 2022
41a8f78
Created migration for planet model
datateur Oct 30, 2022
01a52df
delete and update
sorindevops Oct 30, 2022
c80037e
created helper method to build planet dict
datateur Oct 30, 2022
6090479
Created endpoint to get single planet
datateur Oct 30, 2022
18a6657
accepted changes
sorindevops Oct 30, 2022
eed2515
done for today
datateur Oct 30, 2022
aa816a2
changes to function
sorindevops Oct 30, 2022
b7b7bbe
Created PUT route to update single planet
datateur Nov 3, 2022
0779bf1
Created DELETE route to delete single planet
datateur Nov 3, 2022
3a2bc6d
updates
sorindevops Nov 3, 2022
d72e93e
Merge branch 'main' of https://github.com/datateur/solar-system-api
sorindevops Nov 3, 2022
0cd42c5
Created query params in GET all planets route
datateur Nov 3, 2022
abc5831
updating any missing changes
sorindevops Nov 3, 2022
f0814da
updating any missing changes
sorindevops Nov 3, 2022
4acbc6b
created test files
sorindevops Nov 4, 2022
70986e7
conftest started
sorindevops Nov 4, 2022
ac8d537
changes made after review
sorindevops Nov 4, 2022
45f9864
Reconfigured app to use env
datateur Nov 4, 2022
a0625f6
Merge branch 'main' of https://github.com/datateur/solar-system-api
datateur Nov 4, 2022
44cc2b9
test_routes fucntions created
sorindevops Nov 4, 2022
5b2f9f0
Created get one and get all planets tests
datateur Nov 4, 2022
2538aa4
test_routes functions
sorindevops Nov 4, 2022
8011fd2
Created get all planets test
datateur Nov 4, 2022
c1598e0
Merge branch 'main' of https://github.com/datateur/solar-system-api
sorindevops Nov 4, 2022
2dc7d25
fix merge issues
sorindevops Nov 4, 2022
de95853
Created post route test
datateur Nov 4, 2022
e609b21
Merge branch 'main' of https://github.com/datateur/solar-system-api
datateur Nov 4, 2022
3f8a911
cleaned test files
datateur Nov 4, 2022
b430893
refactoring tests
datateur Jan 25, 2023
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
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):
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍

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

from app.models.planet import Planet

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

from .routes import planet_bp
app.register_blueprint(planet_bp)

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, nullable=False)
description = db.Column(db.Text, nullable=False)
rings = db.Column(db.Boolean, nullable=False)

def build_planet_dict(self):
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Prefer to leave planet out of the name of this function, so build_dict, or as we used in RT, to_dict. Since this is a method of Planet, it's a little redundant to have the class' own name in the methd. We probably will have an instance in a variable named something like planet, in which case, calling this would look like planet.build_planet_dict(). If we shorten the name, it would be planet.build_dict(), or planet.to_dict(), which already communicates that we're converting a planet to a dictionary representation.

return {
"id": self.id,
"name": self.name,
"description": self.description,
"rings": self.rings
}
81 changes: 80 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,81 @@
from flask import Blueprint
from flask import Blueprint, jsonify, abort, make_response, request
from app.models.planet import Planet
from app import db

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

def validate_planet(planet_id):
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 refactoring this to receive the class type as a parameter so that our validate helper could work for more than one type. This will be helpful in Task List when adding the Goal model.

try:
planet_id = int(planet_id)
except:
abort(make_response({"message":f"Planet #{planet_id} invalid"}, 400))

planet = Planet.query.get(planet_id)

if not planet:
abort(make_response({"message":f"Planet #{planet_id} not found"}, 404))

return planet

@planet_bp.route("", methods=["POST"])
def create_planet():
request_body = request.get_json()
new_planet = Planet(name=request_body["name"],
description=request_body["description"],
rings=request_body["rings"])

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

return make_response(f"Planet {new_planet.name} successfully 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.

👀 Make sure to jsonify even plain string responses, otherwise flask will return an HTML response rather than JSON.


@planet_bp.route("", methods=["GET"])
def get_all_planets():
name_query = request.args.get("name")
rings_query = request.args.get("rings")
limit_query = request.args.get("limit")

planet_query = Planet.query

if name_query:
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 handling of multiple query filters.

planet_query = planet_query.filter_by(name=name_query)
if rings_query:
planet_query = planet_query.filter_by(rings=rings_query)
if limit_query:
planet_query = planet_query.limit(limit=limit_query)

planets = planet_query.all()
planets_response = []

for planet in planets:
planets_response.append(planet.build_planet_dict())

return jsonify(planets_response)

@planet_bp.route("/<planet_id>", methods=["GET"])
def read_one_planet(planet_id):
planet = validate_planet(planet_id)

return jsonify(planet.build_planet_dict())

@planet_bp.route("/<planet_id>", methods=["PUT"])
def update_planet(planet_id):
planet = validate_planet(planet_id)
request_body = request.get_json()

planet.name = request_body["name"]
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Here (and in the create method) consider handling a possible KeyError with a more tailored message (similar to the abort handling in the validation function).

planet.description = request_body["description"]
planet.rings = request_body["rings"]

db.session.commit()

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

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

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

return make_response(f"Planet #{planet.id} successfully deleted", 200)
5 changes: 5 additions & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<<<<<<< HEAD
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

It looks like this file (which Alembic should have generated itself) somehow ended up with a merge conflict in it? Not sure what happened here.

Single-database configuration for Flask.
=======
Generic single-database configuration.
>>>>>>> 6090479c75453dcce233fbba05263a13891da630
57 changes: 57 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# 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]
<<<<<<< HEAD
keys = root,sqlalchemy,alembic,flask_migrate
=======
keys = root,sqlalchemy,alembic
>>>>>>> 6090479c75453dcce233fbba05263a13891da630

[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

<<<<<<< HEAD
[logger_flask_migrate]
level = INFO
handlers =
qualname = flask_migrate

=======
>>>>>>> 6090479c75453dcce233fbba05263a13891da630
[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
108 changes: 108 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
from __future__ import with_statement

import logging
from logging.config import fileConfig

<<<<<<< HEAD
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

There are more merge conflcicts here. At some point did your migrations stop working? These conflicts look like they would cause the code in this file to break.

=======
from sqlalchemy import engine_from_config
from sqlalchemy import pool
>>>>>>> 6090479c75453dcce233fbba05263a13891da630
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',
<<<<<<< HEAD
str(current_app.extensions['migrate'].db.get_engine().url).replace(
'%', '%%'))
=======
str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%'))
>>>>>>> 6090479c75453dcce233fbba05263a13891da630
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.')

<<<<<<< HEAD
connectable = current_app.extensions['migrate'].db.get_engine()
=======
connectable = engine_from_config(
config.get_section(config.config_ini_section),
prefix='sqlalchemy.',
poolclass=pool.NullPool,
)
>>>>>>> 6090479c75453dcce233fbba05263a13891da630

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/f361a1882d05_adds_book_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""adds Book model
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍 Good message on the migration


Revision ID: f361a1882d05
Revises:
Create Date: 2022-10-29 19:51:40.904287

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = 'f361a1882d05'
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.Text(), nullable=False),
sa.Column('rings', sa.Boolean(), nullable=False),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('planet')
# ### end Alembic commands ###
32 changes: 32 additions & 0 deletions tests/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
from flask import Flask
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 file should be empty. It just needs to be present for Python to see this folder as a package.

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

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

from app.models.planet import Book

from .routes import books_bp
app.register_blueprint(books_bp)

return app
Loading