Merge pull request #246 from DFE-Digital/expose-channel-id-in-mailing…

…-list-sign-up Expose ChannelId for MailingListAddMember request
DFE-Digital · Sep 11, 2020 · 5c2e03e · 5c2e03e
2 parents 624566e + e82269a
commit 5c2e03e
Show file tree

Hide file tree

Showing 8 changed files with 107 additions and 3 deletions.
diff --git a/GetIntoTeachingApi/Controllers/TypesController.cs b/GetIntoTeachingApi/Controllers/TypesController.cs
@@ -87,6 +87,32 @@ public async Task<IActionResult> GetCandidateChannels()
             return Ok(await _store.GetPickListItems("contact", "dfe_channelcreation").ToListAsync());
         }
 
+        [HttpGet]
+        [CrmETag]
+        [Route("candidate/mailing_list_subscription_channels")]
+        [SwaggerOperation(
+    Summary = "Retrieves the list of candidate mailing list subscription channels.",
+    OperationId = "GetCandidateMailingListSubscriptionChannels",
+    Tags = new[] { "Types" })]
+        [ProducesResponseType(typeof(IEnumerable<TypeEntity>), 200)]
+        public async Task<IActionResult> GetCandidateMailingListSubscriptionChannels()
+        {
+            return Ok(await _store.GetPickListItems("contact", "dfe_gitismlservicesubscriptionchannel").ToListAsync());
+        }
+
+        [HttpGet]
+        [CrmETag]
+        [Route("candidate/event_subscription_channels")]
+        [SwaggerOperation(
+  Summary = "Retrieves the list of candidate event subscription channels.",
+  OperationId = "GetCandidateEventSubscriptionChannels",
+  Tags = new[] { "Types" })]
+        [ProducesResponseType(typeof(IEnumerable<TypeEntity>), 200)]
+        public async Task<IActionResult> GetCandidateEventSubscriptionChannels()
+        {
+            return Ok(await _store.GetPickListItems("contact", "dfe_gitiseventsservicesubscriptionchannel").ToListAsync());
+        }
+
         [HttpGet]
         [CrmETag]
         [Route("candidate/gcse_status")]

diff --git a/GetIntoTeachingApi/Models/MailingListAddMember.cs b/GetIntoTeachingApi/Models/MailingListAddMember.cs
@@ -15,6 +15,8 @@ public class MailingListAddMember
 
         public int? ConsiderationJourneyStageId { get; set; }
         public int? DegreeStatusId { get; set; }
+        [SwaggerSchema(WriteOnly = true)]
+        public int? ChannelId { get; set; }
 
         public string Email { get; set; }
         public string FirstName { get; set; }
@@ -78,7 +80,7 @@ private Candidate CreateCandidate()
                 LastName = LastName,
                 AddressPostcode = AddressPostcode,
                 Telephone = Telephone,
-                ChannelId = CandidateId == null ? (int?)Candidate.Channel.MailingList : null,
+                ChannelId = CandidateId == null ? ChannelId ?? (int?)Candidate.Channel.MailingList : null,
                 OptOutOfSms = false,
                 DoNotBulkEmail = false,
                 DoNotEmail = false,
@@ -108,7 +110,7 @@ private void AddQualification(Candidate candidate)
         private void ConfigureSubscriptions(Candidate candidate)
         {
             candidate.HasMailingListSubscription = true;
-            candidate.MailingListSubscriptionChannelId = (int)Candidate.SubscriptionChannel.MailingList;
+            candidate.MailingListSubscriptionChannelId = ChannelId ?? (int)Candidate.SubscriptionChannel.MailingList;
             candidate.MailingListSubscriptionStartAt = DateTime.UtcNow;
             candidate.MailingListSubscriptionDoNotEmail = false;
             candidate.MailingListSubscriptionDoNotBulkEmail = false;
@@ -117,7 +119,7 @@ private void ConfigureSubscriptions(Candidate candidate)
             candidate.MailingListSubscriptionDoNotSendMm = false;
 
             candidate.HasEventsSubscription = true;
-            candidate.EventsSubscriptionChannelId = (int)Candidate.SubscriptionChannel.Events;
+            candidate.EventsSubscriptionChannelId = ChannelId ?? (int)Candidate.SubscriptionChannel.Events;
             candidate.EventsSubscriptionStartAt = DateTime.UtcNow;
             candidate.EventsSubscriptionDoNotEmail = false;
             candidate.EventsSubscriptionDoNotBulkEmail = false;

diff --git a/GetIntoTeachingApi/Models/Validators/CandidateValidator.cs b/GetIntoTeachingApi/Models/Validators/CandidateValidator.cs
@@ -107,6 +107,14 @@ public CandidateValidator(IStore store)
                 .Must(id => AdviserRequirementIds().Contains(id.ToString()))
                 .Unless(candidate => candidate.AdviserRequirementId == null)
                 .WithMessage("Must be a valid candidate adviser requirement.");
+            RuleFor(candidate => candidate.EventsSubscriptionChannelId)
+                .Must(id => EventSubscriptionChannelIds().Contains(id.ToString()))
+                .Unless(candidate => candidate.EventsSubscriptionChannelId == null)
+                .WithMessage("Must be a valid event subscription channel.");
+            RuleFor(candidate => candidate.MailingListSubscriptionChannelId)
+                .Must(id => MailingListSubscriptionChannelIds().Contains(id.ToString()))
+                .Unless(candidate => candidate.MailingListSubscriptionChannelId == null)
+                .WithMessage("Must be a valid mailing list subscription channel.");
         }
 
         private IEnumerable<string> PreferredTeachingSubjectIds()
