Add boilerplate functions and tests

Author: wrussell1999

README.md

@@ -1 +1,2 @@
 # Orientation Project - Python
+

app.py

@@ -1,22 +1,80 @@
 '''
 Flask Application
 '''
-from flask import Flask, jsonify
+from flask import Flask, jsonify, request
+from models import Experience, Education, Skill
 
 app = Flask(__name__)
 
-data = [
+data = {
+    "experience": [
+        Experience("Software Developer",
+                   "A Cool Company",
+                   "October 2022",
+                   "Present",
+                   "Writing Python Code",
+                   "example-logo.png")
+    ],
+    "education": [
+        Education("Computer Science",
+                  "University of Tech",
+                  "September 2019",
+                  "July 2022",
+                  "80%",
+                  "example-logo.png")
+    ],
+    "skill": [
+        Skill("Python",
+              "1-2 Years",
+              "example-logo.png")
+    ]
+}
 
-]
 
-'''
-Test Function
-'''
-
-
-@app.route('/')
+@app.route('/test')
 def hello_world():
     '''
-    Returns a JSON message
+    Returns a JSON test message
     '''
     return jsonify({"message": "Hello, World!"})
+
+
+@app.route('/resume/experience', methods=['GET', 'POST'])
+def experience():
+    '''
+    Handle experience requests
+    '''
+    if request.method == 'GET':
+        return jsonify()
+
+    if request.method == 'POST':
+        return jsonify({})
+
+    return jsonify({})
+
+@app.route('/resume/education', methods=['GET', 'POST'])
+def education():
+    '''
+    Handles education requests
+    '''
+    if request.method == 'GET':
+        return jsonify({})
+
+    if request.method == 'POST':
+        return jsonify({})
+
+    return jsonify({})
+
+
+@app.route('/resume/skill', methods=['GET', 'POST'])
+def skill():
+    '''
+    Handles Skill requests
+    '''
+    if request.method == 'GET':
+        return jsonify({})
+
+    if request.method == 'POST':
+        return jsonify({})
+
+    return jsonify({})

example-logo.png

@@ -0,0 +1,43 @@
+# pylint: disable=R0913
+
+'''
+Models for the Resume API. Each class is related to
+'''
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Experience:
+    '''
+    Experience Class
+    '''
+    title: str
+    company: str
+    start_date: str
+    end_date: str
+    description: str
+    logo: str
+
+
+@dataclass
+class Education:
+    '''
+    Education Class
+    '''
+    course: str
+    school: str
+    start_date: str
+    end_date: str
+    grade: str
+    logo: str
+
+
+@dataclass
+class Skill:
+    '''
+    Skill Class
+    '''
+    name: str
+    proficiency: str
+    logo: str

models.py

@@ -8,6 +8,67 @@ def test_client():
     '''
     Makes a request and checks the message received is the same
     '''
-    response = app.test_client().get('/')
+    response = app.test_client().get('/test')
     assert response.status_code == 200
     assert response.json['message'] == "Hello, World!"
+
+
+def test_experience():
+    '''
+    Add a new experience and then get all experiences. 
+    
+    Check that it returns the new experience in that list
+    '''
+    example_experience = {
+        "company": "A Cooler Company",
+        "description": "Writing JavaScript Code",
+        "end_date": "Present",
+        "logo": "example-logo.png",
+        "start_date": "October 2022",
+        "title": "Software Developer"
+    }
+
+    item_id = app.test_client().post('/resume/experience',
+                                     json=example_experience).json['id']
+    response = app.test_client().get('/resume/experience')
+    assert response.json[item_id] == example_experience
+
+
+def test_education():
+    '''
+    Add a new education and then get all educations. 
+    
+    Check that it returns the new education in that list
+    '''
+    example_education = {
+        "course": "Engineering",
+        "school": "NYU",
+        "start_date": "October 2022",
+        "end_date": "August 2024",
+        "grade": "86%",
+        "logo": "example-logo.png",
+    }
+    item_id = app.test_client().post('/resume/education',
+                                     json=example_education).json['id']
+
+    response = app.test_client().get('/resume/education')
+    assert response.json[item_id] == example_education
+
+
+def test_skill():
+    '''
+    Add a new skill and then get all skills. 
+    
+    Check that it returns the new skill in that list
+    '''
+    example_skill = {
+        "name": "JavaScript",
+        "proficiency": "2-4 years",
+        "logo": "example-logo.png"
+    }
+
+    item_id = app.test_client().post('/resume/skill',
+                                     json=example_skill).json['id']
+
+    response = app.test_client().get('/resume/skill')
+    assert response.json[item_id] == example_skill