robotframework-openapitools 0.4.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

roboswag/generate/models/endpoint.py

@@ -1,68 +0,0 @@
-from itertools import chain
-from typing import Dict, List
-
-from roboswag.generate.models.parameter import Parameter
-from roboswag.generate.models.response import Response
-
-
-class Endpoint:
-    def __init__(
-        self,
-        method_name: str,
-        http_method,
-        url,
-        summary: str,
-        description: str,
-        path_params: List[Parameter],
-        headers: List[Parameter],
-        query: List[Parameter],
-        body: Parameter,
-        responses: Dict[str, Response],
-        exp_status: str = "200",
-    ):
-        self.method_name: str = method_name
-        self.http_method = http_method
-        self.url = self.prepare_path(url, path_params)
-        self.summary: str = summary
-        self.description: str = description
-        self.path_params: List[Parameter] = path_params
-        self.headers: List[Parameter] = headers
-        self.query: List[Parameter] = query
-        self.body: Parameter = body
-        self.responses: Dict[str, Response] = responses
-        self.exp_status = exp_status
-        self.method_signature: str = self.get_python_method_signature()
-
-    @staticmethod
-    def prepare_path(url, path_params):
-        for param in path_params:
-            url = url.replace(f"{{{param.name}}}", f"{{{param.python_name}}}")
-        return url
-
-    def get_python_method_signature(self) -> str:
-        max_line_length: int = 120
-        args = [
-            str(param)
-            for param in chain(self.path_params, self.headers, self.query)
-            if param
-        ]
-        if self.body:
-            args.append(f"{self.body}")
-        args.append(f"exp_status={self.exp_status}")
-        args.append(f"validate_schema=True")
-        line = f"    def {self.method_name}(self"
-        prefix = len(line) - 4
-        last_index = len(args) - 1
-        method_sig = ""
-        for index, arg in enumerate(args):
-            if not arg:
-                continue
-            if len(line) + len(arg) + 2 > max_line_length - (
-                2 if last_index == index else 0
-            ):
-                method_sig += line
-                line = ",\n" + prefix * " " + arg
-            else:
-                line += f", {arg}"
-        method_sig += line
-        return method_sig

roboswag/generate/models/parameter.py

@@ -1,25 +0,0 @@
-from roboswag.generate.models.utils import pythonify_name
-
-
-class Parameter:
-    def __init__(
-        self,
-        name: str,
-        default=None,
-        param_type=None,
-        description=None,
-        required=None,
-        schema=None,
-    ) -> None:
-        self.name: str = name
-        self.python_name: str = pythonify_name(name)
-        self.default = default
-        self.param_type = param_type
-        self.description = description
-        self.required = required
-        self.schema = schema
-
-    def __str__(self):
-        if self.default is None:
-            return self.python_name
-        return f"{self.python_name}={self.default}"

roboswag/generate/models/response.py

@@ -1,8 +0,0 @@
-class Response:
-    def __init__(self, description: str, headers=None, schema=None):
-        self.description = description
-        self.headers = headers
-        self.schema = schema
-
-    def __repr__(self):
-        return f"schema: {self.schema}"

roboswag/generate/models/tag.py

@@ -1,16 +0,0 @@
-from typing import List
-
-from roboswag.generate.models.endpoint import Endpoint
-from roboswag.generate.models.utils import pythonify_name
-
-
-class Tag:
-    def __init__(self, name: str, description: str = "") -> None:
-        # tag is grouped paths/endpoints
-        self.name: str = pythonify_name(name, join_mark="", join_fn="title")
-        self.description: str = description
-        self.endpoints: List[Endpoint] = []
-
-    @staticmethod
-    def normalize_tag_name(tag_name: str) -> str:
-        return tag_name.strip(" -_").title() + "API"

roboswag/generate/models/utils.py

