Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Procfile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
web: gunicorn 'app:create_app()'
44 changes: 44 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,51 @@
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

if test_config is None:
app.config['SQLALCHEMY_DATABASE_URI'] = \
os.environ.get("SQLALCHEMY_DATABASE_URI")
else:
app.config["TESTING"] = True
app.config['SQLALCHEMY_DATABASE_URI'] = \
os.environ.get("SQLALCHEMY_TEST_DATABASE_URI")



from app.models.planet import Planet

db.init_app(app)
migrate.init_app(app, db)


from .routes import planets_bp
app.register_blueprint(planets_bp)


return app


# from flask import Flask


# def create_app(test_config=None):
# app = Flask(__name__)

# from .routes import planets_bp
# app.register_blueprint(planets_bp)


# return app
Empty file added app/models/__init__.py
Empty file.
34 changes: 34 additions & 0 deletions app/models/planet.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from app import db
from flask import abort, make_response


class Planet(db.Model):
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String)
description = db.Column(db.String)
diameter = db.Column(db.Integer)


def to_dict(self):
return {
"name": self.name,
"description": self.description,
"diameter": self.diameter,
"id": self.id
}

@classmethod
def from_dict(cls,req_body):
return cls(
name=req_body['name'],
description=req_body['description'],
diameter=req_body['diameter']
)

def update(self,req_body):
# try:
self.name = req_body["name"]
self.description = req_body["description"]
self.diameter = req_body["diameter"]
# except KeyError as error:
# abort(make_response({'message': f"Missing attribute: {error}"}))
Comment on lines +12 to +34
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great helper method!

221 changes: 220 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,221 @@
from flask import Blueprint
from app import db
from app.models.planet import Planet
from flask import Blueprint, jsonify, make_response, request, abort

planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets")

@planets_bp.route("", methods=["POST"])
def create_planet():
request_body = request.get_json()
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some validation on the request_body would be nice to do.

new_planet = Planet.from_dict(request_body)
db.session.add(new_planet)
db.session.commit()

return make_response(f"Planet {new_planet.name} has been created", 201)


@planets_bp.route("", methods=["GET"])
def get_all_cats():
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cats?

name_param = request.args.get("name")
diameter_param = request.args.get("diameter")

if name_param:
planets = Planet.query.filter_by(name=name_param)
elif diameter_param:
planets = Planet.query.filter_by(diameter=diameter_param)
else:
planets = Planet.query.all()

result_list = [planet.to_dict() for planet in planets]

return jsonify(result_list), 200


@planets_bp.route("/<id>", methods=["GET"])
def get_one_cat(id):
planet = validate_id(Planet,id)

return jsonify(planet.to_dict()), 200


@planets_bp.route("/<id>", methods=["PUT"])
def update_planet(id):
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting this is untested

planet = validate_id(Planet,id)
request_body = request.get_json()

planet.update(request_body)
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some validation on the request_body would be nice to do.


db.session.commit()

return make_response(f"planet {id} successfully updated")

@planets_bp.route("/<id>", methods=["DELETE"])
def delete_planet(id):
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting this is untested

planet = validate_id(Planet,id)

db.session.delete(planet)

db.session.commit()

return make_response(f"planet {id} successfully deleted")


def validate_id(class_obj,id):
try:
id = int(id)
except:
abort(make_response({"message":f"{class_obj} {id} is an invalid id"}, 400))

query_result = class_obj.query.get(id)
if not query_result:
abort(make_response({"message":f"{class_obj} {id} not found"}, 404))

return query_result
Comment on lines +62 to +73
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice helper



######## before wave 5 ################

# def validate_planet(planet_id):
# try:
# planet_id = int(planet_id)
# except:
# abort(make_response({"message":f"planet {planet_id} invalid"}, 400))

# planet = Planet.query.get(planet_id)

# if not planet:
# abort(make_response({"message":f"planet {planet_id} not found"}, 404))

# return planet

# @planets_bp.route("", methods=["POST"])
# def create_planet():
# request_body = request.get_json()
# new_planet = Planet(id=request_body["id"],
# name=request_body["name"],
# description=request_body["description"],
# diameter=request_body["diameter"])

# db.session.add(new_planet)
# db.session.commit()

# return make_response(f"Planet {new_planet.id} successfully created", 201)

# @planets_bp.route("", methods=["GET"])
# def read_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,
# "diameter": planet.diameter
# }
# )
# return jsonify(planets_response)




# @planets_bp.route("/<planet_id>", methods=["GET"])
# def read_one_planet(planet_id):
# planet = validate_planet(planet_id)
# return {
# "id":planet.id,
# "name":planet.name,
# "description":planet.description,
# "diameter":planet.diameter
# }

# @planets_bp.route("/<planet_id>", methods=["PUT"])
# def update_planet(planet_id):
# planet = validate_planet(planet_id)

# request_body = request.get_json()

# planet.name = request_body["name"]
# planet.description = request_body["description"]
# planet.diameter = request_body["diameter"]

# db.session.commit()

# return make_response(f"Planet # {planet.id} successfully updated")


# @planets_bp.route("/<planet_id>", methods=["DELETE"])
# def delete_planet(planet_id):
# planet = validate_planet(planet_id)

# db.session.delete(planet)
# db.session.commit()

