cic-stack/apps/cic-ussd/cic_ussd/state_machine/logic/user.py

244 lines
8.0 KiB
Python
Raw Normal View History

2021-02-06 16:13:47 +01:00
# standard imports
import json
2021-02-06 16:13:47 +01:00
import logging
from typing import Tuple
# third-party imports
import celery
from cic_types.models.person import Person, generate_metadata_pointer
from cic_types.models.person import generate_vcard_from_contact_data, manage_identity_data
2021-02-06 16:13:47 +01:00
# local imports
from cic_ussd.chain import Chain
2021-04-19 10:44:40 +02:00
from cic_ussd.db.models.account import Account
from cic_ussd.error import MetadataNotFoundError
from cic_ussd.metadata import blockchain_address_to_metadata_pointer
2021-02-06 16:13:47 +01:00
from cic_ussd.operations import save_to_in_memory_ussd_session_data
from cic_ussd.redis import get_cached_data
2021-02-06 16:13:47 +01:00
logg = logging.getLogger(__file__)
2021-04-19 10:44:40 +02:00
def change_preferred_language_to_en(state_machine_data: Tuple[str, dict, Account]):
2021-02-06 16:13:47 +01:00
"""This function changes the user's preferred language to english.
:param state_machine_data: A tuple containing user input, a ussd session and user object.
:type state_machine_data: tuple
"""
user_input, ussd_session, user = state_machine_data
user.preferred_language = 'en'
2021-04-19 10:44:40 +02:00
Account.session.add(user)
Account.session.commit()
2021-02-06 16:13:47 +01:00
2021-04-19 10:44:40 +02:00
def change_preferred_language_to_sw(state_machine_data: Tuple[str, dict, Account]):
2021-02-06 16:13:47 +01:00
"""This function changes the user's preferred language to swahili.
:param state_machine_data: A tuple containing user input, a ussd session and user object.
:type state_machine_data: tuple
"""
user_input, ussd_session, user = state_machine_data
user.preferred_language = 'sw'
2021-04-19 10:44:40 +02:00
Account.session.add(user)
Account.session.commit()
2021-02-06 16:13:47 +01:00
2021-04-19 10:44:40 +02:00
def update_account_status_to_active(state_machine_data: Tuple[str, dict, Account]):
2021-02-06 16:13:47 +01:00
"""This function sets user's account to active.
:param state_machine_data: A tuple containing user input, a ussd session and user object.
:type state_machine_data: tuple
"""
user_input, ussd_session, user = state_machine_data
user.activate_account()
2021-04-19 10:44:40 +02:00
Account.session.add(user)
Account.session.commit()
2021-02-06 16:13:47 +01:00
2021-04-19 10:44:40 +02:00
def process_gender_user_input(user: Account, user_input: str):
"""
:param user:
:type user:
:param user_input:
:type user_input:
:return:
:rtype:
"""
if user.preferred_language == 'en':
if user_input == '1':
gender = 'Male'
2021-06-03 15:40:51 +02:00
elif user_input == '2':
gender = 'Female'
2021-06-03 15:40:51 +02:00
elif user_input == '3':
gender = 'Other'
else:
if user_input == '1':
gender = 'Mwanaume'
2021-06-03 15:40:51 +02:00
elif user_input == '2':
gender = 'Mwanamke'
2021-06-03 15:40:51 +02:00
elif user_input == '3':
gender = 'Nyingine'
return gender
2021-04-19 10:44:40 +02:00
def save_metadata_attribute_to_session_data(state_machine_data: Tuple[str, dict, Account]):
2021-02-06 16:13:47 +01:00
"""This function saves first name data to the ussd session in the redis cache.
:param state_machine_data: A tuple containing user input, a ussd session and user object.
:type state_machine_data: tuple
"""
user_input, ussd_session, user = state_machine_data
# get current menu
current_state = ussd_session.get('state')
# define session data key from current state
key = ''
if 'given_name' in current_state:
key = 'given_name'
2021-06-03 15:40:51 +02:00
if 'family_name' in current_state:
key = 'family_name'
2021-06-03 15:40:51 +02:00
if 'gender' in current_state:
2021-02-06 16:13:47 +01:00
key = 'gender'
user_input = process_gender_user_input(user=user, user_input=user_input)
2021-06-03 15:40:51 +02:00
if 'location' in current_state:
2021-02-06 16:13:47 +01:00
key = 'location'
2021-06-03 15:40:51 +02:00
if 'products' in current_state:
key = 'products'
2021-02-06 16:13:47 +01:00
# check if there is existing session data
if ussd_session.get('session_data'):
session_data = ussd_session.get('session_data')
session_data[key] = user_input
else:
session_data = {
key: user_input
}
save_to_in_memory_ussd_session_data(queue='cic-ussd', session_data=session_data, ussd_session=ussd_session)
2021-04-19 10:44:40 +02:00
def format_user_metadata(metadata: dict, user: Account):
"""
:param metadata:
:type metadata:
:param user:
:type user:
:return:
:rtype:
"""
gender = metadata.get('gender')
given_name = metadata.get('given_name')
family_name = metadata.get('family_name')
2021-06-03 15:40:51 +02:00
# check whether there's existing location data
if isinstance(metadata.get('location'), dict):
location = metadata.get('location')
else:
location = {
"area_name": metadata.get('location')
}
# check whether it is a list
if isinstance(metadata.get('products'), list):
products = metadata.get('products')
else:
products = metadata.get('products').split(',')
2021-06-03 15:40:51 +02:00
phone_number = user.phone_number
date_registered = int(user.created.replace().timestamp())
blockchain_address = user.blockchain_address
chain_spec = f'{Chain.spec.common_name()}:{Chain.spec.network_id()}'
identities = manage_identity_data(
blockchain_address=blockchain_address,
blockchain_type=Chain.spec.engine(),
chain_spec=chain_spec
)
return {
"date_registered": date_registered,
"gender": gender,
"identities": identities,
"location": location,
"products": products,
"vcard": generate_vcard_from_contact_data(
family_name=family_name,
given_name=given_name,
tel=phone_number
)
}
2021-04-19 10:44:40 +02:00
def save_complete_user_metadata(state_machine_data: Tuple[str, dict, Account]):
"""This function persists elements of the user metadata stored in session data
2021-02-06 16:13:47 +01:00
:param state_machine_data: A tuple containing user input, a ussd session and user object.
:type state_machine_data: tuple
"""
user_input, ussd_session, user = state_machine_data
# get session data
metadata = ussd_session.get('session_data')
# format metadata appropriately
user_metadata = format_user_metadata(metadata=metadata, user=user)
blockchain_address = user.blockchain_address
2021-04-14 11:00:10 +02:00
s_create_person_metadata = celery.signature(
'cic_ussd.tasks.metadata.create_person_metadata',
[blockchain_address, user_metadata]
)
2021-04-14 11:00:10 +02:00
s_create_person_metadata.apply_async(queue='cic-ussd')
2021-02-06 16:13:47 +01:00
2021-04-19 10:44:40 +02:00
def edit_user_metadata_attribute(state_machine_data: Tuple[str, dict, Account]):
user_input, ussd_session, user = state_machine_data
blockchain_address = user.blockchain_address
key = generate_metadata_pointer(
identifier=blockchain_address_to_metadata_pointer(blockchain_address=user.blockchain_address),
2021-05-01 16:52:54 +02:00
cic_type=':cic.person'
)
user_metadata = get_cached_data(key=key)
if not user_metadata:
raise MetadataNotFoundError(f'Expected user metadata but found none in cache for key: {blockchain_address}')
given_name = ussd_session.get('session_data').get('given_name')
family_name = ussd_session.get('session_data').get('family_name')
gender = ussd_session.get('session_data').get('gender')
location = ussd_session.get('session_data').get('location')
products = ussd_session.get('session_data').get('products')
# validate user metadata
person = Person()
user_metadata = json.loads(user_metadata)
# edit specific metadata attribute
if given_name:
2021-06-03 15:40:51 +02:00
user_metadata['given_name'] = given_name
if family_name:
user_metadata['family_name'] = family_name
if gender:
user_metadata['gender'] = gender
if location:
# get existing location metadata:
location_data = user_metadata.get('location')
location_data['area_name'] = location
2021-06-03 15:40:51 +02:00
user_metadata['location'] = location_data
if products:
user_metadata['products'] = products
2021-06-03 15:40:51 +02:00
user_metadata = format_user_metadata(metadata=user_metadata, user=user)
2021-04-14 11:00:10 +02:00
s_edit_person_metadata = celery.signature(
2021-06-03 15:40:51 +02:00
'cic_ussd.tasks.metadata.create_person_metadata',
[blockchain_address, user_metadata]
)
2021-04-14 11:00:10 +02:00
s_edit_person_metadata.apply_async(queue='cic-ussd')
2021-04-19 10:44:40 +02:00
def get_user_metadata(state_machine_data: Tuple[str, dict, Account]):
user_input, ussd_session, user = state_machine_data
blockchain_address = user.blockchain_address
s_get_user_metadata = celery.signature(
2021-04-14 11:00:10 +02:00
'cic_ussd.tasks.metadata.query_person_metadata',
[blockchain_address]
)
s_get_user_metadata.apply_async(queue='cic-ussd')