Feature - Add support for reports endpoint

fix - Content key bug
minor enhancements.
bumped version to v0.0.3

Author: zkarpinski

.github/release-drafter-config.yml

@@ -0,0 +1,31 @@
+name-template: 'v$RESOLVED_VERSION 🌈'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+  - title: '🧰 Maintenance'
+    label: 'chore'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/workflows/draft-release.yml

@@ -0,0 +1,36 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+        with:
+          config-name: release-drafter-config.yml
+        #   disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

codeinsight_sdk/client.py

@@ -2,7 +2,8 @@
 import logging
 
 from .handlers import Handler
-from .models import Project, ProjectInventory
+from .models import Project, ProjectInventory, Report
+from .exceptions import CodeInsightError
 
 logger = logging.getLogger(__name__)
 
@@ -29,14 +30,18 @@ def request(self, method, url_part: str, params: dict = None):
         if not response.ok:
             logger.error(f"Error: {response.status_code} - {response.reason}")
             logger.error(response.text)
-            raise response.raise_for_status()      
+            raise CodeInsightError(response)   
 
         return response
 
     @property
     def projects(self) -> Handler:
         return Handler.create(self, Project)
 
+    @property
+    def reports(self) -> Handler:
+        return Handler.create(self, Report)
+    
 
     # Coming soon...?
     def inventories(self):
@@ -57,9 +62,6 @@ def tasks(self):
     def rules(self):
         raise NotImplementedError
 
-    def reports(self):
-        raise NotImplementedError
-    
     def files(self):
         raise NotImplementedError
 

codeinsight_sdk/errors.py

@@ -0,0 +1,28 @@
+
+import requests
+import json
+
+class GenericError(Exception): #pragma: no cover
+    """Generic error class, catch-all for most code insight API errors."""
+    pass
+
+class NotYetImplementedError(Exception): #pragma: no cover
+    """Error class for API features that have not yet been implemented."""
+    pass
+
+class CodeInsightError(GenericError):
+    """Error class for code insight API errors."""
+    def __init__(self, response: requests.Response):
+        try:
+            resp = response.json()
+            self.code = response.status_code
+            self.message = resp['Error: ']
+            self.arguments = resp['Arguments: ']
+            self.error = resp['Key: ']
+            self.add_note(f"Arguments: {self.arguments}")
+            super().__init__("Error: %s - %s" % (self.code, self.message))
+
+        except KeyError:
+            raise Exception(f"Error parsing response: {resp}")
+        except json.decoder.JSONDecodeError:
+            raise Exception(f"Error decoding response: {resp}")

codeinsight_sdk/exceptions.py

@@ -2,6 +2,7 @@
 from typing import List
 
 from codeinsight_sdk.models import Project, ProjectInventory, ProjectInventoryItem
+from codeinsight_sdk.exceptions import CodeInsightError
 
 class Handler(abc.ABC):
     def __init__(self, client, cls):
@@ -11,9 +12,12 @@ def __init__(self, client, cls):
     @staticmethod
     def create(client, cls):
         k = cls.__name__
