Merge pull request #2 from thenamesweretakenalready/api-token-validation

Api token validation + other stuff

Author: benjhar

README.md

@@ -10,14 +10,16 @@ while also maintaining a readable codebase.
 
 You can install jokeapi through [pip](https://pypi.org/project/pip/) by using `pip install jokeapi`
 
-So far there are no build from source instructions.
-
 ---
 
 # get_joke
 
 The wrapper is structured in such a way that the end-user should only ever have to
-interact with one function. This function is `get_joke()`
+interact with one function. This function is `get_joke()`.
+
+Please note that urllib3, the core dependency of this wrapper automatically abides by
+`Retry-After` headers, which means you may have to wait a long time for a joke if you
+have made a lot of requests recently
 
 ---
 
@@ -29,7 +31,8 @@ interact with one function. This function is `get_joke()`
   from jokeapi import Jokes # Import the Jokes class
 
   j = Jokes()  # Initialise the class
-  j.get_joke()  # Retrieve a random joke
+  joke = j.get_joke(type="single", response_format="txt")  # Retrieve a random joke
+  print(joke)
 ```
 
 ### Parameters
@@ -129,15 +132,66 @@ If left blank it will default to `None`
 
 The range in which the selected joke should fall. ID's are decided by the order in which jokes are submitted.
 The argument passes should be in form of list or tuple, and should not exceed length of 2 items. First item
-should be minimum 0.
+should be minimum 0. Maximum value can be determined [here](https://sv443.net/jokeapi/v2/info)
 
 If left blank it will default to the maximum range.
 
 
 #### Example
 
 ```python
-  joke = get_joke(id_range=[10,100])  # Will return a joke with the ID between 10 and 100
+  joke = get_joke(id_range=[10,100])  # Will return a joke with the ID between 10 and 100.
+```
+
+---
+
+### auth_token
+
+A string token provided by the api owner. Using it will mean you are whitelisted by the api and can make
+more requests than normal users. Defaults to None
+
+
+#### Example
+
+```python
+  joke = get_joke(auth_token="aaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbb") # Will send the token to the api in a header.
+```
+
+---
+
+### user_agent
+
+A string sent the the api that tells the api what browser you are (pretending to be). The default user agent
+is Mozilla Firefox from Windows 10 and should work fine, but the functionality is provided in case you wish
+to change it
+
+
+#### Example
+
+```python
+  joke = get_joke(user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:77.0) Gecko/20100101 Firefox/77.0")
+  # This is in fact the default user agent, and tells the API that we are visitng the page from a Firefox 77.0
+  # browser using Windows 10 64bit.
+```
+
+---
+
+### return_headers
+
+A boolean value (True or False) that tells the wrapper if you wish to receive headers in the return from the function.
+Defaults to False.
+
+
+#### Example
+
+```python
+  response = get_joke(return_headers=True)
+  joke = response[0]
+  headers = response[1]
+  # The function returns the joke and then the headers using the "return x, y" syntax, so you can index it like a list or tuple.
+
+  print(f"Joke: {joke}")
+  print(f"Headers: {headers}")
 ```
 
 ---
@@ -151,7 +205,7 @@ Depending on what format is chosen different things will be returned.
 
 A succesful API call will return:
 
-```python
+```json
   {
       "category": "Miscellaneous",
       "type": "twopart",
@@ -228,16 +282,14 @@ He keeps dropping the database.
 
 The wrapper can raise multiple different errors depending on what you did wrong.
 
-### ValueErrors will always be raised with expected errors.
-
 The errors are descriptive enough that you should be able to solve them with the information provided in the error message.
 If not, feel free to ask me through one of the channels provided below.
 
 ---
 
 Developer contact:
 
-[Discord](https://discord.gg/mB989eP)
+![Discord](https://discord.com/assets/07dca80a102d4149e9736d4b162cff6f.ico)[**Discord**](https://discord.gg/mB989eP)
 
 [Issue Tracker](https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper/issues)
 

jokeapi/main.py

@@ -1,6 +1,7 @@
 import urllib3
 import urllib
-import json
+import simplejson as json
+import re
 
 
 class Jokes:
@@ -131,26 +132,39 @@ def build_request(
         return r
 
     def send_request(self, request, response_format, return_headers, auth_token, user_agent):
+        returns = []
+
         if auth_token:
             r = self.http.request('GET', request, headers={'Authorization': str(
                 auth_token), 'user-agent': str(user_agent)})
         else:
             r = self.http.request('GET', request, headers={'user-agent': str(user_agent)})
 
-        if return_headers:
-            if response_format == "json":
-                return r.data, r.headers
-            elif response_format == "xml":
-                return r.data, r.headers
-            else:
-                return r.data, r.headers
+        data = r.data
+
+        if response_format == "json":
+            try:
+                data = json.loads(data)
+            except:
+                print(data)
+                raise
         else:
-            if response_format == "json":
-                return r.data
-            elif response_format == "xml":
-                return r.data
-            else:
-                return r.data
+            data = str(data)[2:-1].replace(r'\n', '\n').replace('\\', '')
+            if len(' '.join(re.split("error", data.lower().replace("\n", "NEWLINECHAR"))[0:][1:]).replace(
+                    '<', '').replace('/', '').replace(' ', '').replace(':', '').replace('>', '').replace('NEWLINECHAR', '\n')) == 4:
+                return [Exception(f"API returned an error. Full response: \n\n {data}")]
+
+        headers = str(r.headers).replace(r'\n', '').replace(
+            '\n', '').replace(r'\\', '').replace(r"\'", '')[15:-1]
+
+        returns.append(data)
+        if return_headers:
+            returns.append(headers)
+
+        if auth_token:
+            returns.append({"Token-Valid": bool(int(re.split(r"Token-Valid", headers)[1][4]))})
+
+        return returns
 
     def get_joke(
         self,

requirements.txt

@@ -1,18 +1,3 @@
-attrs==19.3.0
-coverage==5.0.3
-entrypoints==0.3
-flake8==3.7.9
-mccabe==0.6.1
-more-itertools==8.2.0
-packaging==20.1
-pluggy==0.13.1
-py==1.8.1
-pycodestyle==2.5.0
-pyflakes==2.1.1
-pyparsing==2.4.6
-pytest==5.3.5
-pytest-cov==2.8.1
-six==1.14.0
-wcwidth==0.1.8
 urllib3==1.25.8
-python-dotenv
+simplejson==3.17.0
+python-dotenv==0.13.0

setup.py

@@ -6,15 +6,15 @@
 setuptools.setup(
     name="jokeapi",
     packages=["jokeapi"],
-    version="0.2.1",
+    version="0.2.3",
     license="GNU General Public License v3 (GPLv3)",
     description="An API Wrapper for Sv443's JokeAPI",
     long_description=long_description,
     long_description_content_type="text/markdown",
     author="thenamesweretakenalready",
     author_email="[email protected]",
     url="""https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper""",
-    download_url="https://github.com/user/Sv443s-JokeAPI-Python-Wrapper/archive/v0.1.5.tar.gz",
+    download_url="https://github.com/user/Sv443s-JokeAPI-Python-Wrapper/archive/v0.2.3.tar.gz",
     keywords=["api wrapper", "wrapper", "api", "jokes", "python", "joke api"],
     install_requires=setuptools.find_packages(),
     classifiers=[

test_main.py

@@ -1,6 +1,7 @@
 from os import getenv
 from jokeapi import Jokes
 from dotenv import load_dotenv
+import time
 load_dotenv()
 
 j = Jokes()
@@ -12,69 +13,83 @@
     j.get_joke()
 except Exception as e:
     errors.append({'Error in':  'blank joke get',  'Error': e})
+time.sleep(2)
 
 """Testing auth tokens"""
 try:
     j.get_joke(auth_token=token)
 except Exception as e:
     auth_token = None
     errors.append({'Error in':  'auth usage',  'Error': e})
+time.sleep(2)
 
 """Testing for errors in categories"""
 try:
     j.get_joke(category=["programming"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'category programming', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(category=["miscellaneous"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'category miscellaneous', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(category=["dark"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'category dark', 'Error': e})
+time.sleep(2)
 
 """Testing for errors in blacklist"""
 try:
     j.get_joke(blacklist=["nsfw"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist nsfw', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(blacklist=["religious"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist religious', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(blacklist=["political"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist political', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(blacklist=["racist"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist political', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(blacklist=["sexist"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist sexist',  'Error': e})
+time.sleep(2)
 
 """Testing for errors in response_format"""
 try:
     j.get_joke(response_format="xml", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'response_format xml', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(response_format="yaml", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'response_format yaml', 'Error': e})
+time.sleep(2)
 
 """Testing for errors in type"""
 try:
     j.get_joke(type="single", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'type single', 'Error': e})
+time.sleep(2)
 try:
     j.get_joke(type="twopart", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'type double', 'Error': e})
+time.sleep(2)
 
 """Testing for errors in search_string"""
 try:
@@ -83,12 +98,14 @@
     # it probably doesn't exist in a joke.
 except Exception as e:
     errors.append({'Error in': 'search_string', 'Error': e})
+time.sleep(2)
 
 """Testing for errors in id_range"""
 try:
     j.get_joke(id_range=[30, 151], auth_token=token)
 except Exception as e:
     errors.append({'Error in': 'id_range', 'Error': e})
+time.sleep(2)
 
 if len(errors):
     for e in errors: