Merge pull request #1 from SocketDev/initial-code

Initial code

Author: Douglas

.gitignore

@@ -0,0 +1,7 @@
+*.json
+main.py
+venv
+.idea
+.DS_Store
+*.zip
+*.pyc

README.rst

@@ -0,0 +1,217 @@
+
+socketdev-python-sdk
+###############
+
+Purpose
+-------
+
+The Socket.dev Python SDK provides a wrapper around the Socket.dev REST API to simplify making calls to the API from Python.
+
+Initializing the module
+-----------------------
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+
+Supported Functions
+-------------------
+
+npm.issues(package, version)
+""""""""""""""""""""""""""""
+Retrieve the Issues associated with a package and version.
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.npm.issues("hardhat-gas-report", "1.1.25"))
+
+**PARAMETERS:**
+
+- **package (str)** - The name of the NPM package.
+- **version (str)** - The version of the NPM Package.
+
+npm.score(package, version)
+"""""""""""""""""""""""""""
+Retrieve the Issues associated with a package and version.
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.npm.score("hardhat-gas-report", "1.1.25"))
+
+**PARAMETERS:**
+
+- **package (str)** - The name of the NPM package.
+- **version (str)** - The version of the NPM Package.
+
+dependencies.get(limit, offset)
+""""""""""""""""""
+Retrieve the dependencies for the organization associated with the API Key
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.dependencies.get(10, 0))
+
+**PARAMETERS:**
+
+- **limit (int)** - The maximum number of dependencies to return
+- **offset (int)** - The index to start from for pulling the dependencies
+
+dependencies.post(files, params)
+""""""""""""""""""""""""""""""""
+Retrieve the dependencies for the organization associated with the API Key
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    file_names = [
+        "path/to/package.json"
+    ]
+    params = {
+        "repository": "username/repo-name",
+        "branch": "dependency-branch
+    }
+    print(socket.dependencies.post(file_names, params))
+
+**PARAMETERS:**
+
+- **files (list)** - The file paths of the manifest files to import into the Dependency API.
+- **params (dict)** - A dictionary of the `repository` and `branch` options for the API
+
+org.get()
+"""""""""
+Retrieve the Socket.dev org information
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.org.get())
+
+quota.get()
+"""""""""""
+Retrieve the the current quota available for your API Key
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.quota.get())
+
+report.list()
+"""""""""""""
+Retrieve the list of all reports for the organization
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.report.list())
+
+report.delete(report_id)
+""""""""""""""""""""""""
+Delete the specified report
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.report.delete("report-id"))
+
+**PARAMETERS:**
+
+- **report_id (str)** - The report ID of the report to delete
+
+report.view(report_id)
+""""""""""""""""""""""
+Retrieve the information for a Project Health Report
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.report.view("report_id"))
+
+**PARAMETERS:**
+
+- **report_id (str)** - The report ID of the report to view
+
+report.supported()
+""""""""""""""""""
+Retrieve the supported types of manifest files for creating a report
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.report.supported())
+
+report.create(files)
+""""""""""""""""""""
+Create a new project health report with the provided files
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    files = [
+        "/path/to/manifest/package.json"
+    ]
+    print(socket.report.create(files))
+
+**PARAMETERS:**
+
+- **files (list)** - List of file paths of manifest files
+
+repositories.get()
+""""""""""""""""""
+Get a list of information about the tracked repositores
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.repositories.get())
+
+settings.get()
+""""""""""""""
+Retrieve the Socket Organization Settings
+
+**Usage:**
+
+.. code-block::
+
+    from socketdev import SocketDev
+    socket = SocketDev("REPLACE_ME")
+    print(socket.settings.get())

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,17 @@
+[metadata]
+
+name = socketdev-sdk
+version = 0.0.1
+author = Douglas Coburn
+author_email = [email protected]
+description = A python SDK for the socket.dev API
+long_description = file: README.rst
+long_description_content_type: text/x-rst
+license = MIT
+classifiers =
+    Programming Language :: Python :: 3
+
+[options]
+python_requires = >=3.6
+install_requires =
+    requests

socketdev/__init__.py

@@ -0,0 +1,90 @@
+import logging
+import requests
+import base64
+from socketdev.dependencies import Dependencies
+from socketdev.npm import NPM
+from socketdev.openapi import OpenAPI
+from socketdev.org import Orgs
+from socketdev.quota import Quota
+from socketdev.report import Report
+from socketdev.repositories import Repositories
+from socketdev.settings import Settings
+from socketdev.socket_classes import Dependency, Org, Response
+from socketdev.exceptions import APIKeyMissing, APIFailure, APIAccessDenied, APIInsufficientQuota, APIResourceNotFound
+
+
+__author__ = 'socket.dev'
+__version__ = '0.0.1'
+__all__ = [
+    "SocketDev",
+]
+
+
+global encoded_key
+api_url = "https://api.socket.dev/v0"
+log = logging.getLogger("socketdev")
+log.addHandler(logging.NullHandler())
+
+
+def encode_key(token: str):
+    global encoded_key
+    encoded_key = base64.b64encode(token.encode()).decode('ascii')
+
+
+def do_request(
+        path: str,
+        headers: dict = None,
+        payload: [dict, str] = None,
+        files: list = None,
+        method: str = "GET",
+):
+    if encoded_key is None or encoded_key == "":
+        raise APIKeyMissing
+
+    if headers is None:
+        headers = {
+            'Authorization': f"Basic {encoded_key}",
+            'User-Agent': 'SocketPythonScript/0.0.1',
+            "accept": "application/json"
+        }
+    url = f"{api_url}/{path}"
+    try:
+        response = requests.request(
+            method.upper(),
+            url,
+            headers=headers,
+            data=payload,
+            files=files
+        )
+        if response.status_code >= 400:
+            raise APIFailure("Bad Request")
+        elif response.status_code == 401:
+            raise APIAccessDenied("Unauthorized")
+        elif response.status_code == 403:
+            raise APIInsufficientQuota("Insufficient max_quota for API method")
+        elif response.status_code == 404:
+            raise APIResourceNotFound(f"Path not found {path}")
+        elif response.status_code == 429:
+            raise APIInsufficientQuota("Insufficient quota for API route")
+    except Exception as error:
+        response = Response(
+            text=f"{error}",
+            error=True,
+            status_code=500
+        )
+        raise APIFailure(response)
+    return response
+
+
+class SocketDev:
+    def __init__(self, token: str):
+        self.token = token + ":"
+        encode_key(self.token)
+        self.dependencies = Dependencies()
+        self.npm = NPM()
+        self.openapi = OpenAPI()
+        self.org = Orgs()
+        self.quota = Quota()
+        self.report = Report()
+        self.repositories = Repositories()
+        self.settings = Settings()

socketdev/dependencies/__init__.py

@@ -0,0 +1,48 @@
+import socketdev
+from socketdev.tools import load_files
+from urllib.parse import urlencode
+import json
+
+
+class Dependencies:
+    @staticmethod
+    def post(files: list, params: dict) -> dict:
+        loaded_files = []
+        loaded_files = load_files(files, loaded_files)
+        path = "dependencies/upload?" + urlencode(params)
+        response = socketdev.do_request(
+            path=path,
+            files=loaded_files,
+            method="POST"
+        )
+        if response.status_code == 200:
+            result = response.json()
+        else:
+            result = {}
+            print(f"Error posting {files} to the Dependency API")
+            print(response.text)
+        return result
+
+    @staticmethod
+    def get(
+            limit: int = 50,
+            offset: int = 0,
+    ) -> dict:
+        path = "dependencies/search"
+        payload = {
+            "limit":  limit,
+            "offset": offset
+        }
+        payload_str = json.dumps(payload)
+        response = socketdev.do_request(
+            path=path,
+            method="POST",
+            payload=payload_str
+        )
+        if response.status_code == 200:
+            result = response.json()
+        else:
+            result = {}
+            print("Unable to retrieve Dependencies")
+            print(response.text)
+        return result