init

.gitignore

@@ -0,0 +1,108 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
+*__pycache__*
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# IDE
+
+.idea/
+
+
+# docker/helm
+docker/certificates/**/*
+rules.py
+
+# demo
+demo.py

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Donghui Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,81 @@
+# Python wrapper for JFROG Xray REST API
+`jfrog-xray-api` is a live python package for JFrog Xray REST API. 
+
+# Install
+```
+pip install jfrog-xray-api
+```
+# Usage
+
+## Authentication
+```python
+# User and password OR API_KEY
+from xray import XrayRestClient
+xray_rest_client = XrayRestClient(
+    base_url="http://localhost:8082/xray",
+    username='USERNAME',
+    password='PASSWORD or API_KEY'
+)
+```
+## Components
+### Find Component by Name
+```python
+components = xray_rest_client.components
+response = components.find_component_by_name("jenkinsapi")
+print(response.json())
+```
+### Find Components by CVEs
+```python
+components = xray_rest_client.components
+cve_list = ['CVE-2021-4104']
+response = components.find_components_by_cves(cve_list)
+print(response.json())
+```
+### Find CVEs by Components
+```python
+components = xray_rest_client.components
+components_id_list = ['gav://commons-collections:commons-collections:3.2.1', 'gav://commons-collections:commons-collections:3.2.2']
+response = components.find_cves_by_components(components_id_list)
+print(response.json())
+```
+### Get Component List Per Watch
+```python
+# TODO
+```
+### Get Artifact Dependency Graph
+```python
+components = xray_rest_client.components
+artifact_path = '/Artifactory/pnnl/goss/goss-core-client/0.1.7/goss-core-client-0.1.7-sources.jar'
+response = components.get_artifact_dependency_graph(artifact_path)
+print(response.json())
+```
+### Compare Artifacts
+```python
+components = xray_rest_client.components
+source_artifact_path = '/Artifactory/pnnl/goss/goss-core-client/0.1.7/goss-core-client-0.1.7-sources.jar'
+target_artifact_path = '/Artifactory/pnnl/goss/goss-core-client/0.1.8/goss-core-client-0.1.8-sources.jar'
+response = components.compare_artifacts(source_artifact_path, target_artifact_path)
+print(response.json())
+```
+### Get Build Dependency Graph
+```python
+components = xray_rest_client.components
+artifactory_instance = "myInstance",
+build_name = "someBuild",
+build_number = "someNumber"
+response = components.get_build_dependency_graph(artifactory_instance, build_name, build_number)
+print(response.json())
+```
+### Compare Builds
+```python
+components = xray_rest_client.components
+response = components.compare_builds(
+    "my-instance", "someOriginBuild", "111",
+    "my-instance", "someTargetBuild", "222",
+)
+print(response.json())
+```
+### Export Component Details
+```python
+# TODO
+```

pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "jfrog-xray-api"
+version = "0.0.1"
+authors = [
+  { name="Donghui Wang", email="977675308@qq.com" },
+]
+description = "Python wrapper for JFROG Xray REST API"
+readme = "README.md"
+requires-python = ">=3.7"
+license = {file = "LICENSE.txt"}
+keywords = [
+    "jfrog",
+    "xray",
+    "jfrog-xray",
+    "devsecops"
+]
+dependencies = [
+    "requests"
+]
+# see https://pypi.org/pypi?%3Aaction=list_classifiers
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    'Topic :: Software Development'
+]
+
+[project.urls]
+homepage = "https://github.com/donhui/jfrog-xray-api"
+repository = "https://github.com/donhui/jfrog-xray-api.git"
+"Bug Tracker" = "https://github.com/donhui/jfrog-xray-api/issues"

requirements.txt

@@ -0,0 +1,2 @@
+requests
+

tests/test_xray.py

@@ -0,0 +1,10 @@
+import unittest
+
+
+class MyTestCase(unittest.TestCase):
+    def test_something(self):
+        self.assertEqual(True, False)
+
+
+if __name__ == '__main__':
+    unittest.main()

xray/__init__.py

@@ -0,0 +1,20 @@
+import requests
+from requests.auth import HTTPBasicAuth
+
+from xray.system import XraySystem
+from xray.components import XrayComponents
+
+
+class XrayRestClient(object):
+    def __init__(self, *, base_url, username, password):
+        self.base_url = base_url
+        self._session = requests.Session()
+        self._session.auth = HTTPBasicAuth(username, password)
+
+    @property
+    def system(self):
+        return XraySystem(base_url=self.base_url, session=self._session)
+
+    @property
+    def components(self):
+        return XrayComponents(base_url=self.base_url, session=self._session)