v0.1.0 🌵

Author: RobertoPrevato

.github/workflows/build.yml

@@ -4,7 +4,8 @@ on:
   release:
     types: [published]
   push:
-    tags: "v[1-9]+.[0-9]+.[0-9]+"
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
     branches:
       - main
       - ci
@@ -59,6 +60,10 @@ jobs:
           path: junit/pytest-results-${{ matrix.python-version }}.xml
         if: always()
 
+      - name: Codecov
+        run: |
+          bash <(curl -s https://codecov.io/bash)
+
       - name: Install distribution dependencies
         run: pip install --upgrade twine setuptools wheel
         if: matrix.python-version == 3.8 || matrix.python-version == 3.9

README.md

@@ -2,6 +2,7 @@
 [![pypi](https://img.shields.io/pypi/v/essentials-openapi.svg)](https://pypi.python.org/pypi/essentials-openapi)
 [![versions](https://img.shields.io/pypi/pyversions/essentials-openapi.svg)](https://github.com/neoteroi/essentials-openapi)
 [![license](https://img.shields.io/github/license/neoteroi/essentials-openapi.svg)](https://github.com/neoteroi/essentials-openapi/blob/master/LICENSE)
+[![codecov](https://codecov.io/gh/Neoteroi/essentials-openapi/branch/main/graph/badge.svg?token=WEZ8YECJDF)](https://codecov.io/gh/Neoteroi/essentials-openapi)
 
 # essentials-openapi
 

openapidocs/common.py

@@ -1,28 +1,18 @@
 import copy
 import json
-from essentials.json import FriendlyEncoder
-from dataclasses import asdict, fields, is_dataclass
+from dataclasses import fields, is_dataclass
 from enum import Enum
 from typing import Any, List, Tuple
 
 import yaml
+from essentials.json import FriendlyEncoder
 
 
 class Format(Enum):
     YAML = "YAML"
     JSON = "JSON"
 
 
-class EntitiesJSONEncoder(FriendlyEncoder):
-    def default(self, obj: Any) -> Any:
-        try:
-            return super().default(obj)
-        except TypeError:
-            if is_dataclass(obj):
-                return {k: v for k, v in asdict(obj).items() if v is not None}
-            raise
-
-
 class OpenAPIRoot:
     """Base class for a root OpenAPI Documentation"""
 
@@ -67,8 +57,6 @@ def _asdict_inner(obj, dict_factory):
             value = _asdict_inner(getattr(obj, f.name), dict_factory)
             result.append((f.name, value))
         return dict_factory(result)
-    elif isinstance(obj, tuple) and hasattr(obj, "_fields"):
-        return type(obj)(*[_asdict_inner(v, dict_factory) for v in obj])
     elif isinstance(obj, (list, tuple)):
         return type(obj)(_asdict_inner(v, dict_factory) for v in obj)
     elif isinstance(obj, dict):
@@ -104,7 +92,7 @@ def to_obj(self, item: Any) -> Any:
 
     def to_json(self, item: Any) -> str:
         return json.dumps(
-            self.to_obj(item), indent=4, ensure_ascii=False, cls=EntitiesJSONEncoder
+            self.to_obj(item), indent=4, ensure_ascii=False, cls=FriendlyEncoder
         )
 
     def to_yaml(self, item: Any) -> str:

openapidocs/v2.py

@@ -6,7 +6,7 @@
 from abc import ABC
 from enum import Enum
 from dataclasses import dataclass
-from openapidocs.common import OpenAPIRoot, normalize_dict
+from openapidocs.common import OpenAPIRoot
 from typing import Any, List, Optional, Dict, Type, Union
 
 
@@ -339,18 +339,6 @@ class Tag:
     external_docs: Optional[ExternalDocs] = None
 
 
-@dataclass
-class Security:
-    requirements: List[SecurityRequirement]
-    optional: bool = False
-
-    def to_obj(self):
-        items = [normalize_dict(item) for item in self.requirements]
-        if self.optional:
-            items.insert(0, {})
-        return items
-
-
 @dataclass
 class OpenAPI(OpenAPIRoot):
     swagger: str = "2.0"

setup.py

@@ -8,7 +8,7 @@ def readme():
 
 setup(
     name="essentials-openapi",
-    version="0.0.9",
+    version="0.1.0",
     description="Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML",
     long_description=readme(),
     long_description_content_type="text/markdown",

tests/test_common.py

@@ -0,0 +1,40 @@
+import pytest
+from enum import Enum
+from openapidocs.common import Serializer, normalize_key, normalize_dict_factory
+
+
+class ExampleType(Enum):
+    A = "a"
+    B = "b"
+
+
+def test_serializer_raises_for_unsupported_class():
+    class A:
+        pass
+
+    with pytest.raises(TypeError):
+        Serializer().to_json(A())
+
+
+@pytest.mark.parametrize(
+    "value,expected_result",
+    [
+        ("one", "one"),
+        ("snake_case", "snakeCase"),
+        ("snake_case_really", "snakeCaseReally"),
+        (10, 10),
+        (ExampleType.A, "a"),
+    ],
+)
+def test_normalize_key(value, expected_result):
+    assert normalize_key(value) == expected_result
+
+
+def test_normalize_dict_factory():
+    class A:
+        def to_obj(self):
+            return {"x": 1}
+
+    values = [("a", A())]
+
+    assert normalize_dict_factory(values) == {"a": {"x": 1}}

tests/test_v2.py

@@ -1257,3 +1257,11 @@ def test_equality(example_type: Type[TestItem]) -> None:
     one = example.get_instance()
     two = example.get_instance()
     assert one == two
+
+
+@pytest.mark.parametrize(
+    "value,expected_result",
+    [("one", "#/definitions/one"), (Contact, "#/definitions/Contact")],
+)
+def test_get_ref(value, expected_result):
+    assert get_ref(value) == expected_result