feat: Add support for cookie parameters (#326)

dongfangtianyu · web-flow · commit 2d305ddf6d51 · 2021-02-16T12:58:07.000-07:00
* feat: Add support for cookie parameters * fix: cookies Key is case-sensitive * fix: cookies Key is case-sensitive again * docs: Add CHANGELOG entry for #326
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixes `Enum` deserialization when the value is `UNSET`.
 - Add handling of application/vnd.api+json media type.
 - Support passing models into query parameters (#316). Thanks @forest-benchling!
+- Add support for cookie parameters (#326).
 
 ### Changes
 
diff --git a/end_to_end_tests/golden-record-custom/custom_e2e/api/tests/token_with_cookie_auth_token_with_cookie_get.py b/end_to_end_tests/golden-record-custom/custom_e2e/api/tests/token_with_cookie_auth_token_with_cookie_get.py
@@ -0,0 +1,42 @@
+from typing import Optional
+
+import httpx
+
+from ...types import Response
+
+Client = httpx.Client
+
+
+def _parse_response(*, response: httpx.Response) -> Optional[Union[None, None]]:
+    if response.status_code == 200:
+        response_200 = None
+
+        return response_200
+    if response.status_code == 401:
+        response_401 = None
+
+        return response_401
+    return None
+
+
+def _build_response(*, response: httpx.Response) -> Response[Union[None, None]]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def httpx_request(
+    *,
+    client: Client,
+    my_token: str,
+) -> Response[Union[None, None]]:
+
+    response = client.request(
+        "get",
+        "/auth/token_with_cookie",
+    )
+
+    return _build_response(response=response)
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py
@@ -30,6 +30,7 @@ def _get_kwargs(
     url = "{}/tests/defaults".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     json_datetime_prop: Union[Unset, str] = UNSET
     if not isinstance(datetime_prop, Unset):
@@ -94,7 +95,7 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
     }
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_booleans.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_booleans.py
@@ -13,11 +13,12 @@ def _get_kwargs(
     url = "{}/tests/basic_lists/booleans".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_floats.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_floats.py
@@ -13,11 +13,12 @@ def _get_kwargs(
     url = "{}/tests/basic_lists/floats".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_integers.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_integers.py
@@ -13,11 +13,12 @@ def _get_kwargs(
     url = "{}/tests/basic_lists/integers".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_strings.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_strings.py
@@ -13,11 +13,12 @@ def _get_kwargs(
     url = "{}/tests/basic_lists/strings".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_user_list.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/get_user_list.py
@@ -19,6 +19,7 @@ def _get_kwargs(
     url = "{}/tests/".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     json_an_enum_value = []
     for an_enum_value_item_data in an_enum_value:
@@ -40,7 +41,7 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
     }
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/int_enum_tests_int_enum_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/int_enum_tests_int_enum_post.py
@@ -16,6 +16,7 @@ def _get_kwargs(
     url = "{}/tests/int_enum".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     json_int_enum = int_enum.value
 
@@ -27,7 +28,7 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
     }
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/json_body_tests_json_body_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/json_body_tests_json_body_post.py
@@ -16,13 +16,14 @@ def _get_kwargs(
     url = "{}/tests/json_body".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     json_json_body = json_body.to_dict()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "json": json_json_body,
     }
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py
@@ -13,11 +13,12 @@ def _get_kwargs(
     url = "{}/tests/no_response".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_get.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_get.py
@@ -14,11 +14,12 @@ def _get_kwargs(
     url = "{}/tests/octet_stream".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/optional_value_tests_optional_query_param.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/optional_value_tests_optional_query_param.py
@@ -15,6 +15,7 @@ def _get_kwargs(
     url = "{}/tests/optional_query_param/".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     json_query_param: Union[Unset, List[Any]] = UNSET
     if not isinstance(query_param, Unset):
@@ -28,7 +29,7 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "params": params,
     }
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/test_inline_objects.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/test_inline_objects.py
@@ -16,13 +16,14 @@ def _get_kwargs(
     url = "{}/tests/inline_objects".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     json_json_body = json_body.to_dict()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "json": json_json_body,
     }
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/token_with_cookie_auth_token_with_cookie_get.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/token_with_cookie_auth_token_with_cookie_get.py
@@ -0,0 +1,108 @@
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ...client import Client
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    client: Client,
+    my_token: str,
+) -> Dict[str, Any]:
+    url = "{}/auth/token_with_cookie".format(client.base_url)
+
+    headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    cookies["MyToken"] = my_token
+
+    return {
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+    }
+
+
+def _parse_response(*, response: httpx.Response) -> Optional[Union[None, None]]:
+    if response.status_code == 200:
+        response_200 = None
+
+        return response_200
+    if response.status_code == 401:
+        response_401 = None
+
+        return response_401
+    return None
+
+
+def _build_response(*, response: httpx.Response) -> Response[Union[None, None]]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+    my_token: str,
+) -> Response[Union[None, None]]:
+    kwargs = _get_kwargs(
+        client=client,
+        my_token=my_token,
+    )
+
+    response = httpx.get(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+def sync(
+    *,
+    client: Client,
+    my_token: str,
+) -> Optional[Union[None, None]]:
+    """ Test optional cookie parameters """
+
+    return sync_detailed(
+        client=client,
+        my_token=my_token,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    my_token: str,
+) -> Response[Union[None, None]]:
+    kwargs = _get_kwargs(
+        client=client,
+        my_token=my_token,
+    )
+
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(**kwargs)
+
+    return _build_response(response=response)
+
+
+async def asyncio(
+    *,
+    client: Client,
+    my_token: str,
+) -> Optional[Union[None, None]]:
+    """ Test optional cookie parameters """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            my_token=my_token,
+        )
+    ).parsed
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py
@@ -13,11 +13,12 @@ def _get_kwargs(
     url = "{}/tests/unsupported_content".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
     }
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_file_tests_upload_post.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_file_tests_upload_post.py
@@ -17,14 +17,15 @@ def _get_kwargs(
     url = "{}/tests/upload".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     if keep_alive is not UNSET:
         headers["keep-alive"] = keep_alive
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "files": multipart_data.to_dict(),
     }
diff --git a/end_to_end_tests/openapi.json b/end_to_end_tests/openapi.json
diff --git a/openapi_python_client/parser/openapi.py b/openapi_python_client/parser/openapi.py
diff --git a/openapi_python_client/templates/endpoint_macros.py.jinja b/openapi_python_client/templates/endpoint_macros.py.jinja
diff --git a/openapi_python_client/templates/endpoint_module.py.jinja b/openapi_python_client/templates/endpoint_module.py.jinja
diff --git a/tests/test_parser/test_openapi.py b/tests/test_parser/test_openapi.py
diff --git a/tests/test_templates/endpoint_module.py b/tests/test_templates/endpoint_module.py
