From 57f27d35c24f8a58b8ecdc5efe18a4873aaded9e Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Sat, 23 Apr 2022 03:36:38 +0900 Subject: [PATCH 01/18] completed wave 1 --- app/__init__.py | 5 ++++- app/routes.py | 42 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 45 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b51239bf2 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -3,5 +3,8 @@ def create_app(test_config=None): app = Flask(__name__) - + + from .routes import planets_bp + app.register_blueprint(planets_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..60e19cfe8 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,42 @@ -from flask import Blueprint +from crypt import methods +from flask import Blueprint, jsonify + + +class Planet(): + def __init__(self, id, name, description, circumference, length_of_year): + self.id = id + self.name = name + self.description = description + self.circumference = circumference + self.length_of_year = length_of_year + +planets = [ + Planet(1, "Mercury", "made mostly of rocks", 9522, 88), + Planet(2, "Venus", "most like Earth", 23617, 225), + Planet(3, "Earth", "you are here", 24889, 365), + Planet(4, "Mars", "the red planet", 13256, 687), + Planet(5, "Jupiter", "largest planet", 278985, 4320), + Planet(6, "Saturn", "sun's bae with all 7 rings", 235185, 10620), + Planet(7, "Uranus", "can only be seen with a telescope", 99739, 30240), + Planet(8, "Neptune", "it is an intense blue color", 96645, 59400), + Planet(9, "Pluto", "no dwarf in my book", 7144, 88920) +] + +planets_bp = Blueprint("planets", __name__, url_prefix = "/planets") + +@planets_bp.route("", methods = ["GET"]) +def get_all_planets(): + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "circumference": planet.circumference, + "length of year": planet.length_of_year + }) + return jsonify(planets_response) + + + From 0efeb9a371ff810fcc66ad645dbb7ebd994cf881 Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Mon, 25 Apr 2022 14:07:42 -0500 Subject: [PATCH 02/18] Part 1 finished --- app/routes.py | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 60e19cfe8..78e50ad9a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,5 +1,4 @@ -from crypt import methods -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, abort, make_response class Planet(): @@ -10,6 +9,15 @@ def __init__(self, id, name, description, circumference, length_of_year): self.circumference = circumference self.length_of_year = length_of_year + def to_json(self): + return { + "id" : self.id, + "name" : self.name, + "description" : self.description, + "circumference" : self.circumference, + "length_of_year" : self.length_of_year + } + planets = [ Planet(1, "Mercury", "made mostly of rocks", 9522, 88), Planet(2, "Venus", "most like Earth", 23617, 225), @@ -37,6 +45,18 @@ def get_all_planets(): }) return jsonify(planets_response) +@planets_bp.route("/", methods = ["GET"]) +def get_one_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message":f"Planet {id} is invalid."}, 400)) + + for planet in planets: + if planet.id == id: + return jsonify(planet.to_json()) + return abort(make_response({"message":f"Planet {id} not found."}, 404)) + From 769c4cf27ad9e6917586247f9eb28f6eabaf391b Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Fri, 29 Apr 2022 13:03:56 -0500 Subject: [PATCH 03/18] Cong. db --- app/__init__.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index b51239bf2..2442f71f1 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,19 @@ from flask import Flask +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 + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_api_development' + + db.init_app(app) + migrate.init_app(app, db) + from .routes import planets_bp app.register_blueprint(planets_bp) From 6595fd22c88e4b96693e3c76f7e516cb90319662 Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Fri, 29 Apr 2022 13:17:50 -0500 Subject: [PATCH 04/18] Connect database and Flask. Defined Model --- app/__init__.py | 2 ++ app/models/__init__.py | 0 app/models/planet.py | 9 +++++++++ 3 files changed, 11 insertions(+) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py diff --git a/app/__init__.py b/app/__init__.py index 2442f71f1..4d7eb5006 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -14,6 +14,8 @@ def create_app(test_config=None): 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) diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..36a1612ea --- /dev/null +++ b/app/models/planet.py @@ -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) + circumference = db.Column(db.Integer) + length_of_year= db.Column(db.Integer) + \ No newline at end of file From 93954beae97327455295a3a9669eaa67c239c6a8 Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Fri, 29 Apr 2022 13:24:02 -0500 Subject: [PATCH 05/18] Database Migration Setup --- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../23a4d026f209_adds_planet_model.py | 35 +++++++ 5 files changed, 201 insertions(+) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/23a4d026f209_adds_planet_model.py diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -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 diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -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() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -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"} diff --git a/migrations/versions/23a4d026f209_adds_planet_model.py b/migrations/versions/23a4d026f209_adds_planet_model.py new file mode 100644 index 000000000..42d11d8ca --- /dev/null +++ b/migrations/versions/23a4d026f209_adds_planet_model.py @@ -0,0 +1,35 @@ +"""adds Planet model + +Revision ID: 23a4d026f209 +Revises: +Create Date: 2022-04-29 13:22:02.555439 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '23a4d026f209' +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('circumference', sa.Integer(), nullable=True), + sa.Column('length_of_year', 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 ### From ff2ec6ee54b3f920bfae0eb6eba63ca7ca931ca1 Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Tue, 3 May 2022 13:31:31 -0500 Subject: [PATCH 06/18] Wave 3 finished --- app/routes.py | 128 ++++++++++++++++++++++++++++++++++---------------- 1 file changed, 87 insertions(+), 41 deletions(-) diff --git a/app/routes.py b/app/routes.py index 78e50ad9a..5f93a6655 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,40 +1,60 @@ -from flask import Blueprint, jsonify, abort, make_response - - -class Planet(): - def __init__(self, id, name, description, circumference, length_of_year): - self.id = id - self.name = name - self.description = description - self.circumference = circumference - self.length_of_year = length_of_year - - def to_json(self): - return { - "id" : self.id, - "name" : self.name, - "description" : self.description, - "circumference" : self.circumference, - "length_of_year" : self.length_of_year - } - -planets = [ - Planet(1, "Mercury", "made mostly of rocks", 9522, 88), - Planet(2, "Venus", "most like Earth", 23617, 225), - Planet(3, "Earth", "you are here", 24889, 365), - Planet(4, "Mars", "the red planet", 13256, 687), - Planet(5, "Jupiter", "largest planet", 278985, 4320), - Planet(6, "Saturn", "sun's bae with all 7 rings", 235185, 10620), - Planet(7, "Uranus", "can only be seen with a telescope", 99739, 30240), - Planet(8, "Neptune", "it is an intense blue color", 96645, 59400), - Planet(9, "Pluto", "no dwarf in my book", 7144, 88920) -] +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet + + +# class Planet(): +# def __init__(self, id, name, description, circumference, length_of_year): +# self.id = id +# self.name = name +# self.description = description +# self.circumference = circumference +# self.length_of_year = length_of_year + +# def to_json(self): +# return { +# "id" : self.id, +# "name" : self.name, +# "description" : self.description, +# "circumference" : self.circumference, +# "length_of_year" : self.length_of_year +# } + +# planets = [ +# Planet(1, "Mercury", "made mostly of rocks", 9522, 88), +# Planet(2, "Venus", "most like Earth", 23617, 225), +# Planet(3, "Earth", "you are here", 24889, 365), +# Planet(4, "Mars", "the red planet", 13256, 687), +# Planet(5, "Jupiter", "largest planet", 278985, 4320), +# Planet(6, "Saturn", "sun's bae with all 7 rings", 235185, 10620), +# Planet(7, "Uranus", "can only be seen with a telescope", 99739, 30240), +# Planet(8, "Neptune", "it is an intense blue color", 96645, 59400), +# Planet(9, "Pluto", "no dwarf in my book", 7144, 88920) +# ] planets_bp = Blueprint("planets", __name__, url_prefix = "/planets") +# CREATE PLANET +@planets_bp.route("", methods = ["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet( + name = request_body["name"], + description = request_body["description"], + circumference = request_body["circumference"], + length_of_year = request_body["length_of_year"] + ) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} has been successfully created", 201) + +# GET ALL @planets_bp.route("", methods = ["GET"]) def get_all_planets(): planets_response = [] + planets = Planet.query.all() for planet in planets: planets_response.append({ "id": planet.id, @@ -44,19 +64,45 @@ def get_all_planets(): "length of year": planet.length_of_year }) return jsonify(planets_response) + # planets_response = [] + # planets = Planet.query.all() + # for planet in planets: + # planets_response.append(planet.to_json()) -@planets_bp.route("/", methods = ["GET"]) -def get_one_planet(id): - try: - id = int(id) - except: - return abort(make_response({"message":f"Planet {id} is invalid."}, 400)) + # return jsonify(planets_response), 200 - for planet in planets: - if planet.id == id: - return jsonify(planet.to_json()) - return abort(make_response({"message":f"Planet {id} not found."}, 404)) +# VALIDATE ID +def validate_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"planet {id} is invalid"}, 400)) + + planet = Planet.query.get(id) + if not planet: + abort(make_response({"message":f"planet {id} not found"}, 404)) + + return planet + +# GET ONE PLANET +@planets_bp.route("/", methods = ["GET"]) +def get_one_planet(id): + planet = validate_planet(id) + # return jsonify({ + # "id": planet.id, + # "name": planet.name, + # "description": planet.description, + # "circumference": planet.circumference, + # "length of year": planet.length_of_year + # }) + return jsonify(planet.to_json()), 200 + # { + # name: + # description: + # circumference: + # length_of_year: + # } \ No newline at end of file From a8fae40be71fcbb7f941698d99cc2250605f951c Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Wed, 4 May 2022 12:43:49 -0500 Subject: [PATCH 07/18] Moved to_json --- app/models/planet.py | 10 +++- app/routes.py | 127 +++++++++++++++++++++++++------------------ 2 files changed, 82 insertions(+), 55 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 36a1612ea..efd6a2931 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -6,4 +6,12 @@ class Planet(db.Model): description = db.Column(db.String) circumference = db.Column(db.Integer) length_of_year= db.Column(db.Integer) - \ No newline at end of file + + def to_json(self): + return { + "id" : self.id, + "name" : self.name, + "description" : self.description, + "circumference" : self.circumference, + "length_of_year" : self.length_of_year + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 5f93a6655..2151397c7 100644 --- a/app/routes.py +++ b/app/routes.py @@ -3,35 +3,6 @@ from app.models.planet import Planet -# class Planet(): -# def __init__(self, id, name, description, circumference, length_of_year): -# self.id = id -# self.name = name -# self.description = description -# self.circumference = circumference -# self.length_of_year = length_of_year - -# def to_json(self): -# return { -# "id" : self.id, -# "name" : self.name, -# "description" : self.description, -# "circumference" : self.circumference, -# "length_of_year" : self.length_of_year -# } - -# planets = [ -# Planet(1, "Mercury", "made mostly of rocks", 9522, 88), -# Planet(2, "Venus", "most like Earth", 23617, 225), -# Planet(3, "Earth", "you are here", 24889, 365), -# Planet(4, "Mars", "the red planet", 13256, 687), -# Planet(5, "Jupiter", "largest planet", 278985, 4320), -# Planet(6, "Saturn", "sun's bae with all 7 rings", 235185, 10620), -# Planet(7, "Uranus", "can only be seen with a telescope", 99739, 30240), -# Planet(8, "Neptune", "it is an intense blue color", 96645, 59400), -# Planet(9, "Pluto", "no dwarf in my book", 7144, 88920) -# ] - planets_bp = Blueprint("planets", __name__, url_prefix = "/planets") # CREATE PLANET @@ -56,20 +27,10 @@ def get_all_planets(): planets_response = [] planets = Planet.query.all() for planet in planets: - planets_response.append({ - "id": planet.id, - "name": planet.name, - "description": planet.description, - "circumference": planet.circumference, - "length of year": planet.length_of_year - }) + planets_response.append(planet.to_json()) + return jsonify(planets_response) - # planets_response = [] - # planets = Planet.query.all() - # for planet in planets: - # planets_response.append(planet.to_json()) - - # return jsonify(planets_response), 200 + # VALIDATE ID def validate_planet(id): @@ -89,20 +50,78 @@ def validate_planet(id): @planets_bp.route("/", methods = ["GET"]) def get_one_planet(id): planet = validate_planet(id) - # return jsonify({ - # "id": planet.id, - # "name": planet.name, - # "description": planet.description, - # "circumference": planet.circumference, - # "length of year": planet.length_of_year - # }) return jsonify(planet.to_json()), 200 + + # { + # "name": "Mercury" + # "description": "made mostly of rocks" + # "circumference": 9522 + # "length_of_year": 88 + # } + + + # { + # "name": Venus + # "description": most like Earth + # "circumference": 23617 + # "length_of_year": + # } + + + # { + # "name": "Earth" + # "description": "you are here" + # "circumference": 24889 + # "length_of_year": 365 + # } + + + # { + # "name": "Mars" + # "description": "the red planet" + # "circumference": 13256 + # "length_of_year": 687 + # } + + + # { + # "name": "Jupiter", + # "description": "largest planet", + # "circumference": 278985, + # "length_of_year": 4320 + # } + + + # { + # "name": "Saturn", + # "description": "sun's bae with all 7 rings", + # "circumference": 235185, + # "length_of_year": 10620 + # } + + + # { + # "name": "Uranus", + # "description": "can only be seen with a telescope", + # "circumference": 99739, + # "length_of_year": 30240 + # } + + + # { + # "name": "Neptune", + # "description": "it is an intense blue color", + # "circumference": 96645, + # "length_of_year": 59400 + # } + + # { - # name: - # description: - # circumference: - # length_of_year: - # } \ No newline at end of file + # "name": "Pluto", + # "description": "no dwarf in my book", + # "circumference": 7144, + # "length_of_year": 88920 + # } From cc4aec6ffbfa6001dc73c0bcc1be490a4c5bbaef Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Thu, 5 May 2022 02:51:20 +0900 Subject: [PATCH 08/18] add to json method to cat class --- app/models/planet.py | 10 +++++- app/routes.py | 47 +++++++++++++++++++++------- migrations/versions/459fadb80120_.py | 35 +++++++++++++++++++++ 3 files changed, 80 insertions(+), 12 deletions(-) create mode 100644 migrations/versions/459fadb80120_.py diff --git a/app/models/planet.py b/app/models/planet.py index 36a1612ea..a2d53e37f 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -6,4 +6,12 @@ class Planet(db.Model): description = db.Column(db.String) circumference = db.Column(db.Integer) length_of_year= db.Column(db.Integer) - \ No newline at end of file + + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "circumference": self.circumference, + "length of year": self.length_of_year + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 5f93a6655..b3dc0af83 100644 --- a/app/routes.py +++ b/app/routes.py @@ -48,7 +48,7 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} has been successfully created", 201) + return make_response(f"Planet {new_planet.name} has been successfully created", 201) #use make response when you want to return something that is not json # GET ALL @planets_bp.route("", methods = ["GET"]) @@ -56,14 +56,15 @@ def get_all_planets(): planets_response = [] planets = Planet.query.all() for planet in planets: - planets_response.append({ - "id": planet.id, - "name": planet.name, - "description": planet.description, - "circumference": planet.circumference, - "length of year": planet.length_of_year - }) - return jsonify(planets_response) + # planets_response.append({ + # "id": planet.id, + # "name": planet.name, + # "description": planet.description, + # "circumference": planet.circumference, + # "length of year": planet.length_of_year + # }) + planets_response.append(planet.to_json()) + return jsonify(planets_response) #need jsonify when returning list # planets_response = [] # planets = Planet.query.all() # for planet in planets: @@ -99,10 +100,34 @@ def get_one_planet(id): return jsonify(planet.to_json()), 200 - # { # name: # description: # circumference: # length_of_year: - # } \ No newline at end of file + # } + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(id): + planet = validate_planet(id) + + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.circumference = request_body["circumference"] + planet.length_of_year = request_body["length_of_year"] + + db.session.commit() + + return make_response(f"Planet #{id} succesffully updated"), 200 + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_one_planet(id): + planet = validate_planet(id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{id} was successfully deleted"), 200 diff --git a/migrations/versions/459fadb80120_.py b/migrations/versions/459fadb80120_.py new file mode 100644 index 000000000..ff7dba19a --- /dev/null +++ b/migrations/versions/459fadb80120_.py @@ -0,0 +1,35 @@ +"""empty message + +Revision ID: 459fadb80120 +Revises: +Create Date: 2022-04-30 03:27:32.186440 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '459fadb80120' +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('circumference', sa.Integer(), nullable=True), + sa.Column('length_of_year', 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 ### From 2f0d8ebcaee9a9189c6a4d0ba37926dc68b93c53 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Thu, 5 May 2022 03:32:56 +0900 Subject: [PATCH 09/18] added queries --- app/routes.py | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/app/routes.py b/app/routes.py index 8af49e9e9..b1ee618e0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -24,8 +24,25 @@ def create_planet(): # GET ALL @planets_bp.route("", methods = ["GET"]) def get_all_planets(): + + days_query = request.args.get("length_of_year") + name_query = request.args.get("name") + description_query = request.args.get("description") + circumference_query = request.args.get("circumference") + + if days_query: + planets = Planet.query.filter_by(length_of_year = days_query) + elif name_query: + planets = Planet.query.filter_by(name = name_query) + elif description_query: + planets = Planet.query.filter_by(description = description_query) + elif circumference_query: + planets = Planet.query.filter_by(circumference = circumference_query) + else: + planets = Planet.query.all() + planets_response = [] - planets = Planet.query.all() + for planet in planets: planets_response.append(planet.to_json()) @@ -86,18 +103,18 @@ def delete_one_planet(id): db.session.commit() return make_response(f"Planet #{id} was successfully deleted"), 200 - # "name": "Mercury" - # "description": "made mostly of rocks" - # "circumference": 9522 + # {"name": "Mercury", + # "description": "made mostly of rocks", + # "circumference": 9522, # "length_of_year": 88 # } # { - # "name": Venus - # "description": most like Earth - # "circumference": 23617 - # "length_of_year": + # "name": Venus, + # "description": most like Earth, + # "circumference": 23617, + # "length_of_year": 225 # } @@ -110,9 +127,9 @@ def delete_one_planet(id): # { - # "name": "Mars" - # "description": "the red planet" - # "circumference": 13256 + # "name": "Mars", + # "description": "the red planet", + # "circumference": 13256, # "length_of_year": 687 # } From 32bbf87da5308fcd38ea483bc74f1c17ae03a896 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Thu, 5 May 2022 03:54:24 +0900 Subject: [PATCH 10/18] refactored validate planet in helpers file --- app/models/helpers.py | 15 +++++++++++++++ app/models/planet.py | 2 ++ app/routes.py | 19 ++++++++++--------- 3 files changed, 27 insertions(+), 9 deletions(-) create mode 100644 app/models/helpers.py diff --git a/app/models/helpers.py b/app/models/helpers.py new file mode 100644 index 000000000..81ca10479 --- /dev/null +++ b/app/models/helpers.py @@ -0,0 +1,15 @@ +from flask import abort, make_response +from .planet import Planet + +def validate_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"planet {id} is invalid"}, 400)) + + planet = Planet.query.get(id) + + if not planet: + abort(make_response({"message": f"planet {id} not found"}, 404)) + + return planet diff --git a/app/models/planet.py b/app/models/planet.py index fd6d09a7d..ec0eedc53 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,4 +1,5 @@ from app import db +from flask import abort, make_response class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True) @@ -15,3 +16,4 @@ def to_json(self): "circumference" : self.circumference, "length_of_year" : self.length_of_year } + diff --git a/app/routes.py b/app/routes.py index b1ee618e0..2df66660f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, jsonify, abort, make_response, request from app import db from app.models.planet import Planet +from app.models.helpers import validate_planet planets_bp = Blueprint("planets", __name__, url_prefix = "/planets") @@ -50,18 +51,18 @@ def get_all_planets(): # VALIDATE ID -def validate_planet(id): - try: - id = int(id) - except: - return abort(make_response({"message": f"planet {id} is invalid"}, 400)) +# def validate_planet(id): +# try: +# id = int(id) +# except: +# return abort(make_response({"message": f"planet {id} is invalid"}, 400)) - planet = Planet.query.get(id) +# planet = Planet.query.get(id) - if not planet: - abort(make_response({"message":f"planet {id} not found"}, 404)) +# if not planet: +# abort(make_response({"message":f"planet {id} not found"}, 404)) - return planet +# return planet # GET ONE PLANET @planets_bp.route("/", methods = ["GET"]) From 92d9344505e22d033411579301cb7b83aa5e5dce Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Thu, 5 May 2022 04:12:06 +0900 Subject: [PATCH 11/18] refactored to included update method in planet class --- app/models/planet.py | 7 +++++++ app/routes.py | 10 ++++++---- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index ec0eedc53..962999fee 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -17,3 +17,10 @@ def to_json(self): "length_of_year" : self.length_of_year } + #update + def update(self, request_body): + self.name = request_body["name"] + self.description = request_body["description"] + self.circumference = request_body["circumference"] + self.length_of_year = request_body["length_of_year"] + diff --git a/app/routes.py b/app/routes.py index 2df66660f..7f4de7c98 100644 --- a/app/routes.py +++ b/app/routes.py @@ -86,15 +86,17 @@ def update_planet(id): request_body = request.get_json() - planet.name = request_body["name"] - planet.description = request_body["description"] - planet.circumference = request_body["circumference"] - planet.length_of_year = request_body["length_of_year"] + planet.update(request_body) + # planet.name = request_body["name"] + # planet.description = request_body["description"] + # planet.circumference = request_body["circumference"] + # planet.length_of_year = request_body["length_of_year"] db.session.commit() return make_response(f"Planet #{id} succesffully updated"), 200 +#MAKE PATCH REQUEST @planets_bp.route("/", methods=["DELETE"]) def delete_one_planet(id): From 645b5e6b16c94e86401143f69344fc74b0b71af9 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Thu, 5 May 2022 05:06:08 +0900 Subject: [PATCH 12/18] refactored create factory method --- app/models/planet.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/models/planet.py b/app/models/planet.py index 962999fee..4a972df80 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -24,3 +24,7 @@ def update(self, request_body): self.circumference = request_body["circumference"] self.length_of_year = request_body["length_of_year"] + def create(cls, request_body): + new_planet = cls(name = request_body["name"], description = request_body["description"], circumference = request_body["circumference"], length_of_year = request_body["length_of_year"]) + + return new_planet From 048f1fc4b6d67977b03e989d8dc8399f374eb556 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Fri, 6 May 2022 03:06:20 +0900 Subject: [PATCH 13/18] refactored/created class ethod to clean up POST route --- app/models/planet.py | 1 + app/routes.py | 8 ++------ 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 4a972df80..66c790987 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -24,6 +24,7 @@ def update(self, request_body): self.circumference = request_body["circumference"] self.length_of_year = request_body["length_of_year"] + @classmethod def create(cls, request_body): new_planet = cls(name = request_body["name"], description = request_body["description"], circumference = request_body["circumference"], length_of_year = request_body["length_of_year"]) diff --git a/app/routes.py b/app/routes.py index 7f4de7c98..7277ea1a5 100644 --- a/app/routes.py +++ b/app/routes.py @@ -10,12 +10,8 @@ @planets_bp.route("", methods = ["POST"]) def create_planet(): request_body = request.get_json() - new_planet = Planet( - name = request_body["name"], - description = request_body["description"], - circumference = request_body["circumference"], - length_of_year = request_body["length_of_year"] - ) + + new_planet = Planet.create(request_body) db.session.add(new_planet) db.session.commit() From d0d1fd7e16617a55e784c4590352fbd5b940e1ea Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Fri, 6 May 2022 03:25:11 +0900 Subject: [PATCH 14/18] modify create_app to handle test mode --- app/__init__.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 4d7eb5006..bb760aca5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,8 @@ 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() @@ -9,7 +11,14 @@ def create_app(test_config=None): app = Flask(__name__) app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_api_development' + + 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 88f507384e279a94df4b14c210e477f8ded856c4 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Fri, 6 May 2022 04:17:34 +0900 Subject: [PATCH 15/18] created test folders and made two tests --- app/__init__.py | 1 + app/routes.py | 4 +++- app/tests/__init__.py | 0 app/tests/conftest.py | 26 ++++++++++++++++++++++++++ app/tests/test_routes.py | 26 ++++++++++++++++++++++++++ 5 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 app/tests/__init__.py create mode 100644 app/tests/conftest.py create mode 100644 app/tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index bb760aca5..f26e71da7 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -6,6 +6,7 @@ db = SQLAlchemy() migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) diff --git a/app/routes.py b/app/routes.py index 7277ea1a5..bfa8492b8 100644 --- a/app/routes.py +++ b/app/routes.py @@ -16,7 +16,7 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} has been successfully created", 201) #use make response when you want to return something that is not json + return jsonify(f"Planet {new_planet.name} has been successfully created"), 201 #use make response when you want to return something that is not json # GET ALL @planets_bp.route("", methods = ["GET"]) @@ -76,6 +76,7 @@ def get_one_planet(id): # length_of_year: # } +#PUT or update ONE PLANET @planets_bp.route("/", methods=["PUT"]) def update_planet(id): planet = validate_planet(id) @@ -94,6 +95,7 @@ def update_planet(id): #MAKE PATCH REQUEST +#DELETE ONE PLANET @planets_bp.route("/", methods=["DELETE"]) def delete_one_planet(id): planet = validate_planet(id) diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..e1189b10b --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,26 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + # everytime you finish a request this removes any saved data (like cleaning our a cache) + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + return app.test_client() diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..09bafc1fc --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,26 @@ + +def test_get_all_planets_successfully(client): + # Act + response = client.get("/planets") + # response has more than just json in it so we just want the json + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] # comparing to empty list bc we are in our test database + + + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Goofy", + "description": "goofy", + "circumference": 1, + "length_of_year": 1 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Goofy has been successfully created" From a5f903fb3ee237a580b2f2f233456b7dae7bdbb7 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Fri, 6 May 2022 04:47:13 +0900 Subject: [PATCH 16/18] wrote test_get_one_planet_from_fixture --- app/tests/conftest.py | 13 +++++++++++++ app/tests/test_routes.py | 14 ++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/app/tests/conftest.py b/app/tests/conftest.py index e1189b10b..5e3bae2d4 100644 --- a/app/tests/conftest.py +++ b/app/tests/conftest.py @@ -1,4 +1,5 @@ import pytest +from app.models.planet import Planet from app import create_app from app import db from flask.signals import request_finished @@ -24,3 +25,15 @@ def expire_session(sender, response, **extra): @pytest.fixture def client(app): return app.test_client() + +@pytest.fixture +def two_saved_planets(app): +# Arrange + mercury = Planet(name="Mercury", + description="made mostly of rocks", circumference=9522, length_of_year = 88) + venus = Planet(name="Venus", + description="most like Earth", circumference=23617, length_of_year=225) + + db.session.add_all([mercury, venus]) + # Alternatively, we could do# db.session.add(mercury)# db.session.add(venus) + db.session.commit() diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py index 09bafc1fc..12ba2be92 100644 --- a/app/tests/test_routes.py +++ b/app/tests/test_routes.py @@ -24,3 +24,17 @@ def test_create_one_planet(client): # Assert assert response.status_code == 201 assert response_body == "Planet Goofy has been successfully created" + +def test_get_one_planet_from_fixture_successfully(client, two_saved_planets): + #act + response = client.get("/planets/1") + + response_body = response.get_json() + #assert + assert response.status_code == 200 + assert response_body == {"name": "Mercury", + "description": "made mostly of rocks", + "circumference": 9522, + "length_of_year": 88, + "id": 1 + } From 8fd9181de4dbe05ae2d436ab7305e858d7b3eec8 Mon Sep 17 00:00:00 2001 From: Jande Royalty Date: Thu, 5 May 2022 17:47:50 -0500 Subject: [PATCH 17/18] Project Complete --- app/tests/test_routes.py | 30 ++++++++++++++++++++++++++++++ requirements.txt | 8 ++++++++ 2 files changed, 38 insertions(+) diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py index 12ba2be92..1722efcee 100644 --- a/app/tests/test_routes.py +++ b/app/tests/test_routes.py @@ -38,3 +38,33 @@ def test_get_one_planet_from_fixture_successfully(client, two_saved_planets): "length_of_year": 88, "id": 1 } + +def test_get_one_planet_with_no_data_returns_404(client): + #act + response = client.get("/planets/1") + + response_body = response.get_json() + #assert + assert response.status_code == 404 + assert response_body == {'message': 'planet 1 not found'} + +def test_get_planet_from_fixture_successfully(client, two_saved_planets): + #act + response = client.get("/planets") + + response_body = response.get_json() + #assert + assert response.status_code == 200 + assert response_body == [{"name": "Mercury", + "description": "made mostly of rocks", + "circumference": 9522, + "length_of_year": 88, + "id": 1 + }, + { + "name": "Venus", + "description": "most like Earth", + "circumference": 23617, + "length_of_year": 225, + 'id': 2, + }] \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index a506b4d12..9efd23f87 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==21.4.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 @@ -8,12 +9,18 @@ Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 idna==2.10 +importlib-metadata==4.11.3 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.3 +pluggy==0.13.1 psycopg2-binary==2.8.6 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.8 pytest==6.2.3 pytest-cov==2.12.1 python-dateutil==2.8.1 @@ -25,3 +32,4 @@ SQLAlchemy==1.3.23 toml==0.10.2 urllib3==1.26.4 Werkzeug==1.0.1 +zipp==3.8.0 From ba996be7208b1c3c51b3cc20e3ff99bbe9bf2959 Mon Sep 17 00:00:00 2001 From: Lindsey Still Date: Wed, 11 May 2022 02:59:08 +0900 Subject: [PATCH 18/18] removed comments --- app/routes.py | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/app/routes.py b/app/routes.py index bfa8492b8..4edc8a2af 100644 --- a/app/routes.py +++ b/app/routes.py @@ -44,21 +44,6 @@ def get_all_planets(): planets_response.append(planet.to_json()) return jsonify(planets_response) - - -# VALIDATE ID -# def validate_planet(id): -# try: -# id = int(id) -# except: -# return abort(make_response({"message": f"planet {id} is invalid"}, 400)) - -# planet = Planet.query.get(id) - -# if not planet: -# abort(make_response({"message":f"planet {id} not found"}, 404)) - -# return planet # GET ONE PLANET @planets_bp.route("/", methods = ["GET"])