Example petstore (#216)

* [pt.1] Petstore example

Provides a foundation for a first actual example of what `axion` is
capable of doing. This example will intentionally be left unfinished to
facilitate `mypy` plugin development and bug hunting.

examples/mypy.ini

@@ -0,0 +1,3 @@
+[mypy]
+incremental = false
+show_error_codes = true

examples/openapi.yml

@@ -0,0 +1,163 @@
+---
+# https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
+# downloded and adjusted to match axion requirements
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  description: |
+    A sample API that uses a petstore as an example to demonstrate
+    features in the OpenAPI 3.0 specification in "axion"
+  termsOfService: http://swagger.io/terms/
+  contact:
+    name: Swagger API Team
+    email: [email protected]
+    url: http://swagger.io
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+servers:
+  - url: http://petstore.swagger.io/api
+paths:
+  /pets:
+    get:
+      description: |
+        Returns all pets from the system that the user has access to
+        Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
+
+        Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
+      operationId: petstore.api.list_pets
+      parameters:
+        - name: tags
+          in: query
+          description: tags to filter by
+          required: false
+          style: form
+          schema:
+            type: array
+            items:
+              type: string
+        - name: limit
+          in: query
+          description: maximum number of results to return
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        "200":
+          description: pet response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Pet"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      description: Creates a new pet in the store. Duplicates are allowed
+      operationId: petstore.api.new_pet
+      requestBody:
+        description: Pet to add to the store
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NewPet"
+      responses:
+        "200":
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{id}:
+    get:
+      description: Returns a user based on a single ID, if the user does not have access to the pet
+      operationId: petstore.api.find_pet
+      parameters:
+        - name: id
+          in: path
+          description: ID of pet to fetch
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        "200":
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    delete:
+      description: deletes a single pet based on the ID supplied
+      operationId: petstore.api.delete_pet
+      parameters:
+        - name: id
+          in: path
+          description: ID of pet to delete
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        "204":
+          description: pet deleted
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      allOf:
+        - $ref: "#/components/schemas/NewPet"
+        - type: object
+          required:
+            - id
+          properties:
+            id:
+              type: integer
+              format: int64
+
+    NewPet:
+      type: object
+      required:
+        - name
+      properties:
+        name:
+          type: string
+        tag:
+          type: string
+
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

examples/petstore/__main__.py

@@ -0,0 +1,10 @@
+from pathlib import Path
+
+import axion
+
+ax = axion.Axion(
+    Path.cwd(),
+    'aiohttp',
+    configuration=axion.Configuration(),
+)
+ax.add_api(spec_location=Path('openapi.yml'))

examples/petstore/api/__init__.py

@@ -0,0 +1,35 @@
+import typing as t
+
+from axion import oas_endpoint
+from axion import response
+
+
+@oas_endpoint
+async def list_pets(
+        tags: t.Optional[t.List[str]] = None,
+        limit: t.Optional[int] = None,
+) -> response.Response:
+    return {
+        'http_code': 200,
+    }
+
+
+@oas_endpoint
+async def find_pet(id: int) -> response.Response:
+    return {
+        'http_code': 200,
+    }
+
+
+@oas_endpoint
+async def delete_pet(id: int) -> response.Response:
+    return {
+        'http_code': 204,
+    }
+
+
+@oas_endpoint
+async def new_pet(body: t.Mapping[str, str]) -> response.Response:
+    return {
+        'http_code': 200,
+    }

examples/requirements.txt

@@ -0,0 +1,5 @@
+-e ../
+-r ../requirements/mypy.txt
+
+setupmeta==2.6.15
+more_itertools==8.1.0

examples/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    name='axion_example_api',
+    setup_requires='setupmeta',
+)