surety-api 0.0.1__tar.gz

surety_api-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish
+
+on:
+  workflow_run:
+    workflows: ["Create Release"]
+    types: [completed]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

surety_api-0.0.1/.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements/test.txt
+        pip install -e .
+    - name: Analysing the code with pylint
+      run:
+        python -m pylint surety/api tests

surety_api-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Create Release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  tag-and-release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: pip install build setuptools-scm
+
+      - name: Build package
+        run: python -m build
+
+      - name: Create tag
+        id: tag
+        uses: anothrNick/github-tag-action@1.67.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BUMP: patch
+          WITH_V: true
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.tag.outputs.new_tag }}
+          files: dist/*

surety_api-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    permissions: write-all
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          cache: "pip"
+          cache-dependency-path: |
+            requirements/test.txt
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements/test.txt
+          pip install -e .
+
+      - name: Run tests
+        run: |
+          pytest \
+            --cache-clear \
+            --junitxml=test-report.xml \
+            --cov=surety/api \
+            --cov-report=term-missing:skip-covered \
+            --cov-report=xml \
+            > pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        if: always()
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: pytest-coverage.txt
+          junitxml-path: test-report.xml
+
+      - name: Publish test report
+        if: always()
+        uses: elenakulgavaya/pytest-report-action@v1.3
+        with:
+          path: test-report.xml

surety_api-0.0.1/.gitignore

@@ -0,0 +1,210 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# packaging fixes
+*/__init__.pyi
+
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

surety_api-0.0.1/.pylintrc

@@ -0,0 +1,48 @@
+[MASTER]
+init-hook='import sys; sys.path.append("./src")'
+ignore=LICENSE,
+    pyproject.toml,
+    README.md,
+    requirements/,
+    pytest.ini,
+    setup.cfg,
+    pytest-coverage.txt,
+    test-report.xml
+ignore-paths=dist,
+    fild-api-hug.egg-info
+
+py-version=3.11
+suggestion-mode=yes
+
+[MESSAGES CONTROL]
+disable=missing-function-docstring,
+        missing-class-docstring,
+        missing-module-docstring,
+        import-outside-toplevel,
+        attribute-defined-outside-init,
+        fixme
+
+
+[TYPECHECK]
+ignored-modules=surety
+
+[BASIC]
+good-names=i,
+           j,
+           k,
+           ex,
+           tz,
+           Run,
+           _
+
+[DESIGN]
+max-args=14
+max-attributes=7
+max-bool-expr=5
+max-branches=19
+max-locals=19
+max-parents=7
+max-public-methods=20
+max-returns=6
+max-statements=50
+min-public-methods=0

surety_api-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Elena Kulgavaya
+
+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.

surety_api-0.0.1/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: surety-api
+Version: 0.0.1
+Summary: Contract-aware API interaction layer for the Surety ecosystem.
+Author-email: Elena Kulgavaya <elena.kulgavaya@gmail.com>
+License: MIT
+Keywords: api,contract-testing,automation,integration-testing,surety
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: deepdiff==8.0.1
+Requires-Dist: surety<1.0,>=0.0.4
+Requires-Dist: surety-config>=0.0.3
+Requires-Dist: surety-diff>=0.0.1
+Requires-Dist: requests
+Requires-Dist: pyyaml
+Requires-Dist: waiting
+Dynamic: license-file
+
+# Surety API
+
+Contract-aware API interaction layer for the Surety ecosystem.
+
+`surety-api` enables structured API testing, mocking, and
+interaction based on Surety contracts.
+
+It bridges declarative contracts and real HTTP communication.
+
+---
+
+## Installation
+
+```bash
+pip install surety-api

surety_api-0.0.1/README.md

@@ -0,0 +1,15 @@
+# Surety API
+
+Contract-aware API interaction layer for the Surety ecosystem.
+
+`surety-api` enables structured API testing, mocking, and
+interaction based on Surety contracts.
+
+It bridges declarative contracts and real HTTP communication.
+
+---
+
+## Installation
+
+```bash
+pip install surety-api

surety_api-0.0.1/etc/config.yaml

