Feature/removing raise for status and use request hooks (#36)

* removed all raise_for_status and added a common hook on request

* error handling

* improved overriding custom hooks

* added hooks to the request

* typo

* correct way to concat two lists

* avoid errors on 401

* removed default hook

pystackpath/__init__.py

@@ -1,13 +1,14 @@
-from requests import Session
+from requests import Session, HTTPError
 
 from .stacks import Stacks
 from .config import BASE_URL
 
 
 class OAuth2Session(Session):
-    def __init__(self, clientid, apisecret):
+    def __init__(self, clientid, apisecret, custom_hooks: list = []):
         self._clientid = clientid
         self._apisecret = apisecret
+        self._custom_hooks = custom_hooks
         self._token = ""
 
         super(OAuth2Session, self).__init__()
@@ -30,12 +31,25 @@ def _add_auth(self, kwargs):
         kwargs["headers"]["Authorization"] = "Bearer %s" % self._token
         return kwargs
 
+    def _add_hooks(self, kwargs):
+        if self._custom_hooks:
+            if not "hooks" in kwargs:
+                kwargs["hooks"] = dict()
+            if not "response" in kwargs["hooks"]:
+                kwargs["hooks"]["response"] = list()
+
+            kwargs["hooks"]["response"] = kwargs["hooks"]["response"] + self._custom_hooks
+
+        return kwargs
+
     def request(self, method, url, **kwargs):
         kwargs = self._add_auth(kwargs)
+        kwargs = self._add_hooks(kwargs)
         response = super(OAuth2Session, self).request(method, BASE_URL + url, **kwargs)
         if response.status_code == 401:
             self._refresh_token()
             kwargs = self._add_auth(kwargs)
+            kwargs = self._add_hooks(kwargs)
             response = super(OAuth2Session, self).request(method, BASE_URL + url, **kwargs)
         return response
 
@@ -46,13 +60,13 @@ class Stackpath(object):
 
     client = None
 
-    def __init__(self, clientid, apisecret):
+    def __init__(self, clientid, apisecret, custom_hooks: list = []):
         self._clientid = clientid
         self._apisecret = apisecret
-        self._init_client()
+        self._init_client(custom_hooks)
 
-    def _init_client(self):
-        self.client = OAuth2Session(self._clientid, self._apisecret)
+    def _init_client(self, custom_hooks):
+        self.client = OAuth2Session(self._clientid, self._apisecret, custom_hooks=custom_hooks)
 
     def stacks(self):
         return Stacks(self.client)

pystackpath/stacks/__init__.py

@@ -10,7 +10,6 @@ class Stacks(BaseObject):
     def index(self, first="", after="", filter="", sort_by=""):
         pagination = pagination_query(first=first, after=after, filter=filter, sort_by=sort_by)
         response = self._client.get("/stack/v1/stacks", params=pagination)
-        response.raise_for_status()
         items = []
         for item in response.json()["results"]:
             items.append(self.loaddict(item))
@@ -20,13 +19,11 @@ def index(self, first="", after="", filter="", sort_by=""):
 
     def get(self, stack_id):
         response = self._client.get(f"/stack/v1/stacks/{stack_id}")
-        response.raise_for_status()
         return self.loaddict(response.json())
 
     def create(self, accountid, name):
         response = self._client.post("/stack/v1/stacks",
                                      json={"accountId": accountid, "name": str(name)})
-        response.raise_for_status()
         return self.loaddict(response.json()["stack"])
 
     def add_subscriptions(self, subscriptions: list):
@@ -36,7 +33,6 @@ def add_subscriptions(self, subscriptions: list):
                 "productIds": subscriptions
             }
         )
-        response.raise_for_status()
         return self
 
     def cancel(self, reason_slug, reason_text=""):
@@ -59,7 +55,6 @@ def cancel(self, reason_slug, reason_text=""):
                 "reasonText": reason_text
             }
         )
-        response.raise_for_status()
         return self
 
     def purge(self, items: list) -> str:
