create_gform_items.py

from create_quiz import QUIZ_CATEGORIES


def create_gform_question(question_obj):
    """
    Takes a question python object and returns the JSON
    ready to use building the Google Form

    Args:
        question_obj: A Question object

    """

    return {
        "createItem": {
            "item": {
                "title": question_obj.get_question(),
                "questionItem": {
                    "question": {
                        "required": True,
                        "grading": {
                            "pointValue": 1,
                            "correctAnswers": {
                                "answers":
                                [{"value": question_obj.get_correct_answer()}]
                            },
                        },
                        "choiceQuestion": {
                            "type": "RADIO",
                            "options": [
                                    {"value":
                                     question_obj.get_correct_answer()},
                                    {"value":
                                     question_obj.get_incorrect_answers()[0]},
                                    {"value":
                                     question_obj.get_incorrect_answers()[1]},
                                    {"value":
                                     question_obj.get_incorrect_answers()[2]}
                            ],
                            "shuffle": True
                        }
                    }
                },
            },
            "location": {
                "index": 0
            }
        }
    }


def create_gform_text_question(question_to_ask):
    """
    Makes a Google Forms questions with a
    text field input for response

    Args:
        question_to_ask: The Question to ask
    """

    return {
        "createItem": {
            "item": {
                "title": question_to_ask,
                "questionItem": {
                    "question": {
                        "required": True,
                        "textQuestion": {
                            "paragraph": False
                        }
                    },
                },
            },
            "location": {
                "index": 0
            }
        }
    }


def create_gform_page_break(round_num, category):
    """
    Creates a page break for a Google Form

    Args:
        round_num: The number of the round
        category: The index of the category of the round
    """
    page_break = {
        "createItem": {
            "item": {
                "title": f"Round {round_num}: {QUIZ_CATEGORIES[category]}",
                "pageBreakItem": {}
            },
            "location": {
                "index": 0
            }
        },
    }

    return page_break


def create_gform_round(round_obj):
    """
    Takes a game round python object and returns a list
    of "createItem" objects to send to the Google Forms
    API

    Args:
        round_obj: A Round object
    """

    nums_qs = round_obj.get_num_qs()
    round_num = round_obj.get_round_num()
    category = round_obj.get_category()
    questions = round_obj.get_questions()
    form_items = []

    for question in questions:
        form_items.insert(0, create_gform_question(question))

    form_items.append(create_gform_page_break(round_num, category))

    return form_items


def create_gform_game(game_obj):
    """
    Takes a quiz game python object and returns a list
    of "createItem" objects to send to the Google Forms
    API

    Args:
        game_obj: A Quiz Game object
    """

    form_items = []
    rounds = game_obj.rounds

    for round in rounds:
        form_items.insert(0, create_gform_round(round))

    return form_items