commonground-api-common 2.2.0__py3-none-any.whl → 2.3.0__py3-none-any.whl

vng_api_common/management/commands/generate_swagger.py

@@ -1,197 +0,0 @@
-import logging
-import os
-
-from django.apps import apps
-from django.conf import settings
-from django.contrib.auth import get_user_model
-from django.core.exceptions import ImproperlyConfigured
-from django.template.loader import render_to_string
-from django.urls import NoReverseMatch, reverse
-from django.utils.module_loading import import_string
-
-from drf_yasg import openapi
-from drf_yasg.app_settings import swagger_settings
-from drf_yasg.management.commands import generate_swagger
-from rest_framework.settings import api_settings
-
-from ...version import get_major_version
-
-
-class Table:
-    def __init__(self, resource: str):
-        self.resource = resource
-        self.rows = []
-
-
-class Row:
-    def __init__(
-        self,
-        label: str,
-        description: str,
-        type: str,
-        required: bool,
-        create: bool,
-        read: bool,
-        update: bool,
-        delete: bool,
-    ):
-        self.label = label
-        self.description = description
-        self.type = type
-        self.required = required
-        self.create = create
-        self.read = read
-        self.update = update
-        self.delete = delete
-
-
-class Command(generate_swagger.Command):
-    """
-    Patches to the provided command to modify the schema.
-    """
-
-    leave_locale_alone = True
-
-    def add_arguments(self, parser):
-        super().add_arguments(parser)
-        parser.add_argument("--to-markdown-table", action="store_true")
-
-        parser.add_argument(
-            "--info", dest="info", default=None, help="Path to schema info object"
-        )
-
-        parser.add_argument(
-            "--urlconf",
-            dest="urlconf",
-            default=None,
-            help="Urlconf for schema generator",
-        )
-
-    def get_mock_request(self, *args, **kwargs):
-        request = super().get_mock_request(*args, **kwargs)
-        request.version = api_settings.DEFAULT_VERSION
-        return request
-
-    def write_schema(self, schema, stream, format):
-        del schema.host
-        del schema.schemes
-        super().write_schema(schema, stream, format)
-
-    # need to overwrite the generator class...
-    def handle(
-        self,
-        output_file,
-        overwrite,
-        format,
-        api_url,
-        mock,
-        api_version,
-        user,
-        private,
-        generator_class_name,
-        info=None,
-        urlconf=None,
-        **options,
-    ):
-        # disable logs of WARNING and below
-        logging.disable(logging.WARNING)
-
-        if info:
-            info = import_string(info)
-        else:
-            info = getattr(swagger_settings, "DEFAULT_INFO", None)
-
-        if not isinstance(info, openapi.Info):
-            raise ImproperlyConfigured(
-                'settings.SWAGGER_SETTINGS["DEFAULT_INFO"] should be an '
-                "import string pointing to an openapi.Info object"
-            )
-
-        if not format:
-            if os.path.splitext(output_file)[1] in (".yml", ".yaml"):
-                format = "yaml"
-        format = format or "json"
-
-        try:
-            api_root = reverse("api-root", kwargs={"version": get_major_version()})
-        except NoReverseMatch:
-            api_root = reverse("api-root")
-
-        api_url = (
-            api_url
-            or swagger_settings.DEFAULT_API_URL  # noqa
-            or f"http://example.com{api_root}"  # noqa
-        )
-
-        if user:
-            # Only call get_user_model if --user was passed in order to
-            # avoid crashing if auth is not configured in the project
-            user = get_user_model().objects.get(username=user)
-
-        mock = mock or private or (user is not None) or (api_version is not None)
-        if mock and not api_url:
-            raise ImproperlyConfigured(
-                "--mock-request requires an API url; either provide "
-                "the --url argument or set the DEFAULT_API_URL setting"
-            )
-
-        request = None
-        if mock:
-            request = self.get_mock_request(api_url, format, user)
-
-        api_version = api_version or api_settings.DEFAULT_VERSION
-        if request and api_version:
-            request.version = api_version
-
-        generator = self.get_schema_generator(
-            generator_class_name, info, settings.API_VERSION, api_url
-        )
-        schema = self.get_schema(generator, request, not private)
-
-        if output_file == "-":
-            self.write_schema(schema, self.stdout, format)
-        else:
-            with open(output_file, "w", encoding="utf8") as stream:
-                if options["to_markdown_table"]:
-                    self.to_markdown_table(schema, stream)
-                else:
-                    self.write_schema(schema, stream, format)
-
-    def to_markdown_table(self, schema, stream):
-        template = "vng_api_common/api_schema_to_markdown_table.md"
-        tables = []
-
-        whitelist = [model._meta.object_name for model in apps.get_models()]
-
-        for resource, definition in schema.definitions.items():
-            if resource not in whitelist:
-                continue
-
-            if not hasattr(definition, "properties"):
-                continue
-
-            table = Table(resource)
-            for field, _schema in definition.properties.items():
-                if isinstance(_schema, openapi.SchemaRef):
-                    continue
-                required = (
-                    hasattr(definition, "required") and field in definition.required
-                )
-
-                readonly = getattr(_schema, "readOnly", False)
-                table.rows.append(
-                    Row(
-                        label=field,
-                        description=getattr(_schema, "description", ""),
-                        type=_schema.type,
-                        required=required,
-                        create=not readonly,
-                        read=True,
-                        update=not readonly,
-                        delete=not readonly,
-                    )
-                )
-            tables.append(table)
-
-        markdown = render_to_string(template, context={"tables": tables})
-        stream.write(markdown)