@@ -73,7 +68,6 @@ def purge(self, items: list) -> str:
         }
 
         response = self._client.post(f"/cdn/v1/stacks/{self.id}/purge", json=data)
-        response.raise_for_status()
 
         return response.json()["id"]
 
@@ -84,7 +78,6 @@ def purge_status(self, purge_id) -> float:
         :return: The purge request's progress, ranging from 0.0 to 1.0.
         """
         response = self._client.get(f"/cdn/v1/stacks/{self.id}/purge/{purge_id}")
-        response.raise_for_status()
 
         return response.json()["progress"]
 

pystackpath/stacks/cdnsites/__init__.py

@@ -48,7 +48,6 @@ def disable(self):
         :return: a stackpath site object with the disabled cdn site
         """
         response = self._client.post(f"{self._base_api}/sites/{self.id}/disable")
-        response.raise_for_status()
         return self
 
     def enable(self):
@@ -57,7 +56,6 @@ def enable(self):
         :return: a stackpath site object with the enabled cdn site
         """
         response = self._client.post(f"{self._base_api}/sites/{self.id}/enable")
-        response.raise_for_status()
         return self
 
     def assign_certificate(self, certificate: Certificates):
@@ -67,7 +65,6 @@ def assign_certificate(self, certificate: Certificates):
         :return:
         """
         response = self._client.put(f"{self._base_api}/sites/{self.id}/certificates/{certificate.id}")
-        response.raise_for_status()
 
         certificate = Certificates(self._client, f"{self._base_api}/certificates")
         return certificate.loaddict(response.json()["siteCertificate"]["certificate"])

pystackpath/stacks/cdnsites/scopes/__init__.py

@@ -15,7 +15,6 @@ def index(self, first="", after="", filter="", sort_by="", disable_transparent_m
         }
         response = self._client.get(f"{self._base_api}/scopes",
                                     params={**pagination, **params})
-        response.raise_for_status()
         items = [self.loaddict(item) for item in response.json()["results"]]
         pageinfo = PageInfo(**response.json()["pageInfo"])
 
@@ -33,7 +32,6 @@ def create(self, **payload):
         String	path       The HTTP request path that is handled by a scope.
         """
         response = self._client.post(f"{self._base_api}/scopes", json=payload)
-        response.raise_for_status()
         return self.loaddict(response.json()["scope"])
 
     def delete(self):
@@ -42,7 +40,6 @@ def delete(self):
         :return: delivery domains configured on a site
         """
         response = self._client.delete(f"{self._base_api}/scopes/{self.id}")
-        response.raise_for_status()
         return self
 
     def configuration(self):

pystackpath/stacks/cdnsites/scopes/configuration.py

@@ -9,7 +9,6 @@ def get(self):
         :return: site's scope configuration
         """
         response = self._client.get(f"{self._base_api}/configuration")
-        response.raise_for_status()
         return self.loaddict(response.json()["configuration"])
 
     def update(self, **payload):
@@ -19,5 +18,4 @@ def update(self, **payload):
         :return: dict with new configuration
         """
         response = self._client.patch(f"{self._base_api}/configuration", data=json.dumps(payload))
-        response.raise_for_status()
         return self.loaddict(response.json()["configuration"])

pystackpath/stacks/cdnsites/scopes/origins.py

@@ -4,7 +4,6 @@
 class Origins(BaseObject):
     def index(self):
         response = self._client.get(f"{self._base_api}")
-        response.raise_for_status()
 
         items = list(map(lambda x: self.loaddict(x), response.json()["results"]))
         pageinfo = PageInfo(**response.json()["pageInfo"])
@@ -24,7 +23,6 @@ def create(self, **payload):
         Boolean	dedicated  Whether or not an origin is dedicated to a CDN site.
         """
         response = self._client.post(f"{self._base_api}", json=payload)
-        response.raise_for_status()
         return self.loaddict(response.json()["scopeOrigin"])
 
     def delete(self):
@@ -34,5 +32,4 @@ def delete(self):
         :return:
         """
         response = self._client.delete(f"{self._base_api}")
