def handle_start_report(twiml):
"""Handle a message from the user indicating they want to start a new
report."""
step = STEP_LOCATION
twiml.message('What is your location? Be specific! (e.g. "34th and '
'Spruce in Philadelphia PA")')
return step
def handle_start_report(twiml):
"""Handle a message from the user indicating they want to start a new
report."""
step = STEP_LOCATION
twiml.message('What is your location? Be specific! (e.g. "34th and '
'Spruce in Philadelphia PA")')
return step
def handle_other_agency_step(body, step, twiml):
"""Called when the user wants to enter an 'Other' agency."""
agency_name = body
step = STEP_LICENSE_PLATE
twiml.message('What is the license plate number? Reply "no" to skip. '
'(e.g. MG1234E)')
return agency_name, step
def handle_description_step(body, step, twiml):
"""Handle a message from the user containing the report's description."""
validator_form = IncidentReportForm()
errors = data_errors(form=validator_form, field=validator_form.description,
data=body)
if len(errors) == 0:
description = body
step = STEP_PICTURE
twiml.message('Last, can you take a photo of the vehicle and text '
'it back? Reply "no" to skip.')
else:
description = ''
reply_with_errors(errors, twiml, 'description')
return description, step
def handle_vehicle_id_step(body, step, twiml):
"""Handle a message from the user containing the report's vehicle id."""
validator_form = IncidentReportForm()
errors = data_errors(form=validator_form, field=validator_form.vehicle_id,
data=body)
if len(errors) == 0:
vehicle_id = body
step = STEP_DURATION
twiml.message('How many minutes have you observed the vehicle idling? '
'(e.g. 10)')
else:
vehicle_id = ''
reply_with_errors(errors, twiml, 'vehicle ID')
return vehicle_id, step
def handle_description_step(body, step, twiml):
"""Handle a message from the user containing the report's description."""
validator_form = IncidentReportForm()
errors = data_errors(form=validator_form,
field=validator_form.description,
data=body)
if len(errors) == 0:
description = body
step = STEP_PICTURE
twiml.message('Last, can you take a photo of the vehicle and text '
'it back? Reply "no" to skip.')
else:
description = ''
reply_with_errors(errors, twiml, 'description')
return description, step
def handle_vehicle_id_step(body, step, twiml):
"""Handle a message from the user containing the report's vehicle id."""
validator_form = IncidentReportForm()
errors = data_errors(form=validator_form,
field=validator_form.vehicle_id,
data=body)
if len(errors) == 0:
vehicle_id = body
step = STEP_DURATION
twiml.message('How many minutes have you observed the vehicle idling? '
'(e.g. 10)')
else:
vehicle_id = ''
reply_with_errors(errors, twiml, 'vehicle ID')
return vehicle_id, step
def handle_duration_step(body, step, twiml):
"""Handle a message from the user containing the report's duration."""
errors = []
try:
body = int(body)
except ValueError:
errors.append('Please enter a valid integer.')
if len(errors) == 0:
duration = body
step = STEP_DESCRIPTION
twiml.message('Please describe the situation (e.g. The driver is '
'sleeping)')
else:
duration = 0
reply_with_errors(errors, twiml, 'duration')
return duration, step
def handle_duration_step(body, step, twiml):
"""Handle a message from the user containing the report's duration."""
errors = []
try:
body = int(body)
except ValueError:
errors.append('Please enter a valid integer.')
if len(errors) == 0:
duration = body
step = STEP_DESCRIPTION
twiml.message('Please describe the situation (e.g. The driver is '
'sleeping)')
else:
duration = 0
reply_with_errors(errors, twiml, 'duration')
return duration, step
def handle_license_plate_step(body, step, twiml):
"""Handle a message from the user containing the report's license plate."""
if body.lower() == 'no':
body = ''
validator_form = IncidentReportForm()
errors = data_errors(
form=validator_form,
field=validator_form.license_plate,
data=body
)
if len(errors) == 0:
license_plate = body
step = STEP_VEHICLE_ID
twiml.message('What is the Vehicle ID? This is usually on the back or '
'side of the vehicle. (e.g. 105014)')
else:
license_plate = ''
reply_with_errors(errors, twiml, 'license plate')
return license_plate, step
def handle_agency_step(body_upper, step, twiml):
"""Handle a message from the user containing the report's agency."""
body_upper = body_upper.upper()
agencies = Agency.query.filter_by(is_official=True).order_by(
Agency.name).all()
letters = all_strings(len(agencies) + 1) # one extra letter for Other
letters_to_agency = dict(zip(letters, agencies))
if body_upper == letters[-1]: # Other
step = STEP_OTHER_AGENCY
agency_name = ''
twiml.message('You selected Other. What is the name of the agency '
'which operates the vehicle?')
elif body_upper in letters_to_agency.keys():
step = STEP_LICENSE_PLATE
agency_name = letters_to_agency[body_upper].name
twiml.message('What is the license plate number? Reply "no" to skip. '
'(e.g. MG1234E)')
else:
agency_name = ''
twiml.message('Please enter a letter A through {}.'
.format(letters[-1]))
return agency_name, step
def handle_location_step(body, step, twiml):
"""Handle a message from the user containing the report's location."""
validator_form = IncidentReportForm()
errors = data_errors(form=validator_form, field=validator_form.location,
data=body)
if len(errors) == 0:
location = body
step = STEP_AGENCY
agencies = Agency.query.filter_by(is_official=True).order_by(
Agency.name).all()
letters = all_strings(len(agencies) + 1) # one extra letter for Other
agencies_listed = get_agencies_listed(agencies, letters)
twiml.message('Which agency operates the vehicle you see idling? '
'Select from the following list or enter {} for Other.'
.format(letters[-1]))
twiml.message(agencies_listed)
else:
location = ''
reply_with_errors(errors, twiml, 'location')
return location, step
def handle_message():
"""Called by Twilio when a text message is received."""
body = str(request.values.get('Body')).lower().strip()
num_media = int(request.values.get('NumMedia'))
twilio_hosted_media_url = str(request.values.get('MediaUrl0')) \
if num_media > 0 else None
message_sid = str(request.values.get('MessageSid'))
phone_number = str(request.values.get('From'))
twiml = twilio.twiml.Response()
# Retrieve incident cookies
step = int(request.cookies.get('messagecount', 0))
vehicle_id = str(request.cookies.get('vehicle_id', ''))
duration = int(request.cookies.get('duration', 0))
description = str(request.cookies.get('description', ''))
location = str(request.cookies.get('location', ''))
picture_url = str(request.cookies.get('picture_url', ''))
if 'report' == body.lower():
# reset report variables/cookies
vehicle_id = ''
duration = 0
description = ''
location = ''
picture_url = ''
step = handle_start_report(twiml)
elif step == STEP_LOCATION:
location, step = handle_location_step(body, step, twiml)
elif step == STEP_VEHICLE_ID:
vehicle_id, step = handle_vehicle_id_step(body, step, twiml)
elif step == STEP_DURATION:
duration, step = handle_duration_step(body, step, twiml)
elif step == STEP_DESCRIPTION:
description, step = handle_description_step(body, step, twiml)
elif step == STEP_PICTURE:
step, image_job_id = handle_picture_step(step, message_sid,
twilio_hosted_media_url)
new_incident = handle_create_report(description, duration, location,
picture_url, vehicle_id,
phone_number)
twiml.message('Thanks! See your report on the map at {}'.format(
url_for_external('main.index')))
if new_incident.user is None:
twiml.message('Want to keep track of all your reports? Create an '
'account at {}'.format(
url_for_external('account.register')))
else:
twiml.message('See all your reports at {}'.format(
url_for_external('reports.view_my_reports')))
if image_job_id is not None:
get_queue().enqueue(
attach_image_to_incident_report,
depends_on=image_job_id,
incident_report=new_incident,
image_job_id=image_job_id,
)
# reset report variables/cookies
step = STEP_INIT
else:
twiml.message('Welcome to {}! Please reply "report" to report an '
'idling incident.'.format(
current_app.config['APP_NAME']))
response = make_response(str(twiml))
set_cookie(response, 'messagecount', str(step))
set_cookie(response, 'vehicle_id', vehicle_id)
set_cookie(response, 'duration', str(duration))
set_cookie(response, 'description', description)
set_cookie(response, 'location', location)
set_cookie(response, 'picture_url', picture_url)
return response
def reply_with_errors(errors, twiml, field_name):
"""Reply to the user with errors in a field."""
twiml.message('Sorry, there were some errors with your response. '
'Please enter the {} again.'.format(field_name))
twiml.message('Errors:\n{}'.format('\n'.join(errors)))
def reply_with_errors(errors, twiml, field_name):
"""Reply to the user with errors in a field."""
twiml.message('Sorry, there were some errors with your response. '
'Please enter the {} again.'.format(field_name))
twiml.message('Errors:\n{}'.format('\n'.join(errors)))
def handle_message():
"""Called by Twilio when a text message is received."""
body = str(request.values.get('Body')).lower().strip()
num_media = int(request.values.get('NumMedia'))
twilio_hosted_media_url = str(request.values.get('MediaUrl0')) \
if num_media > 0 else None
message_sid = str(request.values.get('MessageSid'))
phone_number = str(request.values.get('From'))
twiml = twilio.twiml.Response()
# Retrieve incident cookies
step = int(request.cookies.get('messagecount', 0))
vehicle_id = str(request.cookies.get('vehicle_id', ''))
agency_name = str(request.cookies.get('agency_name', ''))
license_plate = str(request.cookies.get('license_plate', ''))
duration = int(request.cookies.get('duration', 0))
description = str(request.cookies.get('description', ''))
location = str(request.cookies.get('location', ''))
picture_url = str(request.cookies.get('picture_url', ''))
if 'report' == body.lower():
# reset report variables/cookies
vehicle_id = ''
agency_name = ''
license_plate = ''
duration = 0
description = ''
location = ''
picture_url = ''
step = handle_start_report(twiml)
elif step == STEP_LOCATION:
location, step = handle_location_step(body, step, twiml)
elif step == STEP_AGENCY:
agency_name, step = handle_agency_step(body, step, twiml)
elif step == STEP_OTHER_AGENCY:
agency_name, step = handle_other_agency_step(body, step, twiml)
elif step == STEP_LICENSE_PLATE:
license_plate, step = handle_license_plate_step(body, step, twiml)
elif step == STEP_VEHICLE_ID:
vehicle_id, step = handle_vehicle_id_step(body, step, twiml)
elif step == STEP_DURATION:
duration, step = handle_duration_step(body, step, twiml)
elif step == STEP_DESCRIPTION:
description, step = handle_description_step(body, step, twiml)
elif step == STEP_PICTURE:
step, image_job_id = handle_picture_step(step, message_sid,
twilio_hosted_media_url)
new_incident = handle_create_report(agency_name, description, duration,
license_plate, location,
picture_url, vehicle_id,
phone_number)
twiml.message('Thanks! See your report on the map at {}'
.format(url_for_external('main.index')))
if new_incident.user is None:
twiml.message('Want to keep track of all your reports? Create an '
'account at {}'
.format(url_for_external('account.register')))
else:
twiml.message('See all your reports at {}'
.format(url_for_external('reports.view_my_reports')))
if image_job_id is not None:
get_queue().enqueue(
attach_image_to_incident_report,
depends_on=image_job_id,
incident_report=new_incident,
image_job_id=image_job_id,
)
# reset report variables/cookies
step = STEP_INIT
else:
twiml.message('Welcome to {}! Please reply "report" to report an '
'idling incident.'
.format(current_app.config['APP_NAME']))
response = make_response(str(twiml))
set_cookie(response, 'messagecount', str(step))
set_cookie(response, 'agency_name', agency_name)
set_cookie(response, 'vehicle_id', vehicle_id)
set_cookie(response, 'license_plate', license_plate)
set_cookie(response, 'duration', str(duration))
set_cookie(response, 'description', description)
set_cookie(response, 'location', location)
set_cookie(response, 'picture_url', picture_url)
return response