@@ -1,60 +0,0 @@
-import datetime
-import re
-import uuid
-from typing import Dict
-
-RESERVED_WORDS = {"global", "cls", "self"}
-
-types_mapping = {
-    "string": {
-        "": str,
-        "byte": str,
-        "password": str,
-        "date": datetime.date,
-        "date-time": datetime.datetime,
-        "binary": bytes,
-        "uuid": uuid.UUID,
-    },
-    "integer": {
-        "": int,
-        "int32": int,
-        "int64": int,
-    },
-    "number": {
-        "float": float,
-        "double": float,
-    },
-    "boolean": bool,
-    "file": "file",
-    "array": list(),
-    "object": object,
-}
-
-
-def get_python_type(param_type, param_format=None):
-    if not param_type:
-        return str
-    if not types_mapping[param_type]:
-        return str
-    if not isinstance(types_mapping[param_type], Dict):
-        return types_mapping[param_type]
-    if param_format:
-        return types_mapping[param_type][param_format]
-    return str
-
-
-def pythonify_name(name: str, join_mark: str = "_", join_fn: str = "lower") -> str:
-    names = re.split("([A-Z][a-z]+)", name)
-    if join_fn == "lower":
-        name = join_mark.join(name.lower() for name in names if name.strip())
-    elif join_fn == "title":
-        name = join_mark.join(name.title() for name in names if name.strip())
-    name = name.replace("-", "")
-    return name
-
-
-def replace_reserved_name(name: str) -> str:
-    """If the name is in reserved words, append it with _"""
-    if name in RESERVED_WORDS:
-        return f"_{name}"
-    return name

roboswag/generate/templates/api_init.jinja

@@ -1,15 +0,0 @@
-"""
-**OpenAPI version:** {{ swagger_version }}
-**Title:** {{ infos["title"] }}
-**API Version:** {{ infos["version"] }}
-{% if infos.get("description") %}**Description:** {{ infos["description"] }}{% endif %}
-{% if infos.get("termsOfService") %}**Terms of Service:** {{ infos["termsOfService"] }}{% endif %}
-{% if infos.get("contact") %}**Contact:**
-{%- for key, value in infos["contact"].items() %}
-    **{{ key }}:** {{ value }}
-{%- endfor %}{% endif %}
-{% if infos.get("license") %}**License:**
-{%- for key, value in infos["license"].items() %}
-    **{{ key }}:** {{ value }}
-{%- endfor %}{% endif %}
-"""

roboswag/generate/templates/models.jinja

@@ -1,7 +0,0 @@
-class {{ class_name }}:
-    def __init__(self{% if properties %}{% for property in properties %}, {{ property.name }}: {{ property.type.__name__ }}{% endfor %}{% endif %}):
-        {% for property in properties %}self.{{ property.name }} = {{ property.name }}
-        {% endfor %}
-        {% if not properties %}
-            pass
-        {% endif %}

roboswag/generate/templates/paths.jinja