-        handlers = {"Project": ProjectHandler, 
+        handlers = {"Project": ProjectHandler,
+                    "Report": ReportHandler
             }
         handler = handlers.get(k)
+        if handler is None:
+            raise Exception(f"Handler not found for class '{k}'")
         return handler(client, cls)
 
     @abc.abstractmethod
@@ -23,18 +27,34 @@ def get(self):
 class ProjectHandler(Handler):
     #Note API endpoints switch between projects and project...
     def all(self) -> List[Project]:
-        path = "projects"
-        resp = self.client.request("GET", url_part=path)
-        projects = []
-        for project_data in resp.json()['data']:
-            projects.append(self.cls.from_dict(project_data))
-        return projects
+            """
+            Retrieves all projects from the server.
+
+            Returns:
+                A list of Project objects representing all the projects.
+            """
+        
+            path = "projects"
+            resp = self.client.request("GET", url_part=path)
+            projects = []
+            for project_data in resp.json()['data']:
+                projects.append(self.cls.from_dict(project_data))
+            return projects
 
-    def get(self, id:str) -> Project:
-        path = f"projects/{id}"
-        resp = self.client.request("GET", url_part=path)
-        project_data = resp.json()['data']
-        return self.cls.from_dict(project_data)
+    def get(self, id:int) -> Project:
+            """
+            Retrieves a project by its ID.
+
+            Args:
+                id (int): The ID of the project requested.
+
+            Returns:
+                Project: The retrieved project.
+            """
+            path = f"projects/{id}"
+            resp = self.client.request("GET", url_part=path)
+            project_data = resp.json()['data']
+            return self.cls.from_dict(project_data)
 
     def get_id(self, projectName:str) -> int:
             """
@@ -44,30 +64,69 @@ def get_id(self, projectName:str) -> int:
                 projectName (str): The name of the project.
 
             Returns:
-                str: The ID of the project.
+                int: The ID of the project.
             """
             path = f"project/id"
             params = {"projectName": projectName}
             resp = self.client.request("GET", url_part=path, params=params)
-            projectId = resp.json()['Content']
+            try:
+                projectId = resp.json()['Content: '] # Yes, the key is called 'Content: ' ...
+            except KeyError:
+                raise CodeInsightError(resp)
+                #raise Exception(f"Content key not found in response: {resp.json()}")
             return projectId
 
     def get_inventory_summary(self, project_id:int) -> List[ProjectInventoryItem]:
-        path = f"projects/{project_id}/inventorySummary"
-        resp = self.client.request("GET", url_part=path)
-        inventory = []
-        for inv_item in resp.json()['data']:
-            inventory.append(ProjectInventoryItem.from_dict(inv_item))
-        return inventory
+            """
+            Retrieves the inventory summary for a specific project.
+
+            Args:
+                project_id (int): The ID of the project.
+
+            Returns:
+                List[ProjectInventoryItem]: A list of ProjectInventoryItem objects representing the inventory summary.
+            """
+            
+            path = f"projects/{project_id}/inventorySummary"
+            resp = self.client.request("GET", url_part=path)
+            inventory = []
+            for inv_item in resp.json()['data']:
+                inventory.append(ProjectInventoryItem.from_dict(inv_item))
+            return inventory
 
     def get_inventory(self,project_id:int,
                       skip_vulnerabilities: bool = False,
                       published:bool = True,
+                      vendor:str = None,
+                      product:str = None,
+                      page_size: int = 100,
+                      page: int = 1,
+                      review_status: str = None,
+                      alerts: str = None,
+                      include_files: bool = True
                       ) -> ProjectInventory:
         path = f"project/inventory/{project_id}"
+        #TODO: Add support for all parameters
         params = {"skipVulnerabilities": skip_vulnerabilities}
         resp = self.client.request("GET", url_part=path, params=params)
         project_inventory = resp.json()
         project_cls = ProjectInventory.from_dict(project_inventory)
         return project_cls
 
+
+class ReportHandler(Handler):
+    def get(self, id:int):
+        path = f"reports/{id}"
+        resp = self.client.request("GET", url_part=path)
+        report_data = resp.json()['data']
+        report = self.cls.from_dict(report_data)
+        return report
+    
+    def all(self):
+        path = "reports"
+        resp = self.client.request("GET", url_part=path)
+        reports = []
+        for report_data in resp.json()['data']:
+            reports.append(self.cls.from_dict(report_data))
+        return reports
+         

codeinsight_sdk/handlers.py

@@ -42,6 +42,18 @@ class ProjectInventoryItem(DataClassJsonMixin):
 
 @dataclass_json #Trying this style instead of DataClassJsonMixin
 @dataclass
-class ProjectInventory(DataClassJsonMixin):
+class ProjectInventory():
     projectId: int
-    inventoryItems: List[ProjectInventoryItem]
+    inventoryItems: List[ProjectInventoryItem]
+
+@dataclass
+class Report(DataClassJsonMixin):
+    id: int
+    name: str
+    path: str
+    default: bool
+    enabled: bool
+    enableProjectPicker: bool
+    order: int
+    createdDateTime: str
+    updatedDateTime: str

codeinsight_sdk/models.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codeinsight_sdk"
-version = "0.0.2"
+version = "0.0.3"
 description = "A Python client for the Revenera Code Insight"
 authors = ["Zachary Karpinski <1206496+zkarpinski@users.noreply.github.com>"]
 readme = "README.md"