Coverage for benefits/enrollment_switchio/models.py: 100%

1import logging 

2 

3from django.core.exceptions import ValidationError 

4from django.db import models 

5 

6from benefits.core.models import EnrollmentGroup, SecretNameField, SystemName, TransitProcessorConfig 

7from benefits.secrets import get_secret_by_name 

8 

9logger = logging.getLogger(__name__) 

10 

11 

12class SwitchioGroupIDs: 

13 # SystemName.name: Switchio group ID 

14 MEDICARE = "MEDICARE" 

15 CALFRESH = "LOW_INCOME" 

16 OLDER_ADULT = "OLDER_ADULT" 

17 VETERAN = "VETERAN" 

18 GCTD_CARD = "AGENCY_CARD" 

19 

20 

21class SwitchioConfig(TransitProcessorConfig): 

22 """Configuration for connecting to Switchio, an entity that applies transit agency fare rules to rider transactions.""" 

23 

24 tokenization_api_key = models.CharField( 

25 help_text="The API key used to access the Switchio API for tokenization.", default="", blank=True 

26 ) 

27 tokenization_api_secret_name = SecretNameField( 

28 help_text="The name of the secret containing the api_secret value used to access the Switchio API for tokenization.", # noqa: E501 

29 default="", 

30 blank=True, 

31 ) 

32 pto_id = models.PositiveIntegerField( 

33 help_text="The Public Transport Operator ID to use with the Switchio API for enrollment.", 

34 default=0, 

35 blank=True, 

36 ) 

37 

38 @property 

39 def tokenization_api_base_url(self): 

40 return get_secret_by_name("switchio-tokenization-api-base-url") 

41 

42 @property 

43 def enrollment_api_base_url(self): 

44 return get_secret_by_name("switchio-enrollment-api-base-url") 

45 

46 @property 

47 def enrollment_api_authorization_header(self): 

48 return get_secret_by_name("switchio-enrollment-api-authorization-header") 

49 

50 @property 

51 def tokenization_api_secret(self): 

52 secret_field = self._meta.get_field("tokenization_api_secret_name") 

53 return secret_field.secret_value(self) 

54 

55 @property 

56 def client_certificate_data(self): 

57 """This SwitchioConfig's client certificate as a string.""" 

58 return get_secret_by_name("switchio-client-cert") 

59 

60 @property 

61 def ca_certificate_data(self): 

62 """This SwitchioConfig's CA certificate as a string.""" 

63 return get_secret_by_name("switchio-ca-cert") 

64 

65 @property 

66 def private_key_data(self): 

67 """This SwitchioConfig's private key as a string.""" 

68 return get_secret_by_name("switchio-private-key") 

69 

70 def clean(self): 

71 field_errors = {} 

72 

73 if self.pk and self.transitagency_set and any([agency.active for agency in self.transitagency_set.all()]): 

74 message = "This field is required when this configuration is referenced by an active transit agency." 

75 needed = dict( 

76 tokenization_api_key=self.tokenization_api_key, 

77 tokenization_api_secret_name=self.tokenization_api_secret_name, 

78 pto_id=self.pto_id, 

79 ) 

80 field_errors.update({k: ValidationError(message) for k, v in needed.items() if not v}) 

81 

82 if field_errors: 

83 raise ValidationError(field_errors) 

84 

85 

86class SwitchioGroup(EnrollmentGroup): 

87 

88 @property 

89 def group_id(self): 

90 """Get the Switchio group ID, which is the same for all agencies for a given flow. 

91 

92 Returns the value of the attribute on SwitchioGroupIDs whose attribute name 

93 matches the one in SystemName that's used by this group's enrollment flow. 

94 """ 

95 return getattr(SwitchioGroupIDs, SystemName(self.enrollment_flow.system_name).name, None) 

96 

97 @staticmethod 

98 def by_id(id): 

99 """Get a SwitchioGroup instance by its ID.""" 

100 logger.debug(f"Get {SwitchioGroup.__name__} by id: {id}") 

101 return SwitchioGroup.objects.get(id=id)