@@ -1,68 +0,0 @@
-import logging
-import json
-
-from roboswag import APIModel
-{% if authentication %}from roboswag.auth import {{ authentication }}{% endif %}
-
-
-class {{ class_name }}(APIModel):
-{% if description %}    """**Description:** {{ description }}"""
-{% endif %}
-    def __init__(self, url):
-        super().__init__(base_url=url{% if authentication %}, authentication={{ authentication }}{% endif %})
-{% for endpoint in endpoints %}
-{{ endpoint.method_signature }}{% if endpoint.body %}, validate_payload=True, overwrite_body=None{% endif %}{% if endpoint.headers %}, overwrite_headers=None{% endif %}{% if endpoint.query %}, overwrite_query=None{% endif %}, **kwargs):
-{% if (endpoint.summary or endpoint.description) %}        """{% if endpoint.summary %}
-        **Summary:** {{ endpoint.summary }}{% endif %}{% if endpoint.description %}
-
-        **Description:** {{ endpoint.description }}{% endif %}
-        """{% endif %}
-{%- if endpoint.headers %}
-        headers = {
-{%- for param in endpoint.headers %}
-            "{{ param.name }}": {{ param.python_name }}{{ "," if not loop.last else "" }}
-{%- endfor %}
-        }
-        if overwrite_headers:
-            headers = overwrite_headers
-{% endif %}
-{%- if endpoint.query %}
-        _query = {
-{%- for param in endpoint.query %}
-            "{{ param.name }}": {{ param.python_name }}{{ "," if not loop.last else "" }}
-{%- endfor %}
-        }
-        if overwrite_query:
-            _query = overwrite_query
-{% endif %}
-{%- if endpoint.body %}
-        if validate_payload:
-        {%- if endpoint.body.schema %}
-            schema = {{ endpoint.body.schema }}
-            self.validate.schema(json.loads({{ endpoint.body.python_name }}), schema)
-        {%- endif %}
-
-        _body = overwrite_body if overwrite_body else {{ endpoint.body.python_name }}
-{%- endif %}
-        response = self.{{ endpoint.http_method }}({{ "f" if "{" in endpoint.url else "" }}"{{ endpoint.url }}"{% if endpoint.headers %}, headers=headers{% endif %}{% if endpoint.query %}, query=_query{% endif %}{% if endpoint.body %}, body=_body{% endif %}, status=exp_status, **kwargs)
-
-        if validate_schema:{% for status_code, resp in endpoint.responses.items() %}
-        {%- if resp.schema %}
-            {% if not loop.first %}el{% endif %}if response.status_code == {{ status_code }}:
-                schema = {{ resp.schema }}
-                self.validate.schema(response.json(), schema)
-        {%- elif status_code != "default" %}
-            {% if not loop.first %}el{% endif %}if response.status_code == {{ status_code }}:
-                # TODO self.validate.response_as_text(response, "FILL EXPECTED MESSAGE")
-                pass
-        {%- else %}
-            {% if not loop.first %}el{% endif %}if response.status_code == "default":
-                # TODO self.validate.response_as_text(response, "FILL EXPECTED MESSAGE")
-                pass
-        {%- endif %}{% endfor %}
-            else:
-                logging.error(f"Received status code ({response.status_code}) is not expected by the API specification")
-                assert False
-
-        return response
-{% endfor %}

roboswag/logger.py

@@ -1,33 +0,0 @@
-from pprint import pformat
-
-from robot.api import logger
-
-
-class Logger:
-    @staticmethod
-    def info(message):
-        logger.info(message)
-
-    @staticmethod
-    def debug(message):
-        logger.debug(message)
-
-    @staticmethod
-    def log_request(response):
-        # TODO we can add flag for removing auth details (such as passwords, tokens) if needed
-        if response.history:  # TODO print redirects
-            original_request = response.history[0].request
-            redirected = "(redirected)"
-        else:
-            original_request = response.request
-            redirected = ""
-        logger.info(
-            f"{original_request.method.upper()} {original_request.url} {redirected}\n"
-            f"headers: {pformat(original_request.headers)}"
-        )  # TODO make pretty print work
-
-    @staticmethod
-    def log_response(response):
-        logger.info(
-            f"{response.request.method.upper()} response: {response.status_code} {response.text}"
-        )

roboswag/validate/__init__.py

@@ -1,6 +0,0 @@
-from roboswag.validate.schema import ValidateSchema
-from roboswag.validate.text_response import ValidateTextResponse
-
-
-class Validate(ValidateSchema, ValidateTextResponse):
-    pass

roboswag/validate/core.py

@@ -1,3 +0,0 @@
-class ValidateBase:
-    def __init__(self, logger):
-        self.logger = logger

roboswag/validate/schema.py

@@ -1,21 +0,0 @@
-import json
-from pathlib import Path
-from typing import Dict, Union
-
-import jsonschema
-
-from roboswag.validate.core import ValidateBase
-
-
-class ValidateSchema(ValidateBase):
-    def schema(self, to_validate, schema: Union[str, Path, Dict]):
-        self.logger.info("Validating schema...")
-        if isinstance(schema, (str, Path)):
-            with open(schema) as fp:
-                schema = json.load(fp)
-        self.logger.debug(f"Schema:\n{json.dumps(schema, indent=4)}")
-        try:
-            jsonschema.validate(instance=to_validate, schema=schema)
-        except jsonschema.exceptions.ValidationError as err:
-            raise err
-        self.logger.info("Schema is valid.")

roboswag/validate/text_response.py

