Aisha Arigbabu

Procfile

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

README.md

@@ -1,6 +1,20 @@
 # Solar System API
 
-Here is a minimal setup for a Flask API.
+# Build
+Clone the forked repo and cd into it
+
+Recreate the following setup steps of the Solar System API repo:
+
+    Create a virtual environment and activate it
+    Install the dependencies
+    Define a Planet class with the attributes id, name, and description, and one additional attribute
+    Create a list of Planet instances
+
+Create the following endpoints, with similar functionality presented in the Hello Books API:
+
+    As a client, I want to send a request to get all existing planets, so that I can see a list of planets, with their id, name, description, and other data of the planet.
+    As a client, I want to send a request to get one existing planet, so that I can see the id, name, description, and other data of the planet.
+    Here is a minimal setup for a Flask API.
 
 ## Github Setup
 

app/__init__.py

@@ -1,7 +1,32 @@
-from flask import Flask
+from flask import Flask, config
+from flask_sqlalchemy import SQLAlchemy
+from flask_migrate import Migrate
+from dotenv import load_dotenv
+import os
+load_dotenv()
 
+db = SQLAlchemy() # why is this outside the create app funtion
+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'] = os.environ.get('SQLALCHEMY_DATABASE_URI')
+        app.config['SQLALCHEMY_ECHO'] = True
+    else:
+        app.config['TESTING'] = True
+        app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI')
+        app.config['SQLALCHEMY_ECHO'] = True
+    db.init_app(app)
+    migrate.init_app(app, db)
+
+    # import model
+    from app.models.planets import Planet
+
+    from .routes import planets_bp
+    app.register_blueprint(planets_bp)
+
     return app

app/models/planets.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)
+    oxygen_level = db.Column(db.String)
+    #__tablename__ = "planets" we can reset the default table name SQLA sets using this line

app/routes.py

@@ -1,2 +1,98 @@
-from flask import Blueprint
+from flask import Blueprint, jsonify, make_response, request
+from app import db
+from app.models.planets import Planet
+
+
+planets_bp = Blueprint("planets", __name__, url_prefix="/planets")
+
+@planets_bp.route("", methods = ["GET", "POST"])
+def handle_planets():
+    request_body = request.get_json()
+
+    if request.method == "GET":
+        planet_response = []
+
+        #name_query_param = request.args.get("name")
+        name_query_param = request.args.get("name")
+
+        if name_query_param is not None:
+            list_of_planets = Planet.query.filter_by(name = name_query_param)
+
+        else:
+            list_of_planets = Planet.query.all()
+        for planet in list_of_planets:
+            planet_response.append(
+                {
+                    "id" : planet.id,
+                    "name": planet.name,
+                    "description": planet.description,
+                    "oxygen_level": planet.oxygen_level
+                }
+            )
+
+        return jsonify(planet_response)
+    elif request.method == "POST":
+        if "name" not in request_body or "description" not in request_body or "oxygen_level" not in request_body:
+            return make_response("Invalid request", 400)
+
+        new_planet = Planet(
+            name = request_body["name"],
+            description = request_body["description"],
+            oxygen_level = request_body["oxygen_level"]
+        )
+
+        db.session.add(new_planet)
+        db.session.commit()
+
+        return make_response(
+            f"Planet {new_planet.name} created", 200
+        )
+        # planet.query.filter_by(param) # use to filter query results
+        # planet.query.limit(100).all() limit number of results
+#@planets_bp.route("/<planet_name>", methods = ["GET"])
+@planets_bp.route("/<planet_id>", methods = ["GET", "PUT", "DELETE"])
+def get_planet_by_id(planet_id):
+    planet = Planet.query.get(planet_id)
+    #for planet in list_of_planets:
+    #if planet.title == planet_name:
+    if request.method == "GET":
+        try:
+            return {
+                "id" : planet.id,
+                "name": planet.name,
+                "description" : planet.description,
+                "oxygen_level" : planet.oxygen_level
+            }
+        except:
+            planet is None
+            return make_response(f"planet {planet_id} is not found", 404)
+
+    elif request.method == "PUT":
+        form_data = request.get_json()
+
+        if "name" not in form_data or "description" not in form_data or "oxygen_level" not in form_data:
+            return make_response(f"you must include a name, description and oxygen_level for your planet", 400)
+
+        try:
+            planet.name = form_data["name"]
+            planet.description = form_data["description"]
+            planet.oxygen_level = form_data["oxygen_level"]
+
+            return make_response(f"{planet.name} successfully updated", 200)
+        except:
+            planet is None
+            return make_response(f"planet {planet.id} does not exist")
+
+    elif request.method == "DELETE":
+        planet_to_delete = planet
+        try:
+            db.session.delete(planet_to_delete)
+            db.session.commit()
+
+            return make_response(f"planet {planet.name} successfully deleted", 200)
+        except:
+            planet_to_delete is None
+            return make_response(f"planet {planet_id} does not exsist", 404)
+
+
 

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

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()

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

migrations/versions/66bb5f0b92c3_adds_planets_model.py

@@ -0,0 +1,34 @@
+"""adds planets model
+
+Revision ID: 66bb5f0b92c3
+Revises: 
+Create Date: 2021-11-19 11:38:37.835475
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '66bb5f0b92c3'
+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('title', sa.String(), nullable=True),
+    sa.Column('description', sa.String(), nullable=True),
+    sa.Column('oxygen_level', sa.String(), nullable=True),
+    sa.PrimaryKeyConstraint('id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('planet')
+    # ### end Alembic commands ###

requirements.txt

@@ -1,18 +1,26 @@
 alembic==1.5.4
+attrs==21.2.0
 autopep8==1.5.5
 certifi==2020.12.5
 chardet==4.0.0
 click==7.1.2
 Flask==1.1.2
 Flask-Migrate==2.6.0
 Flask-SQLAlchemy==2.4.4
+gunicorn==20.1.0
 idna==2.10
+iniconfig==1.1.1
 itsdangerous==1.1.0
 Jinja2==2.11.3
 Mako==1.1.4
 MarkupSafe==1.1.1
+packaging==21.3
+pluggy==1.0.0
 psycopg2-binary==2.8.6
+py==1.11.0
 pycodestyle==2.6.0
+pyparsing==3.0.6
+pytest==6.2.5
 python-dateutil==2.8.1
 python-dotenv==0.15.0
 python-editor==1.0.4