Merge branch 'master' into xray-gettingstarted

Author: mwunderl

.ebextensions/env.config

@@ -1,3 +1,12 @@
+Parameters:
+  EmailAddress:
+    Type: String
+    Default: [email protected]
+
 option_settings:
+  aws:elasticbeanstalk:customoption:
+    NotificationEmail: [email protected]
   aws:elasticbeanstalk:application:environment:
     AWS_REGION: '`{"Ref" : "AWS::Region"}`'
+    NOTIFICATION_TOPIC: '`{"Ref" : "NotificationTopic"}`'
+    NOTIFICATION_EMAIL: '`{"Ref" : "EmailAddress"}`'

.ebextensions/sns-topic.config

@@ -0,0 +1,7 @@
+Resources:
+  NotificationTopic:
+    Type: AWS::SNS::Topic
+    Properties:
+      Subscription:
+      - Endpoint: {"Ref" : "EmailAddress"}
+        Protocol: email

README.md

@@ -22,21 +22,22 @@ Create a Java 8 SE environment in Elastic Beanstalk to host the application.
 3. When your environment is ready, the console redirects you to the environment Dashboard.
 4. Click the URL at the top of the page to open the site.
 
-## Give the application permission to use DynamoDB
-When the Scorekeep API runs in AWS Elastic Beanstalk, it uses the permissions of its EC2 instance to call AWS. Elastic Beanstalk provides a default instance profile that you can extend to grant the application the permissions it needs to read from and write to resource tables in DynamoDB.
+## Give the application permission to use DynamoDB and SNS
+When the Scorekeep API runs in AWS Elastic Beanstalk, it uses the permissions of its EC2 instance to call AWS. Elastic Beanstalk provides a default instance profile that you can extend to grant the application the permissions it needs to read from and write to resource tables in DynamoDB, and send notifications with SNS.
 
-*To add DynamoDB permissions to the instances in your Elastic Beanstalk environment*
+*To add DynamoDB and SNS permissions to the instances in your Elastic Beanstalk environment*
 
 1. Open the Elastic Beanstalk instance profile in the IAM console: [aws-elasticbeanstalk-ec2-role](https://console.aws.amazon.com/iam/home#roles/aws-elasticbeanstalk-ec2-role)
 2. Click **Attach Policy**.
 3. Select [AmazonDynamoDBFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess) and click **Attach Policy**.
+3. Select [AmazonSNSFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AmazonSNSFullAccess) and click **Attach Policy**.
 
 ## Deploy the application
 Deploy the source code for the project to your Elastic Beanstalk environment.
 
 *To deploy the source code*
 
-1. Download the source bundle: [eb-java-scorekeep-v1.zip](https://github.com/awslabs/eb-java-scorekeep/releases/download/v1.1/eb-java-scorekeep-v1.zip)
+1. Download the source bundle: [eb-java-scorekeep-v1.zip](https://github.com/awslabs/eb-java-scorekeep/releases/download/v1.3/eb-java-scorekeep-v1.zip)
 2. Open the [Elastic Beanstalk Management Console](console.aws.amazon.com/elasticbeanstalk/home).
 3. Click your environment's name to open the Dashboard.
 4. Click **Upload and Deploy**.
@@ -47,6 +48,17 @@ Deploy the source code for the project to your Elastic Beanstalk environment.
 
 Click through the app to explore its functionality. Use the network console in your browser to see the HTTP requests that it sends to the API to read and write users, sessions, games, moves and game state to DynamoDB via the API.
 
+## Configure Notifications
+The API uses Amazon SNS to send a notification email when a game ends. To enable notifications, configure your email address in an environment variable.
+
+*To enable notifications*
+1. Open your environment's page in the [environment management console](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environments-console.html).
+2. Choose **Configuration**.
+3. Choose **Software Configuration**
+4. Under **Environment Properties**, set **NOTIFICATION_TOPIC** to your email address.
+5. Check your email for a subscription confirmation.
+6. Complete a game to trigger a notification.
+
 # How it works
 The project includes two independent components, an HTML and JavaScript frontend in Angular 1.5 and a Java backend that uses Spring to provide a public API.
 

build.gradle

@@ -30,6 +30,7 @@ dependencies {
     compile("org.springframework.boot:spring-boot-starter-web")
     testCompile("org.springframework.boot:spring-boot-starter-test")
     compile("com.amazonaws:aws-java-sdk-dynamodb")
+    compile("com.amazonaws:aws-java-sdk-sns")
     compile("com.amazonaws:aws-xray-recorder-sdk-core")
     compile("com.amazonaws:aws-xray-recorder-sdk-aws-sdk")
     compile("com.amazonaws:aws-xray-recorder-sdk-aws-sdk-instrumentor")

src/main/java/scorekeep/MoveFactory.java

@@ -55,6 +55,10 @@ public Move newMove(String sessionId, String gameId, String userId, String moveT
     } catch ( ClassNotFoundException | NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { throw new RulesException(rulesName); }
     // save new game state
     State newState = new State(stateId, sessionId, gameId, newStateText, newTurn);
+    // send notification on game end
+    if ( newStateText.startsWith("A") || newStateText.startsWith("B")) {
+      Utils.sendNotification("Scorekeep game completed", "Winner: " + userId);
+    }
     // register state and move id to game
     gameController.setGameMove(sessionId, gameId, moveId);
     gameController.setGameState(sessionId, gameId, stateId);

src/main/java/scorekeep/Utils.java

@@ -0,0 +1,37 @@
+package scorekeep;
+
+import com.amazonaws.regions.Regions;
+import com.amazonaws.services.sns.AmazonSNS;
+import com.amazonaws.services.sns.AmazonSNSClientBuilder;
+import com.amazonaws.services.sns.model.PublishRequest;
+import com.amazonaws.services.sns.model.PublishResult;
+import com.amazonaws.services.sns.model.SubscribeRequest;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class Utils {
+  private static final Logger logger = LoggerFactory.getLogger("scorekeep.Utils");
+  private static AmazonSNS snsclient = AmazonSNSClientBuilder.standard()
+        .withRegion(Regions.fromName(System.getenv("AWS_REGION")))
+        .build();
+  /*
+   * Send a notification email.
+   */
+  public static void sendNotification(String subject, String body) {
+    String topicarn = System.getenv("NOTIFICATION_TOPIC");
+    PublishRequest publishRequest = new PublishRequest(topicarn, body, subject);
+    PublishResult publishResult = snsclient.publish(publishRequest);
+    logger.info("Email sent: " + publishResult.getMessageId());
+  }
+
+  /*
+   * Create an SNS subscription.
+   */
+  public static void createSubscription() {
+    String topicarn = System.getenv("NOTIFICATION_TOPIC");
+    String emailaddress = System.getenv("NOTIFICATION_EMAIL");
+    SubscribeRequest subRequest = new SubscribeRequest(topicarn, "email", emailaddress);
+    snsclient.subscribe(subRequest);
+  }
+
+}

src/main/java/scorekeep/WebConfig.java

@@ -13,8 +13,12 @@
 import java.net.URL;
 
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 @Configuration
 public class WebConfig {
+  private static final Logger logger = LoggerFactory.getLogger(WebConfig.class);
 
   @Bean
   public Filter TracingFilter() {
@@ -33,5 +37,9 @@ public Filter SimpleCORSFilter() {
     builder.withSamplingStrategy(new LocalizedSamplingStrategy(ruleFile));
 
     AWSXRay.setGlobalRecorder(builder.build());
+
+    if ( System.getenv("NOTIFICATION_EMAIL") != null ){
+      Utils.createSubscription();
+    }
   }
 }