close #4, will include modaq methods separately in future commits

skysomorphic · skysomorphic · commit 78640f06e15f · 2023-12-26T21:20:30.000-05:00
diff --git a/qbreader/asynchronous.py b/qbreader/asynchronous.py
@@ -67,6 +67,7 @@ async def query(
         queryString: Optional[str] = "",
         exactPhrase: Optional[bool] = False,
         ignoreDiacritics: Optional[bool] = False,
+        ignoreWordOrder: Optional[bool] = False,
         regex: Optional[bool] = False,
         randomize: Optional[bool] = False,
         setName: Optional[str] = None,
@@ -94,6 +95,8 @@ class type.
             Ensure that the query string is an exact phrase.
         ignoreDiacritics : bool, default = False
             Ignore or transliterate diacritical marks in `queryString`.
+        ignoreWordOrder : bool, default = False
+            Treat `queryString` as a set of keywords that can appear in any order.
         regex : bool, default = False
             Treat `queryString` as a regular expression.
         randomize : bool, default = False
@@ -142,8 +145,14 @@ class type.
 
         for name, param in tuple(
             zip(
-                ("exactPhrase", "ignoreDiacritics", "regex", "randomize"),
-                (exactPhrase, ignoreDiacritics, regex, randomize),
+                (
+                    "exactPhrase",
+                    "ignoreDiacritics",
+                    "ignoreWordOrder",
+                    "regex",
+                    "randomize",
+                ),
+                (exactPhrase, ignoreDiacritics, ignoreWordOrder, regex, randomize),
             )
         ):
             if not isinstance(param, bool):
@@ -175,6 +184,7 @@ class type.
             "queryString": queryString,
             "exactPhrase": api_utils.normalize_bool(exactPhrase),
             "ignoreDiacritics": api_utils.normalize_bool(ignoreDiacritics),
+            "ignoreWordOrder": api_utils.normalize_bool(ignoreWordOrder),
             "regex": api_utils.normalize_bool(regex),
             "randomize": api_utils.normalize_bool(randomize),
             "setName": setName,
@@ -590,3 +600,63 @@ async def check_answer(
         return await AnswerJudgement.check_answer_async(
             answerline, givenAnswer, self.session
         )
+
+    async def tossup_by_id(self: Self, id: str) -> Tossup:
+        """Get a tossup by its ID.
+
+        Original API doc at https://www.qbreader.org/api-docs/tossup-by-id.
+
+        Parameters
+        ----------
+        id : str
+            The ID of the tossup to get.
+
+        Returns
+        -------
+        Tossup
+            A `Tossup` object.
+        """
+        url = BASE_URL + "/tossup-by-id"
+
+        data = {
+            "id": id,
+        }
+
+        async with self.session.get(url, params=data) as response:
+            if response.status != 200:
+                if response.status == 400:
+                    raise ValueError(f"Invalid tossup ID: {id}")
+                raise Exception(str(response.status) + " bad request")
+
+            json = await response.json()
+            return Tossup.from_json(json["tossup"])
+
+    async def bonus_by_id(self: Self, id: str) -> Bonus:
+        """Get a bonus by its ID.
+
+        Original API doc at https://www.qbreader.org/api-docs/bonus-by-id.
+
+        Parameters
+        ----------
+        id : str
+            The ID of the bonus to get.
+
+        Returns
+        -------
+        Bonus
+            A `Bonus` object.
+        """
+        url = BASE_URL + "/bonus-by-id"
+
+        data = {
+            "id": id,
+        }
+
+        async with self.session.get(url, params=data) as response:
+            if response.status != 200:
+                if response.status == 400:
+                    raise ValueError(f"Invalid bonus ID: {id}")
+                raise Exception(str(response.status) + " bad request")
+
+            json = await response.json()
+            return Bonus.from_json(json["bonus"])
diff --git a/qbreader/synchronous.py b/qbreader/synchronous.py
@@ -32,6 +32,7 @@ def query(
         queryString: Optional[str] = "",
         exactPhrase: Optional[bool] = False,
         ignoreDiacritics: Optional[bool] = False,
+        ignoreWordOrder: Optional[bool] = False,
         regex: Optional[bool] = False,
         randomize: Optional[bool] = False,
         setName: Optional[str] = None,
@@ -59,6 +60,8 @@ class type.
             Ensure that the query string is an exact phrase.
         ignoreDiacritics : bool, default = False
             Ignore or transliterate diacritical marks in `queryString`.
+        ignoreWordOrder : bool, default = False
+            Treat `queryString` as a set of keywords that can appear in any order.
         regex : bool, default = False
             Treat `queryString` as a regular expression.
         randomize : bool, default = False
@@ -107,8 +110,14 @@ class type.
 
         for name, param in tuple(
             zip(
-                ("exactPhrase", "ignoreDiacritics", "regex", "randomize"),
-                (exactPhrase, ignoreDiacritics, regex, randomize),
+                (
+                    "exactPhrase",
+                    "ignoreDiacritics",
+                    "ignoreWordOrder",
+                    "regex",
+                    "randomize",
+                ),
+                (exactPhrase, ignoreDiacritics, ignoreWordOrder, regex, randomize),
             )
         ):
             if not isinstance(param, bool):
@@ -140,6 +149,7 @@ class type.
             "queryString": queryString,
             "exactPhrase": api_utils.normalize_bool(exactPhrase),
             "ignoreDiacritics": api_utils.normalize_bool(ignoreDiacritics),
+            "ignoreWordOrder": api_utils.normalize_bool(ignoreWordOrder),
             "regex": api_utils.normalize_bool(regex),
             "randomize": api_utils.normalize_bool(randomize),
             "setName": setName,
@@ -551,3 +561,63 @@ def check_answer(self: Self, answerline: str, givenAnswer: str) -> AnswerJudgeme
             A `AnswerJudgement` object containing the response.
         """
         return AnswerJudgement.check_answer_sync(answerline, givenAnswer)
+
+    def tossup_by_id(self: Self, id: str) -> Tossup:
+        """Get a tossup by its ID.
+
+        Original API doc at https://www.qbreader.org/api-docs/tossup-by-id.
+
+        Parameters
+        ----------
+        id : str
+            The ID of the tossup to get.
+
+        Returns
+        -------
+        Tossup
+            A `Tossup` object.
+        """
+        url = BASE_URL + "/tossup-by-id"
+
+        data = {
+            "id": id,
+        }
+
+        response: requests.Response = requests.get(url, params=data)
+
+        if response.status_code != 200:
+            if response.status_code == 400:
+                raise ValueError(f"Invalid tossup ID: {id}")
+            raise Exception(str(response.status_code) + " bad request")
+
+        return Tossup.from_json(response.json()["tossup"])
+
+    def bonus_by_id(self: Self, id: str) -> Bonus:
+        """Get a bonus by its ID.
+
+        Original API doc at https://www.qbreader.org/api-docs/bonus-by-id.
+
+        Parameters
+        ----------
+        id : str
+            The ID of the bonus to get.
+
+        Returns
+        -------
+        Bonus
+            A `Bonus` object.
+        """
+        url = BASE_URL + "/bonus-by-id"
+
+        data = {
+            "id": id,
+        }
+
+        response: requests.Response = requests.get(url, params=data)
+
+        if response.status_code != 200:
+            if response.status_code == 400:
+                raise ValueError(f"Invalid bonus ID: {id}")
+            raise Exception(str(response.status_code) + " bad request")
+
+        return Bonus.from_json(response.json()["bonus"])
diff --git a/tests/test_async.py b/tests/test_async.py
@@ -541,6 +541,53 @@ async def test_check_answer_bad_response(self, qbr, mock_get):
             givenAnswer="Rubik's cubes",
         )
 
+    @pytest.mark.asyncio
+    @pytest.mark.parametrize(
+        "id, expected_answer",
+        [
+            ("657fd7d7de6df0163bbe3b3d", "Sweden"),
+            ("657fd7d8de6df0163bbe3b43", "jQuery"),
+        ],
+    )
+    async def test_tossup_by_id(self, qbr, id: str, expected_answer: str):
+        tu: qb.Tossup = await qbr.tossup_by_id(id)
+        judgement: qb.AnswerJudgement = await tu.check_answer_async(
+            expected_answer, session=qbr.session
+        )
+        assert judgement.correct()
+
+    @pytest.mark.asyncio
+    async def test_tossup_by_id_bad_response(self, qbr, mock_get):
+        await async_assert_exception(qbr.tossup_by_id, ValueError, id="not a valid id")
+        mock_get(mock_status_code=404)
+        await async_assert_exception(
+            qbr.tossup_by_id, Exception, id="657fd7d7de6df0163bbe3b3d"
+        )
+
+    @pytest.mark.asyncio
+    @pytest.mark.parametrize(
+        "id, expected_answers",
+        [
+            ("648938e130bd7ab56b095a42", ["volcano", "Magellan", "terra"]),
+            ("648938e130bd7ab56b095a60", ["pH", "NADPH", "perforin"]),
+        ],
+    )
+    async def test_bonus_by_id(self, qbr, id: str, expected_answers: list[str]):
+        b: qb.Bonus = await qbr.bonus_by_id(id)
+        for i, answer in enumerate(expected_answers):
+            judgement: qb.AnswerJudgement = await b.check_answer_async(
+                i, answer, session=qbr.session
+            )
+            assert judgement.correct()
+
+    @pytest.mark.asyncio
+    async def test_bonus_by_id_bad_response(self, qbr, mock_get):
+        await async_assert_exception(qbr.bonus_by_id, ValueError, id="not a valid id")
+        mock_get(mock_status_code=404)
+        await async_assert_exception(
+            qbr.bonus_by_id, Exception, id="648938e130bd7ab56b095a42"
+        )
+
     @pytest.mark.asyncio
     async def test_close(self, qbr):
         await qbr.close()
diff --git a/tests/test_sync.py b/tests/test_sync.py
@@ -431,3 +431,38 @@ def test_check_answer_bad_response(self, mock_get):
             answerline="Rubik's cubes",
             givenAnswer="Rubik's cubes",
         )
+
+    @pytest.mark.parametrize(
+        "id, expected_answer",
+        [
+            ("657fd7d7de6df0163bbe3b3d", "Sweden"),
+            ("657fd7d8de6df0163bbe3b43", "jQuery"),
+        ],
+    )
+    def test_tossup_by_id(self, id: str, expected_answer: str):
+        tu: qb.Tossup = qbr.tossup_by_id(id)
+        judgement: qb.AnswerJudgement = tu.check_answer_sync(expected_answer)
+        assert judgement.correct()
+
+    def test_tossup_by_id_bad_response(self, mock_get):
+        assert_exception(qbr.tossup_by_id, ValueError, id="not a valid id")
+        mock_get(mock_status_code=404)
+        assert_exception(qbr.tossup_by_id, Exception, id="657fd7d7de6df0163bbe3b3d")
+
+    @pytest.mark.parametrize(
+        "id, expected_answers",
+        [
+            ("648938e130bd7ab56b095a42", ["volcano", "Magellan", "terra"]),
+            ("648938e130bd7ab56b095a60", ["pH", "NADPH", "perforin"]),
+        ],
+    )
+    def test_bonus_by_id(self, id: str, expected_answers: list[str]):
+        b: qb.Bonus = qbr.bonus_by_id(id)
+        for i, answer in enumerate(expected_answers):
+            judgement: qb.AnswerJudgement = b.check_answer_sync(i, answer)
+            assert judgement.correct()
+
+    def test_bonus_by_id_bad_response(self, mock_get):
+        assert_exception(qbr.bonus_by_id, ValueError, id="not a valid id")
+        mock_get(mock_status_code=404)
+        assert_exception(qbr.bonus_by_id, Exception, id="648938e130bd7ab56b095a42")
