pingintel-api 0.1.0__tar.gz

pingintel_api-0.1.0/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+release.bat

pingintel_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ping Data Intelligence
+
+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.

pingintel_api-0.1.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.3
+Name: pingintel-api
+Version: 0.1.0
+Summary: Python-based API for Ping Data Intelligence APIs
+Project-URL: Homepage, https://github.com/pingintel/pingintel-api
+Project-URL: Issues, https://github.com/pingintel/pingintel-api
+Author-email: Scott Stafford <scott@pingintel.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# pingintel-api
+Python-based API for Ping Data Technology products.
+
+
+Usage:
+
+```python
+from pingintel_api import PingSOVFixerAPIClient
+
+PingSOVFixerAPIClient(
+```

pingintel_api-0.1.0/README.md

@@ -0,0 +1,11 @@
+# pingintel-api
+Python-based API for Ping Data Technology products.
+
+
+Usage:
+
+```python
+from pingintel_api import PingSOVFixerAPIClient
+
+PingSOVFixerAPIClient(
+```

pingintel_api-0.1.0/justfile

@@ -0,0 +1,5 @@
+build:
+    py -m build
+
+publish:
+    py -m twine upload dist/*

pingintel_api-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pingintel-api"
+dynamic = ["version"]
+authors = [
+  { name="Scott Stafford", email="scott@pingintel.com" },
+]
+description = "Python-based API for Ping Data Intelligence APIs"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/pingintel/pingintel-api"
+Issues = "https://github.com/pingintel/pingintel-api"
+
+[tool.hatch.version]
+path = "src/pingintel_api/__about__.py"
+
+[project.scripts]
+sovfixerapi = "pingintel_api.sovfixerapi_cmd:main"

pingintel_api-0.1.0/requirements.txt

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

pingintel_api-0.1.0/src/pingintel_api/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

pingintel_api-0.1.0/src/pingintel_api/__init__.py

@@ -0,0 +1,2 @@
+from .sov_fixer_api_client import SOVFixerAPIClient
+from .constants import SOV_RESULT_STATUS, SOV_STATUS

pingintel_api-0.1.0/src/pingintel_api/constants.py

@@ -0,0 +1,30 @@
+# Copyright 2021-2024 Ping Data Intelligence
+
+import enum
+
+DEFAULT_TIMEOUT_SECONDS = 5.0
+WAIT_AN_EXTRA_FEW_MINUTES_FOR_AOA_TO_TIMEOUT_IF_I_HAVE_TO = 60.0 * 3
+
+
+class SOV_STATUS(str, enum.Enum):
+    PENDING = "PENDING"
+    IN_PROGRESS = "IN_PROGRESS"
+    ENRICHING = "ENRICHING"
+    REENRICHING = "REENRICHING"
+    COMPLETE = "COMPLETE"
+    FAILED = "FAILED"
+
+
+INCOMPLETE_STATUSES = [
+    SOV_STATUS.PENDING,
+    SOV_STATUS.IN_PROGRESS,
+    SOV_STATUS.ENRICHING,
+    SOV_STATUS.REENRICHING,
+]
+
+
+class SOV_RESULT_STATUS(str, enum.Enum):
+    SUCCESS = "SUCCESS"
+    FAILED_TO_READ = "FAILED_TO_READ"
+    FAILED_TO_PARSE = "FAILED_TO_PARSE"
+    FAILED_TO_PROCESS = "FAILED_TO_PROCESS"

pingintel_api-0.1.0/src/pingintel_api/sov_fixer_api_client.py

@@ -0,0 +1,356 @@
+#!/usr/bin/env python
+
+# Copyright 2021-2024 Ping Data Intelligence
+
+import logging
+import os
+import pprint
+import time
+from timeit import default_timer as timer
+from typing import overload, IO, TypedDict, NotRequired
+import click
+import requests
+from requests.exceptions import HTTPError
+from . import constants as c
+
+logger = logging.getLogger(__name__)
+
+
+global start_time
+start_time = None
+
+
+def log(msg):
+    global start_time
+    if start_time is None:
+        start_time = timer()
+    elapsed = timer() - start_time
+    timestamp = time.strftime("%Y-%m-%d %H:%M:%S")
+    click.echo(f"[{timestamp} T+{elapsed:.1f}s] {msg}")
+
+
+def raise_for_status(response: requests.Response):
+    if response.ok:
+        return
+
+    error_msg = response.text
+    log(f"{response.status_code} {response.reason}: {error_msg}")
+
+    raise HTTPError(error_msg, response=response)
+
+
+def is_fileobj(source):
+    return hasattr(source, "read")
+
+
+class FixSOVResponseRequest(TypedDict):
+    status: c.SOV_STATUS
+    requested_at: str
+    progress_started_at: str
+    completed_at: str | None
+    last_health_check_time: str
+    last_health_status: str
+    pct_complete: int
+
+
+class FixSOVResponseResultOutput(TypedDict):
+    url: str
+    description: str
+    filename: str
+
+
+class FixSOVResponseResult(TypedDict):
+    message: str
+    status: c.SOV_RESULT_STATUS
+    outputs: list[FixSOVResponseResultOutput]
+
+
+class FixSOVResponse(TypedDict):
+    request: FixSOVResponseRequest
+    result: NotRequired[FixSOVResponseResult]
+
+
+class SOVFixerAPIClient:
+    SOV_STATUS = c.SOV_STATUS
+    SOV_RESULT_STATUS = c.SOV_RESULT_STATUS
+
+    @overload
+    def __init__(self, api_url: str, token=None) -> None: ...
+
+    @overload
+    def __init__(self, environment: str = "prod", token=None) -> None: ...
+
+    def __init__(
+        self,
+        api_url: str | None = None,
+        environment: str | None = "prod",
+        token=None,
+    ):
+        if api_url is None:
+            assert environment, "Need either api_url or environment."
+            if environment == "prod":
+                api_url = "https://api.sovfixer.com"
+            elif environment == "prod2":
+                api_url = "https://api2.sovfixer.com"
+            elif environment == "prodeu":
+                api_url = "https://api.eu.sovfixer.com"
+            elif environment == "local":
+                api_url = "http://api-local.sovfixer.com"
+            elif environment == "local2":
+                api_url = "http://localhost:8000"
+            else:
+                api_url = f"https://api-{environment}.sovfixer.com"
+
+        if token is None:
+            if environment in ["staging", "staging2"]:
+                serverspace = "stg"
+            elif environment in ["prod", "prod2"]:
+                serverspace = "prd"
+            elif environment in ["prodeu", "prodeu2"]:
+                serverspace = "prdeu"
+            elif environment in ["dev", "dev2"]:
+                serverspace = "dev"
+            elif environment in ["local", "local2"]:
+                serverspace = "local"
+            else:
+                raise ValueError("Unknown environment and missing token.")
+            token = os.environ.get(f"PING_{serverspace}_AUTH_TOKEN".upper())
+
+        if token is None:
+            token = os.environ.get("SOVFIXER_AUTH_TOKEN")
+        if token is None:
+            raise ValueError(
+                "Need --auth-token or SOVFIXER_AUTH_TOKEN environment variable set."
+            )
+        assert api_url
+        self.api_url = api_url
+        self.token = token
+        self.headers = {"Authorization": f"Token {token}"}
+        self.session = requests.Session()
+        self.session.headers = {
+            "Authorization": f"Token {self.token}",
+            "Accept-Encoding": "gzip",
+        }
+
+    def fix_sov_async_start(
+        self,
+        file: IO[bytes] | str,
+        document_type,
+        filename=None,
+        callback_url=None,
+        output_formats=None,
+        client_ref=None,
+        integrations=None,
+        delegate_to: str | None = None,
+    ):
+        url = self.api_url + "/api/v1/sov"
+
+        if is_fileobj(file):
+            if filename is None:
+                raise ValueError("Need filename if file is a file object.")
+
+            files = {"file": (filename, file)}
+        else:
+            if not os.path.exists(file):
+                raise click.ClickException(f"Path {file} does not exist.")
+
+            files = {"file": open(file, "rb")}
+
+        data = {}
+        if callback_url:
+            data["callback_url"] = callback_url
+        if document_type:
+            data["document_type"] = document_type
+        if output_formats:
+            data["output_formats"] = output_formats
+        if client_ref:
+            data["client_ref"] = client_ref
+        if integrations is not None:
+            data["integrations"] = integrations
+        if delegate_to is not None:
+            data["delegate_to"] = delegate_to
+
+        response = self.session.post(url, files=files, data=data)
+        if response.status_code == 200:
+            pprint.pprint(response.json())
+        else:
+            pprint.pprint(response.text)
+
+        raise_for_status(response)
+
+        response_data = response.json()
+        sov_id = response_data["id"]
+        message = response_data["message"]
+        status_url = self.api_url + f"/api/v1/sov/{sov_id}?include_progress=True"
+        log(
+            f"+ Dispatched {sov_id}: {message}.  Now, polling for results at {status_url}."
+        )
+        return response_data
+
+    def fix_sov_async_check_progress(self, sovid_or_start_ret) -> FixSOVResponse:
+        if isinstance(sovid_or_start_ret, dict):
+            sov_id = sovid_or_start_ret["id"]
+        else:
+            sov_id = sovid_or_start_ret
+
+        status_url = self.api_url + f"/api/v1/sov/{sov_id}?include_progress=True"
+        # params = {"id": sov_id}
+
+        response = self.session.get(status_url)
+        # pprint.pprint(response.json())
+        raise_for_status(response)
+
+        response_data: FixSOVResponse = response.json()
+        # request_status = response_data["request"]["status"]
+        return response_data
+
+    def fix_sov_download(
+        self, output_ret, actually_write=False, output_path=None, environment=None
+    ):
+        return download_output(
+            output_ret,
+            session=self.session,
+            actually_write=actually_write,
+            output_path=output_path,
+            environment=environment,
+        )
+
+
+def download_output(
+    output,
+    environment=None,
+    session=None,
+    auth_token=None,
+    actually_write=False,
+    output_path=None,
+):
+    if session is None:
+        session = requests.Session()
+        session.headers = {
+            "Authorization": f"Token {auth_token}",
+            "Accept-Encoding": "gzip",
+        }
+
+    output_url = output["url"]
+    if (
+        environment
+        and environment == "local2"
+        and "api-local.sovfixer.com" in output_url
+    ):
+        output_url = output_url.replace("api-local.sovfixer.com", "localhost:8000")
+
+    output_description = output["description"]
+    output_filename = output["filename"]
+    if output_path is None:
+        output_path = output_filename
+
+    log(f"Requesting output from {output_url}...")
+    with session.get(output_url, stream=True) as response:
+        raise_for_status(response)
+        filesize_mb = int(response.headers.get("content-length", 0)) / 1024 / 1024
+        pprint.pprint(dict(response.headers))
+        log(f"  - Streaming {output_description} output ({filesize_mb:.2f} MB)...")
+
+        if actually_write:
+            with open(output_path, "wb") as fd:
+                for chunk in response.iter_content(chunk_size=1024 * 1024):
+                    fd.write(chunk)
+        log(f"  - Downloaded {output_description} output: {output_path}.")
+    return output_path if actually_write else None
+
+
+def secure_filename(s):
+    return s
+
+
+def fix_sov(
+    API_URL,
+    filename,
+    document_type,
+    auth_token,
+    environment=None,
+    callback_url=None,
+    actually_write=False,
+    output_formats=None,
+    session=None,
+    client_ref=None,
+):
+    if auth_token is None:
+        auth_token = os.environ.get("SOVFIXER_AUTH_TOKEN")
+    if auth_token is None:
+        raise click.ClickException(
+            "Need --auth-token or SOVFIXER_AUTH_TOKEN environment variable set."
+        )
+
+    if not os.path.exists(filename):
+        raise click.ClickException("Path does not exist.")
+
+    sov_fixer_client = SOVFixerAPIClient(API_URL, auth_token)
+    start_response = sov_fixer_client.fix_sov_async_start(
+        filename,
+        document_type=document_type,
+        callback_url=callback_url,
+        output_formats=output_formats,
+        client_ref=client_ref,
+    )
+
+    while 1:
+        response_data = sov_fixer_client.fix_sov_async_check_progress(start_response)
+        # raise_for_status(response_data)
+        # pprint.pprint(response_data)
+
+        request_status = response_data["request"]["status"]
+
+        POLL_SECS = 2.5
+        if request_status == "PENDING":
+            log(
+                f"  - Has not yet been queued for processing, checking progress in {POLL_SECS}s."
+            )
+            time.sleep(POLL_SECS)
+        elif request_status == "IN_PROGRESS":
+            log(f"  - Still in progress, checking progress in {POLL_SECS}s.")
+            time.sleep(POLL_SECS)
+        else:
+            break
+
+    result_status = response_data["result"]["status"]
+    result_message = response_data["result"]["message"]
+    log(f"+ Finished with result {result_status}: {result_message}")
+
+    if result_status == "SUCCESS":
+        log("Complete!  Fetching outputs.")
+        for output in response_data["result"]["outputs"]:
+            output_url = output["url"]
+            if (
+                environment
+                and environment == "local2"
+                and "api-local.sovfixer.com" in output_url
+            ):
+                output_url = output_url.replace(
+                    "api-local.sovfixer.com", "localhost:8000"
+                )
+
+            output_filename = output["filename"]
+
+            output_path = output_filename
+
+            if actually_write:
+                if os.path.exists(output_path):
+                    yesno = input(
+                        f"Do you want to overwrite the existing file {output_path} [y/N]? "
+                    )
+                    if yesno.lower() != "y":
+                        continue
+
+            response = sov_fixer_client.fix_sov_download(
+                output,
+                actually_write=actually_write,
+                output_path=output_path,
+                environment=environment,
+            )
+            raise_for_status(response)
+        return True
+    else:
+        log("* Parsing failed!  Raw API output:")
+        log(response_data)
+        return False

pingintel_api-0.1.0/src/pingintel_api/sovfixerapi_cmd.py

@@ -0,0 +1,159 @@
+#!/usr/bin/env python
+
+# Copyright 2021-2024 Ping Data Intelligence
+
+import base64
+import enum
+import gzip
+import hashlib
+import io
+import json
+import logging
+import os
+import pathlib
+import pprint
+import random
+import time
+import zipfile
+from timeit import default_timer as timer
+
+import click
+import requests
+from requests.exceptions import HTTPError
+
+from pingintel_api.sov_fixer_api_client import fix_sov
+
+logger = logging.getLogger(__name__)
+
+
+global start_time
+start_time = None
+
+
+"""
+sovfixerapi.py
+
+Example Python commandline script for using the Ping Data Technologies sovfixer API to process SOVs.
+"""
+
+
+def log(msg):
+    global start_time
+    if start_time is None:
+        start_time = timer()
+    elapsed = timer() - start_time
+    timestamp = time.strftime("%Y-%m-%d %H:%M:%S")
+    click.echo(f"[{timestamp} T+{elapsed:.1f}s] {msg}")
+
+
+@click.command()
+@click.argument(
+    "filename", nargs=-1, required=True, type=click.Path(exists=True, dir_okay=False)
+)
+@click.option(
+    "-e",
+    "--environment",
+    type=click.Choice(
+        [
+            "staging",
+            "staging2",
+            "prod",
+            "prod2",
+            "prodeu",
+            "prodeu2",
+            "local",
+            "local2",
+            "dev",
+            "dev2",
+        ],
+        case_sensitive=False,
+    ),
+    default="staging",
+)
+@click.option(
+    "-d",
+    "--document-type",
+    type=click.Choice(
+        ["SOV", "PREM_BDX", "CLAIM_BDX", "SOV_BDX", "ACORD"], case_sensitive=False
+    ),
+    default="SOV",
+    help="Identify `filename` document type.  Defaults to SOV.",
+)
+@click.option(
+    "--auth-token",
+    help="Provide auth token via --auth-token or SOVFIXER_AUTH_TOKEN environment variable.",
+)
+@click.option(
+    "--callback-url", help="(Optional) Provide a URL to which results should be POSTed."
+)
+@click.option(
+    "-o",
+    "--output-format",
+    multiple=True,
+    help="Select output format.",
+)
+@click.option("--client-ref")
+@click.option(
+    "--write",
+    "--no-write",
+    is_flag=True,
+    default=False,
+    help="If set, actually write the output. Otherwise, download as a test but do not write.",
+)
+def main(
+    filename,
+    environment,
+    document_type,
+    auth_token,
+    callback_url,
+    output_format,
+    client_ref,
+    write,
+):
+    if environment == "prod":
+        API_URL = "https://api.sovfixer.com"
+    elif environment == "prod2":
+        API_URL = "https://api2.sovfixer.com"
+    elif environment == "prodeu":
+        API_URL = "https://api.eu.sovfixer.com"
+    elif environment == "local":
+        API_URL = "http://api-local.sovfixer.com"
+    elif environment == "local2":
+        API_URL = "http://localhost:8000"
+    else:
+        API_URL = f"https://api-{environment}.sovfixer.com"
+
+    if auth_token is None:
+        if environment in ["staging", "staging2"]:
+            serverspace = "stg"
+        elif environment in ["prod", "prod2"]:
+            serverspace = "prd"
+        elif environment in ["prodeu", "prodeu2"]:
+            serverspace = "prdeu"
+        elif environment in ["dev", "dev2"]:
+            serverspace = "dev"
+        elif environment in ["local", "local2"]:
+            serverspace = "local"
+        else:
+            raise NotImplementedError()
+        auth_token = os.environ.get(f"PING_{serverspace}_AUTH_TOKEN".upper())
+
+    if isinstance(filename, pathlib.PosixPath):
+        filename = [str(filename)]
+
+    for fn in filename:
+        fix_sov(
+            API_URL,
+            fn,
+            document_type,
+            auth_token,
+            environment,
+            callback_url,
+            actually_write=write,
+            output_formats=output_format,
+            client_ref=client_ref,
+        )
+
+
+if __name__ == "__main__":
+    main()

pingintel_api-0.1.0/tests/tests.py

@@ -0,0 +1,3 @@
+from pingintel_api import SOVFixerAPIClient
+
+SOVFixerAPIClient().ping()