Merge pull request #14 from madeiramadeirabr/api_restful

Api restful

Author: andersoncontreira

.gitignore

@@ -55,5 +55,4 @@ config/integration.en
 /examples/lambda_s3/vendor/*
 /examples/lambda_sns/vendor/*
 /examples/lambda_sqs/vendor/*
-
-./vendor/*
+/vendor/

examples/lambda_api/.projectrc

@@ -2,4 +2,5 @@ PROJECT_NAME=template-serverless-lambda-python-lambda-api
 NETWORK_NAME=service-python
 APP_QUEUE=test-queue
 APP_LAMBDA_NAME=lambda_api
-APP_LAMBDA_EVENT_SOURCE=false
+APP_LAMBDA_EVENT_SOURCE=false
+APP_PORT=5001

examples/lambda_api/app.py

@@ -17,7 +17,7 @@
 from lambda_app.exceptions import ApiException
 from lambda_app.http_resources.request import ApiRequest
 from lambda_app.http_resources.response import ApiResponse
-from lambda_app.services.v1.ocoren_event_service import OcorenEventService
+from lambda_app.services.v1.ocoren_event_service import OcorenEventService as OcorenEventServiceV1
 from lambda_app.vos.events import EventVO
 from lambda_app.logging import get_logger
 from lambda_app import APP_NAME, APP_VERSION, http_helper
@@ -184,7 +184,7 @@ def event_create(event_type):
         #     event_service = OcorenEventService()
         # else:
         #     event_service = ProductEventService()
-        event_service = OcorenEventService()
+        event_service = OcorenEventServiceV1()
         service = EventManager(logger=LOGGER, event_service=event_service)
         result = service.process(event_vo)
         event_hash = event_vo.hash
@@ -262,71 +262,15 @@ def event_list(event_type):
     LOGGER.info('event_type: {}'.format(event_type))
     LOGGER.info('request: {}'.format(request))
 
-    # event_tracker = EventTracker(logger)
-    #
     status_code = 200
     response = ApiResponse(request)
     response.set_hateos(False)
-    # try:
-    #     # event_type validation
-    #     if EventType.from_value(event_type) not in EventType.get_public_events():
-    #         exception = ApiException(MessagesEnum.EVENT_TYPE_UNKNOWN_ERROR)
-    #         exception.set_message_params([event_type])
-    #         raise exception
-    #
-    #     event_vo = EventVO(event_type=event_type, data=request.where)
-    #     # if EventType.from_value(event_type) == EventType.OCOREN_EVENT:
-    #     #     event_service = OcorenEventService()
-    #     # else:
-    #     #     event_service = ProductEventService()
-    #     event_service = OcorenEventService()
-    #     service = EventManager(logger=logger, event_service=event_service)
-    #     result = service.process(event_vo)
-    #     event_hash = event_vo.hash
-    #
-    #     event_tracker.track(event_hash, event_vo.to_dict())
-    #
-    #     if result:
-    #         code = MessagesEnum.EVENT_REGISTERED_WITH_SUCCESS.code
-    #         label = MessagesEnum.EVENT_REGISTERED_WITH_SUCCESS.label
-    #         message = MessagesEnum.EVENT_REGISTERED_WITH_SUCCESS.message
-    #         params = None
-    #     else:
-    #         if isinstance(service.exception, ApiException):
-    #             raise service.exception
-    #         else:
-    #             raise ApiException(MessagesEnum.INTERNAL_SERVER_ERROR)
-    # except Exception as err:
-    #     logger.error(err)
-    #     result = False
-    #     event_hash = None
-    #     if isinstance(err, ApiException):
-    #         api_ex = err
-    #         status_code = 400
-    #     else:
-    #         api_ex = ApiException(MessagesEnum.CREATE_ERROR)
-    #         status_code = 500
-    #
-    #     code = api_ex.code
-    #     label = api_ex.label
-    #     message = api_ex.message
-    #     params = api_ex.params
-    #
-    # data = {
-    #     "result": result,
-    #     "event_hash": event_hash,
-    #     "code": code,
-    #     "label": label,
-    #     "message": message,
-    #     "params": params
-    # }
 
     data = {}
 
     response.set_data(data)
     response.set_total(len(data))
 
-    # event_tracker.track(event_hash, data)
     return response.get_response(status_code)
 
 

examples/lambda_api/lambda_app/http_resources/request.py

@@ -52,9 +52,6 @@ def __getitem__(self, item):
     def __str__(self):
         return self.to_json()
 
-    def __repr__(self):
-        return str(self.to_json())
-
     def to_dict(self, force_str=False):
         data = helper.to_dict(self, force_str)
         data['_request'] = None
@@ -101,6 +98,12 @@ def parse_request(self, app):
         self.server_type = parsed_request.server_type
         self._request = request
 
-        # logger = helper.get_logger()
-        # logger.info('Request: {}'.format(self.to_dict()))
-        return self
+        return self
+
+    @staticmethod
+    def factory(method, host, path):
+        api_request = ApiRequest()
+        api_request.method = method
+        api_request.host = host
+        api_request.path = path
+        return api_request

examples/lambda_api/lambda_app/http_resources/response.py

@@ -27,13 +27,13 @@ def __init__(self, api_request=None):
         self.next = {}
         self.last = {}
         self.limit = api_request.limit if api_request is not None else Pagination.LIMIT
-        self.offset = api_request.offset if api_request is not None else  Pagination.OFFSET
+        self.offset = api_request.offset if api_request is not None else Pagination.OFFSET
         self.total = 0
         self.count = 0
 
         self.api_request = api_request
 
-    def set_hateos(self, flag:bool):
+    def set_hateos(self, flag: bool):
         self.hateos = flag
 
     def set_data(self, data):
@@ -58,23 +58,31 @@ def get_response(self, status_code=None):
 
         headers = self.headers
         status_code = self.status_code
+        success = status_code == 200
+        message = MessagesEnum.OK.message
+        code = MessagesEnum.OK.code
+        label = MessagesEnum.OK.label
+        params = []
 
         if self.exception is not None:
             if isinstance(self.exception, ApiException):
                 code = self.exception.code
                 label = self.exception.label
                 message = self.exception.message
+                params = self.exception.params
             else:
                 message = self.data if not None else MessagesEnum.UNKNOWN_ERROR
                 code = MessagesEnum.NOK.code
                 label = MessagesEnum.NOK.label
                 message = MessagesEnum.NOK.message % message
 
+            # TODO rever
             body = {
                 "error": {
                     "code": code,
                     "label": label,
-                    "message": message
+                    "message": message,
+                    "params": params
                 }
             }
 
@@ -108,27 +116,33 @@ def get_response(self, status_code=None):
                 "last": ""
             }
 
-            if self.hateos:
-                body = {
-                    # data
-                    "data": self.data,
-                    # navigation
-                    "control": {
-                        "offset": self.offset,
-                        "limit": self.limit,
-                        "total": self.total,
-                        "count": self.count,
-                    },
-                    # hypermedia info
-                    "meta": self.meta,
-                    # hypermedia links
-                    "links": self.links
-                }
-            else:
-                body = {
-                    # data
-                    "data": self.data
-                }
+            body = {
+                # success
+                "success": success,
+                "label": label,
+                "code": code,
+                "message": message,
+                "params": [],
+                # data
+                "data": self.data,
+                # navigation
+                "control": {
+                    "offset": self.offset,
+                    "limit": self.limit,
+                    "total": self.total,
+                    "count": self.count,
+                },
+                # hypermedia info
+                "meta": self.meta,
+                # hypermedia links
+                "links": self.links
+            }
+
+            if not self.hateos:
+                del body["meta"]
+                del body["links"]
+
+           # todo deletar o control na leitura de um item unico
 
         if 'Content-Type' in headers and headers['Content-Type'] == 'application/json':
             body = helper.to_json(body)
@@ -143,11 +157,8 @@ def keys(self):
     def __str__(self):
         return self.to_json()
 
-    def __repr__(self):
-        return self.to_json()
-
     def to_dict(self, force_str=False):
         return helper.to_dict(self, force_str)
 
     def to_json(self):
-        return json.dumps(self.to_dict(force_str=False))
+        return json.dumps(self.to_dict(force_str=False))

examples/lambda_api/lambda_app/openapi/api_schemas.py

@@ -2,9 +2,37 @@
 
 from lambda_app.enums.messages import MessagesEnum
 from lambda_app.http_resources.request_control import Pagination
-from lambda_app.openapi.schemas import DeletionSchema, RequestControlSchema, MetaSchema, LinkSchema
+from lambda_app.openapi.schemas import DeletionSchema, RequestControlSchema, MetaSchema, LinkSchema, ErrorSchema
 
 
+class DefaultListResponseSchema(Schema):
+    success = fields.Bool(default=True)
+    code = fields.Int(required=True)
+    label = fields.Str()
+    message = fields.Str()
+    params = fields.List(fields.Str())
+
+
+# ***************************
+# Product
+# ***************************
+class ProductSchema(Schema):
+    sku = fields.Int(example=657705)
+    quantity = fields.Int(example=1)
+    uuid = fields.UUID(example="3d9f2fdb-f71a-4e6d-8fbf-72b12cc0c381")
+
+
+class ProductListResponseSchema(DefaultListResponseSchema):
+    data = fields.List(fields.Nested(ProductSchema))
+    control = fields.Nested(RequestControlSchema)
+    meta = fields.Nested(MetaSchema)
+    links = fields.List(fields.Nested(LinkSchema))
+
+
+# ***************************
+# Event
+# ***************************
+
 class EventSchema(Schema):
     type = fields.Str()
     data = fields.Dict()
@@ -19,25 +47,25 @@ class OcorenSchema(Schema):
     pedido = fields.Str(example="Z1223321")
 
 
-class ProductSchema(Schema):
-    sku = fields.Int(example=657705)
-    quantity = fields.Int(example=1)
-
-
 class EventCreateRequest(OcorenSchema):
     pass
 
+
 class EventUpdateRequest(EventCreateRequest):
     pass
 
 
-class EventListResponseSchema(Schema):
+class EventListResponseSchema(DefaultListResponseSchema):
     data = fields.List(fields.Nested(EventSchema))
     control = fields.Nested(RequestControlSchema)
     meta = fields.Nested(MetaSchema)
     links = fields.List(fields.Nested(LinkSchema))
 
 
+class EventListErrorResponseSchema(ErrorSchema):
+    pass
+
+
 class EventGetResponseSchema(Schema):
     data = fields.Nested(EventSchema)
     control = fields.Nested(RequestControlSchema)

examples/lambda_api/lambda_app/openapi/schemas.py

@@ -4,17 +4,19 @@
 
 
 class DeletionSchema(Schema):
-    success = fields.Bool()
+    success = fields.Bool(default=False)
     code = fields.Int(required=True)
     label = fields.Str()
     message = fields.Str()
     params = fields.List(fields.Str())
 
 
 class ErrorSchema(Schema):
+    success = fields.Bool(default=False)
     code = fields.Int(required=True)
     label = fields.Str()
     message = fields.Str()
+    params = fields.List(fields.Str())
 
 
 class RequestControlSchema(Schema):

examples/lambda_api/lambda_app/repositories/redis/__init__.py renamed to examples/lambda_api/lambda_app/repositories/v1/__init__.py

@@ -3,7 +3,7 @@
 from lambda_app.database.mysql import get_connection
 from lambda_app.http_resources.request_control import Order
 from lambda_app.logging import get_logger
-from lambda_app.repositories.mysql import AbstractRepository
+from lambda_app.repositories.v1.mysql import AbstractRepository
 from lambda_app.vos.product import ProductVO
 import pymysql
 
@@ -82,8 +82,13 @@ def list(self, where: dict, offset=None, limit=None, fields: list = None, sort_b
 
         if sort_by is None:
             sort_by = self.PK
-
-        sort_by = self.BASE_TABLE_ALIAS + '.' + sort_by
+        elif isinstance(sort_by, list):
+            sort_by_arr = []
+            for v in sort_by:
+                sort_by_arr.append(self.BASE_TABLE_ALIAS + '.' + v)
+            sort_by = ",".join(sort_by_arr)
+        else:
+            sort_by = self.BASE_TABLE_ALIAS + '.' + sort_by
 
         sql = "SELECT {} FROM {} as {}".format(fields, self.BASE_TABLE, self.BASE_TABLE_ALIAS)
 
@@ -113,8 +118,13 @@ def count(self, where, sort_by=None, order_by=None):
 
         if sort_by is None:
             sort_by = self.PK
-
-        sort_by = self.BASE_TABLE_ALIAS + '.' + sort_by
+        elif isinstance(sort_by, list):
+            sort_by_arr = []
+            for v in sort_by:
+                sort_by_arr.append(self.BASE_TABLE_ALIAS + '.' + v)
+            sort_by = ",".join(sort_by_arr)
+        else:
+            sort_by = self.BASE_TABLE_ALIAS + '.' + sort_by
 
         sql = "SELECT COUNT(1) as total FROM {} as {}".format(self.BASE_TABLE, self.BASE_TABLE_ALIAS)