Merge pull request #16 from ScrapingAnt/feature/issue14-handle-423-status-code

feature/issue14-handle-423-status-code: done

Author: megabotan

README.md

@@ -86,6 +86,7 @@ Class defining response from API.
 | ScrapingantInvalidInputException | Invalid value provided. Please, look into error message for more info |
 | ScrapingantInternalException | Something went wrong with the server side code. Try again later or contact ScrapingAnt support |
 | ScrapingantSiteNotReachableException | The requested URL is not reachable. Please, check it locally |
+| ScrapingantDetectedException | The anti-bot detection system has detected the request. Please, retry or change the request settings. |
 
 * * *
 

scrapingant_client/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.4"
+__version__ = "0.3.5"
 
 from scrapingant_client.client import ScrapingAntClient
 from scrapingant_client.cookie import Cookie
@@ -8,6 +8,7 @@
     ScrapingantInvalidInputException,
     ScrapingantInternalException,
     ScrapingantSiteNotReachableException,
+    ScrapingantDetectedException,
 )
 from scrapingant_client.response import Response
 
@@ -19,5 +20,6 @@
     'ScrapingantInvalidInputException',
     'ScrapingantInternalException',
     'ScrapingantSiteNotReachableException',
+    'ScrapingantDetectedException',
     'Response',
 ]

scrapingant_client/client.py

@@ -12,6 +12,7 @@
     ScrapingantInvalidInputException,
     ScrapingantInternalException,
     ScrapingantSiteNotReachableException,
+    ScrapingantDetectedException,
 )
 from scrapingant_client.response import Response
 from scrapingant_client.utils import base64_encode_string
@@ -53,10 +54,12 @@ def general_request(
         )
         if response.status_code == 403:
             raise ScrapingantInvalidTokenException()
-        elif response.status_code == 422:
-            raise ScrapingantInvalidInputException(response.text)
         elif response.status_code == 404:
             raise ScrapingantSiteNotReachableException(url)
+        elif response.status_code == 422:
+            raise ScrapingantInvalidInputException(response.text)
+        elif response.status_code == 423:
+            raise ScrapingantDetectedException()
         elif response.status_code == 500:
             raise ScrapingantInternalException()
         json_response = response.json()

scrapingant_client/errors.py

@@ -19,6 +19,13 @@ def __init__(self, url):
         super().__init__(message)
 
 
+class ScrapingantDetectedException(ScrapingantClientException):
+    def __init__(self):
+        message = 'The anti-bot detection system has detected the request. ' \
+                  'Please, retry or change the request settings.'
+        super().__init__(message)
+
+
 class ScrapingantInternalException(ScrapingantClientException):
     def __init__(self):
         message = 'Something went wrong with the server side. Please try later or contact support'

tests/test_exceptions.py

@@ -7,6 +7,7 @@
     ScrapingantInvalidInputException,
     ScrapingantInternalException,
     ScrapingantSiteNotReachableException,
+    ScrapingantDetectedException,
 )
 from scrapingant_client.constants import SCRAPINGANT_API_BASE_URL
 
@@ -47,3 +48,13 @@ def test_not_reachable():
     with pytest.raises(ScrapingantSiteNotReachableException) as e:
         client.general_request('example.com')
     assert 'The requested URL is not reachable (example.com)' in str(e)
+
+
+@responses.activate
+def test_detected():
+    responses.add(responses.POST, SCRAPINGANT_API_BASE_URL + '/general',
+                  json={}, status=423)
+    client = ScrapingAntClient(token='some_token')
+    with pytest.raises(ScrapingantDetectedException) as e:
+        client.general_request('example.com')
+    assert 'The anti-bot detection system has detected the request' in str(e)