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 - Masha & Melley #25

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
ebdc87b
Wave 1
mariia-iureva Oct 22, 2022
3713131
Wave 2
mariia-iureva Oct 22, 2022
46b4f12
Waves 1 and wave_2 done
mell2022 Oct 24, 2022
ce5fffd
Refactored it but it is still not working.
mell2022 Oct 28, 2022
d4ea315
This is the part with the migration
mell2022 Oct 30, 2022
68a4344
Fixed a couple of typos
mariia-iureva Nov 1, 2022
74721d1
Changes from Sunday
mell2022 Nov 1, 2022
a0f14af
After the merge conflict
mell2022 Nov 1, 2022
5d78ee6
read one planet
mariia-iureva Nov 1, 2022
55a8b4a
fixed planet into Planet, wave 4 now working
mariia-iureva Nov 1, 2022
22881bb
Updated planet
mell2022 Nov 1, 2022
cae7539
Delete planet
mell2022 Nov 1, 2022
3b550aa
Refactored version.
mell2022 Nov 2, 2022
685e48b
Code and postman working.
mell2022 Nov 2, 2022
5df92b3
First part of testing done.
mell2022 Nov 3, 2022
5519374
testing if push is working at all with a reame line
mariia-iureva Nov 3, 2022
0482354
I'm not sure but here's our .env file which was ignored before
mariia-iureva Nov 3, 2022
f3c3a73
Wave 6 second attempt
mariia-iureva Nov 3, 2022
71dacfd
I have added new content in routes and test.
mell2022 Nov 3, 2022
b1b5c13
wave 6 last test not working
mariia-iureva Nov 4, 2022
f5f9904
Wave 6 last test fixed
mariia-iureva Nov 4, 2022
aa53137
Wave 6 more tests
mariia-iureva Nov 4, 2022
1e91d0a
Wave 6 even more tests
mariia-iureva Nov 4, 2022
7323393
Last time before submitting it.
mell2022 Nov 4, 2022
f3f06b9
Clean up
mariia-iureva Nov 4, 2022
7b164ae
This is the commit with Procfile.
mell2022 Nov 7, 2022
529c5c8
Requirements fixed.
mell2022 Nov 8, 2022
0a9597e
Procfile updated.
mell2022 Nov 8, 2022
1f4d2ed
Requirements fixed.
mell2022 Nov 8, 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
2 changes: 2 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system
SQLALCHEMY_TEST_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_test
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: gunicorn --log-level=DEBUG 'app:create_app()'
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Solar System API

test line in readme

## Goal


Expand Down
31 changes: 30 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
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
app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get(
"SQLALCHEMY_TEST_DATABASE_URI")

# Import models here
from app.models.planet import Planet

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

# Register Blueprints here
from .routes import planets_bp
app.register_blueprint(planets_bp)


return app
Empty file added app/models/__init__.py
Empty file.
Empty file added app/models/model.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)
description = db.Column(db.String)
color = db.Column(db.String)


def to_dict(self):

return {
"name": self.name,
"color": self.color,
"description": self.description,
"id": self.id
}
@classmethod
def from_json(cls, req_body):
return cls(
name= req_body["name"],
color= req_body["color"],
description= req_body["description"]
)

def update(self, req_body):
self.name= req_body["name"],
self.color= req_body["color"],
self.description= req_body["description"]
Comment on lines +10 to +29

Choose a reason for hiding this comment

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

Great helper methods

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

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

def validate_planet(class_obj, planet_id):
try:
planet_id = int(planet_id)
except:
abort(make_response({"message": f"planet {planet_id} has an invalid planet_id"}, 400))

query_result = class_obj.query.get(planet_id)

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

return query_result
Comment on lines +8 to +19

Choose a reason for hiding this comment

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

Good helper function


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

if color_param:
planets = Planet.query.filter_by(color=color_param)
elif name_param:
planets = Planet.query.filter_by(name=name_param)
else:
planets = Planet.query.all()
planets_response = []

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

return jsonify(planets_response), 200

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

Choose a reason for hiding this comment

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

Some validation on the request_body here would be good to ensure it has the required fields.

new_planet = Planet.from_json(request_body)
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_one_planet(planet_id):
planet = validate_planet(Planet, planet_id)
return jsonify(planet.to_dict()), 200

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

Choose a reason for hiding this comment

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

Again validation here would be appropriate.


planet.update(request_body)

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

db.session.commit()

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

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

Choose a reason for hiding this comment

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

Just noting that this and the update action are untested.

planet = validate_planet(planet_id)

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

return make_response(f"Planet #{planet.id} successfully deleted")
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/02f11d17edc5_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""planet model

Revision ID: 02f11d17edc5
Revises:
Create Date: 2022-10-30 17:42:31.089244

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '02f11d17edc5'
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('color', 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 ###
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ click==7.1.2
Flask==1.1.2
Flask-Migrate==2.6.0
Flask-SQLAlchemy==2.4.4
gunicorn
idna==2.10
itsdangerous==1.1.0
Jinja2==2.11.3
Expand Down
Empty file added tests/__init__.py
Empty file.
Loading