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
0d6e418
Created Planet class
tiffinihyatt Apr 22, 2022
d3635a2
Started to create planets array
tiffinihyatt Apr 22, 2022
0d8bbec
Wave 1 Complete
ArmchairGraduate Apr 22, 2022
c59cbbd
added blueprint to __init__.py, added planet GET method to return pl…
pickled-bot Apr 22, 2022
b9e3617
created validate_planet helper function to check for valid planet id.
ArmchairGraduate Apr 25, 2022
174a417
added function to_dict to Planet class
pickled-bot Apr 25, 2022
4c96a0d
created route for planet_id with function get_planet_by_id
pickled-bot Apr 25, 2022
aef2191
Set up SQLAlchemy
tiffinihyatt Apr 29, 2022
e4ae7ad
added planet model
ArmchairGraduate Apr 29, 2022
dfe4065
added create planet endpoint
pickled-bot Apr 29, 2022
7f2ed54
Added read all planets GET endpoint
tiffinihyatt Apr 29, 2022
0b3a9c7
updated validate_planet function
pickled-bot May 3, 2022
c58002c
added get_planet_by_id function with GET method
pickled-bot May 3, 2022
43e4d2d
Created update_planet endpoint
tiffinihyatt May 3, 2022
8d6d02d
created DELETE endpoint
ArmchairGraduate May 3, 2022
9c95797
Removed old code and created scratch.py file
tiffinihyatt May 4, 2022
f3c2a74
Created to_dictionary Class method and refactored endpoints to use to…
tiffinihyatt May 4, 2022
bd3ba79
refactored create_app method
ArmchairGraduate May 5, 2022
7473c59
created tests folder and made pytest fixtures
pickled-bot May 5, 2022
72fd43a
Updated scratch file
tiffinihyatt May 5, 2022
0509329
Created test_get_all_planets_with_no_records
tiffinihyatt May 5, 2022
2df8138
Created two_saved_planets for test configurations
tiffinihyatt May 5, 2022
de695d4
Created and passed test_get_one_planet
tiffinihyatt May 5, 2022
71ae69d
Made test for planet id not found, 404
pickled-bot May 6, 2022
6ac2887
created get all planets test
ArmchairGraduate May 6, 2022
48837ce
Create test_post_planet_returns_201 and refactored routes to include …
tiffinihyatt May 6, 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
22 changes: 22 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
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'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development'
else:
app.config["TESTING"] = True
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_test'

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/moon.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.String, nullable=False)
distance_from_sun = db.Column(db.Integer, nullable=False)

def to_dictionary(self):
return dict(
id=self.id,
name=self.name,
description=self.description,
distance_from_sun=self.distance_from_sun
)
69 changes: 68 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,69 @@
from flask import Blueprint
from flask import Blueprint, jsonify, abort, make_response, request
from app import db
from app.models.planet import Planet

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

@planets_bp.route("", methods = ["POST"])
def handle_planets():
request_body = request.get_json()
new_planet = Planet(
name = request_body["name"],
description = request_body["description"],
distance_from_sun = request_body["distance from sun"]
)

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

return make_response(jsonify(f'planet {new_planet.name} successfully created!'), 201)

@planets_bp.route("", methods = ["GET"])
def planet_data():
planets = Planet.query.all()
planets_response = []

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

return jsonify(planets_response)

@planets_bp.route("/<planet_id>", methods = ["GET"])
def get_planet_by_id(planet_id):
planet = validate_planet(planet_id)
return jsonify(planet.to_dictionary())

@planets_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"]
planet.description = request_body["description"]
planet.distance_from_sun = request_body["distance from sun"]

db.session.commit()

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

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

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

return make_response(jsonify(f"Planet {planet.name} successfully deleted."))

def validate_planet(planet_id):
Copy link
Copy Markdown

@kelsey-steven-ada kelsey-steven-ada Apr 27, 2022

Choose a reason for hiding this comment

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

I'd consider renaming this function. To me, validate_planet sounds like it should return a true/false based on if the planet passed as a parameter is valid. What name might better describe what the function is doing?

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

planet = Planet.query.get(planet_id)

if not planet:
abort(make_response({"message": f"planet {planet_id} not found"}, 404))
return planet
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/1d660ff870ae_adds_planet_model.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
"""adds Planet model

Revision ID: 1d660ff870ae
Revises:
Create Date: 2022-04-29 11:27:07.136352

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '1d660ff870ae'
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.String(), nullable=False),
sa.Column('distance_from_sun', sa.Integer(), nullable=False),
sa.PrimaryKeyConstraint('id')
)
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('planet')
# ### end Alembic commands ###
71 changes: 71 additions & 0 deletions scratch.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
###########################
###########################
########planet.py##########
###########################
#########__init__.py#######
###########################
#########routes.py#########
###########################
# import json # maybe don't need
# from unicodedata import name # maybe don't need

# planets = [
# Planet(1, "Mercury", "rocky", 1),
# Planet(2, "Venus", "rocky", 2),
# Planet(3, "Earth", "water", 3),
# Planet(4, "Mars", "red", 4),
# Planet(5, "Jupiter", "big", 5),
# Planet(6, "Saturn", "rings", 6),
# Planet(7, "Uranus", "butt", 7),
# Planet(8, "Neptune", "ice", 8),
# Planet(9, "Pluto", "dwarf", 9)
# ]

# class Planet:
# # def __init__(self, id, name, description, dist_from_sun):
# # self.id = id
# # self.name = name
# # self.description = description
# # self.dist_from_sun = dist_from_sun

# def to_dict(self):
# return {
# "id" : self.id,
# "name" : self.name,
# "description" : self.description,
# "distance from sun" : self.dist_from_sun
# }

# from delete_planet_by_id endpoint
# planet_list = []
# for planet in planets:
# planet_list.append({
# "id" : planet.id,
# "name" : planet.name,
# "description" : planet.description,
# "distance from sun" : planet.dist_from_sun
# }
# )
# return jsonify(planet_list)

# @planets_bp.route("/<planet_id>", methods = ["GET"])
# def get_planet_by_id(planet_id):
# planet = validate_planet(planet_id)
# return planet.to_dict()

# from validate_planet() helper function
# for planet in planets:
# if planet.id == planet_id:
# return planet











###########################
Empty file added tests/__init__.py
Empty file.
Loading