in api/views/phones.py [0:0]
def create(self, request):
"""
Add real phone number to the authenticated user.
The "flow" to verify a real phone number is:
1. POST a number (Will text a verification code to the number)
2a. PATCH the verification code to the realphone/{id} endpoint
2b. POST the number and verification code together
The authenticated user must have a subscription that grants one of the
`SUBSCRIPTIONS_WITH_PHONE` capabilities.
The `number` field should be in [E.164][e164] format which includes a country
code. If the number is not in E.164 format, this endpoint will try to
create an E.164 number by prepending the country code of the client
making the request (i.e., from the `X-Client-Region` HTTP header).
If the `POST` does NOT include a `verification_code` and the number is
a valid (currently, US-based) number, this endpoint will text a
verification code to the number.
If the `POST` DOES include a `verification_code`, and the code matches
a code already sent to the number, this endpoint will set `verified` to
`True` for this number.
[e164]: https://en.wikipedia.org/wiki/E.164
"""
incr_if_enabled("phones_RealPhoneViewSet.create")
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
# Check if the request includes a valid verification_code
# value, look for any un-expired record that matches both the phone
# number and verification code and mark it verified.
verification_code = serializer.validated_data.get("verification_code")
if verification_code:
try:
valid_record = (
RealPhone.recent_objects.get_for_user_number_and_verification_code(
request.user,
serializer.validated_data["number"],
verification_code,
)
)
except RealPhone.DoesNotExist:
incr_if_enabled("phones_RealPhoneViewSet.create.invalid_verification")
raise exceptions.ValidationError(
"Could not find that verification_code for user and number."
" It may have expired."
)
headers = self.get_success_headers(serializer.validated_data)
verified_valid_record = valid_record.mark_verified()
incr_if_enabled("phones_RealPhoneViewSet.create.mark_verified")
response_data = model_to_dict(
verified_valid_record,
fields=[
"id",
"number",
"verification_sent_date",
"verified",
"verified_date",
],
)
return response.Response(response_data, status=201, headers=headers)
# to prevent sending verification codes to verified numbers,
# check if the number is already a verified number.
if RealPhone.verified_objects.exists_for_number(
serializer.validated_data["number"]
):
raise ConflictError("A verified record already exists for this number.")
# to prevent abusive sending of verification messages,
# check if there is an un-expired verification code for number
if RealPhone.pending_objects.exists_for_number(
serializer.validated_data["number"]
):
raise ConflictError(
"An unverified record already exists for this number.",
)
# We call an additional _validate_number function with the request
# to try to parse the number as a local national number in the
# request.country attribute
valid_number = _validate_number(request)
serializer.validated_data["number"] = valid_number.phone_number
serializer.validated_data["country_code"] = valid_number.country_code.upper()
self.perform_create(serializer)
incr_if_enabled("phones_RealPhoneViewSet.perform_create")
headers = self.get_success_headers(serializer.validated_data)
response_data = serializer.data
response_data["message"] = (
"Sent verification code to "
f"{valid_number.phone_number} "
f"(country: {valid_number.country_code} "
f"carrier: {valid_number.carrier})"
)
return response.Response(response_data, status=201, headers=headers)