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

Sea Turtles Solar System API Part 1 Tyrah and San #24

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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()'
46 changes: 45 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,51 @@
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()

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_TRACK_MODIFICATIONS"] = False
Copy link

Choose a reason for hiding this comment

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

you can go ahead and remove this

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 Planet

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_TEST_DATABASE_URI'] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI')
Comment on lines +36 to +40
Copy link

Choose a reason for hiding this comment

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

looks like you all have this twice. Its also on lines 20 - 28. You can remove one of them.



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

from .models.planet import Planet

from .routes import bp
app.register_blueprint(bp)

return app
return app
29 changes: 29 additions & 0 deletions app/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# from flask import Flask
Copy link

Choose a reason for hiding this comment

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

if this whole file it commented out you can make it an empty __init__.py file.

# from flask_sqlalchemy import SQLAlchemy
# from flask_migrate import Migrate

# db = SQLAlchemy()
# migrate = Migrate()


# def create_app(test_config=None):
# app = Flask(__name__)

# app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

# if not test_config:

# app.config['SQLALCHEMY_DATABASE_URI'] = SQLALCHEMY_DATABASE_URI

# else:
# app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development'

# from app.models.planet import Planet

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

# # from .routes import bp
# # app.register_blueprint(bp)

# return app
17 changes: 17 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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)
has_moon = db.Column(db.Boolean, nullable=False)
Comment on lines +5 to +7
Copy link

Choose a reason for hiding this comment

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

I like that you all made this nullable = False



#planet turn itself into dictionary
def to_dict(self):
Copy link

Choose a reason for hiding this comment

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

🙌🏽

return ({
"id": self.id,
"name": self.name,
"description": self.description,
"has_moon": self.has_moon
})
114 changes: 113 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,114 @@
from flask import Blueprint

import re
from flask import Blueprint, jsonify, abort, make_response, request
from app import db
from .models.planet import Planet



#instantiate blueprint object
bp = Blueprint("planets_bp",__name__, url_prefix="/planets")

#helper function to get one planet by id or return error message
def get_planet_by_id(id):
try:
id = int(id)
except ValueError:
abort(make_response(jsonify(dict(details=f"Invalid id {id}")), 400))

planet = Planet.query.get(id)

if planet:
return planet

else:
abort(make_response(jsonify(dict(details=f"Invalid id {id}")), 404))

#create a planet
@bp.route("", methods=["POST"])
def create_planet():
request_body = request.get_json()
new_planet = Planet(
name=request_body["name"],
description=request_body["description"],
has_moon=request_body["has_moon"],
)
Comment on lines +31 to +35
Copy link

Choose a reason for hiding this comment

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

you could also make this an instance method in your Planet class.

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

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

#read all planets
@bp.route("", methods=["GET"])
def read_all_planets():
#query params for /planets endpoint
#planets?<key>=<value>
name_query = request.args.get("name")
description_query = request.args.get("description")
has_moon_query = request.args.get("has_moon")


if name_query:
Copy link

Choose a reason for hiding this comment

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

love these multiple ways to query

planets = Planet.query.filter_by(name=name_query)
elif description_query:
planets = Planet.query.filter_by(description=description_query)
elif has_moon_query:
planets = Planet.query.filter_by(has_moon=has_moon_query)
else:
planets = Planet.query.all()
planets_response = [planet.to_dict() for planet in planets]
return jsonify(planets_response)

#get one existing planet
@bp.route("/<planet_id>", methods=["GET"])
def read_one_planet(planet_id):
planet = get_planet_by_id(planet_id)
return jsonify(planet.to_dict())

#replace one existing planet
@bp.route("/<planet_id>", methods=["PUT"])
def replace_one_planet_by_id(planet_id):
request_body = request.get_json()
planet = get_planet_by_id(planet_id)


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

db.session.commit()


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


#update part of one existing planet
@bp.route("<planet_id>", methods=["PATCH"])
def update_planet_by_id(planet_id):
request_body = request.get_json()
planet = get_planet_by_id(planet_id)

planet_keys = request_body.keys()

if "name" in planet_keys:
planet.name = request_body["name"]
if "description" in planet_keys:
planet.description = request_body["description"]
if "has_moon" in planet_keys:
planet.has_moon = request_body["has_moon"]

db.session.commit()

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

#delete record of planet
@bp.route("/<planet_id>", methods=["DELETE"])
def delete_planet(planet_id):
planet = get_planet_by_id(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.
53 changes: 53 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 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,flask_migrate
keys = root,sqlalchemy,alembic
>>>>>>> 5952d2681d2751f9f45eb2cf8657682d11f7f463

[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

[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"}
Loading