Ocelots --- Monica Bao & Jennifer Dai

Procfile

@@ -0,0 +1 @@
+web: gunicorn 'app:create_app()'

app/__init__.py

@@ -1,7 +1,35 @@
 from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
+from dotenv import load_dotenv 
+import os 
 
+#postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development
+db = SQLAlchemy()
+migrate = Migrate(compare_type=True)
+load_dotenv() 
 
 def create_app(test_config=None):
     app = Flask(__name__)
 
+    app.config['JSON_SORT_KEYS'] = False # Don't sort keys alphabetically
+    app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+
+    if test_config: 
+        app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI")
+        app.config["Testing"] = True 
+    else:
+        app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI")
+
+    db.init_app(app)
+    migrate.init_app(app, db)
+
+    from app.models.planet import Planet
+    from app.models.moon import Moon
+    from .routes.planet_routes import planets_bp 
+    from .routes.moon_routes import moon_bp
+
+    app.register_blueprint(planets_bp)  
+    app.register_blueprint(moon_bp)
+
     return app

app/models/moon.py

@@ -0,0 +1,16 @@
+from app import db
+
+class Moon(db.Model): 
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    name = db.Column(db.String)
+    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,
+            "planet_id" : self.planet.id, 
+            "planet" : self.planet.name
+        }
+

app/models/planet.py

@@ -0,0 +1,37 @@
+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)
+    gravity = db.Column(db.Float)
+    distance_from_earth = db.Column(db.Float)
+    moons = db.relationship("Moon", back_populates = "planet")
+
+    def to_dict(self):
+        planet_as_dict = {}
+        planet_as_dict["id"] = self.id
+        planet_as_dict["name"] = self.name
+        planet_as_dict["description"] = self.description
+        planet_as_dict["gravity"] = self.gravity
+        planet_as_dict["distance_from_earth"] = self.distance_from_earth  
+
+        moon_names = []
+        for moon in self.moons:
+            moon_names.append(moon.name)
+        planet_as_dict["moons"] = [moon.name for moon in self.moons]
+
+        return planet_as_dict
+
+    @classmethod
+    def from_dict(cls, planet_data):
+        new_planet = Planet(
+            name=planet_data["name"],
+            description=planet_data["description"],
+            gravity = planet_data['gravity'],
+            distance_from_earth = planet_data['distance_from_earth']
+        )
+
+        return new_planet

app/routes/moon_routes.py

@@ -0,0 +1,64 @@
+from flask import Blueprint, jsonify, abort, make_response, request
+from app import db
+from app.models.moon import Moon
+from app.models.planet import Planet
+from app.routes.planet_routes import validate_model
+
+moon_bp = Blueprint("moons_bp", __name__, url_prefix="/moons")
+
+
+@moon_bp.route("", methods=["POST"])
+def create_new_moon():
+    request_body = request.get_json()
+    new_moon = Moon(name=request_body["name"], )
+
+    db.session.add(new_moon)
+    db.session.commit()
+
+    return make_response(jsonify(f"Moon {new_moon.name} successfully created."), 201)
+
+
+@moon_bp.route("/<moon_id>", methods=["GET"])
+def read_moon_by_id(moon_id):
+    moon_response = validate_model(Moon, moon_id)
+
+    return make_response(jsonify(moon_response.to_dict()), 200)
+
+
+@moon_bp.route("", methods=["GET"])
+def read_all_moons():
+    all_moon = Moon.query.all()
+
+    moons_response = []
+    for moon in all_moon:
+        moons_response.append({
+            "id": moon.id,
+            "name": moon.name,
+        }
+        )
+    return make_response(jsonify(moons_response), 200)
+
+
+@moon_bp.route("/<planet_id>/moon", methods=["POST"])
+def create_moon_to_planet_by_planet_id(planet_id):
+    new_planet = validate_model(Planet, planet_id)
+
+    request_body = request.get_json()
+    new_moon = Moon(
+        name=request_body["name"],
+        planet_id=new_planet.id,
+        planet=new_planet
+    )
+
+    db.session.add(new_moon)
+    db.session.commit()
+
+    return make_response(jsonify(new_moon.to_dict()), 201)
+
+
+@moon_bp.route("/<planet_id>/moons", methods=["GET"])
+def get_moons_by_planet_id(planet_id):
+    planet = validate_model(Planet, planet_id)
+
+    response = planet.to_dict()
+    return make_response(jsonify(response), 200)

app/routes/planet_routes.py

