-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.py
More file actions
509 lines (397 loc) · 15 KB
/
Copy pathmain.py
File metadata and controls
509 lines (397 loc) · 15 KB
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
import base64
import json
from contextlib import asynccontextmanager
from datetime import datetime, timezone
from typing import Generic, Optional, TypeVar
from fastapi import Depends, FastAPI, HTTPException, Response, Query
from pydantic import BaseModel
from sqlalchemy import func
from sqlmodel import Field, Session, SQLModel, create_engine, select
from starlette.requests import Request
from typing_extensions import Annotated
T = TypeVar("T")
# response models
class ApiResponse(BaseModel, Generic[T]):
data: T
message: Optional[str] = None
meta: Optional[dict] = None
class PaginatedResponse(BaseModel, Generic[T]):
data: T
next: Optional[str] = None
prev: Optional[str] = None
message: Optional[str] = None
meta: Optional[dict] = None
# database models
class Campaign(SQLModel, table=True):
campaign_id: Optional[int] = Field(default=None, primary_key=True)
name: str = Field(index=True)
due_date: Optional[datetime] = Field(default=None, index=True)
created_at: datetime = Field(
default_factory=lambda: datetime.now(timezone.utc),
index=True,
)
class Employee(SQLModel, table=True):
employee_id: Optional[int] = Field(default=None, primary_key=True)
first_name: str = Field(index=True)
last_name: str = Field(index=True)
# mapper models for documentation
class CampaignCreate(BaseModel):
name: str
due_date: Optional[datetime] = None
class CampaignUpdate(BaseModel):
name: str
due_date: Optional[datetime] = None
class EmployeeCreate(BaseModel):
first_name: str
last_name: str
class EmployeeUpdate(BaseModel):
first_name: str
last_name: str
# creating database engine
sqlite_file_name = "database.db"
sqlite_url = f"sqlite:///{sqlite_file_name}"
connect_args = {"check_same_thread": False}
engine = create_engine(sqlite_url, echo=True, connect_args=connect_args)
def create_db_and_tables():
SQLModel.metadata.create_all(engine)
# session is kind of like the repository for the db - source of truth
def get_session():
with Session(engine) as session:
yield session
SessionDep = Annotated[Session, Depends(get_session)]
@asynccontextmanager
async def lifespan(app: FastAPI):
create_db_and_tables()
with Session(engine) as session:
if session.exec(select(Campaign)).first() is None:
session.add_all([
Campaign(name="Q3 Customer Retention Initiative", due_date=datetime.now(timezone.utc)),
Campaign(name="Summer Product Launch", due_date=datetime.now(timezone.utc)),
Campaign(name="Back-to-School Promotion", due_date=datetime.now(timezone.utc)),
Campaign(name="Holiday Email Marketing", due_date=datetime.now(timezone.utc)),
Campaign(name="Enterprise Lead Generation", due_date=datetime.now(timezone.utc)),
Campaign(name="Spring Customer Acquisition", due_date=datetime.now(timezone.utc)),
Campaign(name="Referral Rewards Program", due_date=datetime.now(timezone.utc)),
Campaign(name="Black Friday Sales Event", due_date=datetime.now(timezone.utc)),
Campaign(name="Customer Feedback Survey", due_date=datetime.now(timezone.utc)),
Campaign(name="New Feature Awareness Campaign", due_date=datetime.now(timezone.utc)),
Campaign(name="Premium Subscription Upgrade", due_date=datetime.now(timezone.utc)),
Campaign(name="Mobile App Engagement Drive", due_date=datetime.now(timezone.utc)),
Campaign(name="Loyalty Program Enrollment", due_date=datetime.now(timezone.utc)),
Campaign(name="Year-End Customer Appreciation", due_date=datetime.now(timezone.utc)),
Campaign(name="Product Webinar Registration", due_date=datetime.now(timezone.utc)),
])
if session.exec(select(Employee)).first() is None:
session.add_all([
Employee(first_name="Emma", last_name="Johnson"),
Employee(first_name="Michael", last_name="Chen"),
Employee(first_name="Olivia", last_name="Martinez"),
Employee(first_name="David", last_name="Wilson"),
Employee(first_name="Sophia", last_name="Patel"),
Employee(first_name="James", last_name="Anderson"),
Employee(first_name="Charlotte", last_name="Brown"),
Employee(first_name="Benjamin", last_name="Davis"),
Employee(first_name="Amelia", last_name="Garcia"),
Employee(first_name="William", last_name="Harris"),
Employee(first_name="Mia", last_name="Lewis"),
Employee(first_name="Lucas", last_name="Walker"),
Employee(first_name="Evelyn", last_name="Hall"),
Employee(first_name="Henry", last_name="Allen"),
Employee(first_name="Ava", last_name="Young"),
])
session.commit()
yield
app = FastAPI(root_path="/api/v1", lifespan=lifespan)
@app.get("/")
async def root():
return {"message": "Root endpoint of the API"}
@app.get("/campaigns/page", response_model=ApiResponse[list[Campaign]], status_code=200)
async def read_campaigns_by_page_with_offset(
session: SessionDep,
page: int = Query(1, ge=1)
):
# set hard limits and offsets
limit = 3
offset = (page - 1) * limit
campaigns = session.exec(select(Campaign).order_by(Campaign.campaign_id).offset(offset).limit(limit)).all()
return ApiResponse(
data=campaigns,
message="Campaigns retrieved successfully",
meta={"count": len(campaigns)},
)
@app.get("/campaigns/page_size", response_model=PaginatedResponse[list[Campaign]], status_code=200)
async def read_campaigns_by_page_and_page_size_with_offset(
request: Request,
session: SessionDep,
page: int = Query(1, ge=1),
page_size: int = Query(3, ge=1),
):
# 1. Establish offset
# 2. get data from database
# 3. construct base url
# 4. construct next and prev urls
# 5. return response
offset = (page - 1) * page_size
campaigns = session.exec(
select(Campaign)
.order_by(Campaign.campaign_id)
.offset(offset)
.limit(page_size)
).all()
total = session.exec(
select(func.count()).select_from(Campaign)
).one()
base_url = str(request.url).split("?")[0]
next_url = (
f"{base_url}?page={page + 1}&page_size={page_size}"
if offset + page_size < total
else None
)
prev_url = (
f"{base_url}?page={page - 1}&page_size={page_size}"
if page > 1
else None
)
return PaginatedResponse(
data=campaigns,
next=next_url,
prev=prev_url,
message="Campaigns retrieved successfully",
meta={
"count": len(campaigns),
"total": total,
"page": page,
"page_size": page_size,
},
)
@app.get("/campaigns/limit", response_model=PaginatedResponse[list[Campaign]], status_code=200)
async def read_campaigns_by_limit_with_offset(
request: Request,
session: SessionDep,
offset: int = Query(0, ge=0),
limit: int = Query(3, ge=1),
):
# 1. Get data from database
# 2. construct base url
# 3. construct next and prev urls
# 4. return response
campaigns = session.exec(
select(Campaign)
.order_by(Campaign.campaign_id)
.offset(offset)
.limit(limit)
).all()
base_url = str(request.url).split("?")[0]
next_url = f"{base_url}?offset={offset + limit}&limit={limit}"
prev_url = (
f"{base_url}?offset={max(0, offset - limit)}&limit={limit}"
if offset > 0
else None
)
return PaginatedResponse(
data=campaigns,
next=next_url,
prev=prev_url,
message="Campaigns retrieved successfully",
meta={"count": len(campaigns), },
)
# Encodes pagination state into a URL-safe cursor.
#
# Process:
# 1. Store the cursor data (currently the last campaign_id) in a Python dictionary.
# 2. Convert the dictionary into a JSON string.
# 3. Encode the JSON string into UTF-8 bytes.
# 4. Base64 encode those bytes to produce a URL-safe string.
#
# The resulting cursor is opaque to clients but is not encrypted—it simply
# represents the pagination state in a format that can safely travel in a URL.
def encode_cursor(last_id: int) -> str:
payload = {"last_id": last_id}
raw = json.dumps(payload).encode("utf-8")
return base64.urlsafe_b64encode(raw).decode("utf-8")
# Decodes a URL-safe cursor back into its original pagination state.
#
# Process:
# 1. Convert the incoming cursor string into UTF-8 bytes.
# 2. Base64 decode the bytes to recover the original JSON.
# 3. Decode the JSON bytes back into a string.
# 4. Parse the JSON into a Python dictionary.
# 5. Extract and return the last campaign_id used to continue pagination.
#
# If the cursor is malformed or cannot be decoded, a 400 Bad Request is returned.
def decode_cursor(cursor: str) -> int:
try:
raw = base64.urlsafe_b64decode(cursor.encode("utf-8"))
payload = json.loads(raw.decode("utf-8"))
return int(payload["last_id"])
except Exception:
raise HTTPException(status_code=400, detail="Invalid cursor")
@app.get("/campaigns/cursor", response_model=PaginatedResponse[list[Campaign]], status_code=200)
async def read_campaigns_by_cursor(
request: Request,
session: SessionDep,
cursor: Optional[str] = Query(None),
page_size: int = Query(3, ge=1, le=100),
):
last_id = decode_cursor(cursor) if cursor else None
statement = select(Campaign).order_by(Campaign.campaign_id).limit(page_size + 1)
if last_id is not None:
statement = statement.where(Campaign.campaign_id > last_id)
results = session.exec(statement).all()
has_next_page = len(results) > page_size
campaigns = results[:page_size]
next_cursor = encode_cursor(campaigns[-1].campaign_id) if has_next_page and campaigns else None
base_url = str(request.url).split("?")[0]
next_url = (
f"{base_url}?page_size={page_size}"
if next_cursor
else None
)
return PaginatedResponse(
data=campaigns,
next=next_url,
prev=None,
message="Campaigns retrieved successfully",
meta={
"count": len(campaigns),
"page_size": page_size,
"next_cursor": next_cursor,
},
)
@app.get("/campaigns/{campaign_id}", response_model=ApiResponse[Campaign], status_code=200)
async def read_campaign_by_id(
campaign_id: int,
session: SessionDep
):
campaign = session.get(Campaign, campaign_id)
if campaign is None:
raise HTTPException(status_code=404, detail="Campaign not found")
return ApiResponse(
data=campaign,
message="Campaign retrieved successfully",
)
@app.post("/campaigns", response_model=ApiResponse[Campaign], status_code=201)
async def create_campaign(
body: CampaignCreate,
session: SessionDep
):
campaign = Campaign(
name=body.name,
due_date=body.due_date,
)
session.add(campaign)
session.commit()
session.refresh(campaign)
return ApiResponse(
data=campaign,
message="Campaign created successfully",
)
@app.put("/campaigns/{campaign_id}", response_model=ApiResponse[Campaign], status_code=200)
async def update_campaign(
campaign_id: int,
body: CampaignUpdate,
session: SessionDep,
):
campaign = session.get(Campaign, campaign_id)
if campaign is None:
raise HTTPException(status_code=404, detail="Campaign not found")
campaign.name = body.name
campaign.due_date = body.due_date
session.add(campaign)
session.commit()
session.refresh(campaign)
return ApiResponse(
data=campaign,
message="Campaign updated successfully",
)
@app.delete("/campaigns/{campaign_id}", status_code=204)
async def delete_campaign(
campaign_id: int,
session: SessionDep
):
campaign = session.get(Campaign, campaign_id)
if campaign is None:
raise HTTPException(status_code=404, detail="Campaign not found")
session.delete(campaign)
session.commit()
return Response(status_code=204)
@app.get("/employees", response_model=ApiResponse[list[Employee]], status_code=200)
async def read_employees(session: SessionDep):
employees = session.exec(select(Employee)).all()
return ApiResponse(
data=employees,
message="Employees retrieved successfully",
meta={"count": len(employees)},
)
@app.get("/employees/{employee_id}", response_model=ApiResponse[Employee], status_code=200)
async def read_employee_by_id(
employee_id: int,
session: SessionDep
):
employee = session.get(Employee, employee_id)
if employee is None:
raise HTTPException(status_code=404, detail="Employee not found")
return ApiResponse(
data=employee,
message="Employee retrieved successfully",
)
@app.get("/employees/search/{employee_name}", response_model=ApiResponse[Employee], status_code=200)
async def read_first_or_last_employee_name(
employee_name: str,
session: SessionDep
):
statement = select(Employee).where(
(Employee.first_name == employee_name) | (Employee.last_name == employee_name)
)
employee = session.exec(statement).first()
if employee is None:
raise HTTPException(status_code=404, detail="Employee not found")
return ApiResponse(
data=employee,
message="Employee retrieved successfully",
)
@app.post("/employees", response_model=ApiResponse[Employee], status_code=201)
async def create_employee(
body: EmployeeCreate,
session: SessionDep
):
employee = Employee(
first_name=body.first_name,
last_name=body.last_name,
)
session.add(employee)
session.commit()
session.refresh(employee)
return ApiResponse(
data=employee,
message="Employee created successfully",
)
@app.put("/employees/{employee_id}", response_model=ApiResponse[Employee], status_code=200)
async def update_employee(
employee_id: int,
body: EmployeeUpdate,
session: SessionDep,
):
employee = session.get(Employee, employee_id)
if employee is None:
raise HTTPException(status_code=404, detail="Employee not found")
employee.first_name = body.first_name
employee.last_name = body.last_name
session.add(employee)
session.commit()
session.refresh(employee)
return ApiResponse(
data=employee,
message="Employee updated successfully",
)
@app.delete("/employees/{employee_id}", status_code=204)
async def delete_employee(
employee_id: int,
session: SessionDep
):
employee = session.get(Employee, employee_id)
if employee is None:
raise HTTPException(status_code=404, detail="Employee not found")
session.delete(employee)
session.commit()
return Response(status_code=204)