trex-model 1.3.7__tar.gz → 1.3.9__tar.gz

{trex-model-1.3.7/trex_model.egg-info → trex-model-1.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: trex-model
-Version: 1.3.7
+Version: 1.3.9
 Summary: TRex database module package
 Home-page: https://bitbucket.org/lokjac/trex-model
 Author: Jack Lok

{trex-model-1.3.7 → trex-model-1.3.9}/setup.py

@@ -3,7 +3,7 @@ with open("README.md", "r") as fh:
     long_description = fh.read()
 setuptools.setup(
      name='trex-model',  
-     version='1.3.7',
+     version='1.3.9',
      author="Jack Lok",
      author_email="sglok77@gmail.com",
      description="TRex database module package",

{trex-model-1.3.7 → trex-model-1.3.9/trex_model.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: trex-model
-Version: 1.3.7
+Version: 1.3.9
 Summary: TRex database module package
 Home-page: https://bitbucket.org/lokjac/trex-model
 Author: Jack Lok

{trex-model-1.3.7 → trex-model-1.3.9}/trex_model.egg-info/SOURCES.txt

@@ -43,6 +43,7 @@ trexmodel/models/datastore/rating_models.py
 trexmodel/models/datastore/recruit_models.py
 trexmodel/models/datastore/redeem_models.py
 trexmodel/models/datastore/redemption_catalogue_models.py
+trexmodel/models/datastore/referral_program_model.py
 trexmodel/models/datastore/reward_model_helpers.py
 trexmodel/models/datastore/reward_models.py
 trexmodel/models/datastore/spending_base_program_model.py

{trex-model-1.3.7 → trex-model-1.3.9}/trexmodel/models/datastore/lucky_draw_models.py

@@ -58,9 +58,9 @@ class LuckyDrawProgram(LuckyDrawBase):
                                            'created_datetime', 'modified_datetime','archived_datetime', 'completed_status',
                                            'condition_settings', 'exclusivity_settings', 'prize_settings',
                                            'exclusive_tags_list', 'exclusive_memberships_list', 'exclusive_tier_memberships_list',  
-                                           'created_by_username', 'modified_by_username', 'completed_prograss_in_percentage',
+                                           'created_by_username', 'modified_by_username', 'completed_progress_in_percentage',
                                            'is_published', 'is_enabled','is_disabled', 'totalPrizePossibility',
-                                           'image_storage_filename', 'image_public_url', 'test_result', 
+                                           'image_storage_filename', 'image_public_url', 'test_result', 'is_expired',
                                            ]
     
     
@@ -95,6 +95,10 @@ class LuckyDrawProgram(LuckyDrawBase):
     def is_disabled(self):
         return self.enabled==False
     
+    @property
+    def is_expired(self):
+        return self.end_date<datetime.now().date()
+    
     @property
     def is_archived(self):
         return self.archived
@@ -119,7 +123,7 @@ class LuckyDrawProgram(LuckyDrawBase):
             return ','.join(self.exclusivity_settings.get('tier_memberships')) or ''
     
     @property
-    def completed_prograss_in_percentage(self):
+    def completed_progress_in_percentage(self):
         return program_conf.lucky_draw_program_completed_progress_percentage(self.completed_status)
     
     @property

{trex-model-1.3.7 → trex-model-1.3.9}/trexmodel/models/datastore/merchant_models.py

@@ -67,30 +67,32 @@ class MerchantAcct(MerchantMin):
     outlet_count                            = ndb.IntegerProperty(default=0)
     
     published_program_configuration                 = ndb.JsonProperty()
+    published_referral_program_configuration        = ndb.JsonProperty()
     published_voucher_configuration                 = ndb.JsonProperty()
     published_redemption_catalogue_configuration    = ndb.JsonProperty()
     
     membership_configuration                        = ndb.JsonProperty()
     tier_membership_configuration                   = ndb.JsonProperty()
     
-    reward_naming_configuration             = ndb.JsonProperty()
+    reward_naming_configuration                     = ndb.JsonProperty()
     
-    prepaid_configuration                   = ndb.JsonProperty()
+    prepaid_configuration                           = ndb.JsonProperty()
     
-    lucky_draw_configuration                = ndb.JsonProperty(required=False)
+    lucky_draw_configuration                        = ndb.JsonProperty(required=False)
     
-    product_modifier_configuration          = ndb.JsonProperty()
+    product_modifier_configuration                  = ndb.JsonProperty()
     
-    program_settings                        = ndb.JsonProperty()
+    program_settings                                = ndb.JsonProperty()
     
-    stat_figure_update_interval_in_minutes  = conf.MERCHANT_STAT_FIGURE_UPDATE_INTERVAL_IN_MINUTES
-    stat_figure_update_datetime_format      = '%d-%m-%Y %H:%M:%S'
+    stat_figure_update_interval_in_minutes          = conf.MERCHANT_STAT_FIGURE_UPDATE_INTERVAL_IN_MINUTES
+    stat_figure_update_datetime_format              = '%d-%m-%Y %H:%M:%S'
     
     dict_properties = ['company_name', 'brand_name', 'contact_name', 'business_reg_no', 'mobile_phone', 
                        'office_phone', 'fax_phone', 'email', 'account_code', 'country',
                        'registered_datetime', 'modified_datetime', 'plan_start_date', 'plan_end_date', 'currency_code', 
                        'timezone',
-                       'published_program_configuration', 'published_voucher_configuration', 'membership_configuration', 
+                       'published_program_configuration', 'published_referral_program_configuration', 
+                       'published_voucher_configuration', 'membership_configuration', 
                        'tier_membership_configuration', 'prepaid_configuration', 'lucky_draw_configuration', 'product_modifier_configuration',
                        'dashboard_stat_figure', 'program_settings', 'is_tier_membership_configured', 'website', 
                        'product_package', 'loyalty_package','account_plan','outlet_count', 'outlet_limit',
@@ -213,6 +215,47 @@ class MerchantAcct(MerchantMin):
         if self.lucky_draw_configuration.get('settings'):
             return self.lucky_draw_configuration['settings']['ticket_image_url']
     
+    @property
+    def referrer_promote_title(self):
+        if is_not_empty(self.program_settings):
+            if self.program_settings.get('referral_program'):
+                return self.program_settings.get('referral_program').get('referrer_promote_title', '')
+        return ''
+        
+    @property
+    def referee_promote_title(self):
+        if is_not_empty(self.program_settings):
+            if self.program_settings.get('referral_program'):
+                return self.program_settings.get('referral_program').get('referee_promote_title', '')      
+        return ''
+        
+    @property
+    def referrer_promote_desc(self):
+        if is_not_empty(self.program_settings):
+            if self.program_settings.get('referral_program'):
+                return self.program_settings.get('referral_program').get('referrer_promote_desc', '')
+        return ''
+            
+    @property
+    def referee_promote_desc(self):
+        if is_not_empty(self.program_settings):
+            if self.program_settings.get('referral_program'):
+                return self.program_settings.get('referral_program').get('referee_promote_desc', '')            
+        return ''
+        
+    @property
+    def referrer_promote_image(self):
+        if is_not_empty(self.program_settings):
+            if self.program_settings.get('referral_program'):
+                return self.program_settings.get('referral_program').get('referrer_promote_image')
+            
+    @property
+    def referee_promote_image(self):
+        if is_not_empty(self.program_settings):
+            if self.program_settings.get('referral_program'):
+                return self.program_settings.get('referral_program').get('referee_promote_image')        
+        
+    
     @staticmethod
     def default_program_settings():
         return {
@@ -222,7 +265,104 @@ class MerchantAcct(MerchantMin):
                 'membership_renew_late_day'             : 30,
                 
                 }
+    
+    def update_referrer_program_promote_text(self, 
+                                             promote_title=None, 
+                                             promote_desc=None,
+                                             modified_by=None):
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        if is_empty(self.program_settings):
+            self.program_settings = {
+                                    'referral_program':{}
+                                    }
+        else:
+            if is_empty(self.program_settings.get('referral_program')):
+                self.program_settings['referral_program'] = {}
+        
+        self.modified_by            = modified_by.create_ndb_key()
+        self.modified_by_username   = modified_by_username
+            
+        self.program_settings['referral_program']['referrer_promote_title'] =  promote_title
+        self.program_settings['referral_program']['referrer_promote_desc']  =  promote_desc
+        self.put() 
+        
+    def update_referee_program_promote_text(self, 
+                                             promote_title=None, 
+                                             promote_desc=None, 
+                                             modified_by=None):
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        if is_empty(self.program_settings):
+            self.program_settings = {
+                                    'referral_program':{}
+                                    }
+        else:
+            if is_empty(self.program_settings.get('referral_program')):
+                self.program_settings['referral_program'] = {}
         
+        self.modified_by            = modified_by.create_ndb_key()
+        self.modified_by_username   = modified_by_username
+            
+        self.program_settings['referral_program']['referee_promote_title'] =  promote_title
+        self.program_settings['referral_program']['referee_promote_desc']  =  promote_desc
+        self.put()       
+        
+    def upload_referrer_program_promote_image(self, image_public_url=None, image_storage_filename=None, modified_by=None):
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        if is_empty(self.program_settings):
+            self.program_settings = {
+                                    'referral_program':{}
+                                    }
+        else:
+            if is_empty(self.program_settings.get('referral_program')):
+                self.program_settings['referral_program'] = {}
+        
+        self.program_settings['referral_program']['referrer_promote_image']             = image_public_url
+        self.program_settings['referral_program']['referrer_promote_image_filename']    = image_storage_filename
+        
+        self.modified_by            = modified_by.create_ndb_key()
+        self.modified_by_username   = modified_by_username
+        
+        self.put()
+        
+    def upload_referee_program_promote_image(self, image_public_url=None, image_storage_filename=None, modified_by=None):
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        if is_empty(self.program_settings):
+            self.program_settings = {
+                                    'referral_program':{}
+                                    }
+        else:
+            if is_empty(self.program_settings.get('referral_program')):
+                self.program_settings['referral_program'] = {}
+        
+        self.program_settings['referral_program']['referee_promote_image']          = image_public_url
+        self.program_settings['referral_program']['referee_promote_image_filename'] = image_storage_filename
+        
+        self.modified_by            = modified_by.create_ndb_key()
+        self.modified_by_username   = modified_by_username
+        
+        self.put()        
     
     @staticmethod
     def update_details(merchant_acct, company_name=None, brand_name=None, business_reg_no=None, contact_name=None, 
@@ -408,6 +548,32 @@ class MerchantAcct(MerchantMin):
             
         self.put()
         
+    def update_published_referral_program(self, program_configuration):
+        if is_empty(self.published_referral_program_configuration):
+            self.published_referral_program_configuration = {
+                                                'programs'  :[program_configuration],
+                                                'count'     : 1,
+                                                } 
+                                            
+        else:
+            self.flush_dirty_program_configuration()
+            existing_programs_list  = self.published_referral_program_configuration.get('programs')
+            
+            program_key = program_configuration.get('program_key')
+            index = 0
+            for p in existing_programs_list:
+                if p.get('program_key') == program_key:
+                    existing_programs_list.pop(index)
+                
+                index = index+1
+            
+            existing_programs_list.append(program_configuration)
+            
+            self.published_referral_program_configuration['programs']    = existing_programs_list
+            self.published_referral_program_configuration['count']       = len(existing_programs_list) 
+            
+        self.put()    
+        
     def add_voucher(self, voucher_configuration):
         if is_empty(self.published_voucher_configuration):
             self.published_voucher_configuration = {
@@ -678,6 +844,42 @@ class MerchantAcct(MerchantMin):
             
         self.put() 
         
+    def remove_program_from_published_referral_program_configuration(self, program_key_to_remove):
+        
+        logger.debug('remove_program_from_published_referral_program_configuration: program_key_to_remove=%s', program_key_to_remove)
+        
+        #self.flush_dirty_program_configuration()
+        existing_programs_list  = self.published_referral_program_configuration['programs']
+        program_count           = len(existing_programs_list)
+        
+        logger.debug('program_count before remove=%s', program_count)
+        
+        index = 0
+        
+        for program in existing_programs_list:
+            
+            logger.debug('program_key=%s', program.get('program_key'))
+            
+            is_same_program_key = program.get('program_key') == program_key_to_remove
+            
+            logger.debug('is_same_program_key=%s', is_same_program_key)
+            
+            if is_same_program_key:
+                existing_programs_list.pop(index)
+                
+                logger.debug('Found program to be remove')
+                
+            index = index+1
+        
+        program_count = len(existing_programs_list)
+        
+        logger.debug('program_count after remove=%s', program_count)
+        
+        self.published_referral_program_configuration['programs']    = existing_programs_list
+        self.published_referral_program_configuration['count']       = program_count
+            
+        self.put()     
+        
     
         
     def remove_redeption_catalogue(self, catalogue_key):

{trex-model-1.3.7 → trex-model-1.3.9}/trexmodel/models/datastore/program_models.py

@@ -252,10 +252,11 @@ class BaseProgram(BaseNModel, DictModel):
         
         program.put()  
         
-        merchant_acct = program.merchant_acct
-        merchant_acct.remove_program_from_published_program_configuration(program.key_in_str)
-        
-        cls.__remove_schedule_program(program)
+        if program.is_published:
+            merchant_acct = program.merchant_acct
+            merchant_acct.remove_program_from_published_program_configuration(program.key_in_str)
+            
+            cls.__remove_schedule_program(program)
         
     def to_configuration(self):
         program_configuration = {
@@ -279,7 +280,7 @@ class BaseProgram(BaseNModel, DictModel):
 class BasicRewardProgram(BaseProgram):
     
     @property
-    def completed_prograss_in_percentage(self):
+    def completed_progress_in_percentage(self):
         
         return program_conf.program_completed_progress_percentage(self.completed_status, self.loyalty_package)
     
@@ -560,7 +561,7 @@ class BasicRewardProgram(BaseProgram):
 class MerchantProgram(BasicRewardProgram):
     dict_properties                     = ['reward_base', 'giveaway_method', 'reward_format', 'completed_status', 'start_date', 'end_date', 'label','desc', 'program_settings', 
                                            'created_datetime', 'modified_datetime',  'enabled','completed_status','is_enabled', 'is_disabled', 'is_review_state', 
-                                           'is_published', 'archived', 'is_reward_amount_required', 'completed_prograss_in_percentage', 'completed_status_index',
+                                           'is_published', 'archived', 'is_reward_amount_required', 'completed_progress_in_percentage', 'completed_status_index',
                                            'exclusive_tags_list', 'exclusive_memberships_list', 'exclusive_tier_memberships_list',
                                            'is_recurring_scheme', 
                                            'expiration_type', 'expiration_date', 'expiration_value', 'is_expiration_date_type',
@@ -661,13 +662,13 @@ class MerchantTierRewardProgram(MerchantProgram):
     
     dict_properties                     = ['completed_status', 'start_date', 'end_date', 'label', 'desc', 'program_settings', 'reward_format',
                                            'created_datetime', 'modified_datetime',  'enabled','completed_status','is_enabled', 'is_disabled', 'is_review_state', 
-                                           'is_published', 'archived', 'completed_prograss_in_percentage', 'completed_status_index',
+                                           'is_published', 'archived', 'completed_progress_in_percentage', 'completed_status_index',
                                            'exclusive_tags_list', 'exclusive_memberships_list', 'exclusive_tier_memberships_list',
                                            'is_tier_recycle', 'is_show_progress', 'max_unlock_tier_count_per_trax',
                                            'created_by_username', 'modified_by_username', 'loyalty_package']
     
     @property
-    def completed_prograss_in_percentage(self):
+    def completed_progress_in_percentage(self):
         return program_conf.tier_reward_program_completed_progress_percentage(self.completed_status)
     
     @property

{trex-model-1.3.7 → trex-model-1.3.9}/trexmodel/models/datastore/recruit_models.py

@@ -27,12 +27,13 @@ class CoFounderRecruit(RecruitBase):
     founding_details            = ndb.TextProperty(required=False)
     employment_time             = ndb.TextProperty(required=True)
     skill                       = ndb.TextProperty(required=True)
+    other_skill                 = ndb.TextProperty(required=True)
     linkedin_profile            = ndb.TextProperty(required=True)
     
     
     @staticmethod
     def create(name=None, mobile_phone=None, email=None, address=None, involved_in_founding=False,
-               founding_details=None, employment_time=None, skill=None, linkedin_profile=None):
+               founding_details=None, employment_time=None, skill=None, other_skill=None, linkedin_profile=None):
         CoFounderRecruit(
             name                    = name,
             mobile_phone            = mobile_phone,
@@ -42,6 +43,7 @@ class CoFounderRecruit(RecruitBase):
             founding_details        = founding_details,
             employment_time         = employment_time,
             skill                   = skill,
+            other_skill             = other_skill,
             linkedin_profile        = linkedin_profile,
             ).put()
     

{trex-model-1.3.7 → trex-model-1.3.9}/trexmodel/models/datastore/redemption_catalogue_models.py

@@ -49,7 +49,7 @@ class RedemptionCatalogue(BaseNModel, DictModel):
                         "label","desc","completed_status","start_date","end_date","created_datetime",
                         "redeem_reward_format","catalogue_settings", "image_storage_filename", "image_public_url",
                         "exclusive_tags_list", "exclusive_memberships_list", "exclusive_tier_memberships_list",
-                        "completed_prograss_in_percentage","completed_status_index", "catalogue_items",
+                        "completed_progress_in_percentage","completed_status_index", "catalogue_items",
                         "is_enabled", "is_disabled", "is_archived", "is_published", "loyalty_package",
                         ]
     
@@ -93,7 +93,7 @@ class RedemptionCatalogue(BaseNModel, DictModel):
         return self.catalogue_settings.get('items') or []
     
     @property
-    def completed_prograss_in_percentage(self):
+    def completed_progress_in_percentage(self):
         return program_conf.redemption_catalogue_completed_progress_percentage(self.completed_status, self.loyalty_package)
     
     @property

trex-model-1.3.9/trexmodel/models/datastore/referral_program_model.py

@@ -0,0 +1,370 @@
+'''
+Created on 8 Apr 2024
+
+@author: jacklok
+'''
+
+from google.cloud import ndb
+from trexmodel.models.datastore.ndb_models import BaseNModel, DictModel
+import trexmodel.conf as model_conf
+from trexlib.utils.string_util import is_not_empty, random_string, is_empty
+from trexmodel.models.datastore.merchant_models import MerchantAcct, Outlet,\
+    MerchantUser
+from trexmodel.models.datastore.coporate_models import CorporateAcct
+import logging
+from trexmodel import conf, program_conf
+from datetime import datetime
+from trexmodel.models.datastore.model_decorators import model_transactional
+from trexlib.utils.common.common_util import sort_list, sort_dict_list
+from builtins import staticmethod
+    
+
+
+#logger = logging.getLogger('model')
+logger = logging.getLogger('debug')
+
+class BaseProgram(BaseNModel, DictModel):
+    completed_status                    = ndb.StringProperty(required=True, choices=set(program_conf.REFERRAL_PROGRAM_STATUS))
+    #reward_format                       = ndb.StringProperty(required=False, choices=set(program_conf.REWARD_FORMAT_SET))
+    start_date                          = ndb.DateProperty(required=True)
+    end_date                            = ndb.DateProperty(required=True)
+    
+    label                               = ndb.StringProperty(required=False)
+    desc                                = ndb.StringProperty(required=False)
+    
+    promote_title                       = ndb.StringProperty(required=False)
+    promote_desc                        = ndb.StringProperty(required=False)
+    
+    program_settings                    = ndb.JsonProperty(required=True)
+    created_datetime                    = ndb.DateTimeProperty(required=True, auto_now_add=True)
+    modified_datetime                   = ndb.DateTimeProperty(required=True, auto_now=True)
+    published_datetime                  = ndb.DateTimeProperty(required=False)
+    archived_datetime                   = ndb.DateTimeProperty(required=False)
+    remarks                             = ndb.StringProperty(required=False)
+    
+    created_by                          = ndb.KeyProperty(name="created_by", kind=MerchantUser)
+    created_by_username                 = ndb.StringProperty(required=False)
+    modified_by                         = ndb.KeyProperty(name="modified_by", kind=MerchantUser)
+    modified_by_username                = ndb.StringProperty(required=False)
+    
+    enabled                             = ndb.BooleanProperty(default=True)
+    archived                            = ndb.BooleanProperty(default=False)
+    
+    image_storage_filename              = ndb.StringProperty(required=False)
+    image_public_url                    = ndb.StringProperty(required=False)
+    
+    program_code                        = ndb.StringProperty(required=False)
+    
+    loyalty_package                     = ndb.StringProperty(required=False, default=program_conf.LOYALTY_PACKAGE_SCALE)
+    
+    @property
+    def is_enabled(self):
+        return self.enabled
+    
+    @property
+    def is_disabled(self):
+        return self.enabled==False
+    
+    @property
+    def is_archived(self):
+        return self.archived
+    
+    @property
+    def is_published(self):
+        return self.completed_status == program_conf.PROGRAM_STATUS_PUBLISH
+    
+    @property
+    def is_review_state(self):
+        return program_conf.is_existing_referral_program_status_final_state(self.completed_status)
+    
+    @classmethod
+    @model_transactional(desc="publish_program")
+    def publish_program(cls, program):
+        program.completed_status = program_conf.PROGRAM_STATUS_PUBLISH
+        program.published_datetime = datetime.now()
+        program.put()
+        
+        merchant_acct = program.merchant_acct_entity
+        merchant_acct.update_published_referral_program(program.to_configuration())
+        
+    @classmethod
+    @model_transactional(desc="archive_program")
+    def archive_program(cls, program):
+        program.archived = True
+        program.archived_datetime = datetime.now()
+        program.put()
+        
+        merchant_acct = program.merchant_acct_entity
+        merchant_acct.remove_program_from_published_referral_program_configuration(program.key_in_str) 
+        
+    
+    @classmethod
+    @model_transactional(desc="enable program")
+    def enable(cls, program, modified_by=None):
+        program.enabled = True
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        program.modified_by            = modified_by.create_ndb_key()
+        program.modified_by_username   = modified_by_username
+        
+        if program.is_published:
+            merchant_acct = program.merchant_acct_entity
+            merchant_acct.update_published_referral_program(program.to_configuration())
+        
+        program.put()
+            
+    @classmethod
+    @model_transactional(desc="disable program")
+    def disable(cls, program, modified_by=None):
+        program.enabled = False
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+                program.modified_by            = modified_by.create_ndb_key()
+                
+        program.modified_by_username   = modified_by_username
+        
+        program.put()  
+        
+        if program.is_published:
+            merchant_acct = program.merchant_acct_entity
+            merchant_acct.remove_program_from_published_referral_program_configuration(program.key_in_str)
+        
+    @property
+    def merchant_acct_entity(self):
+        return MerchantAcct.fetch(self.key.parent().urlsafe())    
+        
+    def to_configuration(self):
+        program_configuration = {
+                                'merchant_acct_key'                 : self.parent_key,
+                                'program_key'                       : self.key_in_str,
+                                'label'                             : self.label,
+                                'desc'                              : self.desc,
+                                'start_date'                        : self.start_date.strftime('%d-%m-%Y'),
+                                'end_date'                          : self.end_date.strftime('%d-%m-%Y'),
+                                'promote_title'                     : self.promote_title,
+                                'promote_desc'                      : self.promote_desc,
+                                'promote_image_link'                : self.image_public_url,    
+                                'program_settings'                  : self.program_settings,
+                                'is_published'                      : self.is_published,  
+                                }
+        
+        return program_configuration
+
+class MerchantReferralProgram(BaseProgram):
+    dict_properties                     = [
+                                           'completed_status', 'start_date', 'end_date', 'label','desc', 
+                                           'program_settings', 
+                                           'created_datetime', 'modified_datetime',  'enabled',
+                                           'archived_datetime',
+                                           'is_enabled', 'is_disabled', 'is_review_state', 
+                                           'is_published', 'archived', 'completed_progress_in_percentage', 
+                                           'completed_status_index',
+                                           'promote_title', 'promote_desc', 'promote_image_link',
+                                           'remarks', 'loyalty_package', 'image_storage_filename', 'image_public_url',
+                                           'created_by_username', 'modified_by_username']
+    
+    
+    @property
+    def promote_image_link(self):
+        return self.image_public_url
+    
+    @property
+    def completed_progress_in_percentage(self):
+        return program_conf.referral_program_completed_progress_percentage(self.completed_status)
+    
+    @property
+    def completed_status_index(self):
+        return program_conf.get_referral_program_completed_status_index(self.completed_status)
+    
+    @staticmethod
+    def create(merchant_acct, label=None, 
+               desc=None, start_date=None, end_date=None, created_by=None,
+               default_promote_image = None,
+               loyalty_package = program_conf.LOYALTY_PACKAGE_SCALE,
+               ):
+        
+        created_by_username = None
+        if is_not_empty(created_by):
+            if isinstance(created_by, MerchantUser):
+                created_by_username = created_by.username
+        
+        program_settings = {
+                            }
+        
+        
+        
+        merchant_program =  MerchantReferralProgram(
+                                        parent                = merchant_acct.create_ndb_key(),
+                                        label                 = label,
+                                        #reward_format         = reward_format,
+                                        desc                  = desc,
+                                        start_date            = start_date,
+                                        end_date              = end_date,
+                                        created_by            = created_by.create_ndb_key(),
+                                        created_by_username   = created_by_username,
+                                        completed_status      = program_conf.PROGRAM_STATUS_PROGRAM_BASE,
+                                        program_settings      = program_settings,
+                                        loyalty_package       = loyalty_package,
+                                        image_public_url      = default_promote_image,
+                                        )
+        
+        merchant_program.put()
+        return merchant_program
+    
+    @staticmethod
+    def update_program_base_data(program, label=None,   
+                                 desc=None,start_date=None, end_date=None, modified_by=None, 
+                                 default_promote_image = None, 
+                                 loyalty_package=program_conf.LOYALTY_PACKAGE_LITE,
+                                 ):
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        program_settings = program.program_settings or {}
+        
+        
+        program.label                   = label
+        program.desc                    = desc
+        #program.reward_format           = reward_format
+        program.start_date              = start_date
+        program.end_date                = end_date
+        program.modified_by             = modified_by.create_ndb_key()
+        program.modified_by_username    = modified_by_username
+        program.completed_status        = program_conf.PROGRAM_STATUS_PROGRAM_BASE 
+        program.program_settings        = program_settings
+        program.loyalty_package         = loyalty_package
+        program.image_public_url        = default_promote_image
+        
+        
+        program.put()
+        
+        return program
+    
+    @staticmethod
+    def define_referrer_reward(program, modified_by=None):
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        program.modified_by             = modified_by.create_ndb_key()
+        program.modified_by_username    = modified_by_username
+        program.completed_status        = program_conf.PROGRAM_STATUS_DEFINE_REFERRER_REWARD 
+        
+        
+        program.put()
+        
+        return program
+    
+    @staticmethod
+    def define_referee_reward(program, modified_by=None):
+        
+        modified_by_username = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        program.modified_by             = modified_by.create_ndb_key()
+        program.modified_by_username    = modified_by_username
+        program.completed_status        = program_conf.PROGRAM_STATUS_DEFINE_REFEREE_REWARD 
+        
+        
+        program.put()
+        
+        return program
+    
+    @staticmethod
+    def __add_program_reward(program, point_configuration, modified_by=None, target_reward_items_naming='referrer_reward_items'):
+        modified_by_username = None
+        
+        rewards_list = None
+        
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        if program.program_settings is None:
+            rewards_list       = []
+            program_settings    = {}
+            
+        else:
+            program_settings    = program.program_settings
+            rewards_list       = program_settings.get(target_reward_items_naming) or []
+            
+        
+        rewards_list.append(point_configuration)
+        logger.debug('rewards_list=%s', rewards_list)
+        program_settings[target_reward_items_naming]    = rewards_list
+        
+        program.modified_by            = modified_by.create_ndb_key()
+        program.modified_by_username   = modified_by_username
+        program.program_settings       = program_settings
+        
+        program.put()
+        
+        return program
+    
+    @staticmethod
+    def __remove_program_reward(program, voucher_index, modified_by=None, target_reward_items_naming='referrer_reward_items'):
+        if is_not_empty(modified_by):
+            if isinstance(modified_by, MerchantUser):
+                modified_by_username = modified_by.username
+        
+        program_settings            = program.program_settings
+        existing_rewards_list      = program_settings.get(target_reward_items_naming) or []
+        new_rewards_list = []
+        for reward in existing_rewards_list:
+            if reward.get('reward_index') !=voucher_index:
+                new_rewards_list.append(reward)
+        
+        program_settings[target_reward_items_naming]    = new_rewards_list
+        
+        program.modified_by            = modified_by.create_ndb_key()
+        program.modified_by_username   = modified_by_username
+        program.program_settings       = program_settings
+        
+        program.put()
+    
+    @staticmethod
+    def add_referrer_program_reward(program, reward_configuration, modified_by=None):
+        return MerchantReferralProgram.__add_program_reward(program, reward_configuration, modified_by=modified_by, target_reward_items_naming='referrer_reward_items')
+    
+    @staticmethod
+    def add_referee_program_reward(program, reward_configuration, modified_by=None):
+        return MerchantReferralProgram.__add_program_reward(program, reward_configuration, modified_by=modified_by, target_reward_items_naming='referee_reward_items')
+    
+    @staticmethod
+    def remove_referrer_program_reward(program, reward_index, modified_by=None):
+        MerchantReferralProgram.__remove_program_reward(program, reward_index, modified_by=modified_by, target_reward_items_naming='referrer_reward_items')
+        
+    @staticmethod
+    def remove_referee_program_reward(program, reward_index, modified_by=None):
+        MerchantReferralProgram.__remove_program_reward(program, reward_index, modified_by=modified_by, target_reward_items_naming='referee_reward_items')        
+    
+    @staticmethod
+    def list_by_merchant_account(merchant_acct):
+        return MerchantReferralProgram.query(ndb.AND(MerchantReferralProgram.archived!=True), ancestor=merchant_acct.create_ndb_key()).fetch(limit=model_conf.MAX_FETCH_RECORD)
+    
+    @staticmethod
+    def list_archived_by_merchant_account(merchant_acct):
+        return MerchantReferralProgram.query(ndb.AND(MerchantReferralProgram.archived==True), ancestor=merchant_acct.create_ndb_key()).fetch(limit=model_conf.MAX_FETCH_RECORD)
+    
+    
+    
+    

{trex-model-1.3.7 → trex-model-1.3.9}/trexmodel/program_conf.py

@@ -43,6 +43,7 @@ FEATURE_CODE_TIER_REWARD_PROGRAM            = 'tier_reward'
 FEATURE_CODE_REWARDING_PROGRAM              = 'rewarding'
 FEATURE_CODE_REDEMPTION_PROGRAM             = 'redemption'
 FEATURE_CODE_LUCKY_DRAW_PROGRAM             = 'lucky_draw'
+FEATURE_CODE_REFERRAL_PROGRAM               = 'referral'
 
 PRODUCT_CODE_POINT_OF_SALES                 = 'pos'
 PRODUCT_CODE_LOYALTY                        = 'loyalty'
@@ -114,7 +115,7 @@ PACKAGE_FEATURE_PROGRAM_MAP = {
                                                 FEATURE_CODE_REWARDING_PROGRAM,
                                                 FEATURE_CODE_REDEMPTION_PROGRAM,
                                                 FEATURE_CODE_LUCKY_DRAW_PROGRAM,
-                                                
+                                                FEATURE_CODE_REFERRAL_PROGRAM,
                                                 ],
                                        
                                        }
@@ -197,12 +198,17 @@ PROGRAM_STATUS_DEFINE_TIER              = 'define_program_tier'
 PROGRAM_STATUS_DEFINE_REWARD            = 'define_reward'
 PROGRAM_STATUS_DEFINE_CONDITION         = 'define_condition'
 PROGRAM_STATUS_UPLOAD_TICKET_IMAGE      = 'upload_material'
+PROGRAM_STATUS_UPLOAD_MATERIAL          = 'upload_material'
 PROGRAM_STATUS_DEFINE_PRIZE             = 'define_prize'
 PROGRAM_STATUS_DEFINE_PRIZE_POSSIBILITY = 'define_prize_possibility'
 PROGRAM_STATUS_EXCLUSIVITY              = 'exclusivity'
 PROGRAM_STATUS_REVIEW                   = 'review'
 PROGRAM_STATUS_PUBLISH                  = 'published'
 PROGRAM_STATUS_DEFINE_ITEM              = 'define_item'
+PROGRAM_STATUS_DEFINE_PROMOTE_TEXT      = 'define_promote_text'
+
+PROGRAM_STATUS_DEFINE_REFERRER_REWARD   = 'define_program_referrer_reward'
+PROGRAM_STATUS_DEFINE_REFEREE_REWARD    = 'define_program_referee_reward'
 
 ACTION_AFTER_UNLOCK_TIER_NO_ACTION          = 'no_action'
 ACTION_AFTER_UNLOCK_TIER_CONSUME_REWARD     = 'consume_reward'
@@ -243,6 +249,14 @@ BASIC_REWARD_PROGRAM_STATUS                          = [PROGRAM_STATUS_PROGRAM_B
                                                                   PROGRAM_STATUS_PUBLISH
                                                                   ]
 
+REFERRAL_REWARD_PROGRAM_STATUS                          = [PROGRAM_STATUS_PROGRAM_BASE, 
+                                                                  PROGRAM_STATUS_DEFINE_REFERRER_REWARD, 
+                                                                  PROGRAM_STATUS_DEFINE_REFEREE_REWARD,
+                                                                  PROGRAM_STATUS_REVIEW,
+                                                                  PROGRAM_STATUS_PUBLISH
+                                                                  ]
+
+
 LITE_BASIC_REWARD_PROGRAM_STATUS                     = [PROGRAM_STATUS_PROGRAM_BASE, 
                                                                   PROGRAM_STATUS_REWARD_SCHEME, 
                                                                   PROGRAM_STATUS_REVIEW,
@@ -260,10 +274,19 @@ TIER_REWARD_PROGRAM_STATUS                          = [PROGRAM_STATUS_PROGRAM_BA
 LUCKY_DRAW_PROGRAM_STATUS                          = [
                                                                   PROGRAM_STATUS_PROGRAM_BASE, 
                                                                   #PROGRAM_STATUS_DEFINE_CONDITION,
-                                                                  PROGRAM_STATUS_UPLOAD_TICKET_IMAGE,  
-                                                                  PROGRAM_STATUS_DEFINE_PRIZE,  
+                                                                  PROGRAM_STATUS_DEFINE_PRIZE,
                                                                   PROGRAM_STATUS_DEFINE_PRIZE_POSSIBILITY,
                                                                   PROGRAM_STATUS_EXCLUSIVITY,
+                                                                  PROGRAM_STATUS_UPLOAD_TICKET_IMAGE,  
+                                                                  PROGRAM_STATUS_PUBLISH,
+                                                                  ]
+
+REFERRAL_PROGRAM_STATUS                            = [PROGRAM_STATUS_PROGRAM_BASE, 
+                                                                  PROGRAM_STATUS_DEFINE_REFERRER_REWARD, 
+                                                                  PROGRAM_STATUS_DEFINE_REFEREE_REWARD,
+                                                                  #PROGRAM_STATUS_DEFINE_PROMOTE_TEXT,
+                                                                  #PROGRAM_STATUS_UPLOAD_MATERIAL,
+                                                                  #PROGRAM_STATUS_REVIEW,
                                                                   PROGRAM_STATUS_PUBLISH,
                                                                   ]
 
@@ -273,7 +296,7 @@ ALL_PROGRAM_STATUS                            = (PROGRAM_STATUS_PROGRAM_BASE,
                                                  PROGRAM_STATUS_DEFINE_REWARD,
                                                  PROGRAM_STATUS_EXCLUSIVITY,
                                                  PROGRAM_STATUS_REVIEW,
-                                                 PROGRAM_STATUS_PUBLISH
+                                                 PROGRAM_STATUS_PUBLISH,
                                                  )
 
 REDEMPTION_CATALOGUE_STATUS_DEFINED_CATALOGUE       = 'define_catalogue'
@@ -368,6 +391,7 @@ REWARD_EXPIRATION_TYPE_AFTER_YEAR        = 'year'
 REWARD_EXPIRATION_TYPE_AFTER_MONTH       = 'month'
 REWARD_EXPIRATION_TYPE_AFTER_WEEK        = 'week'
 REWARD_EXPIRATION_TYPE_AFTER_DAY         = 'day'
+REWARD_EXPIRATION_TYPE_END_OF_MONTH      = 'eom'
 
 FIRST_DAY_OF_MONTH                       = 'month_start'
 ON_DOB_DATE                              = 'dob_date'
@@ -451,6 +475,9 @@ def get_lucky_draw_program_completed_status_index(completed_status):
 def get_redemption_catalogue_completed_status_index(completed_status):
     return REDEMPTION_CATALOGUE_STATUS.index(completed_status)
 
+def get_referral_program_completed_status_index(completed_status):
+    return REFERRAL_PROGRAM_STATUS.index(completed_status)
+
 def is_program_current_status_reach(checking_status, completed_status):
     completed_status_index  = get_program_completed_status_index(completed_status)
     checking_status_index   = get_program_completed_status_index(checking_status)
@@ -460,6 +487,15 @@ def is_program_current_status_reach(checking_status, completed_status):
     
     return checking_status_index<=completed_status_index+1
 
+def is_referral_program_current_status_reach(checking_status, completed_status):
+    completed_status_index  = get_referral_program_completed_status_index(completed_status)
+    checking_status_index   = get_referral_program_completed_status_index(checking_status)
+    
+    print('completed_status_index=%s'%completed_status_index)
+    print('checking_status_index=%s'%checking_status_index)
+    
+    return checking_status_index<=completed_status_index+1
+
 def is_voucher_current_status_reach(checking_status, completed_status):
     completed_status_index  = get_voucher_completed_status_index(completed_status)
     checking_status_index   = get_voucher_completed_status_index(checking_status)
@@ -494,6 +530,12 @@ def is_valid_to_update_program_status(checking_status, completed_status):
     
     return checking_status_index<=completed_status_index+1
 
+def is_valid_to_update_referral_program_status(checking_status, completed_status):
+    completed_status_index  = get_referral_program_completed_status_index(completed_status)
+    checking_status_index   = get_referral_program_completed_status_index(checking_status)
+    
+    return checking_status_index<=completed_status_index+1
+
 def is_valid_to_update_voucher_status(checking_status, completed_status):
     completed_status_index  = get_voucher_completed_status_index(completed_status)
     checking_status_index   = get_voucher_completed_status_index(checking_status)
@@ -524,6 +566,11 @@ def is_existing_program_status_final_state(completed_status):
     
     return completed_status_index==len(BASIC_REWARD_PROGRAM_STATUS)-1
 
+def is_existing_referral_program_status_final_state(completed_status):
+    completed_status_index  = get_referral_program_completed_status_index(completed_status)
+    
+    return completed_status_index==len(BASIC_REWARD_PROGRAM_STATUS)-1
+
 def is_existing_tier_reward_program_status_final_state(completed_status):
     completed_status_index  = get_tier_reward_program_completed_status_index(completed_status)
     
@@ -559,3 +606,8 @@ def redemption_catalogue_completed_progress_percentage(completed_status, loyalty
         return int((completed_status_index+1)/len(LITE_REDEMPTION_CATALOGUE_STATUS) * 100)
     else:
         return int((completed_status_index+1)/len(REDEMPTION_CATALOGUE_STATUS) * 100)
+
+def referral_program_completed_progress_percentage(completed_status):
+    completed_status_index  = get_referral_program_completed_status_index(completed_status)
+    print('referral_program_completed_progress_percentage: completed_status_index(%s)=%s'% (completed_status,completed_status_index))
+    return int((completed_status_index+1)/len(REFERRAL_PROGRAM_STATUS) * 100)