@@ -134,6 +142,16 @@ private IEnumerable<string> ChannelIds()
             return _store.GetPickListItems("contact", "dfe_channelcreation").Select(channel => channel.Id);
         }
 
+        private IEnumerable<string> MailingListSubscriptionChannelIds()
+        {
+            return _store.GetPickListItems("contact", "dfe_gitismlservicesubscriptionchannel").Select(channel => channel.Id);
+        }
+
+        private IEnumerable<string> EventSubscriptionChannelIds()
+        {
+            return _store.GetPickListItems("contact", "dfe_gitiseventsservicesubscriptionchannel").Select(channel => channel.Id);
+        }
+
         private IEnumerable<string> GcseStatusIds()
         {
             return _store.GetPickListItems("contact", "dfe_websitehasgcseenglish").Select(status => status.Id);

diff --git a/GetIntoTeachingApi/Services/Store.cs b/GetIntoTeachingApi/Services/Store.cs
@@ -194,6 +194,8 @@ private async Task SyncTypeEntities(ICrmService crm)
             await SyncTypes(crm.GetPickListItems("contact", "dfe_candidatestatus"));
             await SyncTypes(crm.GetPickListItems("contact", "dfe_iscandidateeligibleforadviser"));
             await SyncTypes(crm.GetPickListItems("contact", "dfe_isadvisorrequiredos"));
+            await SyncTypes(crm.GetPickListItems("contact", "dfe_gitismlservicesubscriptionchannel"));
+            await SyncTypes(crm.GetPickListItems("contact", "dfe_gitiseventsservicesubscriptionchannel"));
             await SyncTypes(crm.GetPickListItems("dfe_candidatequalification", "dfe_degreestatus"));
             await SyncTypes(crm.GetPickListItems("dfe_candidatequalification", "dfe_ukdegreegrade"));
             await SyncTypes(crm.GetPickListItems("dfe_candidatequalification", "dfe_type"));

diff --git a/GetIntoTeachingApiTests/Controllers/TypesControllerTests.cs b/GetIntoTeachingApiTests/Controllers/TypesControllerTests.cs
@@ -102,6 +102,30 @@ public async void GetCandidateChannels_ReturnsAllChannels()
             ok.Value.Should().BeEquivalentTo(mockEntities);
         }
 
+        [Fact]
+        public async void GetCandidateMailingListSubscriptionChannels_ReturnsAllChannels()
+        {
+            var mockEntities = MockTypeEntities();
+            _mockStore.Setup(mock => mock.GetPickListItems("contact", "dfe_gitismlservicesubscriptionchannel")).Returns(mockEntities.AsAsyncQueryable());
+
+            var response = await _controller.GetCandidateMailingListSubscriptionChannels();
+
+            var ok = response.Should().BeOfType<OkObjectResult>().Subject;
+            ok.Value.Should().BeEquivalentTo(mockEntities);
+        }
+
+        [Fact]
+        public async void GetCandidateEventSubscriptionChannels_ReturnsAllChannels()
+        {
+            var mockEntities = MockTypeEntities();
+            _mockStore.Setup(mock => mock.GetPickListItems("contact", "dfe_gitiseventsservicesubscriptionchannel")).Returns(mockEntities.AsAsyncQueryable());
+
+            var response = await _controller.GetCandidateEventSubscriptionChannels();
+
+            var ok = response.Should().BeOfType<OkObjectResult>().Subject;
+            ok.Value.Should().BeEquivalentTo(mockEntities);
+        }
+
         [Fact]
         public async void GetCandidateGcseStatus_ReturnsAllStatus()
         {

diff --git a/GetIntoTeachingApiTests/Models/MailingListAddMemberTests.cs b/GetIntoTeachingApiTests/Models/MailingListAddMemberTests.cs
@@ -150,5 +150,15 @@ public void Candidate_ChannelIdWhenCandidateIdIsNotNull_IsNull()
 
             request.Candidate.ChannelId.Should().BeNull();
         }
