-
Notifications
You must be signed in to change notification settings - Fork 1
/
app_crud.py
247 lines (197 loc) · 7.23 KB
/
app_crud.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
"""control dependencies to support CRUD app routes and APIs"""
from flask import Blueprint, render_template, request, url_for, redirect, jsonify, make_response
from flask_restful import Api, Resource
import requests
from crud.model import Users
# blueprint defaults https://flask.palletsprojects.com/en/2.0.x/api/#blueprint-objects
app_crud = Blueprint('crud', __name__,
url_prefix='/crud',
template_folder='templates/crud/',
static_folder='static',
static_url_path='assets')
# API generator https://flask-restful.readthedocs.io/en/latest/api.html#id1
api = Api(app_crud)
""" Application control for CRUD is main focus of this File, key features:
1.) User table queries
2.) app routes (Blueprint)
3.) API routes
4.) API testing
"""
""" Users table queries"""
# User/Users extraction from SQL
def users_all():
"""converts Users table into JSON list """
return [peep.read() for peep in Users.query.all()]
def users_ilike(term):
"""filter Users table by term into JSON list """
term = "%{}%".format(term) # "ilike" is case insensitive and requires wrapped %term%
table = Users.query.filter((Users.name.ilike(term)) | (Users.email.ilike(term)))
return [peep.read() for peep in table]
# User extraction from SQL
def user_by_id(userid):
"""finds User in table matching userid """
return Users.query.filter_by(userID=userid).first()
# User extraction from SQL
def user_by_email(email):
"""finds User in table matching email """
return Users.query.filter_by(email=email).first()
""" app route section """
# Default URL
@app_crud.route('/')
def crud():
"""obtains all Users from table and loads Admin Form"""
return render_template("crud.html", table=users_all())
# CRUD create/add
@app_crud.route('/create/', methods=["POST"])
def create():
"""gets data from form and add it to Users table"""
if request.form:
po = Users(
request.form.get("name"),
request.form.get("email"),
request.form.get("password"),
request.form.get("phone")
)
po.create()
return redirect(url_for('crud.crud'))
# CRUD read
@app_crud.route('/read/', methods=["POST"])
def read():
"""gets userid from form and obtains corresponding data from Users table"""
table = []
if request.form:
userid = request.form.get("userid")
po = user_by_id(userid)
if po is not None:
table = [po.read()] # placed in list for easier/consistent use within HTML
return render_template("crud.html", table=table)
# CRUD update
@app_crud.route('/update/', methods=["POST"])
def update():
"""gets userid and name from form and filters and then data in Users table"""
if request.form:
userid = request.form.get("userid")
name = request.form.get("name")
po = user_by_id(userid)
if po is not None:
po.update(name)
return redirect(url_for('crud.crud'))
# CRUD delete
@app_crud.route('/delete/', methods=["POST"])
def delete():
"""gets userid from form delete corresponding record from Users table"""
if request.form:
userid = request.form.get("userid")
po = user_by_id(userid)
if po is not None:
po.delete()
return redirect(url_for('crud.crud'))
# Search Form
@app_crud.route('/search/')
def search():
"""loads form to search Users data"""
return render_template("search.html")
# Search request and response
@app_crud.route('/search/term/', methods=["POST"])
def search_term():
""" obtain term/search request """
req = request.get_json()
term = req['term']
response = make_response(jsonify(users_ilike(term)), 200)
return response
""" API routes section """
class UsersAPI:
# class for create/post
class _Create(Resource):
def post(self, name, email, password, phone):
po = Users(name, email, password, phone)
person = po.create()
if person:
return person.read()
return {'message': f'Processed {name}, either a format error or {email} is duplicate'}, 210
# class for read/get
class _Read(Resource):
def get(self):
return users_all()
# class for read/get
class _ReadILike(Resource):
def get(self, term):
return users_ilike(term)
# class for update/put
class _Update(Resource):
def put(self, email, name):
po = user_by_email(email)
if po is None:
return {'message': f"{email} is not found"}, 210
po.update(name)
return po.read()
class _UpdateAll(Resource):
def put(self, email, name, password, phone):
po = user_by_email(email)
if po is None:
return {'message': f"{email} is not found"}, 210
po.update(name, password, phone)
return po.read()
# class for delete
class _Delete(Resource):
def delete(self, userid):
po = user_by_id(userid)
if po is None:
return {'message': f"{userid} is not found"}, 210
data = po.read()
po.delete()
return data
# building RESTapi resource
api.add_resource(_Create, '/create/<string:name>/<string:email>/<string:password>/<string:phone>')
api.add_resource(_Read, '/read/')
api.add_resource(_ReadILike, '/read/ilike/<string:term>')
api.add_resource(_Update, '/update/<string:email>/<string:name>')
api.add_resource(_UpdateAll, '/update/<string:email>/<string:name>/<string:password>/<string:phone>')
api.add_resource(_Delete, '/delete/<int:userid>')
""" API testing section """
def api_tester():
# local host URL for model
url = 'http://localhost:5222/crud'
# test conditions
API = 0
METHOD = 1
tests = [
['/create/Wilma Flintstone/wilma@bedrock.org/123wifli/0001112222', "post"],
['/create/Fred Flintstone/fred@bedrock.org/123wifli/0001112222', "post"],
['/read/', "get"],
['/read/ilike/John', "get"],
['/read/ilike/com', "get"],
['/update/wilma@bedrock.org/Wilma S Flintstone/123wsfli/0001112229', "put"],
['/update/wilma@bedrock.org/Wilma Slaghoople Flintstone', "put"],
['/delete/4', "delete"],
['/delete/5', "delete"],
]
# loop through each test condition and provide feedback
for test in tests:
print()
print(f"({test[METHOD]}, {url + test[API]})")
if test[METHOD] == 'get':
response = requests.get(url + test[API])
elif test[METHOD] == 'post':
response = requests.post(url + test[API])
elif test[METHOD] == 'put':
response = requests.put(url + test[API])
elif test[METHOD] == 'delete':
response = requests.delete(url + test[API])
else:
print("unknown RESTapi method")
continue
print(response)
try:
print(response.json())
except:
print("unknown error")
def api_printer():
print()
print("Users table")
for user in users_all():
print(user)
"""validating api's requires server to be running"""
if __name__ == "__main__":
api_tester()
api_printer()