cic-internal-integration/apps/cic-ussd/cic_ussd/metadata/base.py

141 lines
5.0 KiB
Python
Raw Normal View History

2021-04-14 11:00:10 +02:00
# standard imports
import json
import logging
import os
from typing import Dict, Union
# third-part imports
import requests
from cic_types.models.person import generate_metadata_pointer, Person
# local imports
from cic_ussd.metadata import make_request
from cic_ussd.metadata.signer import Signer
from cic_ussd.redis import cache_data
from cic_ussd.error import MetadataStoreError
logg = logging.getLogger().getChild(__name__)
class Metadata:
"""
2021-04-14 11:00:10 +02:00
:cvar base_url: The base url or the metadata server.
:type base_url: str
"""
base_url = None
2021-04-14 11:00:10 +02:00
def metadata_http_error_handler(result: requests.Response):
""" This function handles and appropriately raises errors from http requests interacting with the metadata server.
:param result: The response object from a http request.
:type result: requests.Response
"""
status_code = result.status_code
if 100 <= status_code < 200:
raise MetadataStoreError(f'Informational errors: {status_code}, reason: {result.reason}')
elif 300 <= status_code < 400:
raise MetadataStoreError(f'Redirect Issues: {status_code}, reason: {result.reason}')
elif 400 <= status_code < 500:
raise MetadataStoreError(f'Client Error: {status_code}, reason: {result.reason}')
elif 500 <= status_code < 600:
raise MetadataStoreError(f'Server Error: {status_code}, reason: {result.reason}')
class MetadataRequestsHandler(Metadata):
def __init__(self, cic_type: str, identifier: bytes, engine: str = 'pgp'):
"""
:param cic_type: The salt value with which to hash a specific metadata identifier.
:type cic_type: str
:param engine: Encryption used for sending data to the metadata server.
:type engine: str
:param identifier: A unique element of data in bytes necessary for creating a metadata pointer.
:type identifier: bytes
"""
self.cic_type = cic_type
self.engine = engine
self.headers = {
'X-CIC-AUTOMERGE': 'server',
'Content-Type': 'application/json'
}
self.identifier = identifier
self.metadata_pointer = generate_metadata_pointer(
identifier=self.identifier,
cic_type=self.cic_type
)
if self.base_url:
self.url = os.path.join(self.base_url, self.metadata_pointer)
def create(self, data: Union[Dict, str]):
""" This function is responsible for posting data to the metadata server with a corresponding metadata pointer
for storage.
:param data: The data to be stored in the metadata server.
:type data: dict|str
"""
2021-06-03 15:40:51 +02:00
data = json.dumps(data)
2021-04-14 11:00:10 +02:00
result = make_request(method='POST', url=self.url, data=data, headers=self.headers)
metadata_http_error_handler(result=result)
2021-06-03 15:40:51 +02:00
metadata = result.json()
2021-04-14 11:00:10 +02:00
self.edit(data=metadata)
2021-06-03 15:40:51 +02:00
def edit(self, data: Union[Dict, str]):
2021-04-14 11:00:10 +02:00
""" This function is responsible for editing data in the metadata server corresponding to a unique pointer.
:param data: The data to be edited in the metadata server.
2021-06-03 15:40:51 +02:00
:type data: dict
2021-04-14 11:00:10 +02:00
"""
cic_meta_signer = Signer()
signature = cic_meta_signer.sign_digest(data=data)
algorithm = cic_meta_signer.get_operational_key().get('algo')
formatted_data = {
2021-06-03 15:40:51 +02:00
'm': json.dumps(data),
2021-04-14 11:00:10 +02:00
's': {
'engine': self.engine,
'algo': algorithm,
'data': signature,
2021-06-03 15:40:51 +02:00
'digest': data.get('digest'),
2021-04-14 11:00:10 +02:00
}
}
formatted_data = json.dumps(formatted_data)
2021-04-14 11:00:10 +02:00
result = make_request(method='PUT', url=self.url, data=formatted_data, headers=self.headers)
logg.info(f'signed metadata submission status: {result.status_code}.')
metadata_http_error_handler(result=result)
try:
decoded_identifier = self.identifier.decode("utf-8")
except UnicodeDecodeError:
decoded_identifier = self.identifier.hex()
2021-06-03 15:40:51 +02:00
logg.info(f'identifier: {decoded_identifier}. metadata pointer: {self.metadata_pointer} set to: {data}.')
2021-04-14 11:00:10 +02:00
def query(self):
2021-06-03 15:40:51 +02:00
"""
:return:
:rtype:
"""
# retrieve the metadata
2021-04-14 11:00:10 +02:00
result = make_request(method='GET', url=self.url)
metadata_http_error_handler(result=result)
2021-06-03 15:40:51 +02:00
# json serialize retrieved data
result_data = result.json()
# validate result data format
if not isinstance(result_data, dict):
raise ValueError(f'Invalid result data object: {result_data}.')
2021-05-01 16:52:54 +02:00
if result.status_code == 200 and self.cic_type == ':cic.person':
2021-06-03 15:40:51 +02:00
# validate person metadata
2021-04-14 11:00:10 +02:00
person = Person()
2021-06-03 15:40:51 +02:00
person_data = person.deserialize(person_data=result_data)
# format new person data for caching
data = json.dumps(person_data.serialize())
# cache metadata
cache_data(key=self.metadata_pointer, data=data)
2021-04-14 11:00:10 +02:00
logg.debug(f'caching: {data} with key: {self.metadata_pointer}')