Sarah and Brooke - Pine - Part 1

.gitignore

@@ -5,6 +5,7 @@
 __pycache__/
 *.py[cod]
 *$py.class
+.env
 
 # C extensions
 *.so

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
+
+# initialize sqlalchemy
+db = SQLAlchemy()
+migrate = Migrate()
+load_dotenv()
 
 
 def create_app(test_config=None):
     app = Flask(__name__)
 
-    return app
+    # configure sql alchemy
+    if not test_config:
+        app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+        app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('DATABASE_CONNECTION_STRING')
+    else:
+        app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+        app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('TEST_DATABASE_CONNECTION_STRING')
+        app.config['TESTING'] = True
+
+    # import models
+    from app.models.planet import Planet
+
+    # hook up flask and sql alchemy
+    db.init_app(app)
+    migrate.init_app(app, db)
+
+    from .routes import planets_bp
+    app.register_blueprint(planets_bp)
+
+    return app

app/list_of_planets.py

@@ -0,0 +1,13 @@
+from .planets import Planet
+
+planets = [
+    Planet("Mercury", "Closest to the sun, hot.", False),
+    Planet("Venus", "Spins the opposite direction of other planets.", False),
+    Planet("Earth", "You are here."),
+    Planet("Mars", "Red planet."),
+    Planet("Jupiter", "Gas Giant."),
+    Planet("Saturn", "Has rings."),
+    Planet("Uranus", "Controversy over pronunciation."),
+    Planet("Neptune", "Smallest gas giant, with faint rings."),
+    Planet("Pluto", "Brooke still believes!")
+]

app/models/planet.py

@@ -0,0 +1,17 @@
+from app import db
+
+class Planet(db.Model):
+
+    __tablename__ = "planets"
+    id = db.Column(db.Integer, primary_key = True, autoincrement = True)
+    name = db.Column(db.String(50))
+    description = db.Column(db.String(200))
+    has_moons = db.Column(db.Boolean)
+
+    def create_planet_dictionary(self):
+        return {
+            "id": self.id,
+            "name": self.name,
+            "description": self.description,
+            "has moons": self.has_moons
+        }

app/planets.py

@@ -0,0 +1,21 @@
+class Planet:
+    number_of_planets = 0
+    def __init__(self, name, description, has_moons=True):
+        self.name = name
+        self.description = description
+        self.has_moons = has_moons
+        self.id = Planet.number_of_planets 
+        Planet.increase_number_of_planets()
+
+    @classmethod
+    def increase_number_of_planets(Planet):
+        Planet.number_of_planets += 1
+
+    def create_planet_dictionary(self):
+        return {
+            "id": self.id,
+            "name": self.name,
+            "description": self.description,
+            "has moons": self.has_moons
+        }
+

app/routes.py

@@ -1,2 +1,62 @@
-from flask import Blueprint
+from flask import Blueprint, json, jsonify, request
+# from .list_of_planets import planets
+from app.models.planet import Planet
+from app import db 
 
+planets_bp = Blueprint("planets", __name__, url_prefix="/planets")
+
+@planets_bp.route("", methods=["GET", "POST"])
+def handle_planets():
+    if request.method == "POST":
+        request_body = request.get_json()
+
+        if type(request_body) == list:
+            for planet in request_body:
+                new_planet = Planet(name = planet["name"], description = planet["description"], has_moons = planet["has_moons"])
+
+                db.session.add(new_planet)
+                db.session.commit()
+        else:
+            new_planet = Planet(name = request_body["name"], description = request_body["description"], has_moons = request_body["has_moons"])
+            if "name" not in request_body or "description" not in request_body or "has_moons" not in request_body:
+                return jsonify({"message": "Missing information - you need name, description, and if the planet has moons."}), 400
+
+            db.session.add(new_planet)
+            db.session.commit()
+
+        return f"New Planets Added!", 201
+
+    elif request.method == "GET":
+        planets = Planet.query.all()
+        planet_list = []
+        for planet in planets:
+            planet_list.append(planet.create_planet_dictionary())
+
+        return jsonify(planet_list), 200
+
+@planets_bp.route("/<planet_id>", methods=["GET", "DELETE", "PUT"])
+def handle_planet(planet_id):
+
+    planet_id = int(planet_id)
+    planet = Planet.query.get(planet_id)
+
+    if not planet:
+        return { "Error" : f"Planet {planet_id} was not found."}, 404
+
+    if request.method == "GET":    
+        return jsonify(planet.create_planet_dictionary())
+
+    elif request.method == "DELETE":
+        db.session.delete(planet)
+        db.session.commit()
+        return jsonify({"Message": f"Success! Planet with id {planet_id} was destroyed!"})
+
+    elif request.method == "PUT":
+        input_data = request.get_json()
+        planet.name = input_data["name"]
+        planet.description = input_data["description"]
+        planet.has_moons = input_data["has_moons"]
+
+        db.session.commit()
+
+        return jsonify(planet.create_planet_dictionary()), 200

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/83d4f23ae332_added_a_planet_model.py

@@ -0,0 +1,34 @@
+"""Added a Planet Model
+
+Revision ID: 83d4f23ae332
+Revises: 
+Create Date: 2021-10-25 14:05:53.661140
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '83d4f23ae332'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('planets',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('name', sa.String(length=50), nullable=True),
+    sa.Column('description', sa.String(length=200), nullable=True),
+    sa.Column('has_moons', sa.Boolean(), nullable=True),
+    sa.PrimaryKeyConstraint('id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('planets')
+    # ### end Alembic commands ###

notes.md

@@ -0,0 +1,3 @@
+# Notes
+Follow the directions in Learn - Building an API part 1 activity
+This will be very similar to the 'books' API