Merge pull request #30 from hellohaptik/team-strategy

enhance(Strategy): Add Team ID based strategy

Author: parvez301

FeatureToggle/__init__.py

@@ -9,6 +9,12 @@
 from UnleashClient.utils import LOGGER
 
 
+def split_and_strip(parameters: str):
+    return [
+        x.strip() for x in parameters.split(',')
+    ]
+
+
 class FeatureToggles:
     __client = None
     __url = None
@@ -208,6 +214,29 @@ def is_enabled_for_expert(feature_name: str,
         return FeatureToggles.__get_unleash_client().is_enabled(feature_name,
                                                                 context)
 
+    @staticmethod
+    def is_enabled_for_team(feature_name: str,
+                            team_id: Optional[int] = None):
+        """
+        Util method to check whether given feature is enabled or not
+        Args:
+            feature_name(str): feature name
+            team_id(Optional[str]): list of team IDs
+        Returns:
+            (bool): True if feature is enabled else False
+        """
+        feature_name = FeatureToggles.__get_full_feature_name(feature_name)
+
+        context = {}
+        if team_id:
+            context['team_ids'] = team_id
+
+        return (
+            FeatureToggles
+            .__get_unleash_client()
+            .is_enabled(feature_name, context)
+        )
+
     @staticmethod
     def fetch_feature_toggles():
         """
@@ -247,6 +276,7 @@ def fetch_feature_toggles():
                     partner_names = []
                     business_via_names = []
                     expert_emails = []
+                    team_ids = []
 
                     if cas_name == FeatureToggles.__cas_name and environment == FeatureToggles.__environment:
                         # Strip CAS and ENV name from feature name
@@ -260,14 +290,15 @@ def fetch_feature_toggles():
                             strategy_name = strategy.get('name', '')
                             parameters = strategy.get('parameters', {})
                             if strategy_name == 'EnableForPartners':
-                                partner_names = parameters.get('partner_names', '').replace(', ', ',').split(',')
-
+                                partner_names = split_and_strip(parameters.get('partner_names', ''))
                             elif strategy_name == 'EnableForBusinesses':
-                                business_via_names = parameters.get('business_via_names', '').replace(', ', ',').split(',')
+                                business_via_names = split_and_strip(parameters.get('business_via_names', ''))
                             elif strategy_name == 'EnableForDomains':
-                                domain_names = parameters.get('domain_names', '').replace(', ', ',').split(',')
+                                domain_names = split_and_strip(parameters.get('domain_names', ''))
                             elif strategy_name == 'EnableForExperts':
-                                expert_emails = parameters.get('expert_emails', '').replace(', ', ',').split(',')
+                                expert_emails = split_and_strip(parameters.get('expert_emails', ''))
+                            elif strategy_name == 'EnableForTeams':
+                                team_ids = split_and_strip(parameters.get('team_ids', ''))
 
                                 # Keep updating this list for new strategies which gets added
 
@@ -276,8 +307,9 @@ def fetch_feature_toggles():
                         response[full_feature_name]['business_via_names'] = business_via_names
                         response[full_feature_name]['domain_names'] = domain_names
                         response[full_feature_name]['expert_emails'] = expert_emails
+                        response[full_feature_name]['team_ids'] = team_ids
         except Exception as err:
             # Handle this exception from where this util gets called
-            raise Exception(f'Error occured while parsing the response: {str(err)}')
+            raise Exception(f'An error occurred while parsing the response: {str(err)}')
 
-        return response
+        return response

UnleashClient/__init__.py

@@ -7,13 +7,14 @@
     GradualRolloutSessionId, GradualRolloutUserId, UserWithId, RemoteAddress, FlexibleRollout, \
     EnableForDomains, EnableForBusinesses, EnableForPartners, EnableForExperts
 from UnleashClient import constants as consts
+from UnleashClient.strategies.EnableForTeamStrategy import EnableForTeams
 from UnleashClient.utils import LOGGER
 from UnleashClient.loader import load_features
 from UnleashClient.deprecation_warnings import strategy_v2xx_deprecation_check, default_value_warning
 
 
 # pylint: disable=dangerous-default-value
-class UnleashClient():
+class UnleashClient:
     """
     Client implementation.
     """
@@ -85,7 +86,8 @@ def __init__(self,
             "EnableForDomains": EnableForDomains,
             "EnableForExperts": EnableForExperts,
             "EnableForPartners": EnableForPartners,
-            "EnableForBusinesses": EnableForBusinesses
+            "EnableForBusinesses": EnableForBusinesses,
+            "EnableForTeams": EnableForTeams
         }
 
         if custom_strategies:

UnleashClient/strategies/EnableForBusinessStrategy.py

@@ -1,5 +1,6 @@
 from UnleashClient.strategies import Strategy
 
+
 class EnableForBusinesses(Strategy):
     def load_provisioning(self) -> list:
         return [

UnleashClient/strategies/EnableForDomainStrategy.py

@@ -1,5 +1,6 @@
 from UnleashClient.strategies import Strategy
 
+
 class EnableForDomains(Strategy):
     def load_provisioning(self) -> list:
         return [x.strip() for x in self.parameters["domain_names"].split(',')]

UnleashClient/strategies/EnableForExpertStrategy.py

@@ -1,5 +1,6 @@
 from UnleashClient.strategies import Strategy
 
+
 class EnableForExperts(Strategy):
     def load_provisioning(self) -> list:
         return [x.strip() for x in self.parameters["expert_emails"].split(',')]

UnleashClient/strategies/EnableForPartnerStrategy.py

@@ -1,6 +1,7 @@
 
 from UnleashClient.strategies import Strategy
 
+
 class EnableForPartners(Strategy):
     def load_provisioning(self) -> list:
         return [

UnleashClient/strategies/EnableForTeamStrategy.py

@@ -0,0 +1,22 @@
+from UnleashClient.strategies import Strategy
+
+
+class EnableForTeams(Strategy):
+    def load_provisioning(self) -> list:
+        return [
+            x.strip() for x in self.parameters["team_ids"].split(',')
+        ]
+
+    def apply(self, context: dict = None) -> bool:
+        """
+        Check if feature is enabled for given team or not
+        
+        Args:
+            context(dict): team IDs provided as context
+        """
+        default_value = False
+
+        if "team_ids" in context.keys():
+            default_value = context["team_ids"] in self.parsed_provisioning
+
+        return default_value

UnleashClient/utils.py

@@ -4,6 +4,7 @@
 
 LOGGER = logging.getLogger(__name__)
 
+
 def normalized_hash(identifier: str,
                     activation_group: str,
                     normalizer: int = 100) -> int: