Merge pull request #11 from NehaDC-IMC/processor-template-with-openapi-cookiecutter

Filter by environment and Fix error updating the parameters.

Author: NehaDC-IMC

examples/connect_processor_example/connect_processor/app/utils/globals.py

@@ -11,7 +11,7 @@ class Globals:
     """
 
     PRODUCTS = ['PRD-411-678-887']
-    ENVIRONMENT = 'preview'
+    ENVIRONMENT = ['preview']
     DAY_TO_REPORT_USAGE = 0
 
     ACTIVATION_TEMPLATE_NAME = 'Default Activation Template'

examples/connect_processor_example/connect_processor/processor.py

@@ -65,6 +65,7 @@ def process_request():
     # Filter to fetch all the subscription Fulfillment requests from Connect that need to be processed by this Processor
     query = R()
     query &= R().asset.product.id.oneof(Globals.PRODUCTS)
+    query &= R().asset.connection.type.oneof(Globals.ENVIRONMENT)
     query &= R().status.oneof(['pending'])
 
     # Applying the filter

{{cookiecutter.project_slug}}/connect_processor/app/dynamic_validation.py

@@ -4,7 +4,8 @@
 # All rights reserved.
 #
 
-from flask import Flask, request, json
+from flask import Flask, request
+from connect_processor.app.utils.utils import Utils
 
 api = Flask(__name__)
 
@@ -15,13 +16,6 @@
 """
 
 
-def get_parameter_by_id(params, param_id):
-    for param in params:
-        if param['id'] == param_id:
-            return param
-    raise Exception('Parameter {id} not found.'.format(id=param_id))
-
-
 def set_parameter(params, param):
     ret = []
     for p in params:
@@ -32,36 +26,23 @@ def set_parameter(params, param):
     return ret
 
 
-def get_validation_request_data(request):
-    data = request.data.decode("utf-8")
-    json_data = json.loads(data)
-    return json_data
-
-
 # The webhook configured in Connect will call the validate method to validate the value provided as ordering
 # parameter during order placement
 @api.route('/validate', methods=['POST', 'GET'])
 def do_validate():
-    json_data = get_validation_request_data(request)
-    params = json_data['asset']['params']
-    # Customize: replace 'param_dynamic_validation' with Id of the parameter that requires to be validated
-    param_1 = get_parameter_by_id(params, 'param_dynamic_validation')
+    json_data = request.json
+    # Customize: replace 'param_id_to_validate' with Id of the parameter that requires to be validated
+    value = Utils.get_param_value(json_data, 'ordering', 'param_id_to_validate')
     # Customize: Implement the desired logic to validate the value provided as the parameter
-    if param_1 and param_1['value'].isnumeric():
-        return api.response_class(
-            response=json.dumps(json_data),
-            status=200,
-            mimetype='application/json'
-        )
-
-    else:
-        # Customize: Provide proper error message
-        param_1['value_error'] = "This error is from the validation script! Value should be numeric."
-        params = set_parameter(params, param_1)
-        json_data['asset']['params'] = params
-        response = json.dumps(json_data)
-        return api.response_class(
-            response=response,
-            status=400,
-            mimetype='application/json'
-        )
+    # api_client = APIClient(api_url='',
+    #                        api_key='')
+    # error_message = api_client.validate_param(value)
+
+    # Customize: Provide proper error message
+    error_message = "Param param_id_to_validate not valid "
+    if len(error_message) > 0:
+        params = json_data['asset']['params']
+        validated_param = Utils.get_item_by_id(params, 'param_id_to_validate')
+        validated_param['value_error'] = error_message
+        set_parameter(params, validated_param)
+    return json_data

{{cookiecutter.project_slug}}/connect_processor/app/purchase.py

@@ -56,14 +56,14 @@ def _save_fulfillment_parameters(request, client):
                         "id": "subscription_id",
                         "value": "value for subscription ID in Vendor System",
                         "value_error": "",
-                        "structured_value": ""
+                        "structured_value": {}
                     },
                     {
                         # TODO: Change and/or add the fulfillment parameters id, as configured in product in Connect
                         "id": "param_b",
                         "value": "value for parameter b",
                         "value_error": "",
-                        "structured_value": ""
+                        "structured_value": {}
                     }
                 ]
             }

{{cookiecutter.project_slug}}/connect_processor/processor.py

@@ -34,6 +34,7 @@
 
         query_tcr = R()
         query_tcr &= R().configuration.product.id.oneof(Globals.PRODUCTS)
+        query_tcr &= R().configuration.connection.type.oneof(Globals.ENVIRONMENT)
         query_tcr &= R().status.oneof(['pending'])
         tc_requests = client.ns('tier').collection('config-requests').filter(query_tcr)
         # Process each TCR
@@ -43,6 +44,7 @@
     # Filter to fetch all the subscription Fulfillment requests from Connect that need to be processed by this Processor
     query = R()
     query &= R().asset.product.id.oneof(Globals.PRODUCTS)
+    query &= R().asset.connection.type.oneof(Globals.ENVIRONMENT)
     query &= R().status.oneof(['pending'])
 
     # Applying the filter