vng_api_common/management/commands/patch_error_contenttypes.py

@@ -1,61 +0,0 @@
-"""
-Patch the content-type of error responses.
-
-Due to the changes between Swagger 2.0 and OpenAPI 3.0, we cannot handle
-this at the Python level.
-"""
-
-from django.core.management import BaseCommand
-
-import oyaml as yaml
-
-from ...views import ERROR_CONTENT_TYPE
-
-
-class Command(BaseCommand):
-    help = "Patch the error-response content types in the OAS 3 spec"
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "api-spec", help="Path to the openapi spec. Will be overwritten!"
-        )
-
-    def patch_response(self, response):
-        content = {}
-
-        for contenttype, _response in response["content"].items():
-            contenttype = ERROR_CONTENT_TYPE
-            content[contenttype] = _response
-
-        response["content"] = content
-
-    def handle(self, **options):
-        source = options["api-spec"]
-
-        # Enforce the file to be read as UTF-8 to prevent any platform
-        # dependent encoding.
-        with open(source, "r", encoding="utf8") as infile:
-            spec = yaml.safe_load(infile)
-
-            for endpoint in spec["paths"].values():
-                for data in endpoint.values():
-                    # filter the available request methods
-                    if not "responses" in data:
-                        continue
-
-                    for status, response in data["responses"].items():
-                        # Only edit the error responses which are defined directly
-                        # and not referencing existing error responses
-                        if not (400 <= int(status) < 600) or not "content" in response:
-                            continue
-
-                        self.patch_response(response)
-
-            for status, response in spec["components"]["responses"].items():
-                if not (400 <= int(status) < 600):
-                    continue
-
-                self.patch_response(response)
-
-        with open(source, "w", encoding="utf8") as outfile:
-            yaml.dump(spec, outfile, default_flow_style=False)

vng_api_common/management/commands/use_external_components.py