-        response.raise_for_status()
         return self

pystackpath/stacks/certificates.py

@@ -5,7 +5,6 @@ class Certificates(BaseObject):
     def index(self, first="", after="", filter="", sort_by=""):
         pagination = pagination_query(first=first, after=after, filter=filter, sort_by=sort_by)
         response = self._client.get(f"{self._base_api}/certificates", params=pagination)
-        response.raise_for_status()
 
         items = list(map(lambda x: self.loaddict(x), response.json()["results"]))
         pageinfo = PageInfo(**response.json()["pageInfo"])
@@ -14,7 +13,6 @@ def index(self, first="", after="", filter="", sort_by=""):
 
     def get(self, certificate_id: str):
         response = self._client.get(f"{self._base_api}/certificates/{certificate_id}")
-        response.raise_for_status()
 
         return self.loaddict(response.json()["certificate"])
 
@@ -26,13 +24,11 @@ def add(self, certificate_string: str, key_string: str, ca_bundle_string: str =
         }
 
         response = self._client.post(f"{self._base_api}/certificates", json=data)
-        response.raise_for_status()
 
         return self.loaddict(response.json()["certificate"])
 
     def delete(self):
         response = self._client.delete(f"{self._base_api}/certificates/{self.id}")
-        response.raise_for_status()
 
         return self
 
@@ -44,12 +40,10 @@ def update(self, certificate_string = None, key_string = None, ca_bundle_string:
         }
 
         response = self._client.put(f"{self._base_api}/certificates/{self.id}", json=data)
-        response.raise_for_status()
 
         return self.loaddict(response.json()["certificate"])
 
     def renew(self):
         response = self._client.post(f"{self._base_api}/certificates/{self.id}/renew")
-        response.raise_for_status()
 
         return self

pystackpath/stacks/deliverysites/__init__.py

@@ -39,7 +39,6 @@ def disable_cdn(self):
         :return: a stackpath site object with the disabled cdn site
         """
         response = self._client.delete(f"{self._base_api}/sites/{self.id}/cdn")
-        response.raise_for_status()
         return self
 
     def enable_cdn(self):
@@ -48,7 +47,6 @@ def enable_cdn(self):
         :return: a stackpath site object with the enabled cdn site
         """
         response = self._client.post(f"{self._base_api}/sites/{self.id}/cdn")
-        response.raise_for_status()
         return self
 
     def disable_waf(self):
@@ -57,7 +55,6 @@ def disable_waf(self):
         :return: a stackpath site object with the disabled waf site
         """
         response = self._client.delete(f"{self._base_api}/sites/{self.id}/waf")
-        response.raise_for_status()
         return self
 
     def enable_waf(self):
@@ -66,7 +63,6 @@ def enable_waf(self):
         :return: a stackpath site object with the enabled waf site
         """
         response = self._client.post(f"{self._base_api}/sites/{self.id}/waf")
-        response.raise_for_status()
         return self
 
     def disable_scripting(self):
@@ -75,7 +71,6 @@ def disable_scripting(self):
         :return: a stackpath site object with the disabled scripting site
         """
         response = self._client.delete(f"{self._base_api}/sites/{self.id}/scripting")
-        response.raise_for_status()
         return self
 
     def enable_scripting(self):
@@ -84,7 +79,6 @@ def enable_scripting(self):
         :return: a stackpath site object with the enabled scripting site
         """
         response = self._client.post(f"{self._base_api}/sites/{self.id}/scripting")
-        response.raise_for_status()
         return self
 
     def delivery_domains(self):

pystackpath/stacks/deliverysites/delivery_domain.py

@@ -10,7 +10,6 @@ def index(self, first="", after="", filter="", sort_by=""):
         pagination = pagination_query(first=first, after=after, filter=filter, sort_by=sort_by)
         response = self._client.get(f"{self._base_api}/delivery_domains",
                                     params=pagination)
