first endpoint report

Author: maceto

.gitignore

@@ -0,0 +1,33 @@
+# IDES
+.vscode
+
+# Terraform
+.terraform
+*.tfstate
+*.tfstate.*
+*.terraform.lock.hcl
+secret.tfvars
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+*tfplan*
+.terraformrc
+terraform.rc
+*.tfvars
+*.local.tfvars
+
+/terraform
+
+# env
+.envrc
+
+# CLI
+.DS_Store
+
+# asdf
+/.tool-versions
+
+# python
+__pycache__
+.pytest_cache

conftest.py

@@ -0,0 +1,2 @@
+import pytest
+from functions import *

functions/report/libs/__init__.py

@@ -0,0 +1,28 @@
+import os
+from google.cloud import firestore
+from .result import Result 
+
+DB = firestore.Client(project=os.environ.get('PROJECT'))
+
+def list_data(params):
+  ref = DB.collection(u'reports')
+
+  query = ref
+
+  if 'start' in params:
+    query = query.where('date', '>=', params['start'])
+  if 'end' in params:
+    query = query.where('date', '<', params['end'])
+  if 'category' in params:
+    query = query.where('category', '==', params['category'])
+  if 'geo' in params:
+    query = query.where('geo', '==', params['geo'])
+  
+  documents = query.stream()
+
+  data = {}
+
+  for doc in documents:
+    data[doc.id] = doc.to_dict()
+
+  return Result(result=data)

functions/report/libs/queries.py

@@ -0,0 +1,20 @@
+
+class Result():
+  def __init__(self, status=None, result=None, errors=[]):
+    self._status = status
+    self.result = result
+    self.errors = errors
+
+  def success(self) -> bool:
+    return not self.failure()
+
+  def failure(self) -> bool:
+    return len(self.errors) > 0
+  
+  @property
+  def status(self):
+    if self._status != None:
+      return self._status
+  
+    return "ok" if self.success else "error"
+    

functions/report/libs/result.py

@@ -0,0 +1,6 @@
+import json
+
+def output(result):
+  status = 200 if result.success() else 400
+  payload = result.result if result.success() else result.errors
+  return (json.dumps(payload), status)

functions/report/libs/utils.py

@@ -0,0 +1,21 @@
+from .result import Result
+
+class Validator():
+  def __init__(self, params):
+    self.params = params
+    self.errors = []
+    self.normalizer_params = self.normalize(params)
+
+  def validate(self):
+    result = Result(status="ok", result="()")
+
+    if 'geo' not in self.params:
+      self.add_error("geo", "missing geo parameters")
+
+    return Result(errors=self.errors, result=self.params)
+  
+  def add_error(self, key, error):
+    self.errors.append([key, error])
+
+  def normalize(self, params):
+    return ""

functions/report/libs/validator.py

@@ -0,0 +1,19 @@
+import functions_framework
+from .libs.validator import Validator
+from .libs.utils import output
+from .libs.queries import list_data
+
+@functions_framework.http
+def dispatcher(request):
+  args = request.args.to_dict()
+
+  validator = Validator(params=args)
+  result = validator.validate()
+
+  if result.failure():
+    print("error", result.errors)
+    return output(result)
+  
+  response = list_data(result.result)
+
+  return output(response)

functions/report/main.py

@@ -0,0 +1,3 @@
+functions-framework
+google-cloud-firestore
+pytest

functions/report/requirements.txt

@@ -0,0 +1,5 @@
+functions-framework
+google-cloud-firestore
+google-cloud-error-reporting
+mock-firestore
+pytest

requirements.txt

@@ -0,0 +1,32 @@
+import pytest
+from functions.report.libs.result import Result
+
+def test_success():
+    r = Result(status="success")
+    assert r.success() == True
+    assert r.failure() == False
+
+def test_failure():
+    r = Result(errors=["some error"])
+    assert r.success() == False
+    assert r.failure() == True
+
+def test_default_status():
+    r = Result()
+    assert r.status == "ok"
+    assert r.success() == True
+    assert r.failure() == False
+
+def test_custom_status():
+    r = Result(status="custom")
+    assert r.status == "custom"
+    assert r.success() == True
+    assert r.failure() == False
+
+def test_result():
+    r = Result(result="some result")
+    assert r.result == "some result"
+
+def test_errors():
+    r = Result(errors=["some error"])
+    assert r.errors == ["some error"]

tests/test_report/libs/test_result.py

@@ -0,0 +1,24 @@
+from functions.report.libs.utils import *
+from functions.report.libs.result import Result
+import json
+
+def test_output():
+    # Create a mock result object with a successful status
+    result_success = Result(status="success", result={"message": "Hello, world!"})
+    
+    # Call the output function with the mock result object
+    output_result_success = output(result_success)
+    
+    # Verify that the output has the correct HTTP status code and payload
+    assert output_result_success[0] == 200
+    assert json.loads(output_result_success[1]) == {"message": "Hello, world!"}
+    
+    # Create a mock result object with an error status
+    result_error = Result(status="error", errors=["Invalid request"])
+    
+    # Call the output function with the mock result object
+    output_result_error = output(result_error)
+    
+    # Verify that the output has the correct HTTP status code and payload
+    assert output_result_error[0] == 400
+    assert json.loads(output_result_error[1]) == ["Invalid request"]