fix(detail): convert error to detail

Author: jguerreiro

Pipfile.lock

@@ -1,12 +1,13 @@
 from datetime import date
-from typing import ClassVar, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List, Optional
 
 from marshmallow import (
     EXCLUDE,
     Schema,
     ValidationError,
     fields,
     post_load,
+    pre_load,
     validate,
     validates,
 )
@@ -91,6 +92,14 @@ def __repr__(self):
 class DetailSchema(Schema):
     detail = fields.String(required=True)
 
+    @pre_load
+    def rename_errors(self, data: Dict, many: bool, **kwargs: Any) -> Dict:
+        error = data.pop("error", None)
+        if error is not None:
+            data["detail"] = str(error)
+
+        return data
+
     @post_load
     def make_detail_response(self, data, **kwargs):
         return Detail(**data)

pygitguardian/models.py

@@ -0,0 +1,78 @@
+interactions:
+  - request:
+      body: null
+      headers:
+        Accept:
+          - "*/*"
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        User-Agent:
+          - pygitguardian/1.1.0 (Linux;py3.8.3)
+      method: GET
+      uri: https://api.gitguardian.com/v1/health
+    response:
+      body:
+        string: '{"error":"Configuration error."}'
+      headers:
+        Allow:
+          - OPTIONS, GET
+        Connection:
+          - keep-alive
+        Content-Length:
+          - "27"
+        Content-Type:
+          - application/json
+        Date:
+          - Fri, 19 Jun 2020 13:32:39 GMT
+        Server:
+          - nginx
+        Vary:
+          - Cookie
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+      status:
+        code: 400
+        message: OK
+  - request:
+      body: null
+      headers:
+        Accept:
+          - "*/*"
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        User-Agent:
+          - pygitguardian/1.1.0 (Linux;py3.8.3)
+      method: GET
+      uri: https://api.gitguardian.com/v1/health
+    response:
+      body:
+        string: '{"detail":"Valid API key."}'
+      headers:
+        Allow:
+          - OPTIONS, GET
+        Connection:
+          - keep-alive
+        Content-Length:
+          - "27"
+        Content-Type:
+          - application/json
+        Date:
+          - Fri, 19 Jun 2020 14:58:35 GMT
+        Server:
+          - nginx
+        Vary:
+          - Cookie
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+      status:
+        code: 200
+        message: OK
+version: 1

tests/cassettes/test_health_check_error.yaml

@@ -276,6 +276,19 @@ def test_health_check(client: GGClient):
     assert type(health.to_json()) == str
 
 
+@my_vcr.use_cassette
+def test_health_check_error(client: GGClient):
+    health = client.health_check()
+    assert health.status_code == 400
+    assert health.detail == "Configuration error."
+    assert str(health) == "400:Configuration error."
+    assert bool(health) is False
+    assert health.success is False
+
+    assert type(health.to_dict()) == dict
+    assert type(health.to_json()) == str
+
+
 @pytest.mark.parametrize(
     "name, to_scan, expected, has_secrets, has_policy_breaks",
     [