Solar System API #30

thao325 · 2022-10-25T21:51:56Z

No description provided.

CheezItMan

Nice work, y'all hit the main learning goals here. I left some suggestions, just ping me on Slack if you have comments/questions.

CheezItMan · 2022-11-20T21:36:41Z

app/models/planet.py

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


Great helper method!

CheezItMan · 2022-11-20T21:37:52Z

app/routes.py

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


CheezItMan · 2022-11-20T21:38:14Z

app/routes.py

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


Some validation on the request_body would be nice to do.

CheezItMan · 2022-11-20T21:38:30Z

app/routes.py

+
+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


Nice helper

CheezItMan · 2022-11-20T21:38:56Z

app/routes.py

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


Some validation on the request_body would be nice to do.

CheezItMan · 2022-11-20T21:39:21Z

app/routes.py

+#     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
+#     }


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

# }

CheezItMan · 2022-11-20T21:40:10Z

app/tests/test_routes.py

+    actual_planet = Planet.query.get(EXPECTED_ID)
+
+    # assert
+    assert response.status_code == 201


You can also test that the Database now has 1 more Planet and the details of that planet in the DB.

CheezItMan · 2022-11-20T21:40:31Z

app/tests/test_routes.py

+    assert response_body["description"] ==one_planet.description
+    assert response_body["diameter"]==one_planet.diameter
+
+def test_create_planet_can_create_planet_in_empty_db(client):   


I would also include a test for the create action with an invalid request body.

CheezItMan · 2022-11-20T21:40:48Z

app/routes.py

+    return make_response(f"planet {id} successfully updated")
+
+@planets_bp.route("/<id>", methods=["DELETE"])
+def delete_planet(id):


Just noting this is untested

CheezItMan · 2022-11-20T21:40:53Z

app/routes.py

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


Just noting this is untested

niloofar62 and others added 15 commits October 21, 2022 18:07

wave_1 in progress

ad91652

wave 01 complete

dd6dd42

handle error

eef6af6

wave 02 complete

b97be08

models

7ab3baa

delete files

51d8c88

wave 03 complete

f36f377

Merge branch 'main' of https://github.com/thao325/solar-system-api

72b8a84

wave 3, 4 completed

15c98f3

wave 5 complete

9327f09

3 test passed

ac456c3

add new test in wave_6

1a7e6d9

thao's changes, undo

92612f0

Merge branch 'main' of https://github.com/thao325/solar-system-api

8fe6631

add requirements

1ca82fa

CheezItMan reviewed Nov 20, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Solar System API #30

Solar System API #30

thao325 commented Oct 25, 2022

CheezItMan left a comment

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022

CheezItMan Nov 20, 2022



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

Solar System API #30

Are you sure you want to change the base?

Solar System API #30

Conversation

thao325 commented Oct 25, 2022

CheezItMan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment