Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
3e0b4c0
Instances of planets
louloera Apr 20, 2023
938e61e
created list of planets
charliemushishi Apr 20, 2023
875405f
fixed listed instances of planets
charliemushishi Apr 20, 2023
9b59854
Created blueprint for planets
louloera Apr 21, 2023
91368e3
endpoint to return list of planets
charliemushishi Apr 21, 2023
172f588
Made endpoint for specific planet
louloera Apr 21, 2023
a0d0b34
Merge branch 'main' of https://github.com/louloera/solar-system-api
louloera Apr 21, 2023
40908b5
Logic to return a specific planet info in /<planet_id> endpoint
louloera Apr 21, 2023
2d40007
added handling for invalid format and nonexisting planets
charliemushishi Apr 23, 2023
4d5b1cb
Created bones of databas
louloera Apr 27, 2023
025c500
added model and created Planet object made visible in init
charliemushishi Apr 27, 2023
9c736e0
creatd route to post new planet in db
charliemushishi Apr 27, 2023
1940e93
Created route to return all of the planets
louloera Apr 27, 2023
89ee99e
removed comments
charliemushishi May 1, 2023
2783e27
refactored get one planet route and created a function to validate id
louloera May 1, 2023
a9a999f
created update planet endpoint
charliemushishi May 1, 2023
6d46731
Created route to delete a planet
louloera May 1, 2023
d77592a
added query param
charliemushishi May 2, 2023
d72945d
created env file and reconfiged createapp
charliemushishi May 3, 2023
b42869e
Created tests folder and the test_fixture file
louloera May 3, 2023
76e6e5e
added test for GET with 200 response
charliemushishi May 3, 2023
0f72de7
Created test case to return one planet and populated test database wi…
louloera May 3, 2023
8e07257
added test for empty db proper status return
charliemushishi May 5, 2023
8ea9274
Created test case to validate the get rout for all planets
louloera May 5, 2023
b49eaf0
added test for post to return 201
charliemushishi May 5, 2023
cab0671
Changed database connector string to deployment env
louloera May 9, 2023
6e27096
updated requirements.txt to contain gunicorn
louloera May 9, 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
30 changes: 30 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,37 @@
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")
app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("RENDER_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.routes import planets
app.register_blueprint(planets)

from app.models.Planet import Planet

return app


9 changes: 9 additions & 0 deletions app/models/Planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
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)
place = db.Column(db.Integer)


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


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

@planets.route("", methods=["POST"])
def handle_planet():
request_body = request.get_json()
new_planet = Planet(name=request_body["name"],
description=request_body["description"],
place=request_body["place"])
db.session.add(new_planet)
db.session.commit()

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


@planets.route("", methods=["GET"])
def return_all_planets():

name_query = request.args.get("name")
if name_query:
planets = Planet.query.filter_by(name=name_query)
else:
planets = Planet.query.all()

planet_response = []
for planet in planets:
planet_response.append({
"id": planet.id,
"name": planet.name,
"description":planet.description,
'place':planet.place
})
return jsonify(planet_response)

def handle_planet_id(planet_id):
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


@planets.route("/<planet_id>", methods=["GET"])
def returns_one_planet_info(planet_id):
planet= handle_planet_id(planet_id)
planet_response= ({
"id": planet.id,
"name": planet.name,
"description":planet.description,
'place':planet.place
})
return (planet_response)


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

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

db.session.commit()

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

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

def delete_planet(planet_id):
planet = handle_planet_id(planet_id)

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

return make_response(f"Planet #{planet.id} succesfully 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/869f3c3ab97b_adds_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""adds planet model

Revision ID: 869f3c3ab97b
Revises:
Create Date: 2023-04-27 13:29:14.798363

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '869f3c3ab97b'
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('place', 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 ###
7 changes: 7 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@ blinker==1.4
certifi==2020.12.5
chardet==4.0.0
click==7.1.2
coverage==7.2.3
exceptiongroup==1.1.1
Flask==1.1.2
Flask-Migrate==2.6.0
Flask-SQLAlchemy==2.4.4
gunicorn==20.1.0
idna==2.10
iniconfig==2.0.0
itsdangerous==1.1.0
Jinja2==2.11.3
Mako==1.1.4
MarkupSafe==1.1.1
packaging==23.1
pluggy==1.0.0
psycopg2-binary==2.9.5
pycodestyle==2.6.0
pytest==7.3.1
Expand All @@ -23,5 +29,6 @@ requests==2.25.1
six==1.15.0
SQLAlchemy==1.3.23
toml==0.10.2
tomli==2.0.1
urllib3==1.26.4
Werkzeug==1.0.1
Empty file added tests/__init__.py
Empty file.
Loading