-        response.raise_for_status()
         items = [self.loaddict(item) for item in response.json()["results"]]
         pageinfo = PageInfo(**response.json()["pageInfo"])
 
@@ -24,7 +23,6 @@ def create(self, **payload):
         String	domain     An individual delivery domain.
         """
         response = self._client.post(f"{self._base_api}/delivery_domains", json=payload)
-        response.raise_for_status()
         return self.loaddict(response.json()["domain"])
 
     def delete(self):
@@ -33,5 +31,4 @@ def delete(self):
         :return: delivery domains configured on a site
         """
         response = self._client.delete(f"{self._base_api}/delivery_domains/{self.domain}")
-        response.raise_for_status()
         return self

pystackpath/stacks/metrics.py

@@ -37,6 +37,5 @@ def get(self, start_date: dt = None, end_date: dt = None, granularity="AUTO",
                 "site_type_filter": site_type_filter
             }
         )
-        response.raise_for_status()
 
         return self.loaddict(response.json())

pystackpath/stacks/wafsites/ddos.py

@@ -5,7 +5,6 @@
 class Ddos(BaseObject):
     def get(self):
         response = self._client.get(f"{self._base_api}/ddos")
-        response.raise_for_status()
         return self.loaddict(response.json()["ddosSettings"])
 
     def update(self, **payload):
@@ -15,5 +14,4 @@ def update(self, **payload):
         :return: dict with new rule
         """
         response = self._client.patch(f"{self._base_api}/ddos", data=json.dumps(payload))
-        response.raise_for_status()
         return self.loaddict(response.json()["ddosSettings"])

pystackpath/stacks/wafsites/rules.py

@@ -11,15 +11,13 @@ def index(self, first="", after="", filter="", sort_by=""):
         pagination = pagination_query(first=first, after=after, filter=filter, sort_by=sort_by)
         response = self._client.get(f"{self._base_api}/rules",
                                     params=pagination)
-        response.raise_for_status()
         items = [self.loaddict(item) for item in response.json()["rules"]]
         pageinfo = PageInfo(**response.json()["pageInfo"])
 
         return {"results": items, "pageinfo": pageinfo}
 
     def get(self, rule_id):
         response = self._client.get(f"{self._base_api}/rules/{rule_id}")
-        response.raise_for_status()
         return self.loaddict(response.json()["rule"])
 
     def create(self, **payload):
@@ -29,7 +27,6 @@ def create(self, **payload):
         :return: dict with created rule
         """
         response = self._client.post(f"{self._base_api}/rules", json=payload)
-        response.raise_for_status()
         return self.loaddict(response.json()["rule"])
 
     def update(self, **payload):
@@ -39,7 +36,6 @@ def update(self, **payload):
         :return: dict with new rule
         """
         response = self._client.patch(f"{self._base_api}/rules/{self.id}", data=json.dumps(payload))
-        response.raise_for_status()
         return self.loaddict(response.json()["rule"])
 
     def delete(self):
@@ -48,7 +44,6 @@ def delete(self):
         :return: waf rule configured on a site
         """
         response = self._client.delete(f"{self._base_api}/rules/{self.id}")
-        response.raise_for_status()
         return self
 
     def bulk_delete(self, ruleIds: list):
@@ -57,20 +52,17 @@ def bulk_delete(self, ruleIds: list):
         :param ruleIds: The IDs of the rules to delete.
         """
         response = self._client.post(f"{self._base_api}/rules/bulk_delete", data=json.dumps(dict(ruleIds=ruleIds)))
-        response.raise_for_status()
 
     def enable(self):
         """
         Enable a WAF rule
         :param rule_id: The ID of the rule to enable
         """
         response = self._client.post(f"{self._base_api}/rules/{self.id}/enable")
-        response.raise_for_status()
 
     def disable(self):
         """
         Disable a WAF rule
         :param rule_id: The ID of the rule to disable
         """
         response = self._client.post(f"{self._base_api}/rules/{self.id}/disable")
-        response.raise_for_status()