@@ -1,14 +0,0 @@
-from roboswag.validate.core import ValidateBase
-
-
-class ValidateTextResponse(ValidateBase):
-    def response_as_text(self, response, exp_response):
-        self.logger.info("Validating response...")
-        assertion_err_msg = (
-            "Received response description:\n"
-            f"    '{response.text}'\n"
-            "does not equal expected:\n"
-            f"    '{exp_response}'"
-        )
-        assert response.text == exp_response, assertion_err_msg
-        self.logger.info("Response is valid.")

robotframework_openapitools-0.4.0.dist-info/METADATA

@@ -1,42 +0,0 @@
-Metadata-Version: 2.1
-Name: robotframework-openapitools
-Version: 0.4.0
-Summary: A set of Robot Framework libraries to test APIs for which the OAS is available.
-Home-page: https://github.com/MarketSquare/robotframework-openapitools
-License: Apache-2.0
-Author: Bartlomiej Hirsz
-Author-email: bartek.hirsz@gmail.com
-Maintainer: Robin Mackaij
-Maintainer-email: r.a.mackaij@gmail.com
-Requires-Python: >=3.8,<4.0
-Classifier: Framework :: Robot Framework
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Testing
-Classifier: Topic :: Software Development :: Testing :: Acceptance
-Requires-Dist: Faker (>=23.1.0)
-Requires-Dist: Jinja2 (>=3.1.2)
-Requires-Dist: black (>=24.1.0)
-Requires-Dist: openapi-core (>=0.19.0)
-Requires-Dist: prance[cli] (>=23)
-Requires-Dist: requests (>=2.31.0)
-Requires-Dist: rich_click (>=1.7.0)
-Requires-Dist: robotframework (>=6.0.0,!=7.0.0)
-Requires-Dist: robotframework-datadriver (>=1.10.0)
-Requires-Dist: rstr (>=3.2.0)
-Description-Content-Type: text/markdown
-
-# OpenApiTools for Robot Framework
-
-OpenApiTools is a set of libraries centered around the OpenAPI Specification:
-
-- [OpenApiDriver](./driver.md)
-- [OpenApiLibCore](./libcore.md)
-

robotframework_openapitools-0.4.0.dist-info/RECORD

