feat(pygitguardian): add has_policy_breaks and port to pytest

fix(readme): fix readme badges

fix(readme): remove \n between badges

fix(models): fix small documentation typos

fix(readme): fix readme link

Author: jguerreiro

.github/workflows/test-lint.yml

@@ -45,7 +45,7 @@ jobs:
           pipenv install --system --dev --skip-lock
       - name: Test with pytest
         run: |
-          pipenv run coverage run --source pygitguardian -m nose tests
+          pipenv run coverage run --source pygitguardian -m pytest --disable-pytest-warnings
           pipenv run coverage report --fail-under=80
           pipenv run coverage xml
       - uses: codecov/codecov-action@v1

.gitignore

@@ -115,6 +115,9 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 
+# Pylinting
+.mypy_cache
+
 # Catch sensitive files
 .env
 secrets.py

CONTRIBUTING.md

@@ -23,7 +23,7 @@ pipenv run pre-commit install -f --hook-type commit-msg --hook-type pre-commit
 
 ## Testing
 
-Pygitguardian testing is done with `nosetest`. You should make sure your changes don't report any error on
+Pygitguardian testing is done with `pytest`. You should make sure your changes don't report any error on:
 
 ```
 make test

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 gg-code / prm
+Copyright (c) 2020 GitGuardian
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -13,10 +13,10 @@ all:
 	echo "      make isort"          # Run isort linter on python code
 
 test:
-	pipenv run nosetests $(test)
+	pipenv run pytest --disable-pytest-warnings -vvv $(test)
 
 coverage:
-	pipenv run coverage run --source pygitguardian -m nose tests && pipenv run coverage report --fail-under=80
+	pipenv run coverage run --source pygitguardian -m pytest --disable-pytest-warnings && pipenv run coverage report --fail-under=80
 
 black:
 	pipenv run black --config black.toml .

Pipfile

@@ -13,7 +13,6 @@ flake8 = "*"
 flake8-isort = "*"
 ipython = "*"
 isort = "*"
-nose = "*"
 pre-commit = "*"
+pytest = "*"
 vcrpy = "*"
-vcrpy-unittest = "*"

README.md

@@ -1,13 +1,13 @@
-<img src="https://cdn.jsdelivr.net/gh/gitguardian/py-gitguardian/doc/logo.svg">
+<a href="https://gitguardian.com/"><img src="https://cdn.jsdelivr.net/gh/gitguardian/py-gitguardian/doc/logo.svg"></a>
 
-# GitGuardian API Client
+# [py-gitguardian](https://github.com/GitGuardian/py-gitguardian) - GitGuardian API Client
 
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/GitGuardian/py-gitguardian/Main?color=%231B2D55&style=for-the-badge)
-![PyPI](https://img.shields.io/pypi/v/pygitguardian?color=%231B2D55&style=for-the-badge)
-![GitHub](https://img.shields.io/github/license/GitGuardian/py-gitguardian?color=%231B2D55&style=for-the-badge)
-![GitHub stars](https://img.shields.io/github/stars/gitguardian/py-gitguardian?color=%231B2D55&style=for-the-badge)
-![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/gitguardian/py-gitguardian?color=%231B2D55&style=for-the-badge)
-![Codecov](https://img.shields.io/codecov/c/github/GitGuardian/py-gitguardian?color=%231B2D55&style=for-the-badge)
+[![PyPI](https://img.shields.io/pypi/v/pygitguardian?color=%231B2D55&style=for-the-badge)](https://pypi.org/project/pygitguardian/)
+[![License](https://img.shields.io/github/license/GitGuardian/py-gitguardian?color=%231B2D55&style=for-the-badge)](LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/gitguardian/py-gitguardian?color=%231B2D55&style=for-the-badge)](https://github.com/GitGuardian/py-gitguardian/stargazers)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/GitGuardian/py-gitguardian/Main?style=for-the-badge)
+[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/gitguardian/py-gitguardian?style=for-the-badge)](https://www.codefactor.io/repository/github/gitguardian/py-gitguardian)
+[![Codecov](https://img.shields.io/codecov/c/github/GitGuardian/py-gitguardian?style=for-the-badge)](https://codecov.io/gh/GitGuardian/py-gitguardian/)
 
 API client library for the [GitGuardian API](https://api.gitguardian.com/).
 

pygitguardian/__init__.py

@@ -2,7 +2,7 @@
 from .client import GGClient
 
 
-__version__ = "1.0.4"
+__version__ = "1.1.0"
 GGClient._version = __version__
 
 __all__ = [

pygitguardian/client.py

@@ -1,6 +1,6 @@
 import platform
 import urllib.parse
-from typing import Dict, Iterable, Optional, Union
+from typing import Dict, List, Optional, Union
 
 import requests
 from requests import Response, Session, codes
@@ -24,7 +24,7 @@ def __init__(
         session: Optional[requests.Session] = None,
         user_agent: Optional[str] = None,
         timeout: Optional[float] = DEFAULT_TIMEOUT,
-    ) -> "GGClient":
+    ):
         """
         :param api_key: API Key to be added to requests
         :param base_uri: Base URI for the API, defaults to "https://api.gitguardian.com"
@@ -65,7 +65,11 @@ def __init__(
         )
 
     def request(
-        self, method: str, endpoint: str, version: str = DEFAULT_API_VERSION, **kwargs
+        self,
+        method: str,
+        endpoint: str,
+        version: Optional[str] = DEFAULT_API_VERSION,
+        **kwargs
     ) -> Response:
         if version:
             endpoint = urllib.parse.urljoin(version + "/", endpoint)
@@ -93,7 +97,7 @@ def post(
         )
 
     def get(
-        self, endpoint: str, version: str = DEFAULT_API_VERSION, **kwargs
+        self, endpoint: str, version: Optional[str] = DEFAULT_API_VERSION, **kwargs
     ) -> Response:
         return self.request(method="get", endpoint=endpoint, version=version, **kwargs)
 
@@ -141,7 +145,7 @@ def content_scan(
         return obj
 
     def multi_content_scan(
-        self, documents: Iterable[Dict[str, str]],
+        self, documents: List[Dict[str, str]],
     ) -> Union[Detail, MultiScanResult]:
         """
         multi_content_scan handles the /multiscan endpoint of the API

pygitguardian/models.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Optional
+from typing import ClassVar, Dict, List, Optional
 
 from marshmallow import (
     EXCLUDE,
@@ -14,7 +14,7 @@
 
 
 class Base:
-    SCHEMA = None
+    SCHEMA: ClassVar[Schema]
 
     def __init__(self):
         self.status_code = None
@@ -204,6 +204,10 @@ def __init__(self, break_type: str, policy: str, matches: List[Match], **kwargs)
         self.policy = policy
         self.matches = matches
 
+    @property
+    def is_secret(self) -> bool:
+        return self.policy == "Secrets detection"
+
     def __repr__(self):
         return (
             "break_type:{0}, "
@@ -255,19 +259,29 @@ def __init__(
         self.policy_breaks = policy_breaks
 
     @property
-    def has_secrets(self) -> bool:
+    def has_policy_breaks(self) -> bool:
         """has_secrets is an easy way to check if your provided document has policy breaks
 
         >>> obj = ScanResult(2, [], [])
-        >>> obj.has_secrets
+        >>> obj.has_policy_breaks
         True
 
-        :return: true if there were policy breaks in the documents
+        :return: true if there were policy breaks (including secrets) in the document
         :rtype: bool
         """
 
         return self.policy_break_count > 0
 
+    @property
+    def has_secrets(self) -> bool:
+        """has_secrets is an easy way to check if your provided document has secrets
+
+        :return: true if there were secrets in the document
+        :rtype: bool
+        """
+
+        return any(policy_break.is_secret for policy_break in self.policy_breaks)
+
     def __repr__(self):
         return (
             "policy_break_count:{0}, "
@@ -280,7 +294,7 @@ def __repr__(self):
     def __str__(self):
         return "{0} policy breaks from the evaluated policies: {1}".format(
             self.policy_break_count,
-            ", ".join([policy_break.policy for policy_break in self.policy_breaks]),
+            ", ".join(policy_break.policy for policy_break in self.policy_breaks),
         )
 
 
@@ -316,20 +330,28 @@ def __init__(self, scan_results: List[ScanResult], **kwargs):
         self.scan_results = scan_results
 
     @property
-    def has_secrets(self) -> bool:
-        """has_secrets is an easy way to check if your provided document has policy breaks
+    def has_policy_breaks(self) -> bool:
+        """has_policy_breaks is an easy way to check if your provided document has policy breaks
 
         >>> obj = ScanResult(2, [], [])
-        >>> obj.has_secrets
+        >>> obj.has_policy_breaks
         True
 
-        :return: true if there were policy breaks in the documents
+        :return: true if there were policy breaks (including secrets) in the documents
         :rtype: bool
         """
 
-        return any(
-            (len(scan_result.policy_breaks) > 0 for scan_result in self.scan_results)
-        )
+        return any(scan_result.has_policy_breaks for scan_result in self.scan_results)
+
+    @property
+    def has_secrets(self) -> bool:
+        """has_secrets is an easy way to check if your provided document has secrets
+
+        :return: true if there were secrets in the documents
+        :rtype: bool
+        """
+
+        return any(scan_result.has_secrets for scan_result in self.scan_results)
 
     def __repr__(self):
         return "scan_results:{0}".format(self.scan_results)

setup.cfg

@@ -7,12 +7,8 @@ max-line-length = 120
 line_length=88
 lines_after_imports=2
 multi_line_output=3
-known_third_party=marshmallow,requests,setuptools,vcr_unittest
+known_third_party=marshmallow,pytest,requests,setuptools,vcr
 include_trailing_comma=true
 
 [metadata]
 description-file = README.md
-
-[nosetests]
-verbosity=2
-with-doctest=1