Add Signup to Rest API

openapi/dredd_hook.py

@@ -1,6 +1,6 @@
 import dredd_hooks as hooks
 import json
-from utils import update_query_parameter_values, update_dictionary_values
+from utils import update_query_parameter_values, update_dictionary_values, replace_json_dictionary_values
 
 not_found_parameter_values = {
     'room_id': 1,
@@ -26,17 +26,20 @@ def replace_4xx_parameter_values(transaction):
     It isn't possible to specify individual parameter example values for each response type in OpenAPI.
     To properly test the return value of not-found parameters, replace all parameters.
     """
-    if transaction['expected']['statusCode'][0] == '4':
-        new_path = update_query_parameter_values(transaction['fullPath'], not_found_parameter_values)
-        print(f"Update endpoint path, from '{transaction['fullPath']}' to '{new_path}'")
-        transaction['fullPath'] = new_path
-        transaction['request']['uri'] = new_path
-
-
-@hooks.before_each
-def replace_body_in_post_requests(transaction):
-    if transaction['expected']['statusCode'][0] == '4' and transaction['id'].startswith("POST"):
-        body = json.loads(transaction['request']['body'])
-        update_dictionary_values(body, not_found_parameter_values)
-
-        transaction['request']['body'] = json.dumps(body)
+    replace_username = transaction['expected']['statusCode'][0] == '4'
+
+    if transaction['id'].startswith("POST"):
+        # Signup is opposite, since we want to sign up a user that doesn't already exist.
+        if transaction['id'].endswith("/api/signup"):
+            replace_username = not replace_username
+
+        if replace_username:
+            transaction['request']['body'] = replace_json_dictionary_values(
+                transaction['request']['body'],
+                not_found_parameter_values)
+    else:
+        if replace_username:
+            new_path = update_query_parameter_values(transaction['fullPath'], not_found_parameter_values)
+            print(f"Update endpoint path, from '{transaction['fullPath']}' to '{new_path}'")
+            transaction['fullPath'] = new_path
+            transaction['request']['uri'] = new_path

openapi/stregsystem.yaml

@@ -7,7 +7,7 @@ info:
     Existing client software utilizing the API include Stregsystem-CLI (STS) and Fappen (F-Club Web App).
 
     Disclaimer - The implementation is not generated using this specification, therefore they can get out of sync if changes are made directly to the codebase without updating the OpenAPI specification file accordingly.
-  version: "1.1"
+  version: "1.1.1"
 externalDocs:
   description: Find out more about Stregsystemet at GitHub.
   url: https://github.com/f-klubben/stregsystemet/
@@ -21,6 +21,8 @@ tags:
     description: Related to the products.
   - name: Sale
     description: Related to performing a sale.
+  - name: Signup
+    description: Related to registration of new members.
 paths:
   /api/member:
     get:
@@ -159,6 +161,38 @@ paths:
           $ref: '#/components/responses/SaleSuccess'
         '400':
           $ref: '#/components/responses/Member_RoomIdParameter_BadResponse'
+  /api/signup/status:
+    get:
+      tags:
+        - Signup
+      summary: Gets status regarding a signup
+      description: Retrieves the signup status for a specific member by username.
+      operationId: api_signup_status
+      parameters:
+        - $ref: '#/components/parameters/username_param'
+      responses:
+        '200':
+          $ref: '#/components/responses/SignupStatus'
+        '400':
+          $ref: '#/components/responses/MemberUsernameParameter_BadResponse'
+  /api/signup:
+    post:
+      tags:
+        - Signup
+      summary: Posts a signup
+      description: Performs a signup using member info.
+      operationId: api_signup
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/signup_input'
+      responses:
+        '200':
+          $ref: '#/components/responses/SignupSuccess'
+        '400':
+          $ref: '#/components/responses/Signup_BadResponse'
 components:
   examples:
     MemberNotFoundExample:
@@ -182,7 +216,20 @@ components:
     MissingMemberUsernameExample:
       summary: No username given
       value: "Parameter missing: username"
+    UsernameTakenExample:
+      summary: Member with that username already exist
+      value: "Username already taken"
+    MissingOrInvalidParameterExample:
+      summary: A parameter is invalid or missing
+      value: "Parameter invalid: <parameter>"
   parameters:
+    signup_id_param:
+      name: signup_id
+      in: query
+      description: Signup ID of the signup to retrieve.
+      required: true
+      schema:
+        $ref: '#/components/schemas/signup_id'
     member_id_param:
       name: member_id
       in: query
@@ -239,6 +286,12 @@ components:
     missingMemberUsernameMessage:
       type: string
       example: "Parameter missing: username"
+    usernameTakenMessage:
+      type: string
+      example: "Username already taken"
+    invalidParameterMessage:
+      type: string
+      example: "Parameter invalid: <parameter>"
     balance:
       type: integer
       example: 20000
@@ -257,6 +310,35 @@ components:
     room_id:
       type: integer
       example: 10
+    email:
+      type: string
+      format: email
+      example: [email protected]
+    firstname:
+      type: string
+      example: Kresten
+    lastname:
+      type: string
+      example: Laust
+    education:
+      type: string
+      description: Acknowledged shortening, e.g. sw/ixd/dad/dat
+      example: sw
+    gender:
+      type: string
+      enum:
+        - U
+        - M
+        - F
+      example: M
+    approval_status:
+      type: string
+      description: U = Unreviewed, A = Approved, I = Ignored, R = Rejected.
+      enum:
+        - U
+        - A
+        - I
+        - R
     timestamp:
       type: string
       format: date-time
@@ -274,13 +356,24 @@ components:
       type: integer
       example: 1800
     stregoere_balance:
+      type: integer
+      example: 15000
+    stregoere_due:
       type: integer
       example: 20000
     stregkroner_balance:
       description: Stregbalance in kroner, only used in API-Sale
       type: number
       format: float
       example: 182.00
+    signup_id:
+      type: integer
+      example: 5
+    named_products_example:
+      type: object
+      properties:
+        beer:
+          $ref: '#/components/schemas/product_id'
     sale_input:
       type: object
       properties:
@@ -290,6 +383,21 @@ components:
           $ref: '#/components/schemas/buystring'
         room:
           $ref: '#/components/schemas/room_id'
+    signup_input:
+      type: object
+      properties:
+        education:
+          $ref: '#/components/schemas/education'
+        username:
+          $ref: '#/components/schemas/username'
+        email:
+          $ref: '#/components/schemas/email'
+        firstname:
+          $ref: '#/components/schemas/firstname'
+        lastname:
+          $ref: '#/components/schemas/lastname'
+        gender:
+          $ref: '#/components/schemas/gender'
     active_product:
       type: object
       properties:
@@ -359,6 +467,13 @@ components:
     member_has_low_balance:
       type: boolean
       example: false
+    signup_values_result_example:
+      type: object
+      properties:
+        due:
+          $ref: '#/components/schemas/stregoere_due'
+        username:
+          $ref: '#/components/schemas/username'
     sale_values_result_example:
       type: object
       properties:
@@ -472,6 +587,17 @@ components:
             properties:
               sales:
                 $ref: '#/components/schemas/sales'
+    SignupStatus:
+      description: Signup information found.
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              due:
+                $ref: '#/components/schemas/stregoere_due'
+              status:
+                $ref: '#/components/schemas/approval_status'
     NamedProducts:
       description: Dictionary of all named_product names.
       content:
@@ -511,6 +637,21 @@ components:
                 example: "OK"
               values:
                 $ref: '#/components/schemas/sale_values_result_example'
+    SignupSuccess:
+      description: An object containing info regarding the signup.
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              status:
+                type: integer
+                example: 200
+              msg:
+                type: string
+                example: "OK"
+              values:
+                $ref: '#/components/schemas/signup_values_result_example'
     QRCodeGenerated:
       description: QR code with link to open MobilePay with the provided information.
       content:
@@ -594,3 +735,16 @@ components:
               $ref: '#/components/examples/InvalidRoomIdExample'
             missingRoomId:
               $ref: '#/components/examples/MissingRoomIdExample'
+    Signup_BadResponse:
+      description: Username is taken, missing parameter, or invalid parameter.
+      content:
+        text/html; charset=utf-8:
+          schema:
+            oneOf:
+              - $ref: '#/components/schemas/usernameTakenMessage'
+              - $ref: '#/components/schemas/invalidParameterMessage'
+          examples:
+            usernameTaken:
+              $ref: '#/components/examples/UsernameTakenExample'
+            invalidParameter:
+              $ref: '#/components/examples/MissingOrInvalidParameterExample'

openapi/utils.py

@@ -1,7 +1,34 @@
 from typing import Any
 from urllib.parse import parse_qs, urlencode, urlparse, urlunparse
+import json
 
 
+def replace_json_dictionary_values(body, replacements):
+    """
+    body: JSON string or dict
+    replacements: dict of key -> replacement value
+    Generated by ChatGPT
+    """
+    if isinstance(body, str):
+        data = json.loads(body)
+    else:
+        data = body
+
+    def recurse(obj):
+        if isinstance(obj, dict):
+            for k, v in obj.items():
+                if k in replacements:
+                    obj[k] = replacements[k]
+                else:
+                    recurse(v)
+        elif isinstance(obj, list):
+            for item in obj:
+                recurse(item)
+
+    recurse(data)
+
+    return json.dumps(data)
+
 def update_dictionary_values(original: dict[Any, Any], replacement: dict[Any, Any]) -> None:
     """
     Same as dict.update(...) but doesn't add new keys.