@@ -0,0 +1,5 @@
+App:
+  url: http://localhost:9000
+MockServer:
+  host: localhost
+  port: 8088

surety_api-0.0.1/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "surety-api"
+description = "Contract-aware API interaction layer for the Surety ecosystem."
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+authors = [
+    { name = "Elena Kulgavaya", email = "elena.kulgavaya@gmail.com" }
+]
+dynamic = ["version"]
+dependencies = [
+    "deepdiff==8.0.1",
+    "surety>=0.0.4,<1.0",
+    "surety-config>=0.0.3",
+    "surety-diff>=0.0.1",
+    "requests",
+    "pyyaml",
+    "waiting"
+]
+keywords = [
+    "api",
+    "contract-testing",
+    "automation",
+    "integration-testing",
+    "surety"
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["surety*"]
+
+[tool.setuptools_scm]
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"

surety_api-0.0.1/requirements/common.txt

@@ -0,0 +1,7 @@
+deepdiff==8.0.1
+surety==0.0.4
+surety-config==0.0.3
+surety-diff==0.0.1
+requests==2.32.3
+pyyaml==6.0.2
+waiting==1.5.0

surety_api-0.0.1/requirements/test.txt

@@ -0,0 +1,7 @@
+-r common.txt
+
+pylint==3.2.7
+pytest==8.3.3
+pytest-cov==5.0.0
+pytest-mock==3.14.0
+requests-mock==1.12.1

surety_api-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

surety_api-0.0.1/surety/api/__init__.py

@@ -0,0 +1,4 @@
+from .caller import ApiCaller
+from .mock.service import MockServer
+from .method import ApiMethod
+from .schema import HttpMethod

surety_api-0.0.1/surety/api/caller.py

@@ -0,0 +1,85 @@
+from surety.process import dictionary
+from surety.sdk import Field
+from surety.diff import compare
+
+from surety.api.method import ApiMethod
+
+
+class ApiCaller:
+    method: ApiMethod
+
+    def __init__(self, req_body=None, path_params=None, headers=None,
+                 params=None, cookies=None, updates=None):
+        self.req_body = req_body
+        self.response = None
+        self.path_params = path_params
+        self.headers = headers
+        self.params = params
+        self.cookies = cookies
+        self.updates = updates
+
+    def request(self):
+        req_body = self.req_body
+        params = self.params
+
+        if req_body is None:
+            pass
+        elif isinstance(self.req_body, Field):
+            req_body = self.req_body.value
+
+        if self.updates:
+            req_body = dictionary.merge_with_updates(req_body, self.updates)
+
+        if params is None:
+            pass
+        elif isinstance(self.params, Field):
+            params = self.params.value
+
+        self.response = self.method.call(
+            req_body=req_body,
+            path_params=self.path_params,
+            headers=self.headers,
+            params=params,
+            cookies=self.cookies
+        )
+
+        return self
+
+    def verify_response(self, error_code=None, resp_body=None, normalize=False,
+                        normalize_keys=None, parse_response=None, rules=None):
+        if error_code:
+            assert self.response.status_code == error_code, (
+                f'Unexpected code: {self.response.status_code}\n'
+                f'Response text: {self.response.text}'
+            )
+        else:
+            assert self.response.status_code == 200, (
+                f'Unexpected response code: {self.response.status_code}'
+                f'\nResponse text: {self.response.text}'
+            )
+
+        if resp_body is not None or isinstance(resp_body, Field):
+            content_type = self.response.headers.get('Content-Type')
+
+            if content_type == 'text/csv':
+                result_data = self.response.text
+
+                if parse_response and callable(parse_response):
+                    result_data = parse_response(result_data)
+            else:
+                result_data = self.response.text and self.response.json()
+
+            if isinstance(resp_body, Field):
+                resp_body = resp_body.value
+
+            if normalize or normalize_keys:
+                resp_body = dictionary.normalize(resp_body, result_data, keys=normalize_keys)
+
+            compare(
+                expected=resp_body,
+                actual=result_data,
+                rules=rules,
+                target_name='api response'
+            )
+
+        return self