➕🐛📝 Fix serialisation, error checking for resp.

Author: benjhar

README.md

@@ -15,7 +15,11 @@ You can install jokeapi through [pip](https://pypi.org/project/pip/) by using `p
 # 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
 
 ---
 
@@ -201,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",
@@ -278,8 +282,6 @@ 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.
 

jokeapi/main.py

@@ -1,6 +1,7 @@
 import urllib3
 import urllib
-import json
+import simplejson as json
+import re
 
 
 class Jokes:
@@ -139,14 +140,29 @@ def send_request(self, request, response_format, return_headers, auth_token, use
         else:
             r = self.http.request('GET', request, headers={'user-agent': str(user_agent)})
 
-        headers = r.headers
-        returns.append(r.data)
+        data = r.data
 
+        if response_format == "json":
+            try:
+                data = json.loads(data)
+            except:
+                print(data)
+                raise
+        else:
+            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 not headers["Token-Valid"]:
-            returns.append({"Token-Valid": False})
+        if auth_token:
+            returns.append({"Token-Valid": bool(int(re.split(r"Token-Valid", headers)[1][4]))})
 
         return returns
 

requirements.txt

@@ -1,17 +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
+simplejson==3.17.0
+python-dotenv==0.13.0

setup.py

@@ -6,15 +6,15 @@
 setuptools.setup(
     name="jokeapi",
     packages=["jokeapi"],
-    version="0.2.2",
+    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.2.2.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: