survey_report.py

import argparse
import os
import time
from io import StringIO

import six
from core_data_modules.traced_data import TracedData, Metadata
from core_data_modules.traced_data.io import TracedDataJsonIO
from core_data_modules.util import PhoneNumberUuidTable

from echo_mobile_session import EchoMobileSession

if six.PY2:
    import unicodecsv as csv
if six.PY3:
    import csv

if __name__ == "__main__":
    BASE_URL = "https://www.echomobile.org/api/"

    parser = argparse.ArgumentParser(description="Poll Echo Mobile for survey results")
    parser.add_argument("-v", "--verbose", help="Verbose output", action="store_true")
    parser.add_argument("user", help="Identifier of user launching this program, for use by TracedData Metadata")
    parser.add_argument("echo_mobile_username", metavar="echo-mobile-username", help="Echo Mobile username")
    parser.add_argument("echo_mobile_password", metavar="echo-mobile-password", help="Echo Mobile password")
    parser.add_argument("account", help="Name of Echo Mobile organisation to log into")
    parser.add_argument("survey_name", metavar="survey-name", help="Name of survey to download the results of")
    parser.add_argument("phone_uuid_table_path", metavar="phone-uuid-table-path",
                        help="JSON file containing an existing phone number <-> UUID lookup table. "
                             "This file will be updated with the new phone numbers which are found by this process.")
    parser.add_argument("json_output_path", metavar="json-output-path",
                        help="Path to a JSON file to write processed TracedData messages to")

    args = parser.parse_args()
    verbose_mode = args.verbose
    user = args.user
    echo_mobile_username = args.echo_mobile_username
    echo_mobile_password = args.echo_mobile_password
    account_name = args.account
    survey_name = args.survey_name
    phone_uuid_path = args.phone_uuid_table_path
    json_output_path = args.json_output_path

    # Load the existing UUID table
    with open(phone_uuid_path, "r") as f:
        phone_uuids = PhoneNumberUuidTable.load(f)

    session = EchoMobileSession(verbose=verbose_mode)
    try:
        # Download survey report from Echo Mobile
        session.login(echo_mobile_username, echo_mobile_password)
        session.use_account_with_name(account_name)
        report = session.survey_report_for_name(survey_name)
    finally:
        session.delete_session_background_tasks()

    # Parse the downloaded report into a list of TracedData objects, de-identifying in the process.
    data = []
    for row in csv.DictReader(StringIO(report)):
        row["avf_phone_id"] = phone_uuids.add_phone(row["phone"])
        del row["phone"]
        del row["name"]
        data.append(TracedData(dict(row), Metadata(user, Metadata.get_call_location(), time.time())))

    # Convert times to ISO
    for td in data:
        td.append_data(
            {
                "invited_date": session.echo_mobile_date_to_iso(td["invite_date"]),
                "start_date": session.echo_mobile_date_to_iso(td["start_date"]),
                "complete_date":
                    None if td["complete_date"] == "" else session.echo_mobile_date_to_iso(td["complete_date"])
            },
            Metadata(user, Metadata.get_call_location(), time.time())
        )

    # Write the UUIDs out to a file
    with open(phone_uuid_path, "w") as f:
        phone_uuids.dump(f)

    # Write the parsed items to a json file
    if os.path.dirname(json_output_path) is not "" and not os.path.exists(os.path.dirname(json_output_path)):
        os.makedirs(os.path.dirname(json_output_path))
    with open(json_output_path, "w") as f:
        TracedDataJsonIO.export_traced_data_iterable_to_json(data, f, pretty_print=True)