Moon

app/__init__.py

@@ -1,7 +1,38 @@
-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__)
 
+    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")
+
+
+    # app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+    # app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development'
+
+    db.init_app(app)
+    migrate.init_app(app, db)
+
+    from app.models.planet import Planet
+
+    from .routes import planets_bp
+    # app.register_blueprint(planet_bp)
+    app.register_blueprint(planets_bp)
+
     return app

app/models/moon.py

@@ -0,0 +1,24 @@
+from app import db
+
+class Moon(db.Model):
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    name = db.Column(db.String(255), nullable=False)
+    description = db.Column(db.Text, nullable=False)
+    size = db.Column(db.String(255), nullable=False)
+    planet_id = db.Column(db.Integer, db.ForeignKey("planet.id"))
+    planet = db.relationship("Planet", back_populates="moons")
+
+
+    def to_dict(self):
+        return ({"id": self.id,
+                "name": self.name,
+                "description": self.description,
+                "size": self.size})
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        return cls(
+            name = data_dict["name"],
+            description = data_dict["description"],
+            size = data_dict["size"]
+        )

app/models/planet.py

@@ -0,0 +1,30 @@
+from app import db
+
+class Planet(db.Model):
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    name = db.Column(db.String(255), nullable=False)
+    description = db.Column(db.Text, nullable=False)
+    distance = db.Column(db.String(255), nullable=False)
+    moons = db.relationship("Moon", back_populates="planet")
+
+    def to_dict(self):
+        moon_data = []
+        if self.moons:
+            for moon in self.moons:
+                moon_data.append(moon.to_dict())
+
+
+
+        return ({"id": self.id,
+                "name": self.name,
+                "description": self.description,
+                "distance": self.distance,
+                "moons" : moon_data})
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        return cls(
+            name = data_dict["name"],
+            description = data_dict["description"],
+            distance = data_dict["distance"]
+        )

app/routes.py

@@ -1,2 +1,111 @@
-from flask import Blueprint
+from app import db 
+from app.models.planet import Planet
+from app.models.moon import Moon
+from flask import Blueprint, jsonify, abort, make_response, request
 
+planets_bp = Blueprint("planets", __name__, url_prefix="/planets")
+
+
+def validate_model(cls, model_id):
+    try:
+        model_id = int(model_id)
+    except:
+        message = f"{cls.__name__} {model_id} is invalid"
+        abort(make_response({"message" : message}, 400))
+
+    model = cls.query.get(model_id)
+
+    if not model:
+        message = f"{cls.__name__} {model_id} not found"
+        abort(make_response({"message": message}, 404))
+
+    return model
+
+#route functions
+@planets_bp.route("", methods=["POST"])
+def create_planet():
+    request_body = request.get_json()
+    try:
+        new_planet = Planet.from_dict(request_body)
+        db.session.add(new_planet)
+        db.session.commit()
+
+        message = f"Planet {new_planet.name} successfully created"
+        return make_response(message, 201)
+
+    except KeyError as e:
+        abort(make_response({"message": f"missing required value: {e}"}, 400))
+
+    db.session.add(new_planet)
+    db.session.commit()
+
+    return make_response(f"Planet {new_planet.name} successfully created", 201)
+
+@planets_bp.route("", methods=["GET"])
+def get_all_planets():
+    name_query = request.args.get("name")
+    description_query = request.args.get("description")
+    if name_query:
+        planets = Planet.query.filter_by(name = name_query)
+    elif description_query:
+        planets = Planet.query.filter_by(description = description_query)
+    else:
+        planets = Planet.query.all()
+
+    results = [planet.to_dict() for planet in planets]
+    return jsonify(results)
+
+@planets_bp.route("<planet_id>/moons", methods=["GET"])
+def read_moons(planet_id):
+    planet = validate_model(Planet, planet_id)
+
+    planet_response = []
+    for moon in planet.moons:
+        planet_response.append(moon.to_dict())
+
+    return(jsonify(planet_response))
+
+
+
+@planets_bp.route("/<planet_id>", methods=["GET"])
+def get_one_planet(planet_id):
+    planet = validate_model(Planet, planet_id)
+    return planet.to_dict()
+
+@planets_bp.route("/<planet_id>", methods=["PUT"])
+def update_planet(planet_id):
+    planet_data = request.get_json()
+    planet_to_update = validate_model(Planet, planet_id)
+
+    planet_to_update.name = planet_data["name"]
+    planet_to_update.description = planet_data["description"]
+    planet_to_update.distance = planet_data["distance"]
+
+    db.session.commit()
+
+    return make_response(f"Planet {planet_to_update.name} succesfully updated", 200)
+
+@planets_bp.route("/<planet_id>", methods=["DELETE"])
+def delete_planet(planet_id):
+    planet = validate_model(Planet, planet_id)
+
+    db.session.delete(planet)
+    db.session.commit()
+
+    return make_response(f"Planet #{planet_id} succesfully deleted")
+
+
+@planets_bp.route("<planet_id>/moons", methods=["POST"])
+def create_moon(planet_id):
+    planet = validate_model(Planet, planet_id)
+    request_body = request.get_json()
+    try:
+        new_moon = Moon.from_dict(request_body)
+        new_moon.planet = planet
+
+        db.session.add(new_moon)
+        db.session.commit()
+
+        return make_response(jsonify(f"Moon {new_moon.name} cared by {planet.name} successfully created"), 201)
+    except KeyError as e:
+        abort(make_response({"message": f"missing required value: {e}"}, 400))

migrations/README

@@ -0,0 +1 @@
+Single-database configuration for Flask.

migrations/alembic.ini

@@ -0,0 +1,50 @@
+# 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
+
+[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
+
+[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

migrations/env.py

@@ -0,0 +1,110 @@
+import logging
+from logging.config import fileConfig
+
+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')
+
+
+def get_engine():
+    try:
+        # this works with Flask-SQLAlchemy<3 and Alchemical
+        return current_app.extensions['migrate'].db.get_engine()
+    except TypeError:
+        # this works with Flask-SQLAlchemy>=3
+        return current_app.extensions['migrate'].db.engine
+
+
+def get_engine_url():
+    try:
+        return get_engine().url.render_as_string(hide_password=False).replace(
+            '%', '%%')
+    except AttributeError:
+        return str(get_engine().url).replace('%', '%%')
+
+
+# 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', get_engine_url())
+target_db = current_app.extensions['migrate'].db
+
+# 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 get_metadata():
+    if hasattr(target_db, 'metadatas'):
+        return target_db.metadatas[None]
+    return target_db.metadata
+
+
+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=get_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 = get_engine()
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=get_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()