Merge pull request #47 from fossology/feat/support-1.1.1

Feat/support 1.1.1

Author: deveaud-m

.github/workflows/staticchecks.yml

@@ -11,7 +11,6 @@ jobs:
     strategy:
       matrix:
         container:
-        - 'python:3.6-slim'
         - 'python:3.7-slim'
         - 'python:3.8-slim'
         - 'python:3.9-slim'

README.rst

@@ -6,7 +6,7 @@
 .. |PyPI Version| image:: https://badge.fury.io/py/fossology.svg
    :target: https://pypi.org/project/fossology
 
-.. |Python Version| image:: https://img.shields.io/badge/python-3.6%2C3.7%2C3.8-blue?logo=python
+.. |Python Version| image:: https://img.shields.io/badge/python-3.7%2C3.8%2C3.9-blue?logo=python
    :target: https://www.python.org/doc/versions/
 
 .. |Static Checks| image:: https://github.com/deveaud-m/fossology-python/workflows/Static%20Checks/badge.svg
@@ -22,7 +22,7 @@ A simple wrapper for the Fossology REST API.
 
 See `the OpenAPI specification <https://raw.githubusercontent.com/fossology/fossology/master/src/www/ui/api/documentation/openapi.yaml>`_ used to implement this library.
 
-   Compatible with API version 1.1.0
+   Compatible with API version 1.1.1
 
 Documentation
 =============
@@ -91,7 +91,7 @@ Develop
    `docstrings <https://realpython.com/documenting-python-code/>`__ to
    document functions and classes
 
