Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
2826bdd
Created planet class and objects
paperbackwriter2 Oct 18, 2021
cff5319
Added /planets route to return all planets.
paperbackwriter2 Oct 18, 2021
bbdc9b3
Create route for individual planets '/<planet_id>'
paperbackwriter2 Oct 18, 2021
b2d27c1
Create instance method that returns object as dictionary
paperbackwriter2 Oct 18, 2021
c6c8f80
Add error handling.
paperbackwriter2 Oct 18, 2021
6c9ccf3
Fix spacing error in line 42.
paperbackwriter2 Oct 18, 2021
bdd2d54
Update create_app to access database and SQLAlchemy
paperbackwriter2 Oct 25, 2021
c83adb3
Create Planet model and import into create_app
paperbackwriter2 Oct 25, 2021
f9dca04
Applies migration
paperbackwriter2 Oct 25, 2021
d52149d
Creates /planets POST endpoint
paperbackwriter2 Oct 25, 2021
a0bf00c
Adds /planets GET endpoint
paperbackwriter2 Oct 25, 2021
04ad8f0
Create /<planet_id> GET endpoint
paperbackwriter2 Oct 25, 2021
8c72e85
Add PATCH endpoint for updating a planet
paperbackwriter2 Oct 26, 2021
8a417e8
Add DELETE endpoint for single planet
paperbackwriter2 Oct 26, 2021
2b7a691
Add error handling for non-int planet id in url
paperbackwriter2 Oct 26, 2021
09626e0
Add to_dict method to Planet model. Implement in GET endpoints.
paperbackwriter2 Oct 26, 2021
88fa564
Refactored routes to have single method
mobregong Oct 27, 2021
055f1a0
Refactor routes to have single method
mobregong Oct 27, 2021
dd99c8e
Merge branch 'main' of https://github.com/mobregong/solar-system-api
mobregong Oct 28, 2021
8b49c49
Add connection strings as environment variables, refactor create_app …
mobregong Oct 28, 2021
30d6c91
Set up files and configurations needed for testing
mobregong Oct 28, 2021
8b38a31
Adds tests 0-3
mobregong Oct 28, 2021
684cfa4
Add test for creating new planet with POST to /planets
paperbackwriter2 Oct 28, 2021
8515ca2
Refactor create planet POST /planets test
paperbackwriter2 Oct 28, 2021
870caca
Refactor make_response returns for consistency. Update tests accordin…
paperbackwriter2 Oct 28, 2021
d4ce56f
Adds Procfile
mobregong Nov 3, 2021
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_development
SQLALCHEMY_TEST_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_test
10 changes: 5 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ celerybeat.pid
# SageMath parsed files
*.sage.py

# Environments
.env
# # Environments
# .env
.venv
env/
# env/
venv/
ENV/
env.bak/
# ENV/
# env.bak/
venv.bak/

# Spyder project settings
Expand Down
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()'
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__)

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 .routes import planets_bp
app.register_blueprint(planets_bp)

from app.models.planet import Planet

return app
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)
description = db.Column(db.String)
size_rank = db.Column(db.Integer)

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

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

#Helper functions
def valid_planet(planet_id):
try:
int(planet_id)
except:
abort(make_response({"error": "planet_id must be an int"}, 400))

def get_planet_from_id(planet_id):
valid_planet(planet_id)
selected_planet = Planet.query.get_or_404(planet_id)
return selected_planet

# Routes
@planets_bp.route("", methods=["POST"], strict_slashes=False)
def add_planet():
request_body = request.get_json()
new_planet = Planet(
name=request_body["name"],
description=request_body["description"],
size_rank=request_body["size_rank"]
)
db.session.add(new_planet)
db.session.commit()
return make_response({"planet": new_planet.to_dict()}, 201)

@planets_bp.route("", methods=["GET"], strict_slashes=False)
def get_all_planets():
planet_objects = Planet.query.all() # returning list of objects
response_list = []
for planet in planet_objects:
response_list.append(planet.to_dict())
return make_response(jsonify(response_list), 200)

# Routes for single planet
@planets_bp.route("/<planet_id>", methods=["GET"])
def get_planet(planet_id):
selected_planet = get_planet_from_id(planet_id)
return make_response({"planet": selected_planet.to_dict()}, 200)

@planets_bp.route("/<planet_id>", methods=["PATCH"])
def update_planet(planet_id):
selected_planet = get_planet_from_id(planet_id)
request_body = request.get_json()
if "name" in request_body:
selected_planet.name = request_body["name"]
if "description" in request_body:
selected_planet.description = request_body["description"]
if "size_rank" in request_body:
selected_planet.size_rank = request_body["size_rank"]
db.session.commit()
return make_response(f"{selected_planet.name} updated", 200)

@planets_bp.route("/<planet_id>", methods=["DELETE"])
def delete_planet(planet_id):
selected_planet = get_planet_from_id(planet_id)
db.session.delete(selected_planet)
db.session.commit()
return make_response(f"{selected_planet.name} deleted", 200)


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

Revision ID: 9129fcb5000b
Revises:
Create Date: 2021-10-25 13:59:20.565157

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '9129fcb5000b'
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('size_rank', 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 ###
10 changes: 9 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
alembic==1.5.4
attrs==20.3.0
autopep8==1.5.5
certifi==2020.12.5
chardet==4.0.0
click==7.1.2
Flask==1.1.2
Flask-Migrate==2.6.0
Flask-SQLAlchemy==2.4.4
gunicorn==20.1.0
idna==2.10
iniconfig==1.1.1
itsdangerous==1.1.0
Jinja2==2.11.3
Mako==1.1.4
MarkupSafe==1.1.1
packaging==20.9
pluggy==0.13.1
psycopg2-binary==2.8.6
py==1.10.0
pycodestyle==2.6.0
pyparsing==2.4.7
pytest==6.2.3
python-dateutil==2.8.1
python-dotenv==0.15.0
python-editor==1.0.4
Expand All @@ -21,4 +29,4 @@ six==1.15.0
SQLAlchemy==1.3.23
toml==0.10.2
urllib3==1.26.4
Werkzeug==1.0.1
Werkzeug==1.0.1
Empty file added tests/__init__.py
Empty file.
Loading