@@ -1,41 +0,0 @@
-OpenApiDriver/__init__.py,sha256=34h5RkB8nBNRKPId4r_B_xzcgXJYD3m2QYwIaPfpv80,1331
-OpenApiDriver/openapi_executors.py,sha256=L_oixhT1Ux6ZOTz0-iQEBos_Qz1kkRc3W_YjI-A-VuM,12434
-OpenApiDriver/openapi_reader.py,sha256=4kSM-hFd54ws-jq88inbienkaoC5sSDwfRuxLrHP7aA,4652
-OpenApiDriver/openapidriver.libspec,sha256=5Wleyi6EM42z4_Wzg38L5YGUPNRBjGw-XU0ZaYut4ow,27181
-OpenApiDriver/openapidriver.py,sha256=HD2t32pU0RokKbf2VopjxlArIVoh_-fLcwiJmfQ2MJM,15209
-OpenApiDriver/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-OpenApiLibCore/__init__.py,sha256=CGZRj3Vh4TZ76LOLWJOrBFr27QYWVXsO1imLqH-aP9E,1604
-OpenApiLibCore/dto_base.py,sha256=GE_vXY0bJsDfOyQFahRy9jVgFR6BbWDmyrAegl1NQS4,12299
-OpenApiLibCore/dto_utils.py,sha256=maYX9QqPaJtiEo8vIFQLsT2FOT-LUGVnNcVaca4zCDk,2903
-OpenApiLibCore/oas_cache.py,sha256=Qg_Is5pAJZjZu5VmwEEarQs8teKrh3Y2psCcpDLU5Y4,379
-OpenApiLibCore/openapi_libcore.libspec,sha256=o3_sXNjA3QSr-sPH6Ai5mGPg0MFToLJ5GnTWqZWajfc,47001
-OpenApiLibCore/openapi_libcore.py,sha256=zRk8QMc22wFLqpLQQOac1aZgoF_IDQdZdRkrBtfqCF0,93211
-OpenApiLibCore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-OpenApiLibCore/value_utils.py,sha256=wO5ssYTuk4YWWMJb0kl5n20X2r0NG55FXvgLqQd8qvw,18145
-roboswag/__init__.py,sha256=-8ql4wuY_ftOZRdCxSmBCMW3WpDk7Ir__st9xcb9qCI,223
-roboswag/__main__.py,sha256=sZyVODLDUj4yuWwQEdB8lSOuNsmTfmt4XqbYUgwcIOg,35
-roboswag/auth.py,sha256=Nh4p0OsRH6dvpPSPmFfLVsTcNXqDemzmtqHymRbCWNc,1323
-roboswag/cli.py,sha256=mmdRPmu1J0w9gmHcd0ezSi7HAWLi_U18wELVztmIucs,2216
-roboswag/core.py,sha256=TFv6XTno-c9SqzVuFjgUbpgn7xAQvuSsr3-hk3GxegY,2870
-roboswag/generate/__init__.py,sha256=ibIs0SR9XqajHy9fPQJdCAQrTr1JXym3T0PZB_hXR_M,59
-roboswag/generate/generate.py,sha256=a2okQD56z3Ql7d_LF9GfO_mM-jtgwUFYmjiXWmweTew,4706
-roboswag/generate/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-roboswag/generate/models/api.py,sha256=wuBGnmP85DDUjlGDUrmZRxAxE8tlG5PAAit57qtupzU,8528
-roboswag/generate/models/definition.py,sha256=PX4sPU000ceezlgF7s3UqIHzp5gqzurQbSMdkvHQM0o,841
-roboswag/generate/models/endpoint.py,sha256=GnHtZV-2kB-28QNrJNvCUSoOy2tmT6qUlmeIG50ZhGg,2304
-roboswag/generate/models/parameter.py,sha256=CWUuAgT8opjcuJ_ew6q-nYe5nWDZ8g4pe8H55bXQhf0,682
-roboswag/generate/models/response.py,sha256=KTcQez15japXnSMsrYGdfRF9jz5igQf_ZFwpG4CejX8,257
-roboswag/generate/models/tag.py,sha256=uV3YSujM-f7HVbHyWMZ46PV65SOzrYCiXsRhk7PwcGY,561
-roboswag/generate/models/utils.py,sha256=NPDl9_urjctkL0nzYEb1lOMcbX64VqliszPPGhzklwY,1550
-roboswag/generate/templates/api_init.jinja,sha256=NyvQ9I1lhzv3f1nsxaJx2l8iifwsG_HpK44POtNiJjI,621
-roboswag/generate/templates/models.jinja,sha256=upTukanAN__KcaNLNphn0M2miMcJx91r1cqU9F9qiz8,357
-roboswag/generate/templates/paths.jinja,sha256=jfqahBD0hSqDwaVfVZn-nFvsiGV-rZNE_p1qBTLbxx4,3191
-roboswag/logger.py,sha256=SdxkYw8UITgy0zyGVyUSFh4PVXrDHf8ElZ052iDzF8U,1025
-roboswag/validate/__init__.py,sha256=stpgQmvZvqlqPBjZ3Vxhd3wbX_Nb85jyIbj44_EhK_w,188
-roboswag/validate/core.py,sha256=CfUEhkXPFAzIppRSiGyh62j4BYW4vkjIXWEzRcJFD6o,84
-roboswag/validate/schema.py,sha256=jyD44GcYU_JQLw5hb1wK-DwxOsbJ-FstoNHwIVVMqoo,711
-roboswag/validate/text_response.py,sha256=P7WEC6ot1OG3YDEXRtmOwIFwki8jgq8fMb-L77X4vIo,527
-robotframework_openapitools-0.4.0.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-robotframework_openapitools-0.4.0.dist-info/METADATA,sha256=gebYOaq4qzFePksuD1iKi6kdc7nYGv9nFuwwWc7IAwc,1621
-robotframework_openapitools-0.4.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-robotframework_openapitools-0.4.0.dist-info/RECORD,,