added twilio sms api (#25)

dtoki · web-flow · commit e4b721099d5b · 2021-04-09T14:49:33.000-07:00
* wrap response in json
* cleanup and suggested fixes
* bump version for releasea

authors: songsc, dtoki
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.envrc
 zero-notification-service
 .history/
 api/openapi.yaml
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -6,6 +6,8 @@ internal/server/api_health.go
 internal/server/api_health_service.go
 internal/server/api_notification.go
 internal/server/api_notification_service.go
+internal/server/api_sms.go
+internal/server/api_sms_service.go
 internal/server/helpers.go
 internal/server/impl.go
 internal/server/model_email_recipient.go
@@ -20,6 +22,8 @@ internal/server/model_send_mail_request.go
 internal/server/model_send_mail_response.go
 internal/server/model_send_slack_message_request.go
 internal/server/model_send_slack_message_response.go
+internal/server/model_send_sms_request.go
+internal/server/model_send_sms_response.go
 internal/server/model_slack_message.go
 internal/server/model_slack_recipient.go
 internal/server/routers.go
diff --git a/README.md b/README.md
@@ -31,6 +31,9 @@ A number of environment variables are available to configure the service at runt
 | GRACEFUL_SHUTDOWN_TIMEOUT_SECONDS | The number of seconds the application will continue servicing in-flight requests before the application stops after it receives an interrupt signal | 10 |
 | STRUCTURED_LOGGING                | If enabled, logs will be in JSON format, and only above INFO level | false |
 | ALLOW_EMAIL_TO_DOMAINS            | A comma separated list of domains. Only addresses in this list can have email sent to them. If empty, disable this "sandboxing" functionality. | |
+| TWILIO_ACCOUNT_ID                 | The Account ID for Twilio | |
+| TWILIO_AUTH_TOKEN                 | The Account Auth Token for Twilio | |
+| TWILIO_PHONE_NUMBER               | The Assigned Twilio Phone Number | |
 
 
 ### Releasing a new version on GitHub and Brew
diff --git a/api/notification-service.yaml b/api/notification-service.yaml
@@ -80,6 +80,33 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
 
+  /sms/send:
+    post:
+      summary: Send an SMS
+      operationId: sendSMS
+      tags:
+        - sms
+      requestBody:
+        description: Parameters of the message to send
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SendSMSRequest'
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: string
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
   /notification/slack/send:
     post:
       summary: Send a Slack message
@@ -278,6 +305,23 @@ components:
           description: Schedule these mesages to go out at the time specified by this UNIX timestamp
           format: int64
 
+    SendSMSRequest:
+      type: object
+      required:
+        - recipientPhoneNumber
+        - message
+      properties:
+        recipientPhoneNumber:
+          type: string
+        message:
+          type: string
+
+    SendSMSResponse:
+      type: object
+      properties:
+        message:
+          type: string
+
     SlackRecipient:
       type: object
       required:
diff --git a/charts/zero-notifcation-service/Chart.yaml b/charts/zero-notifcation-service/Chart.yaml
@@ -15,9 +15,9 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.0.7
+version: 0.0.8
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
-appVersion: 0.0.10
+appVersion: 0.0.11
diff --git a/charts/zero-notifcation-service/templates/secret.yaml b/charts/zero-notifcation-service/templates/secret.yaml
@@ -7,3 +7,5 @@ type: Opaque
 data:
   SENDGRID_API_KEY: {{ .Values.application.sendgridApiKey | b64enc | quote }}
   SLACK_API_KEY: {{ .Values.application.slackApiKey | b64enc | quote }}
+  TWILIO_ACCOUNT_ID: {{ .Values.application.twilioAccountID | b64enc | quote }}
+  TWILIO_AUTH_TOKEN: {{ .Values.application.twilioAuthToken | b64enc | quote }} 
diff --git a/charts/zero-notifcation-service/values.yaml b/charts/zero-notifcation-service/values.yaml
@@ -81,6 +81,9 @@ affinity: {}
 application:
   sendgridApiKey:
   slackApiKey:
+  twilioAccountID:
+  twilioAuthToken:
+  twilioPhoneNumber:
   gracefulShutdownTimeout: 10
   structuredLogging: true
   allowEmailToDomains:
diff --git a/cmd/server/main.go b/cmd/server/main.go
@@ -48,13 +48,16 @@ func main() {
 	EmailApiService := service.NewEmailApiService(config)
 	EmailApiController := server.NewEmailApiController(EmailApiService)
 
+	SmsApiService := service.NewSmsApiService(config)
+	SmsApiController := server.NewSmsApiController(SmsApiService)
+
 	HealthApiService := service.NewHealthApiService(config)
 	HealthApiController := server.NewHealthApiController(HealthApiService)
 
 	NotificationApiService := service.NewNotificationApiService(config)
 	NotificationApiController := server.NewNotificationApiController(NotificationApiService)
 
-	router := server.Logger(server.NewRouter(EmailApiController, HealthApiController, NotificationApiController), "")
+	router := server.NewRouter(EmailApiController, SmsApiController, HealthApiController, NotificationApiController)
 
 	serverAddress := fmt.Sprintf("0.0.0.0:%d", config.Port)
 	server := &http.Server{Addr: serverAddress, Handler: router}
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -12,6 +12,9 @@ type Config struct {
 	Port                    int
 	SendgridAPIKey          string
 	SlackAPIKey             string
+	TwilioAccountID         string
+	TwilioAuthToken         string
+	TwilioPhoneNumber       string
 	GracefulShutdownTimeout time.Duration
 	StructuredLogging       bool
 	DebugDumpRequests       bool
@@ -25,6 +28,9 @@ const (
 	Port
 	SendgridAPIKey
 	SlackAPIKey
+	TwilioAccountID
+	TwilioAuthToken
+	TwilioPhoneNumber
 	GracefulShutdownTimeout
 	StructuredLogging
 	DebugDumpRequests
@@ -49,6 +55,15 @@ func loadConfig() *Config {
 	viper.SetDefault(SlackAPIKey, "")
 	viper.BindEnv(SlackAPIKey, "SLACK_API_KEY")
 
+	viper.SetDefault(TwilioAccountID, "")
+	viper.BindEnv(TwilioAccountID, "TWILIO_ACCOUNT_ID")
+
+	viper.SetDefault(TwilioAuthToken, "")
+	viper.BindEnv(TwilioAuthToken, "TWILIO_AUTH_TOKEN")
+
+	viper.SetDefault(TwilioPhoneNumber, "")
+	viper.BindEnv(TwilioPhoneNumber, "TWILIO_PHONE_NUMBER")
+
 	viper.SetDefault(GracefulShutdownTimeout, "10")
 	viper.BindEnv(GracefulShutdownTimeout, "GRACEFUL_SHUTDOWN_TIMEOUT_SECONDS")
 
@@ -74,6 +89,9 @@ func loadConfig() *Config {
 		Port:                    viper.GetInt(Port),
 		SendgridAPIKey:          viper.GetString(SendgridAPIKey),
 		SlackAPIKey:             viper.GetString(SlackAPIKey),
+		TwilioAccountID:         viper.GetString(TwilioAccountID),
+		TwilioAuthToken:         viper.GetString(TwilioAuthToken),
+		TwilioPhoneNumber:       viper.GetString(TwilioPhoneNumber),
 		GracefulShutdownTimeout: viper.GetDuration(GracefulShutdownTimeout),
 		StructuredLogging:       viper.GetBool(StructuredLogging),
 		DebugDumpRequests:       viper.GetBool(DebugDumpRequests),
diff --git a/internal/service/api_email_service.go b/internal/service/api_email_service.go
@@ -98,7 +98,7 @@ func (s *EmailApiService) SendBulk(ctx context.Context, sendBulkMailRequest serv
 	}
 	responseCode := http.StatusOK
 	if len(successful) == 0 {
-		responseCode = http.StatusInternalServerError
+		responseCode = http.StatusBadRequest
 	}
 	return server.Response(responseCode, server.SendBulkMailResponse{Successful: successful, Failed: failed}), nil
 }
diff --git a/internal/service/api_sms_service.go b/internal/service/api_sms_service.go
@@ -0,0 +1,66 @@
+package service
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"strings"
+
+	"github.com/commitdev/zero-notification-service/internal/config"
+	"github.com/commitdev/zero-notification-service/internal/server"
+	"go.uber.org/zap"
+)
+
+// EmailApiService is a service that implents the logic for the EmailApiServicer
+// This service should implement the business logic for every endpoint for the EmailApi API.
+// Include any external packages or services that will be required by this service.
+type SmsApiService struct {
+	config *config.Config
+}
+
+// NewSmsApiService creates a default api service
+func NewSmsApiService(c *config.Config) server.SmsApiServicer {
+	return &SmsApiService{c}
+}
+
+// SendSMS - Send an email
+func (s *SmsApiService) SendSMS(ctx context.Context, sendSMSRequest server.SendSmsRequest) (server.ImplResponse, error) {
+	// Set initial variables
+	accountSid := s.config.TwilioAccountID
+	authToken := s.config.TwilioAuthToken
+	urlStr := fmt.Sprintf("https://api.twilio.com/2010-04-01/Accounts/%s/Messages.json", accountSid)
+
+	// Build out the data for our message
+	v := url.Values{}
+	v.Set("To", sendSMSRequest.RecipientPhoneNumber)
+	v.Set("From", s.config.TwilioPhoneNumber)
+	v.Set("Body", sendSMSRequest.Message)
+	rb := *strings.NewReader(v.Encode())
+
+	// Create Client
+	client := &http.Client{}
+
+	req, _ := http.NewRequest("POST", urlStr, &rb)
+	req.SetBasicAuth(accountSid, authToken)
+	req.Header.Add("Accept", "application/json")
+	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
+
+	// Make request
+	resp, err := client.Do(req)
+
+	// Convert request.body response to string
+	body, _ := ioutil.ReadAll(resp.Body)
+	bodyString := string(body)
+
+	if err != nil {
+		zap.S().Errorf("Error sending SMS: %v", err)
+		return server.Response(http.StatusInternalServerError, nil), fmt.Errorf("unable to send SMS: %v", err)
+	}
+	if !(resp.StatusCode >= 200 && resp.StatusCode <= 299) {
+		zap.S().Errorf("Failure from Twilio when sending SMS: %v\n", bodyString)
+		return server.Response(http.StatusBadRequest, server.SendSmsResponse{Message: fmt.Sprintf("Error sending SMS: %d\n, Message from SMS Provider: %v\n", resp.StatusCode, bodyString)}), nil
+	}
+	return server.Response(http.StatusOK, server.SendSmsResponse{Message: "SMS Sent"}), nil
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.envrc`
`1`	`2`	`zero-notification-service`
`2`	`3`	`.history/`
`3`	`4`	`api/openapi.yaml`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ func (s *EmailApiService) SendBulk(ctx context.Context, sendBulkMailRequest serv`
`98`	`98`	`}`
`99`	`99`	`responseCode := http.StatusOK`
`100`	`100`	`if len(successful) == 0 {`
`101`		`- responseCode = http.StatusInternalServerError`
	`101`	`+ responseCode = http.StatusBadRequest`
`102`	`102`	`}`
`103`	`103`	`return server.Response(responseCode, server.SendBulkMailResponse{Successful: successful, Failed: failed}), nil`
`104`	`104`	`}`