def basic_auth(user="******", passwd="passwd"):
"""Prompts the user for authorization using HTTP Basic Auth.
---
tags:
- Auth
parameters:
- in: path
name: user
type: string
- in: path
name: passwd
type: string
produces:
- application/json
responses:
200:
description: Sucessful authentication.
401:
description: Unsuccessful authentication.
"""
if not check_basic_auth(user, passwd):
return status_code(401)
return jsonify(authenticated=True, user=user)
def image():
"""Returns a simple image of the type suggest by the Accept header.
---
tags:
- Images
produces:
- image/webp
- image/svg+xml
- image/jpeg
- image/png
- image/*
responses:
200:
description: An image.
"""
headers = get_headers()
if "accept" not in headers:
return image_png() # Default media type to png
accept = headers["accept"].lower()
if "image/webp" in accept:
return image_webp()
elif "image/svg+xml" in accept:
return image_svg()
elif "image/jpeg" in accept:
return image_jpeg()
elif "image/png" in accept or "image/*" in accept:
return image_png()
else:
return status_code(406) # Unsupported media type
def cache():
"""Returns a 304 if an If-Modified-Since header or If-None-Match is present. Returns the same as a GET otherwise.
---
tags:
- Response inspection
parameters:
- in: header
name: If-Modified-Since
- in: header
name: If-None-Match
produces:
- application/json
responses:
200:
description: Cached response
304:
description: Modified
"""
is_conditional = request.headers.get(
"If-Modified-Since") or request.headers.get("If-None-Match")
if is_conditional is None:
response = view_get()
response.headers["Last-Modified"] = http_date()
response.headers["ETag"] = uuid.uuid4().hex
return response
else:
return status_code(304)
def view_status_code(codes):
"""Return status code or random status code if more than one are given
---
tags:
- Status codes
parameters:
- in: path
name: codes
produces:
- text/plain
responses:
100:
description: Informational responses
200:
description: Success
300:
description: Redirection
400:
description: Client Errors
500:
description: Server Errors
"""
if "," not in codes:
try:
code = int(codes)
except ValueError:
return Response("Invalid status code", status=400)
return status_code(code)
choices = []
for choice in codes.split(","):
if ":" not in choice:
code = choice
weight = 1
else:
code, weight = choice.split(":")
try:
choices.append((int(code), float(weight)))
except ValueError:
return Response("Invalid status code", status=400)
code = weighted_choice(choices)
return status_code(code)
def etag(etag):
"""Assumes the resource has the given etag and responds to If-None-Match and If-Match headers appropriately.
---
tags:
- Response inspection
parameters:
- in: header
name: If-None-Match
- in: header
name: If-Match
produces:
- application/json
responses:
200:
description: Normal response
412:
description: match
"""
if_none_match = parse_multi_value_header(
request.headers.get("If-None-Match"))
if_match = parse_multi_value_header(request.headers.get("If-Match"))
if if_none_match:
if etag in if_none_match or "*" in if_none_match:
response = status_code(304)
response.headers["ETag"] = etag
return response
elif if_match:
if etag not in if_match and "*" not in if_match:
return status_code(412)
# Special cases don't apply, return normal response
response = view_get()
response.headers["ETag"] = etag
return response
def status():
n = request.values.get('status', 200)
return status_code(int(n))
