BL-751-BE-Build an Email Service #124
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,3 +39,4 @@ jspm_packages/ | |
| .env | ||
| .env.test | ||
| .env.local | ||
| sendgrid.env | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| const express = require('express'); | ||
|
|
||
| const { sendEmail, addToList } = require('../../api/email/emailHelper'); | ||
| const server = express(); | ||
|
|
||
| server.use(express.json()); | ||
|
|
||
| jest.mock('../../api/email/emailHelper.js'); | ||
| jest.mock('../../api/email/emailHelper.js', () => | ||
| jest.fn((req, res, next) => next()) | ||
| ); | ||
|
|
||
| const newStudent = { | ||
| dynamic_template_data: { | ||
| name: 'New Student Here', | ||
| }, | ||
| to: '[email protected]', | ||
| // The from email must be the email address of a verified sender in SendGrid account. If/when you verify the domain, an email coming from the domain is likely good enough. | ||
| from: '[email protected]', | ||
| template_id: 'd-a6dacc6241f9484a96554a13bbdcd971', | ||
| }; | ||
|
|
||
| const newParent = { | ||
| dynamic_template_data: { | ||
| name: 'New Parent Here', | ||
| }, | ||
| to: '[email protected]', | ||
| from: '[email protected]', | ||
| template_id: 'd-19b895416ae74cea97e285c4401fcc1f', | ||
| }; | ||
|
|
||
| const newInstructor = { | ||
| dynamic_template_data: { | ||
| name: 'New Parent Here', | ||
| }, | ||
| to: '[email protected]', | ||
| from: '[email protected]', | ||
| template_id: 'd-a4de80911362438bb35d481efa068398', | ||
| }; | ||
|
|
||
| const newStudentContact = { | ||
| list_ids: ['e7b598d9-23ca-48df-a62b-53470b5d1d86'], | ||
| email: '[email protected]', | ||
| name: 'new student firstname', | ||
| }; | ||
|
|
||
| const newParentContact = { | ||
| list_ids: ['e7b598d9-23ca-48df-a62b-53470b5d1d86'], | ||
| email: '[email protected]', | ||
| name: 'new parent firstname', | ||
| }; | ||
|
|
||
| const newInstructorContact = { | ||
| list_ids: ['e7b598d9-23ca-48df-a62b-53470b5d1d86'], | ||
| email: '[email protected]', | ||
| name: 'new instructor firstname', | ||
| }; | ||
|
|
||
| describe('Send different email types', () => { | ||
| describe('Send an email to a new student', () => { | ||
| it('Should return 202 when it successfully posts a new student email to SendGrid', async () => { | ||
| const res = await sendEmail(newStudent); | ||
| expect(res.status).toBe(202); | ||
| expect(res.headers.date.length).not.toBe(0); | ||
| }); | ||
| }); | ||
| describe('Send an email to a new parent', () => { | ||
| it('Should return 202 when it successfully posts a new parent email to SendGrid', async () => { | ||
| const res = await sendEmail(newParent); | ||
| expect(res.status).toBe(202); | ||
| expect(res.headers.date.length).not.toBe(0); | ||
| }); | ||
| }); | ||
| describe('Send an email to a new instructor', () => { | ||
| it('Should return 202 when it successfully posts a new instructor email to SendGrid', async () => { | ||
| const res = await sendEmail(newInstructor); | ||
| expect(res.status).toBe(202); | ||
| expect(res.headers.date.length).not.toBe(0); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Add users to a contact list on SendGrid', () => { | ||
| describe('Add a new student to a contact list', () => { | ||
| it('Should return 202 when it successfully adds a new student to a contact list', async () => { | ||
| const res = await addToList(newStudentContact); | ||
| expect(res.status).toBe(202); | ||
| expect(res.headers.date.length).not.toBe(0); | ||
| }); | ||
| }); | ||
| describe('Add a new parent to a contact list', () => { | ||
| it('Should return 202 when it successfully adds a new parent to a contact list', async () => { | ||
| const res = await addToList(newParentContact); | ||
| expect(res.status).toBe(202); | ||
| expect(res.headers.date.length).not.toBe(0); | ||
| }); | ||
| }); | ||
| describe('Add a new instructor to a contact list', () => { | ||
| it('Should return 202 when it successfully adds a new instructor to a contact list', async () => { | ||
| const res = await addToList(newInstructorContact); | ||
| expect(res.status).toBe(202); | ||
| expect(res.headers.date.length).not.toBe(0); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| const sgMail = require('@sendgrid/mail'); | ||
| sgMail.setApiKey(process.env.SENDGRID_API_KEY); | ||
|
|
||
| const sendEmail = (data) => { | ||
| sgMail | ||
| .send(data) | ||
| .then((response) => { | ||
| console.log(JSON.stringify(response)); | ||
| }) | ||
| .catch((error) => { | ||
| console.error(error); | ||
| }); | ||
| }; | ||
|
|
||
| const addToList = (data) => { | ||
| let request = require('request'); | ||
| let options = { | ||
| method: 'PUT', | ||
| url: 'https://api.sendgrid.com/v3/marketing/contacts', | ||
| headers: { | ||
| 'content-type': 'application/json', | ||
| authorization: 'Bearer ' + process.env.SENDGRID_API_KEY, | ||
| }, | ||
| body: { | ||
| list_ids: data.list_ids, | ||
| contacts: [ | ||
| { | ||
| email: data.email, | ||
| first_name: data.name, | ||
| }, | ||
| ], | ||
| }, | ||
| json: true, | ||
| }; | ||
| request(options, function (error, response, body) { | ||
| if (error) throw new Error(error); | ||
| console.log(body); | ||
| }); | ||
| }; | ||
|
|
||
| module.exports = { sendEmail, addToList }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! This is great documentation for people working on this in the future. I am sure they will appreciate how thorough you are.