@@ -1,94 +0,0 @@
-"""
-Replace internal references to external for reusable components
-
-Due to the limitations of drf_yasg we cannot handle this at the Python level
-"""
-
-import os.path
-
-from django.conf import settings
-from django.core.management import BaseCommand
-
-import oyaml as yaml
-import requests
-
-
-class QuotedString(str):
-    pass
-
-
-def quoted_scalar(dumper, data):
-    # a representer to force quotations on scalars
-    return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="'")
-
-
-def replace_refs(source: dict, replace_dict: dict) -> None:
-    for k, v in source.items():
-        if isinstance(v, dict):
-            replace_refs(v, replace_dict)
-
-        if k != "$ref":
-            continue
-
-        if v in replace_dict:
-            source[k] = QuotedString(replace_dict[v])
-
-
-class Command(BaseCommand):
-    help = "Replace internal references to external for reusable components"
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "api-spec", help="Path to the openapi spec. Will be overwritten!"
-        )
-        parser.add_argument(
-            "output", help="Path to the yaml file with external components"
-        )
-
-    def handle(self, **options):
-        source = options["api-spec"]
-        output = options["output"]
-        common_url = settings.COMMON_SPEC
-        try:
-            response = requests.get(common_url)
-            response.raise_for_status()
-            common_yaml = response.text
-        except requests.exceptions.RequestException:
-            return
-
-        common_spec = yaml.safe_load(common_yaml)
-        common_components = common_spec["components"]
-
-        with open(source, "r", encoding="utf8") as infile:
-            spec = yaml.safe_load(infile)
-            components = spec["components"]
-            refs = {}
-
-            for scope, scope_items in components.items():
-                if scope not in common_components:
-                    continue
-
-                for item, item_spec in scope_items.copy().items():
-                    if item not in common_components[scope]:
-                        continue
-
-                    common_item_spec = common_components[scope][item]
-                    if item_spec == common_item_spec:
-                        # add ref to replace
-                        ref = f"#/components/{scope}/{item}"
-                        refs[ref] = f"{common_url}{ref}"
-
-                        # remove item from internal components
-                        del components[scope][item]
-
-            # remove empty components
-            for scope, scope_items in components.copy().items():
-                if not scope_items:
-                    del components[scope]
-
-            # replace all refs
-            replace_refs(spec, refs)
-
-        with open(output, "w", encoding="utf8") as outfile:
-            yaml.add_representer(QuotedString, quoted_scalar)
-            yaml.dump(spec, outfile, default_flow_style=False)

vng_api_common/templates/vng_api_common/api_schema_to_markdown_table.md

@@ -1,16 +0,0 @@
-{% load vng_api_common %}# Resources
-
-Dit document beschrijft de (RGBZ-)objecttypen die als resources ontsloten
-worden met de beschikbare attributen.
-
-{% for table in tables %}
-## {{ table.resource }}
-
-Objecttype op [GEMMA Online]({{ table.resource|gemmaonline_url }})
-
-| Attribuut | Omschrijving | Type | Verplicht | CRUD* |
-| --- | --- | --- | --- | --- |{% for row in table.rows %}
-| {{ row.label|md_table_cell }} | {{ row.description|md_table_cell }} | {{ row.type|md_table_cell }} | {{ row.required|yesno:"ja,nee" }} | {{ row|crud }} |{% endfor %}
-{% endfor %}
-
-* Create, Read, Update, Delete

vng_api_common/templates/vng_api_common/autorisaties.md

@@ -1,15 +0,0 @@
-{% load vng_api_common markup_tags %}
-# Autorisaties
-## Scopes voor {{ project_name }} API
-
-Scopes worden typisch per component gedefinieerd en geven aan welke rechten er zijn.
-Zie de repository van de [Autorisaties API](https://github.com/VNG-Realisatie/autorisaties-api)
-
-{% for scope in scopes %}
-### {{ scope.label }}
-
-**Scope**
-`{{ scope.label }}`
-
-{{ scope.description|default:"" }}
-{% endfor %}

vng_api_common/templates/vng_api_common/notificaties.md

@@ -1,24 +0,0 @@
-## Notificaties
-## Berichtkenmerken voor {{ project_name }} API
-
-Kanalen worden typisch per component gedefinieerd. Producers versturen berichten op bepaalde kanalen,
-consumers ontvangen deze. Consumers abonneren zich via een notificatiecomponent (zoals {{ 'https://notificaties-api.vng.cloud/api/v1/schema/'|urlize }}) op berichten.
-
-Hieronder staan de kanalen beschreven die door deze component gebruikt worden, met de kenmerken bij elk bericht.
-
-De architectuur van de notificaties staat beschreven op {{ 'https://github.com/VNG-Realisatie/notificaties-api'|urlize }}.
-
-{% for kanaal in kanalen %}
-### {{ kanaal.label }}
-
-**Kanaal**
-`{{ kanaal.label }}`
-
-{{ kanaal.description|default:""|urlize }}
-
-**Resources en acties**
-
-{% for resource, actions in kanaal.get_usage %}
-* <code>{{ resource }}</code>: {{ actions|join:", " }}
-{% endfor %}
-{% endfor %}