feat(client): save app and secrets engine version

Author: Jeremy Desanlis

pygitguardian/client.py

@@ -10,7 +10,22 @@
  DEFAULT_TIMEOUT,
  MULTI_DOCUMENT_LIMIT,
 )
-from .models import Detail, Document, MultiScanResult, QuotaResponse, ScanResult
+from .models import (
+ Detail,
+ Document,
+ HealthCheckResponse,
+ MultiScanResult,
+ QuotaResponse,
+ ScanResult,
+)
+
+
+class Versions:
+ app_version: Optional[str] = None
+ secrets_engine_version: Optional[str] = None
+
+
+VERSIONS = Versions()
 
 
 def load_detail(resp: Response) -> Detail:
@@ -111,16 +126,47 @@ def request(
  if extra_headers
  else self.session.headers
  )
- return self.session.request(
+ response: Response = self.session.request(
  method=method, url=url, timeout=self.timeout, headers=headers, **kwargs
  )
 
+ self.app_version = response.headers.get("X-App-Version", self.app_version)
+ self.secrets_engine_version = response.headers.get(
+ "X-Secrets-Engine-Version", self.secrets_engine_version
+ )
+
+ return response
+
  def _url_from_endpoint(self, endpoint: str, version: Optional[str]) -> str:
  if version:
  endpoint = urllib.parse.urljoin(version + "/", endpoint)
 
  return urllib.parse.urljoin(self.base_uri + "/", endpoint)
 
+ @property
+ def app_version(self) -> Optional[str]:
+ global VERSIONS
+
+ return VERSIONS.app_version
+
+ @app_version.setter
+ def app_version(self, value: Optional[str]):
+ global VERSIONS
+
+ VERSIONS.app_version = value
+
+ @property
+ def secrets_engine_version(self) -> Optional[str]:
+ global VERSIONS
+
+ return VERSIONS.secrets_engine_version
+
+ @secrets_engine_version.setter
+ def secrets_engine_version(self, value: Optional[str]):
+ global VERSIONS
+
+ VERSIONS.secrets_engine_version = value
+
  def get(
  self,
  endpoint: str,
@@ -153,7 +199,7 @@ def post(
  **kwargs,
  )
 
- def health_check(self) -> Detail:
+ def health_check(self) -> HealthCheckResponse:
  """
  health_check handles the /health endpoint of the API
 
@@ -164,10 +210,12 @@ def health_check(self) -> Detail:
  """
  resp = self.get(endpoint="health")
 
- obj = load_detail(resp)
- obj.status_code = resp.status_code
-
- return obj
+ return HealthCheckResponse(
+ detail=load_detail(resp).detail,
+ status_code=resp.status_code,
+ app_version=self.app_version,
+ secrets_engine_version=self.secrets_engine_version,
+ )
 
  def content_scan(
  self,

pygitguardian/models.py

@@ -420,7 +420,9 @@ def __repr__(self):
  "count:{0}, "
  "limit:{1}, "
  "remaining:{2}, "
- "since:{3}".format(self.count, self.limit, self.remaining, self.since.isoformat())
+ "since:{3}".format(
+ self.count, self.limit, self.remaining, self.since.isoformat()
+ )
  )
 
 
@@ -452,3 +454,41 @@ def __init__(self, content: Quota, **kwargs):
 
  def __repr__(self):
  return "content:{0}".format(repr(self.content))
+
+
+class HealthCheckResponseSchema(BaseSchema):
+ detail = fields.String(allow_none=False)
+ status_code = fields.Int(allow_none=False)
+ app_version = fields.String(allow_none=True)
+ secrets_engine_version = fields.String(allow_none=True)
+
+
+class HealthCheckResponse(Base):
+ SCHEMA = HealthCheckResponseSchema()
+
+ def __init__(
+ self,
+ detail: str,
+ status_code: int,
+ app_version: Optional[str],
+ secrets_engine_version: Optional[str],
+ **kwargs,
+ ):
+ super().__init__()
+ self.detail = detail
+ self.status_code = status_code
+ self.app_version = app_version
+ self.secrets_engine_version = secrets_engine_version
+
+ def __repr__(self):
+ return (
+ "detail:{0}, "
+ "status_code:{1}, "
+ "app version:{2}, "
+ "secrets engine version:{3}".format(
+ self.detail,
+ self.status_code,
+ self.app_version or "",
+ self.secrets_engine_version or "",
+ )
+ )

tests/cassettes/filename.yaml

@@ -38,6 +38,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK
@@ -80,6 +84,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/filename_secret.yaml

@@ -43,6 +43,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK
@@ -90,6 +94,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/max_size_array.yaml

@@ -67,6 +67,10 @@ interactions:
  - DENY
  content-length:
  - "2141"
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK
@@ -138,6 +142,10 @@ interactions:
  - DENY
  content-length:
  - "2141"
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/no_breaks.yaml

@@ -38,6 +38,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK
@@ -80,6 +84,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/quota.yaml

@@ -32,6 +32,10 @@ interactions:
  - nginx
  Strict-Transport-Security:
  - max-age=31536000; includeSubDomains
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/secret.yaml

@@ -42,6 +42,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK
@@ -88,6 +92,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/test_assert_content_type.yaml

@@ -309,6 +309,10 @@ interactions:
  - Tue, 16 Jun 2020 12:37:49 GMT
  Server:
  - nginx
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK
@@ -622,6 +626,10 @@ interactions:
  - Tue, 16 Jun 2020 12:37:49 GMT
  Server:
  - nginx
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 200
  message: OK

tests/cassettes/test_content_not_ok.yaml

@@ -40,6 +40,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 401
  message: Unauthorized
@@ -84,6 +88,10 @@ interactions:
  - nosniff
  X-Frame-Options:
  - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
  status:
  code: 401
  message: Unauthorized