@@ -0,0 +1,143 @@
+from flask import Blueprint, jsonify, abort, make_response, request 
+from app import db 
+from app.models.planet import Planet 
+from app.models.moon import Moon 
+
+planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets")
+
+# ---------------------------------------------- Route Functions ----------------------------------------------
+@planets_bp.route("", methods = ["POST"])
+def create_planet(): 
+    request_body =  request.get_json()
+    validate_request_body(request_body)
+    #use from_dict function to simplfied code
+    new_planet = Planet.from_dict(request_body)
+
+    db.session.add(new_planet)
+    db.session.commit() 
+
+    return make_response(jsonify(f"Planet: {new_planet.name} created successfully."), 201)
+
+@planets_bp.route("", methods = ["GET"])
+def read_planets(): 
+
+    planet_query = Planet.query # Get a query object for later use 
+
+    # Query planets use name argument 
+    name_query = request.args.get("name")
+    distance_query = request.args.get("distance_from_earth")
+    gravity_query = request.args.get("gravity")
+    # Sort argument passed by client 
+    is_sort = request.args.get("sort")
+
+    if name_query:
+        planet_query = planet_query.filter_by(name = name_query) 
+
+    if distance_query:
+        planet_query = planet_query.filter_by(distance_from_earth = distance_query)
+
+    if gravity_query:
+        planet_query = planet_query.filter_by(gravity = gravity_query)
+
+    if is_sort:
+        attribute = None 
+        sort_method = is_sort
+
+        split_sort = is_sort.split(":") 
+
+        if len(split_sort) == 2: # Case: ?sort=attribute:asc 
+            attribute = split_sort[0] 
+            sort_method = split_sort[1] 
+        if len(split_sort) > 2: 
+            abort(make_response("Too many parameters", 400))
+
+        # Sort records by client's request 
+        if attribute == "distance_from_earth":
+            planet_query = sort_helper(planet_query, Planet.distance_from_earth, sort_method)
+        elif attribute == "gravity":
+            planet_query = sort_helper(planet_query, Planet.gravity, sort_method)
+        else: # If user don't specify any attribute, we would sort by name 
+            planet_query = sort_helper(planet_query, Planet.name, sort_method)
+    else:
+        # Sort by id asc if no sort param porvided 
+        planet_query = sort_helper(planet_query, Planet.id, "asc")
+
+    planets = planet_query.all()
+
+    planet_response = [] 
+    for planet in planets: 
+        planet_response.append(planet.to_dict())   #use to_dict function to make code more readable
+
+    return make_response(jsonify(planet_response), 200)
+
+@planets_bp.route("/<planet_id>", methods = ["GET"])
+def read_one_planet_by_id(planet_id): 
+    planet = validate_model(Planet, planet_id) 
+    #use to_dict function to make code more readable
+    return (planet.to_dict(), 200)  
+
+@planets_bp.route("/<planet_id>", methods = ["PUT"])
+def update_planet_by_id(planet_id):
+    planet = validate_model(Planet, planet_id) 
+
+    request_body = request.get_json() 
+    validate_request_body(request_body)
+
+    planet.name = request_body["name"]
+    planet.description = request_body["description"]
+    planet.gravity = request_body["gravity"]
+    planet.distance_from_earth = request_body["distance_from_earth"]
+
+    db.session.commit() 
+
+    return make_response(jsonify(f"Planet: {planet_id} has been updated successfully."), 200) 
+
+@planets_bp.route("/<planet_id>", methods = ["DELETE"])
+def delete_planet_by_id(planet_id): 
+    planet = validate_model(Planet, planet_id)  
+
+    # Delete moon when we delete the planet they associate to to avoid having dangling nodes 
+    moons_query = Moon.query.all()
+    if moons_query:
+        for moon in moons_query:
+            if moon.planet_id == planet.id:
+                db.session.delete(moon)
+                db.session.commit()
+
+    db.session.delete(planet)
+    db.session.commit()
+
+    return make_response(jsonify(f"Planet: {planet_id} has been deleted successfully."), 200) 
+
+
+#---------------------------------------------- Helper Functions----------------------------------------------
+def validate_model(cls, model_id):
+    try:
+        model_id = int(model_id)
+    except: 
+        abort(make_response({"message":f"{cls.__name__} {model_id} is invalid"}, 400)) 
+
+    model = cls.query.get(model_id)
+
+    if not model:
+        abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404))    
+    return model 
+
+def validate_request_body(request_body): 
+
+    if "name" not in request_body or "description" not in request_body or "gravity" \
+        not in request_body or "distance_from_earth" not in request_body:
+        abort(make_response("Invalid Request", 400))
+
+def sort_helper(planet_query, atr = None, sort_method = "asc"): 
+    if sort_method == "asc" and atr: 
+        planet_query = planet_query.order_by(atr.asc())
+    elif sort_method == "desc" and atr: 
+        planet_query = planet_query.order_by(atr.desc())
+    elif sort_method == "desc": 
+        planet_query = planet_query.order_by(Planet.name.desc())
+    else:
+        #Sort by name in ascending order by default 
+        planet_query = planet_query.order_by(Planet.name.asc())
+
+    return planet_query

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

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