From a2e5f804d6338cb37c3b9a8d407a3bd4afac8dde Mon Sep 17 00:00:00 2001 From: Scott Idem Date: Fri, 15 Apr 2022 18:25:06 -0400 Subject: [PATCH] Work on ISHLT Impexium importing --- app/methods/event_badge_methods.py | 24 ++-- app/models/event_badge_models.py | 131 +++++++++++++++++++- app/models/event_exhibit_tracking_models.py | 4 + app/models/event_person_models.py | 3 +- app/routers/e_impexium.py | 80 ++++++++++-- app/routers/event_exhibit_tracking.py | 83 +++++++++++++ 6 files changed, 303 insertions(+), 22 deletions(-) diff --git a/app/methods/event_badge_methods.py b/app/methods/event_badge_methods.py index 7c42618..a9a0520 100644 --- a/app/methods/event_badge_methods.py +++ b/app/methods/event_badge_methods.py @@ -9,7 +9,7 @@ from app.lib_general import log, logging, logger_reset from app.methods.event_badge_template_methods import load_event_badge_template_obj -from app.models.event_badge_models import Event_Badge_Base +from app.models.event_badge_models import Event_Badge_Base, Event_Badge_Basic_Base # ### BEGIN ### API Event Badge Methods ### load_event_badge_obj() ### @@ -23,8 +23,9 @@ def load_event_badge_obj( model_as_dict: bool = False, enabled: str = 'enabled', # enabled, disabled, all inc_event_badge_template: bool = False, + return_basic_model: bool = False, ) -> Event_Badge_Base|dict|bool: - log.setLevel(logging.INFO) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL + log.setLevel(logging.DEBUG) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL log.debug(locals()) if event_badge_id := redis_lookup_id_random(record_id_random=event_badge_id, table_name='event_badge'): pass @@ -33,12 +34,19 @@ def load_event_badge_obj( if event_badge_rec := sql_select(table_name='v_event_badge', record_id=event_badge_id): pass else: return False - try: - event_badge_obj = Event_Badge_Base(**event_badge_rec) - log.debug(event_badge_obj) - except ValidationError as e: - log.error(e.json()) - return False + if return_basic_model: + try: + event_badge_obj = Event_Badge_Basic_Base(**event_badge_rec) + except ValidationError as e: + log.error(e.json()) + return False + else: + try: + event_badge_obj = Event_Badge_Base(**event_badge_rec) + except ValidationError as e: + log.error(e.json()) + return False + log.debug(event_badge_obj) # Updated 2022-03-14 if inc_event_badge_template: diff --git a/app/models/event_badge_models.py b/app/models/event_badge_models.py index 8797a3e..1ce585c 100644 --- a/app/models/event_badge_models.py +++ b/app/models/event_badge_models.py @@ -44,7 +44,8 @@ class Event_Badge_Base(BaseModel): person_id: Optional[int] external_id: Optional[str] # Generated internally or externally. Needs to be stable. It should not change. - external_sys_id: Optional[str] # Generated by external system (should be stable and not change) + external_sys_id: Optional[str] # Person ID generated by external system (should be stable and not change) + external_reg_id: Optional[str] # Registration ID generated by external system (should be stable and not change) pronouns: Optional[str] # Preferred pronouns informal_name: Optional[str] @@ -62,7 +63,7 @@ class Event_Badge_Base(BaseModel): professional_title: Optional[str] # Professional title title: Optional[str] # NOTE: Phasing out! Use *professional_title* instead. - display_name: Optional[str] # Actual name shown on badge and other "public" areas + display_name: Optional[str] # # Override full_name; Actual name shown on badge and other "public" areas # BEGIN # Auto created name variations full_name: Optional[str] # title_names given_name middle_name family_name designations @@ -70,6 +71,7 @@ class Event_Badge_Base(BaseModel): affiliations: Optional[str] # One or more affiliations with organizations, companies, and other groups affiliation: Optional[str] # NOTE: Phasing out! Use *affiliations* instead. affiliation_name: Optional[str] # NOTE: Phasing out! Use *affiliations* instead. + display_affiliations: Optional[str] # Override affiliations email: Optional[str] @@ -86,6 +88,7 @@ class Event_Badge_Base(BaseModel): location: Optional[str] # Actual location name shown on badge and other "public" areas location_short: Optional[str] # Auto generated short version location_long: Optional[str] # Auto generated long version + display_location: Optional[str] # Override location # This is updated using SQL triggers and a SQL function # Combines informal, given, middle, family, email @@ -185,3 +188,127 @@ class Event_Badge_Base(BaseModel): underscore_attrs_are_private = True allow_population_by_field_name = True fields = base_fields + + +class Event_Badge_Basic_Base(BaseModel): + log.setLevel(logging.WARNING) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL + log.debug(locals()) + + id_random: Optional[str] = Field( + **base_fields['event_badge_id_random'], + alias = 'event_badge_id_random', + ) + event_badge_template_id_random: Optional[str] + # event_badge_template_id: Optional[int] + + event_person_id_random: Optional[str] + # event_person_id: Optional[int] + + external_id: Optional[str] # Generated internally or externally. Needs to be stable. It should not change. + # external_sys_id: Optional[str] # Person ID generated by external system (should be stable and not change) + # external_reg_id: Optional[str] # Registration ID generated by external system (should be stable and not change) + + pronouns: Optional[str] # Preferred pronouns + informal_name: Optional[str] + + title_names: Optional[str] # Title for generation, official position, or professional or academic qualification, other honorific, or other name prefix + given_name: Optional[str] + middle_name: Optional[str] + family_name: Optional[str] + designations: Optional[str] # Temporary or long-term designations related to family, relationships, person differentiation (Junior/Senior), location, social status, professional qualifications, legal status, or other name suffix + + professional_title: Optional[str] # Professional title + + display_name: Optional[str] # Override full_name; Actual name shown on badge and other "public" areas + + # BEGIN # Auto created name variations + full_name: Optional[str] # title_names given_name middle_name family_name designations + + affiliations: Optional[str] # One or more affiliations with organizations, companies, and other groups + display_affiliations: Optional[str] # Override affiliations + + email: Optional[str] + + city: Optional[str] + county: Optional[str] # NOTE: This is for a county within a state or province + country_subdivision_code: Optional[str] + state_province: Optional[str] + state_province_abb: Optional[str] + + country_alpha_2_code: Optional[str] + country: Optional[str] + + # full_address: Optional[str] + location: Optional[str] # Actual location name shown on badge and other "public" areas + # location_short: Optional[str] # Auto generated short version + # location_long: Optional[str] # Auto generated long version + display_location: Optional[str] # Override location + + # NOTE: More badge fields need to be added here once things are cleaned up + badge_type_code: Optional[str] + badge_type: Optional[str] + member_type_code: Optional[str] + member_type: Optional[str] + registration_type_code: Optional[str] + registration_type: Optional[str] + + # other_1: Optional[str] + # other_2: Optional[str] + + # agree_to_tc: Optional[bool] # Agree to terms and conditions + allow_tracking: Optional[bool] # Allow tracking for lead retrival and other marketing + + # print_first_datetime: Optional[datetime.datetime] = None + # print_last_datetime: Optional[datetime.datetime] = None + # print_count: Optional[int] + + # priority: Optional[bool] + # sort: Optional[int] + # group: Optional[str] + enable: Optional[bool] + + # notes: Optional[str] + created_on: Optional[datetime.datetime] = None + updated_on: Optional[datetime.datetime] = None + + # Including other related objects + # order: Optional[Union[Order_Base, None]] + # ticket_list: Optional[list] + event_badge_template: Optional[Union[Event_Badge_Template_Base, None]] + + _processed_at: datetime.datetime = PrivateAttr(default_factory=datetime.datetime.now) + + #@validator('event_badge_id_random', always=True) + # def event_badge_id_random_copy(cls, v, values, **kwargs): + # log.setLevel(logging.WARNING) + # log.debug(locals()) + + # if values['id_random']: + # return values['id_random'] + # return None + + # @validator('id', always=True) + # def event_badge_id_lookup(cls, v, values, **kwargs): + # if isinstance(v, int) and v > 0: return v + # elif id_random := values.get('id_random'): + # return redis_lookup_id_random(record_id_random=id_random, table_name='event_badge') + # return None + + # @validator('event_badge_template_id', always=True) + # def event_badge_template_id_lookup(cls, v, values, **kwargs): + # if isinstance(v, int) and v > 0: return v + # elif id_random := values.get('event_badge_template_id_random'): + # return redis_lookup_id_random(record_id_random=id_random, table_name='event_badge_template') + # return None + + # @validator('event_person_id', always=True) + # def event_person_id_lookup(cls, v, values, **kwargs): + # if isinstance(v, int) and v > 0: return v + # elif id_random := values.get('event_person_id_random'): + # return redis_lookup_id_random(record_id_random=id_random, table_name='event_person') + # return None + + class Config: + underscore_attrs_are_private = True + allow_population_by_field_name = True + fields = base_fields diff --git a/app/models/event_exhibit_tracking_models.py b/app/models/event_exhibit_tracking_models.py index 4998816..f5518ef 100644 --- a/app/models/event_exhibit_tracking_models.py +++ b/app/models/event_exhibit_tracking_models.py @@ -38,6 +38,10 @@ class Event_Exhibit_Tracking_Base(BaseModel): event_badge_id_random: Optional[str] event_badge_id: Optional[int] + exhibitor_notes: Optional[str] + # json_data: Optional[str] + json_data: Optional[Json] + enable: Optional[bool] hide: Optional[bool] priority: Optional[bool] = False diff --git a/app/models/event_person_models.py b/app/models/event_person_models.py index c9676bb..fec3607 100644 --- a/app/models/event_person_models.py +++ b/app/models/event_person_models.py @@ -57,7 +57,8 @@ class Event_Person_Base(BaseModel): user_id: Optional[int] external_id: Optional[str] # Generated internally or externally. Needs to be stable. It should not change. - external_sys_id: Optional[str] # Generated by external system (should be stable and not change) + external_sys_id: Optional[str] # Person ID generated by external system (should be stable and not change) + external_reg_id: Optional[str] # Registration ID generated by external system (should be stable and not change) file_count: Optional[int] diff --git a/app/routers/e_impexium.py b/app/routers/e_impexium.py index be97c6b..c140495 100644 --- a/app/routers/e_impexium.py +++ b/app/routers/e_impexium.py @@ -22,7 +22,7 @@ router = APIRouter() # ### BEGIN ### API Impexium ### event_import_reg() ### -# Updated 2021-10-07 +# Updated 2022-04-15 @router.get('/event/{e_impexium_event_id}/import_reg', response_model=Resp_Body_Base) async def event_import_reg( e_impexium_event_id: str = Query(..., min_length=11, max_length=22), # For ISHLT: 42_AM (2022-04); EX22_AM (2022-04); 41V_2 (2021-04) @@ -70,18 +70,24 @@ async def event_import_reg( # Creating an external ID from the Impexium record number and registration number. Very explicitly converting each number to a string before joining, just in case. external_id_old = str(event_registrant.get('recordNumber'))+':'+str(event_registrant.get('registrationNumber')) - external_id_new = str(e_impexium_event_id)+':'+str(event_registrant.get('recordNumber'))+':'+str(event_registrant.get('registrationNumber')) + external_id_v2 = str(e_impexium_event_id)+':'+str(event_registrant.get('recordNumber'))+':'+str(event_registrant.get('registrationNumber')) + + external_id_v3 = str(e_impexium_event_id)+':'+str(event_registrant.get('recordNumber')) + external_sys_id = event_registrant.get('id') # Impexium UUID for person + external_reg_id = event_registrant.get('recordNumber') # Impexium record number for a registration (guest should match) event_person_summary_data = {} - event_person_summary_data['external_id'] = external_id_new + event_person_summary_data['external_id'] = external_id_v3 event_person_data = {} + event_person_data['enable'] = True event_person_data['account_id'] = account_id event_person_data['event_id'] = event_id - event_person_data['external_id'] = external_id_new + event_person_data['external_id'] = external_id_v3 event_person_data['external_sys_id'] = external_sys_id + event_person_data['external_reg_id'] = external_reg_id # event_person_data['external_id_old'] = external_id_old email = None @@ -122,6 +128,7 @@ async def event_import_reg( event_person_profile_data = {} + event_person_profile_data['enable'] = True event_person_profile_data['pronouns'] = event_registrant.get('gender') event_person_profile_data['informal_name'] = event_registrant.get('preferredFirstName') @@ -136,8 +143,8 @@ async def event_import_reg( else: event_person_profile_data['professional_title'] = None # event_registrant.get('title') # Should this be None if no degrees found above??? - event_person_profile_data['display_name'] = event_registrant.get('badgeName') - event_person_summary_data['display_name'] = event_registrant.get('badgeName') + event_person_profile_data['full_name'] = event_registrant.get('badgeName') + event_person_summary_data['full_name'] = event_registrant.get('badgeName') if organization_name: event_person_profile_data['affiliations'] = organization_name # Ideally should be organization_name for ISHLT @@ -150,9 +157,11 @@ async def event_import_reg( event_person_data['event_person_profile'] = event_person_profile_data event_badge_data = {} + event_badge_data['enable'] = True event_badge_data['event_id'] = event_id - event_badge_data['external_id'] = external_id_new + event_badge_data['external_id'] = external_id_v3 event_badge_data['external_sys_id'] = external_sys_id + event_badge_data['external_reg_id'] = external_reg_id # event_badge_data['external_id_old'] = external_id_old if reg_type_code := event_registrant.get('registrantTypeCode'): @@ -182,15 +191,36 @@ async def event_import_reg( else: event_badge_data['badge_type'] = event_registrant.get('registrantTypeName') + if custom_fields := event_registrant.get('itemizedCustomFields'): + if isinstance(custom_fields, list): + log.info('Found list of custom fields for an exhibitor. Searching for "exhibitor_reg_type') + for field in custom_fields: + if field.get('name') == 'registration_type': + event_badge_data['registration_type_code'] = field.get('name') + event_badge_data['registration_type'] = field.get('value') + break + else: log.info('Found custom fields section, but no list was found.') + else: + log.warning('The custom fields were not found at all. Are the "details" being included?') + event_badge_data['event_badge_template_id'] = 3 + elif e_impexium_event_id == '42_AM': if not reg_type_code and event_registrant.get('guestOfRecordNumber'): event_badge_data['badge_type_code'] = 'GUEST' event_badge_data['badge_type'] = 'Guest' + + event_badge_data['registration_type_code'] = 'GUEST' + event_badge_data['registration_type'] = 'Guest' else: event_badge_data['badge_type_code'] = 'UNKNOWN' event_badge_data['badge_type'] = 'Unknown Type' + + event_badge_data['registration_type_code'] = 'UNKNOWN' + event_badge_data['registration_type'] = 'Unknown Type' + event_badge_data['event_badge_template_id'] = 3 + elif e_impexium_event_id == 'EX22_AM': event_badge_data['badge_type_code'] = 'EX' event_badge_data['badge_type'] = 'Exhibit Staff' @@ -206,35 +236,63 @@ async def event_import_reg( elif field.get('value') == 'Exhibitor All Access ': event_badge_data['badge_type_code'] = 'EXALL' event_badge_data['badge_type'] = 'Exhibitor All Access' + + event_badge_data['registration_type_code'] = field.get('value') + event_badge_data['registration_type'] = field.get('value') + break else: log.info('Found custom fields section, but no list was found.') else: log.warning('The custom fields were not found at all. Are the "details" being included?') event_badge_data['event_badge_template_id'] = 3 + elif e_impexium_event_id == '2022HEART': if not reg_type_code and event_registrant.get('guestOfRecordNumber'): event_badge_data['badge_type_code'] = 'GUEST' event_badge_data['badge_type'] = 'Guest' + + event_badge_data['registration_type_code'] = 'GUEST' + event_badge_data['registration_type'] = 'Guest' else: event_badge_data['badge_type_code'] = 'HEART' event_badge_data['badge_type'] = 'HFTX Core' + + event_badge_data['registration_type_code'] = 'HEART' + event_badge_data['registration_type'] = 'HFTX Core' + event_badge_data['event_badge_template_id'] = 5 + + # event_badge_data['registration_type_code'] = event_registrant.get('registrantTypeCode') + # event_badge_data['registration_type'] = event_registrant.get('registrantTypeName') + elif e_impexium_event_id == '2022LUNG': if not reg_type_code and event_registrant.get('guestOfRecordNumber'): event_badge_data['badge_type_code'] = 'GUEST' event_badge_data['badge_type'] = 'Guest' + + event_badge_data['badge_type_code'] = 'GUEST' + event_badge_data['badge_type'] = 'Guest' else: event_badge_data['badge_type_code'] = 'LUNG' event_badge_data['badge_type'] = 'LTX Core' + + event_badge_data['registration_type_code'] = 'LUNG' + event_badge_data['registration_type'] = 'LTX Core' + event_badge_data['event_badge_template_id'] = 5 + + # event_badge_data['registration_type_code'] = event_registrant.get('registrantTypeCode') + # event_badge_data['registration_type'] = event_registrant.get('registrantTypeName') + else: event_badge_data['badge_type_code'] = 'UNKNOWN' event_badge_data['badge_type'] = 'Unknown Type' event_badge_data['event_badge_template_id'] = 3 + event_badge_data['registration_type_code'] = event_registrant.get('registrantTypeCode') + event_badge_data['registration_type'] = event_registrant.get('registrantTypeName') + event_badge_data['member_type_code'] = event_registrant.get('customerType') # Using this as the member_type - event_badge_data['registration_type_code'] = event_registrant.get('registrantTypeCode') - event_badge_data['registration_type'] = event_registrant.get('registrantTypeName') event_badge_data['pronouns'] = event_registrant.get('gender') event_badge_data['informal_name'] = event_registrant.get('preferredFirstName') @@ -250,7 +308,7 @@ async def event_import_reg( else: event_badge_data['professional_title'] = None # event_registrant.get('title') # Should this be None if no degrees found above??? - event_badge_data['display_name'] = event_registrant.get('badgeName') + event_badge_data['full_name'] = event_registrant.get('badgeName') if organization_name: event_badge_data['affiliations'] = organization_name # Ideally should be organization_name for ISHLT @@ -369,7 +427,7 @@ async def event_import_reg( # event_badge_data['professional_title'] = event_registrant.get('title') - # event_badge_data['display_name'] = event_registrant.get('badgeName') + # event_badge_data['full_name'] = event_registrant.get('badgeName') # event_badge_data['affiliations'] = event_registrant.get('badgeOrganization') diff --git a/app/routers/event_exhibit_tracking.py b/app/routers/event_exhibit_tracking.py index 1bb82c6..6b3b57e 100644 --- a/app/routers/event_exhibit_tracking.py +++ b/app/routers/event_exhibit_tracking.py @@ -9,6 +9,7 @@ from app.db_sql import sql_insert, sql_update, sql_insert_or_update, sql_select, from app.routers.api_crud import delete_obj_template, get_obj_template, get_obj_li_template, patch_obj_template, post_obj_template +from app.methods.event_badge_methods import load_event_badge_obj from app.methods.event_exhibit_tracking_methods import create_event_exhibit_tracking_obj, remove_event_exhibit_tracking_obj, get_event_exhibit_tracking_rec_list, load_event_exhibit_tracking_obj, update_event_exhibit_tracking_obj from app.models.event_exhibit_tracking_models import Event_Exhibit_Tracking_Base @@ -301,3 +302,85 @@ def delete_event_exhibit_tracking_obj( log.warning('Likely bad request') return mk_resp(data=False, status_code=400, response=response) # Bad Request # ### END ### API Event Exhibit Tracking ### delete_event_exhibit_tracking_obj() ### + + + +# ### BEGIN ### API Event Exhibit Tracking ### lookup_event_badge_id_tracking() ### +# Updated 2022-04-15 +@router.get('/e/event/exhibit/lookup_id_for_tracking', response_model=Resp_Body_Base) +async def lookup_event_badge_id_tracking( + event_exhibit_id: str = Query(..., min_length=11, max_length=22), + event_badge_id: str = Query(..., min_length=11, max_length=22), + + # add: bool = False, + remove: bool = False, + + commons: Common_Route_Params = Depends(common_route_params), + ): + log.setLevel(logging.DEBUG) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL + log.debug(locals()) + + if event_exhibit_id := redis_lookup_id_random(record_id_random=event_exhibit_id, table_name='event_exhibit'): pass + else: return mk_resp(data=None, status_code=404, response=commons.response, status_message='The Event Exhibit ID was invalid or not found.') + + if event_badge_id := redis_lookup_id_random(record_id_random=event_badge_id, table_name='event_badge'): pass + else: return mk_resp(data=None, status_code=404, response=commons.response, status_message='The Event Badge ID was invalid or not found.') + + if event_badge_obj_result := load_event_badge_obj( + event_badge_id = event_badge_id, + return_basic_model = True): + event_badge_obj = event_badge_obj_result + event_badge_id_random = event_badge_obj.id_random + log.info(f'Event Badge ID found: {event_badge_id_random}') + log.debug(event_badge_obj) + + event_exhibit_tracking_data = {} + if event_badge_obj.allow_tracking is True: + event_exhibit_tracking_data['hide'] = False + else: + event_exhibit_tracking_data['hide'] = True + event_exhibit_tracking_data['notes'] = 'Added by external API' + + if get_event_exhibit_tracking_rec_list_result := get_event_exhibit_tracking_rec_list( + event_exhibit_id = event_exhibit_id, + event_badge_id = event_badge_id, + hidden = 'all', + limit = 1, + ): + event_exhibit_tracking_rec = get_event_exhibit_tracking_rec_list_result[0] + event_exhibit_tracking_id = event_exhibit_tracking_rec.get('event_exhibit_tracking_id') + + if update_event_exhibit_tracking_obj_result := update_event_exhibit_tracking_obj( + event_exhibit_tracking_id = event_exhibit_tracking_id, + event_exhibit_tracking_dict_obj = event_exhibit_tracking_data, + ): + log.info(f'Updated Event Exhibit Tracking ID: {event_exhibit_tracking_id}') + else: + log.info(f'Event Exhibit Tracking ID not updated for Event Badge ID: {event_badge_id}') + log.debug(update_event_exhibit_tracking_obj_result) + else: + if create_event_exhibit_tracking_obj_result := create_event_exhibit_tracking_obj( + event_exhibit_id = event_exhibit_id, + event_exhibit_tracking_dict_obj = event_exhibit_tracking_data, + event_badge_id = event_badge_id + ): + event_exhibit_tracking_id = create_event_exhibit_tracking_obj_result + # event_exhibit_tracking_id_random = event_exhibit_tracking_obj.id_random + log.info(f'New Event Exhibit Tracking ID: {event_exhibit_tracking_id}') + # log.debug(event_exhibit_tracking_id) + else: + log.info(f'New Event Exhibit Tracking ID not created for Event Badge ID: {event_badge_id}') + log.debug(create_event_exhibit_tracking_obj_result) + + if event_badge_obj.allow_tracking is True: + return mk_resp(data=event_badge_obj, response=commons.response) # Success + else: + log.info('Tracking is now allowed') + return mk_resp(data=None, status_code=404, response=commons.response, status_message='The Event Badge could not be returned. They have not opted in to lead retrieval at this time.') # Not Found + elif event_badge_obj_result is None: # None + log.info('No results') + return mk_resp(data=None, status_code=404, response=commons.response, status_message='The Event Badge could not be returned. They may not have opted in to lead retrieval at this time.') # Not Found + else: + log.warning('Likely bad request') + return mk_resp(data=False, status_code=400, response=commons.response) # Bad Request +# ### END ### API Event Exhibit Tracking ###