grepper-python pull request

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2023 Grepper, Inc. (https://www.grepper.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,2 +1,25 @@
-# grepper-python
-python client library
+# Grepper Python Client
+The Grepper Python library provides convenient access to the Grepper API from applications written in the Python language.
+
+## Requirements
+Python 3.7 and later.
+
+## PIP
+```
+pip install grepper-python
+```
+
+## Manual Installation
+```bash
+git clone https://github.com/CantCode023/grepper-python
+cd grepper-python
+python setup.py install
+```
+
+## Getting Started
+Simple usage:
+```py
+grepper = Grepper("your-grepper-api-key")
+answers = grepper.search("query")
+print(answers)
+```

grepper_python/__init__.py

@@ -0,0 +1,27 @@
+"""
+Python Grepper API
+~~~~~~~~~~~~~~~~~~~
+An API wrapper for the Grepper API.
+"""
+
+__title__ = "grepper-python"
+__author__ = "CodeGrepper"
+__license__ = "MIT"
+__copyright__ = "Copyright 2010-2023 Grepper, Inc."
+__version__ = "0.0.1a"
+
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+
+import logging
+from typing import NamedTuple, Literal
+
+from .answer import GrepperAnswer
+from .main import Grepper
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+del (
+    logging,
+    NamedTuple,
+    Literal,
+)

grepper_python/answer.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class GrepperAnswer:
+    id: int
+    content: str
+    author_name: str
+    author_profile_url: str
+    title: str
+    upvotes: int
+    downvotes: int

grepper_python/exceptions.py

@@ -0,0 +1,45 @@
+"""
+grepper-python.exceptions
+~~~~~~~~~~~~~~~~~~~
+This module contains the set of grepper-python's exceptions.
+"""
+
+
+# 400
+class BadRequest:
+    """Your request is invalid."""
+
+
+# 401
+class Unauthorized:
+    """Your API key is wrong."""
+
+
+# 403
+class Forbidden:
+    """You do not have access to the requested resource."""
+
+
+# 404
+class NotFound:
+    """The specified enpoint could not be found."""
+
+
+# 405
+class MethodNotAllowed:
+    """You tried to access an enpoint with an invalid method."""
+
+
+# 429
+class TooManyRequests:
+    """You're making too many requests! Slow down!"""
+
+
+# 500
+class InternalServerError:
+    """We had a problem with our server. Try again later."""
+
+
+# 503
+class ServiceUnavailable:
+    """We're temporarily offline for maintenance. Please try again later."""

grepper_python/main.py

@@ -0,0 +1,152 @@
+"""
+The MIT License
+
+Copyright (c) 2010-2023 Grepper, Inc. (https://www.grepper.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
+
+from __future__ import annotations
+
+from typing import Optional
+
+from .answer import GrepperAnswer
+from .exceptions import *
+
+import requests
+
+
+def exception_handler(status_code: str):
+    if status_code == "400":
+        return BadRequest
+    elif status_code == "401":
+        return Unauthorized
+    elif status_code == "403":
+        return Forbidden
+    elif status_code == "404":
+        return NotFound
+    elif status_code == "405":
+        return MethodNotAllowed
+    elif status_code == "429":
+        return TooManyRequests
+    elif status_code == "500":
+        return InternalServerError
+    elif status_code == "503":
+        return ServiceUnavailable
+
+
+class Grepper:
+    """
+    Python Grepper API Wrapper
+    """
+
+    def __init__(self, __api_key: str):
+        self.__api_key = __api_key
+
+    def search(
+        self, query: str = False, similarity: Optional[int] = 60
+    ):
+        """This function searches all answers based on a query.
+
+        Args:
+            query (str, optional): Query to search through answer titles. ex: "Javascript loop array backwords". Defaults to False.
+            similarity (Optional[int], optional): How similar the query has to be to the answer title. 1-100 where 1 is really loose matching and 100 is really strict/tight match. Defaults to 60.
+
+        Returns:
+            GrepperAnswer
+        """
+        response = requests.get(
+            "https://api.grepper.com/v1/answers/search",
+            params={"query": query, "similarity": similarity},
+            auth=(self.__api_key, ""),
+        )
+        if str(response.status_code) != "200":
+            exception = exception_handler(str(response.status_code))
+            raise exception(exception.__doc__)
+        json_response = response.json()
+        data = []
+        for i in json_response["data"]:
+            new_answer = GrepperAnswer(
+                id=i["id"],
+                content=i["content"],
+                author_name=i["author_name"],
+                author_profile_url=i["author_profile_url"],
+                title=i["title"],
+                upvotes=i["upvotes"],
+                downvotes=i["downvotes"],
+            )
+            data.append(new_answer)
+        return data
+
+    def fetch_answer(
+        self, id: int
+    ):
+        """This function returns an answer specified by the id.
+
+        Args:
+            id (int, required): The id for the specified answer. ex: "560676 ".
+
+        Returns:
+            GrepperAnswer
+        """
+        response = requests.get(
+            f"https://api.grepper.com/v1/answers/{id}",
+            auth=(self.__api_key, "")
+        )
+        if str(response.status_code) != "200":
+            exception = exception_handler(str(response.status_code))
+            raise exception(exception.__doc__)
+        json_response = response.json()
+        answer = GrepperAnswer(
+            id=json_response["id"],
+            content=json_response["content"],
+            author_name=json_response["author_name"],
+            author_profile_url=json_response["author_profile_url"],
+            title=json_response["title"],
+            upvotes=json_response["upvotes"],
+            downvotes=json_response["downvotes"],
+        )
+        return answer
+
+    def update_answer(
+        self, id: int, answer: str
+    ):
+        """This function returns an answer specified by the id.
+
+        Args:
+            id (int, required): The id for the specified answer. ex: "560676 ".
+            answer (str, required): The answer you want it to update to. ex "new answer content here".
+
+        Returns:
+            Dict
+        """
+        headers = {
+            'Content-Type': 'application/x-www-form-urlencoded',
+        }
+        data = f"""answer[content]={answer}"""
+        response = requests.post(
+            f"https://api.grepper.com/v1/answers/{id}",
+            headers=headers,
+            data=data
+        )
+        if str(response.status_code) != "200":
+            exception = exception_handler(str(response.status_code))
+            raise exception(exception.__doc__)
+        else:
+            return response.json()

setup.py

@@ -0,0 +1,24 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup_info = {
+    "name": "grepper-python",
+    "version": "0.0.1a",
+    "author": "CodedGrepper",
+    "author_email": "[email protected]",
+    "description": "An API wrapper for the Grepper API.",
+    "long_description": long_description,
+    "long_description_content_type": "text/markdown",
+    "url": "https://github.com/CodeGrepper/grepper-python",
+    "packages": setuptools.find_packages(),
+    "install_requires": ["requests", "urllib3"],
+    "classifiers": [
+        "Programming Language :: Python :: 3",
+    ],
+    "python_requires": '>=3.7'
+}
+
+
+setuptools.setup(**setup_info)

tests/test_fetch_answer.py

@@ -0,0 +1,71 @@
+import unittest
+from unittest.mock import patch
+
+from grepper_python import Grepper
+from grepper_python.exceptions import *
+
+
+class Test(unittest.TestCase):
+    def setUp(self):
+        self.api_key = "my_api_key"  # Replace with your actual API key
+        self.grepper = Grepper(self.api_key)
+
+    @patch("requests.get")
+    def test_fetch_answer_success(self, mock_get):
+        # Mock successful API response
+        mock_response = mock_get.return_value
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            "id": 12345,
+            "title": "Sample answer title",
+            "content": "Sample answer content",
+            "author_name": "John Doe",
+            "author_profile_url": "https://www.example.com/johndoe",
+            "upvotes": 10,
+            "downvotes": 0,
+        }
+
+        # Call the function
+        answer = self.grepper.fetch_answer(12345)
+
+        # Assertions
+        self.assertEqual(answer.id, 12345)
+        self.assertEqual(answer.title, "Sample answer title")
+        self.assertEqual(answer.content, "Sample answer content")
+        self.assertEqual(answer.author_name, "John Doe")
+        self.assertEqual(answer.author_profile_url, "https://www.example.com/johndoe")
+        self.assertEqual(answer.upvotes, 10)
+        self.assertEqual(answer.downvotes, 0)
+
+    @patch("requests.get")
+    def test_fetch_answer_not_found(self, mock_get):
+        # Mock API response with 404 status code
+        mock_response = mock_get.return_value
+        mock_response.status_code = 404
+        mock_response.text = "Not Found"
+
+        # Call the function and expect an exception
+        with self.assertRaises(NotFound) as cm:
+            self.grepper.fetch_answer(12345)
+
+        self.assertEqual(str(cm.exception), "HTTPException: Not Found")
+
+    @patch("requests.get")
+    def test_fetch_answer_other_error(self, mock_get):
+        # Mock API response with unexpected status code
+        mock_response = mock_get.return_value
+        mock_response.status_code = 500
+        mock_response.text = "Internal Server Error"
+
+        # Call the function and expect an exception
+        with self.assertRaises(Exception) as cm:
+            self.grepper.fetch_answer(12345)
+
+        self.assertEqual(
+            str(cm.exception),
+            "HTTPException: Unexpected status code: 500 (Internal Server Error)",
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()