Added very basic security support

Closes #4

Author: dbanty

openapi_python_client/__init__.py

@@ -41,7 +41,8 @@ def _build_project(openapi: OpenAPI):
     package_dir.mkdir()
     package_init = package_dir / "__init__.py"
     package_description = f"A client library for accessing {openapi.title}"
-    package_init.write_text(f'""" {package_description} """')
+    package_init_template = env.get_template("package_init.pyi")
+    package_init.write_text(package_init_template.render(description=package_description))
 
     # Create a pyproject.toml file
     pyproject_template = env.get_template("pyproject.toml")

openapi_python_client/models/openapi.py

@@ -72,6 +72,7 @@ def from_dict(d: Dict[str, Dict[str, Dict]], /) -> Dict[str, EndpointCollection]
                     parameters=parameters,
                     responses=responses,
                     form_body_reference=form_body_reference,
+                    requires_security=method_data.get("security"),
                 )
 
                 collection = endpoints_by_tag.setdefault(tag, EndpointCollection(tag=tag))
@@ -95,6 +96,7 @@ class Endpoint:
     name: str
     parameters: List[Parameter]
     responses: List[Response]
+    requires_security: bool
     form_body_reference: Optional[Reference]
 
     @staticmethod

openapi_python_client/templates/client.pyi

@@ -1,6 +1,21 @@
 from dataclasses import dataclass
+from typing import Dict
 
 @dataclass
 class Client:
     """ A class for keeping track of data related to the API """
     base_url: str
+
+    def get_headers(self) -> Dict[str, str]:
+        """ Get headers to be used in all endpoints """
+        return {}
+
+
+@dataclass
+class AuthenticatedClient(Client):
+    """ A Client which has been authenticated for use on secured endpoints """
+    token: str
+
+    def get_headers(self) -> Dict[str, str]:
+        """ Get headers to be used in authenticated endpoints """
+        return {"Authorization": f"Bearer {self.token}"}

openapi_python_client/templates/endpoint_module.pyi

@@ -2,15 +2,20 @@ from dataclasses import asdict
 
 import requests
 
-from ..client import Client
+from ..client import AuthenticatedClient, Client
 {% for relative in collection.relative_imports %}
 {{ relative }}
 {% endfor %}
-
 {% for endpoint in collection.endpoints %}
+
+
 def {{ endpoint.name }}(
     *,
+    {% if endpoint.requires_security %}
+    client: AuthenticatedClient,
+    {% else %}
     client: Client,
+    {% endif %}
     {% if endpoint.form_body_reference %}
     form_data: {{ endpoint.form_body_reference.class_name }},
     {% endif %}
@@ -19,31 +24,30 @@ def {{ endpoint.name }}(
     url = client.base_url + "{{ endpoint.path }}"
 
     {% if endpoint.method == "get" %}
-    return requests.get(url=url)
+    return requests.get(url=url, headers=client.get_headers())
     {% elif endpoint.method == "post" %}
     return requests.post(
         url=url,
+        headers=client.get_headers(),
         {% if endpoint.form_body_reference %}
         data=asdict(form_data),
         {% endif %}
     )
     {% elif endpoint.method == "patch" %}
     return requests.patch(
         url=url,
+        headers=client.get_headers()
         {% if endpoint.form_body_reference %}
         data=asdict(form_data),
         {% endif %}
     )
     {% elif endpoint.method == "put" %}
     return requests.put(
         url=url,
+        headers=client.get_headers()
         {% if endpoint.form_body_reference %}
         data=asdict(form_data),
         {% endif %}
     )
     {% endif %}
-
-
 {% endfor %}
-
-

openapi_python_client/templates/package_init.pyi

@@ -0,0 +1,2 @@
+""" {{ description }} """
+from .client import Client, AuthenticatedClient