--  Don't forget to extend the minimal `testsuite <test.py>`_ with the
+-  Extend the testsuite `poetry run pytest`_ with the
    new functions/classes
 
 -  The **documentation website** can automatically be generated by the `Sphinx autodoc

docs-source/conf.py

@@ -20,10 +20,10 @@
 # -- Project information -----------------------------------------------------
 
 project = "fossology"
-copyright = "2020, Siemens AG"
+copyright = "2021, Siemens AG"
 
 # The full version, including major/minor/patch tags
-release = "0.2.0"
+release = "1.0.0"
 
 
 # -- General configuration ---------------------------------------------------

fossology/__init__.py

@@ -1,13 +1,21 @@
-# Copyright 2019-2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 import re
 import logging
 import requests
 from datetime import date, timedelta
 
-from typing import List
-from fossology.obj import Agents, User, File, TokenScope, SearchTypes, get_options
+from typing import Dict, List
+from fossology.obj import (
+    Agents,
+    Upload,
+    User,
+    File,
+    TokenScope,
+    SearchTypes,
+    get_options,
+)
 from fossology.folders import Folders
 from fossology.uploads import Uploads
 from fossology.jobs import Jobs
@@ -22,6 +30,37 @@
 logger.setLevel(logging.DEBUG)
 
 
+def search_headers(
+    searchType: SearchTypes = SearchTypes.ALLFILES,
+    upload: Upload = None,
+    filename: str = None,
+    tag: str = None,
+    filesizemin: int = None,
+    filesizemax: int = None,
+    license: str = None,
+    copyright: str = None,
+    group: str = None,
+) -> Dict:
+    headers = {"searchType": searchType.value}
+    if upload:
+        headers["uploadId"] = str(upload.id)
+    if filename:
+        headers["filename"] = filename
+    if tag:
+        headers["tag"] = tag
+    if filesizemin:
+        headers["filesizemin"] = filesizemin
+    if filesizemax:
+        headers["filesizemax"] = filesizemax
+    if license:
+        headers["license"] = license
+    if copyright:
+        headers["copyright"] = copyright
+    if group:
+        headers["groupName"] = group
+    return headers
+
+
 def fossology_token(
     url, username, password, token_name, token_scope=TokenScope.READ, token_expire=None
 ):
@@ -50,6 +89,8 @@ def fossology_token(
     :type expire: string, e.g. 2019-12-25
     :return: the new token
     :rtype: string
+    :raises AuthenticationError: if the username or password is incorrect
+    :raises FossologyApiError: if another error occurs
     """
     data = {
         "username": username,
@@ -67,6 +108,9 @@ def fossology_token(
         if response.status_code == 201:
             token = response.json()["Authorization"]
             return re.sub("Bearer ", "", token)
+        elif response.status_code == 404:
+            description = "Authentication error"
+            raise AuthenticationError(description, response)
         else:
             description = "Error while generating new token"
             raise FossologyApiError(description, response)
@@ -131,8 +175,8 @@ def _auth(self):
             if user.name == self.name:
                 self.user = user
                 return self.user
-        logger.error(f"User {self.name} was not found")
-        raise AuthenticationError(self.host)
+        description = f"User {self.name} was not found on {self.host}"
+        raise AuthenticationError(description)
 
     def close(self):
         self.session.close()
@@ -222,28 +266,31 @@ def delete_user(self, user):
 
     def search(
         self,
-        searchType=SearchTypes.ALLFILES,
-        filename=None,
-        tag=None,
-        filesizemin=None,
-        filesizemax=None,
-        license=None,
-        copyright=None,
-        group=None,
+        searchType: SearchTypes = SearchTypes.ALLFILES,
+        upload: Upload = None,
+        filename: str = None,
+        tag: str = None,
+        filesizemin: int = None,
+        filesizemax: int = None,
+        license: str = None,
+        copyright: str = None,
+        group: str = None,
     ):
         """Search for a specific file
 
         API Endpoint: GET /search
 
         :param searchType: Limit search to: directory, allfiles (default), containers
+        :param upload: Limit search to a specific upload
         :param filename: Filename to find, can contain % as wild-card
         :param tag: tag to find
         :param filesizemin: Min filesize in bytes
         :param filesizemax: Max filesize in bytes
         :param license: License search filter
         :param copyright: Copyright search filter
         :param group: the group name to choose while performing search (default: None)
-        :type searchType: SearchType Enum
+        :type searchType: one of SearchTypes Enum
+        :type upload: Upload
         :type filename: string
         :type tag: string
         :type filesizemin: int
@@ -256,22 +303,17 @@ def search(
         :raises FossologyApiError: if the REST call failed
         :raises AuthorizationError: if the user can't access the group
         """
-        headers = {"searchType": searchType.value}
-        if filename:
-            headers["filename"] = filename
-        if tag:
-            headers["tag"] = tag
-        if filesizemin:
-            headers["filesizemin"] = filesizemin
-        if filesizemax:
-            headers["filesizemax"] = filesizemax
-        if license:
-            headers["license"] = license
-        if copyright:
-            headers["copyright"] = copyright
-        if group:
-            headers["groupName"] = group
-
+        headers = search_headers(
+            searchType,
+            upload,
+            filename,
+            tag,
+            filesizemin,
+            filesizemax,
+            license,
+            copyright,
+            group,
+        )
         response = self.session.get(f"{self.api}/search", headers=headers)
 
         if response.status_code == 200:
@@ -294,7 +336,7 @@ def filesearch(
 
         The response does not generate Python objects yet, the plain JSON data is simply returned.
 
-        :param filelist: the list of files (or containers) to search for (default: [])
+        :param filelist: the list of files (or containers) hashes to search for (default: [])
         :param group: the group name to choose while performing search (default: None)
         :type filelist: list
         :return: list of items corresponding to the search criteria

fossology/exceptions.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 from json.decoder import JSONDecodeError
@@ -13,12 +13,15 @@ class Error(Exception):
 class AuthenticationError(Error):
     """Authentication error"""
 
-    def __init__(self, url):
-        self.url = url
-        self.message = (
-            f"An error occurred during authentication against {self.url}\n"
-            f"Check your API Token and try again"
-        )
+    def __init__(self, description, response=None):
+        if response:
+            try:
+                message = response.json().get("message")
+            except JSONDecodeError:
+                message = response.text
+            self.message = f"{description}: {message} ({response.status_code})"
+        else:
+            self.message = description
 
 
 class AuthorizationError(Error):

fossology/folders.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 import logging

fossology/jobs.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 import json

fossology/obj.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 import json
@@ -334,7 +334,7 @@ def __init__(
         self.additional_info = kwargs
 
     def __str__(self):
-        return f"File SHA1: {self.sha1} MD5 {self.md5} SH256 {self.sha256} Size {self.filesize}B"
+        return f"File SHA1: {self.sha1} MD5 {self.md5} SH256 {self.sha256} Size {self.size}B"
 
     @classmethod
     def from_json(cls, json_dict):

fossology/report.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 import re
@@ -104,7 +104,7 @@ def download_report(self, report_id: int, group: str = None) -> Tuple[str, str]:
             return response.text, report_name
         elif response.status_code == 403:
             description = (
-                f"Getting report {report_id} {get_options(group)} not authorized"
+                f"Getting report {report_id} {get_options(group)}not authorized"
             )
             raise AuthorizationError(description, response)
         elif response.status_code == 503:

fossology/uploads.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Siemens AG
+# Copyright 2019-2021 Siemens AG
 # SPDX-License-Identifier: MIT
 
 import json
@@ -193,7 +193,7 @@ def upload_file(  # noqa: C901
                 f"{self.api}/uploads", data=data, headers=headers
             )
         else:
-            logger.debug(
+            logger.info(
                 "Neither VCS, or Url or filename option given, not uploading anything"
             )
             return