# return make_response(f"Planet # {planet.id} successfully deleted")



# solar_system_bp = Blueprint("solar_system", __name__)


# class Planet:
# def __init__(self, id, name, description, diameter):
# self.id = id
# self.name = name
# self.description = description
# self.diameter = diameter
# planets = [
# Planet(1, "Mercury", "The smallest planet in the solar system", 3031.9),
# Planet(2, "Venus", "The hottest planet in the solar system", 7520.8),
# Planet(3, "Earth", "Two-thirds of the planet is covered by water", 7917.5),
# Planet(4, "Mars", "A dusty, cold, desert world", 4212.3),
# Planet(5, "Jupiter", "The planet with swirling cloud stripes", 86881),
# Planet(6, "Saturn", "A massive ball made mostly of hydrogen and helium", 72367),
# Planet(7, "Uranus", "The first planet found, discovered in 1781", 31518),
# Planet(8, "Neptune", "The densest giant planet", 30599),

# # ]
# planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets")

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

# @planets_bp.route("",methods=["GET"])
# def handle_planets():
# planets_response = []
# for planet in planets:
# planets_response.append(
# {
# "id":planet.id,
# "name":planet.name,
# "description":planet.description,
# "diameter":planet.diameter
# }
# )
# return jsonify(planets_response)


# @planets_bp.route("/<planet_id>", methods=["GET"])
# def handle_planet(planet_id):
# planet = validate_planet(planet_id)

# return {
# "id": planet.id,
# "name": planet.name,
# "description": planet.description,
# "diameter": planet.diameter
# }
Comment on lines +76 to +221
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
######## before wave 5 ################
# def validate_planet(planet_id):
# try:
# planet_id = int(planet_id)
# except:
# abort(make_response({"message":f"planet {planet_id} invalid"}, 400))
# planet = Planet.query.get(planet_id)
# if not planet:
# abort(make_response({"message":f"planet {planet_id} not found"}, 404))
# return planet
# @planets_bp.route("", methods=["POST"])
# def create_planet():
# request_body = request.get_json()
# new_planet = Planet(id=request_body["id"],
# name=request_body["name"],
# description=request_body["description"],
# diameter=request_body["diameter"])
# db.session.add(new_planet)
# db.session.commit()
# return make_response(f"Planet {new_planet.id} successfully created", 201)
# @planets_bp.route("", methods=["GET"])
# def read_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,
# "diameter": planet.diameter
# }
# )
# return jsonify(planets_response)
# @planets_bp.route("/<planet_id>", methods=["GET"])
# def read_one_planet(planet_id):
# planet = validate_planet(planet_id)
# return {
# "id":planet.id,
# "name":planet.name,
# "description":planet.description,
# "diameter":planet.diameter
# }
# @planets_bp.route("/<planet_id>", methods=["PUT"])
# def update_planet(planet_id):
# planet = validate_planet(planet_id)
# request_body = request.get_json()
# planet.name = request_body["name"]
# planet.description = request_body["description"]
# planet.diameter = request_body["diameter"]
# db.session.commit()
# return make_response(f"Planet # {planet.id} successfully updated")
# @planets_bp.route("/<planet_id>", methods=["DELETE"])
# def delete_planet(planet_id):
# planet = validate_planet(planet_id)
# db.session.delete(planet)
# db.session.commit()
# return make_response(f"Planet # {planet.id} successfully deleted")
# solar_system_bp = Blueprint("solar_system", __name__)
# class Planet:
# def __init__(self, id, name, description, diameter):
# self.id = id
# self.name = name
# self.description = description
# self.diameter = diameter
# planets = [
# Planet(1, "Mercury", "The smallest planet in the solar system", 3031.9),
# Planet(2, "Venus", "The hottest planet in the solar system", 7520.8),
# Planet(3, "Earth", "Two-thirds of the planet is covered by water", 7917.5),
# Planet(4, "Mars", "A dusty, cold, desert world", 4212.3),
# Planet(5, "Jupiter", "The planet with swirling cloud stripes", 86881),
# Planet(6, "Saturn", "A massive ball made mostly of hydrogen and helium", 72367),
# Planet(7, "Uranus", "The first planet found, discovered in 1781", 31518),
# Planet(8, "Neptune", "The densest giant planet", 30599),
# # ]
# planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets")
# 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))
# @planets_bp.route("",methods=["GET"])
# def handle_planets():
# planets_response = []
# for planet in planets:
# planets_response.append(
# {
# "id":planet.id,
# "name":planet.name,
# "description":planet.description,
# "diameter":planet.diameter
# }
# )
# return jsonify(planets_response)
# @planets_bp.route("/<planet_id>", methods=["GET"])
# def handle_planet(planet_id):
# planet = validate_planet(planet_id)
# return {
# "id": planet.id,
# "name": planet.name,
# "description": planet.description,
# "diameter": planet.diameter
# }

Empty file added app/tests/__init__.py
Empty file.
39 changes: 39 additions & 0 deletions app/tests/conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
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(send, 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 one_planet(app):
# Arrange
ocean_planet = Planet(name="Mercury", description="watr 4evr",
diameter="39999")


db.session.add(ocean_planet)
# Alternatively, we could do
# db.session.add(ocean_planet)
# db.session.add(mountain_book)
db.session.commit()
return ocean_planet
Loading