edxnotes.py 1.73 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
"""
Tools for creating edxnotes content fixture data.
"""

import json
import factory
import requests

from . import EDXNOTES_STUB_URL


class Range(factory.Factory):
13
    class Meta(object):
muhammad-ammar committed
14
        model = dict
15

16 17 18 19 20 21 22
    start = "/div[1]/p[1]"
    end = "/div[1]/p[1]"
    startOffset = 0
    endOffset = 8


class Note(factory.Factory):
23
    class Meta(object):
muhammad-ammar committed
24
        model = dict
25

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
    user = "dummy-user"
    usage_id = "dummy-usage-id"
    course_id = "dummy-course-id"
    text = "dummy note text"
    quote = "dummy note quote"
    ranges = [Range()]


class EdxNotesFixtureError(Exception):
    """
    Error occurred while installing a edxnote fixture.
    """
    pass


class EdxNotesFixture(object):
    notes = []

    def create_notes(self, notes_list):
        self.notes = notes_list
        return self

    def install(self):
        """
        Push the data to the stub EdxNotes service.
        """
        response = requests.post(
            '{}/create_notes'.format(EDXNOTES_STUB_URL),
            data=json.dumps(self.notes)
        )

        if not response.ok:
            raise EdxNotesFixtureError(
                "Could not create notes {0}.  Status was {1}".format(
                    json.dumps(self.notes), response.status_code
                )
            )

        return self

    def cleanup(self):
        """
        Cleanup the stub EdxNotes service.
        """
        self.notes = []
        response = requests.put('{}/cleanup'.format(EDXNOTES_STUB_URL))

        if not response.ok:
            raise EdxNotesFixtureError(
                "Could not cleanup EdxNotes service {0}.  Status was {1}".format(
                    json.dumps(self.notes), response.status_code
                )
            )

        return self