diff --git a/app/__init__.py b/app/__init__.py index 70b4cabf..33b6e6bc 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,39 @@ -from flask import Flask +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 + # app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_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") + + # Import models here + db.init_app(app) + migrate.init_app(app, db) + + from app.models.planet import Planet + + # Register Blueprints here + from .routes import planets_bp + app.register_blueprint(planets_bp) + return app + + diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 00000000..923e9dc7 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,8 @@ +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) + moons = db.Column(db.Integer) + \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe68..5b3553ea 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,133 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify,abort, make_response, request + + + + +# class Planet: +# def __init__(self, id, name, description, moons): +# self.id = id +# self.name = name +# self.description = description +# self.moons = moons + +# planets = [ +# Planet(1, "Mercury", "Mercury is the first planet from the Sun. It is the smallest and the fastest of all planets in our Solar system",0), +# Planet(2, "Venus", "Venus is the second planet from the Sun. It spins clockwise on its axis and is the second brightest natural object in the night sky after the Moon", 0), +# Planet(3, "Earth", "Third planet from the Sun and our home planet is 4.5 billion years old. The only planet to sustain a liquid surface area", 1), +# Planet(4, "Mars", "This planet is named after Mars, the Roman god of war. It's landmass which is similar to Earth, has a reddish-brown color.", 2), +# Planet(5, "Jupiter", "Jupiter is the largest of all planets in our Solar system. This gaseous planet is more than twice as large as the other planets combined", 79), +# Planet(6, "Saturn", "Saturn is the second largest of the planets and is primarily composed of hydrogen gas. It is known for its over 30 stunning Rings of ice", 82), +# Planet(7, "Uranus", "This ice giant is massive with a size four times wider than of Earth. It has 13 known Rings", 27), +# Planet(8, "Neptune", "At a distance of 2.8 billion miles from the Sun, this massive planet is four times wider than Earth. It's mainly made up of icy materials- water, methane and ammonia with 7 Rings", 14), +# ] + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + + + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name = name_query) + + else: + planets = Planet.query.all() + + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "moons": planet.moons + }) + return jsonify(planets_response) + + + +@planets_bp.route("", methods=[ "POST"]) +def create_planet(): + + request_body = request.get_json() + new_planet = Planet( + name = request_body["name"], + description = request_body["description"], + moons = request_body["moons"], + ) + + db.session.add(new_planet) + # staging instance new-book + db.session.commit() + # commit instance + + return make_response(f"Planet {new_planet.name} created", 201) + + + +#Get Planet +@planets_bp.route("/", methods=["GET"]) +def get_planet_by_id(planet_id): + planet = validate_planet(planet_id) + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "moons":planet.moons + } +# Update +@planets_bp.route("/", methods=["PUT"]) +def update_planet_by_id(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + + db.session.commit() + return (f"Planet {planet.name} successfully updated.") +# Delete +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet_by_id(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet with id {planet.id} was successfully deleted!") + +# Helper Function +def validate_planet(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 + + abort(make_response(jsonify(dict(details=f"No planet with id {id} found")), 404)) +# @planets_bp.route("/", methods=["GET"]) +# def handle_planet(planet_id): +# planet = validate_planet(planet_id) +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "moons": planet.moons +# } +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) + +# for planet in planets: +# if planet.id == planet_id: +# return planet +# abort(make_response({"message": f"planet {planet_id} not found"}, 404)) diff --git a/app/solar-system-api.code-workspace b/app/solar-system-api.code-workspace new file mode 100644 index 00000000..bab1b7f6 --- /dev/null +++ b/app/solar-system-api.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": ".." + } + ], + "settings": {} +} \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 00000000..98e4f9c4 --- /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 00000000..f8ed4801 --- /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 00000000..8b3fb335 --- /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 00000000..2c015630 --- /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/e7ecb2883def_adds_planet_model.py b/migrations/versions/e7ecb2883def_adds_planet_model.py new file mode 100644 index 00000000..8afa64e2 --- /dev/null +++ b/migrations/versions/e7ecb2883def_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds planet model + +Revision ID: e7ecb2883def +Revises: +Create Date: 2022-04-30 18:48:25.187445 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e7ecb2883def' +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('moons', 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 ### diff --git a/test_fixtures.py b/test_fixtures.py new file mode 100644 index 00000000..d0441cbb --- /dev/null +++ b/test_fixtures.py @@ -0,0 +1,43 @@ +import pytest + +@pytest.fixture +def empty_list(): + return [] + +def test_len_of_empty_list(empty_list): + assert isinstance(empty_list, list) + assert len(empty_list) == 0 + +@pytest.fixture +def one_item(empty_list): + empty_list.append("item") + return empty_list + +def test_len_of_unary_list(one_item): + assert isinstance(one_item, list) + assert len(one_item) == 1 + assert one_item[0] =="item" + +class FancyObject: + def __init__(self): + self.fancy = True + print(f"\nFancyObject: {self.fancy}") + + def or_is_it(self): + self.fancy = not self.fancy + + def cleanup(self): + print(f"\ncleanup: {self.fancy}") + +@pytest.fixture +def so_fancy(): + fancy_object = FancyObject() + + yield fancy_object + + fancy_object.cleanup() + +def test_so_fancy(so_fancy): + assert so_fancy.fancy + so_fancy.or_is_it() + assert not so_fancy.fancy \ No newline at end of file diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 00000000..8a74ab94 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,42 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @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() + +@pytest.fixture +def two_saved_planets(app): + # Arrange + venus_planet = Planet(id = 1, + name="Venus", + description="test venus description", + moons = 2) + mars_planet = Planet(id = 2, + name="Mars", + description="test mars description", + moons = 3) + + db.session.add_all([venus_planet, mars_planet]) + + db.session.commit() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 00000000..6b43c29c --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,61 @@ +from app.models.planet import Planet + +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_planets(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id":1, + "name":"Venus", + "description":"test venus description", + "moons":2} + +def test_get_planet_with_valid_test_data(client,two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [{ + "id":1, + "name":"Venus", + "description":"test venus description", + "moons":2}, + {"id":2, + "name":"Mars", + "description":"test mars description", + "moons": 3}] + +def test_create_one_planet(client): + #Act + response = client.post("/planets",json={"name":"New Planet", + "description":"test new description", + "moons":3 + + }) + response_body = response.get_json() + + #Assert + assert response.status_code == 201 + +def test_get_one_planet_not_exists(client): + # Act + response = client.get("/planets/5") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + \ No newline at end of file