+
+        [Fact]
+        public void Candidate_WhenChannelIsProvided_SetsOnAllModels()
+        {
+            var request = new MailingListAddMember() { ChannelId = 123 };
+
+            request.Candidate.ChannelId.Should().Be(123);
+            request.Candidate.MailingListSubscriptionChannelId.Should().Be(123);
+            request.Candidate.EventsSubscriptionChannelId.Should().Be(123);
+        }
     }
 }
diff --git a/GetIntoTeachingApiTests/Models/Validators/CandidateValidatorTests.cs b/GetIntoTeachingApiTests/Models/Validators/CandidateValidatorTests.cs
@@ -44,6 +44,12 @@ public void Validate_WhenValid_HasNoErrors()
             _mockStore
                 .Setup(mock => mock.GetPickListItems("contact", "dfe_channelcreation"))
                 .Returns(new[] { mockPickListItem }.AsQueryable());
+            _mockStore
+                .Setup(mock => mock.GetPickListItems("contact", "dfe_gitismlservicesubscriptionchannel"))
+                .Returns(new[] { mockPickListItem }.AsQueryable());
+            _mockStore
+                .Setup(mock => mock.GetPickListItems("contact", "dfe_gitiseventsservicesubscriptionchannel"))
+                .Returns(new[] { mockPickListItem }.AsQueryable());
             _mockStore
                 .Setup(mock => mock.GetPickListItems("contact", "dfe_websitehasgcseenglish"))
                 .Returns(new[] { mockPickListItem }.AsQueryable());
@@ -95,6 +101,8 @@ public void Validate_WhenValid_HasNoErrors()
                 PreferredEducationPhaseId = int.Parse(mockPickListItem.Id),
                 InitialTeacherTrainingYearId = int.Parse(mockPickListItem.Id),
                 ChannelId = int.Parse(mockPickListItem.Id),
+                MailingListSubscriptionChannelId = int.Parse(mockPickListItem.Id),
+                EventsSubscriptionChannelId = int.Parse(mockPickListItem.Id),
                 PrivacyPolicy = new CandidatePrivacyPolicy() { AcceptedPolicyId = (Guid)mockPrivacyPolicy.Id }
             };
 
@@ -444,6 +452,18 @@ public void Validate_AssignmentStatusIdIsNull_HasNoError()
             _validator.ShouldNotHaveValidationErrorFor(candidate => candidate.AssignmentStatusId, null as int?);
         }
 
+        [Fact]
+        public void Validate_MailingListSubscriptionChannelIdIsInvalid_HasError()
+        {
+            _validator.ShouldHaveValidationErrorFor(candidate => candidate.MailingListSubscriptionChannelId, 123);
+        }
+
+        [Fact]
+        public void Validate_EventSubscriptionChannelIdIsInvalid_HasError()
+        {
+            _validator.ShouldHaveValidationErrorFor(candidate => candidate.EventsSubscriptionChannelId, 123);
+        }
+
         [Fact]
         public void Validate_ChannelIdIsInvalid_HasError()
         {

diff --git a/GetIntoTeachingApiTests/Services/StoreTests.cs b/GetIntoTeachingApiTests/Services/StoreTests.cs
@@ -287,6 +287,8 @@ public async void SyncAsync_SyncsAllTypeEntities()
             mockCrm.Verify(m => m.GetPickListItems("contact", "dfe_candidatestatus"));
             mockCrm.Verify(m => m.GetPickListItems("contact", "dfe_iscandidateeligibleforadviser"));
             mockCrm.Verify(m => m.GetPickListItems("contact", "dfe_isadvisorrequiredos"));
+            mockCrm.Verify(m => m.GetPickListItems("contact", "dfe_gitismlservicesubscriptionchannel"));
+            mockCrm.Verify(m => m.GetPickListItems("contact", "dfe_gitiseventsservicesubscriptionchannel"));
             mockCrm.Verify(m => m.GetPickListItems("dfe_candidatequalification", "dfe_degreestatus"));
             mockCrm.Verify(m => m.GetPickListItems("dfe_candidatequalification", "dfe_ukdegreegrade"));
             mockCrm.Verify(m => m.GetPickListItems("dfe_candidatequalification", "dfe_type"));