├── .DS_Store ├── images └── architecture.png ├── CODE_OF_CONDUCT.md ├── src └── main │ └── java │ ├── service │ ├── SlackService.java │ ├── TwilioService.java │ ├── ChimeService.java │ ├── DynamoService.java │ ├── SecretsManagerService.java │ └── TwitterService.java │ └── LambdaHandler.java ├── CONTRIBUTING.md ├── pom.xml ├── README.md └── LICENSE /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xdevplatform/tweet-notifier/HEAD/.DS_Store -------------------------------------------------------------------------------- /images/architecture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xdevplatform/tweet-notifier/HEAD/images/architecture.png -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | We feel that a welcoming community is important and we ask that you follow Twitter's 2 | [Open Source Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md) 3 | in all interactions with the community. 4 | -------------------------------------------------------------------------------- /src/main/java/service/SlackService.java: -------------------------------------------------------------------------------- 1 | package service; 2 | 3 | import net.gpedro.integrations.slack.SlackApi; 4 | import net.gpedro.integrations.slack.SlackMessage; 5 | 6 | public class SlackService { 7 | 8 | private String webhook; 9 | private String slackBotName; 10 | 11 | public SlackService(String url, String name) { 12 | webhook = url; 13 | slackBotName = name; 14 | } 15 | 16 | public void postMessage(String url) { 17 | if (validParameters(webhook, slackBotName)) { 18 | SlackApi api = new SlackApi(webhook); 19 | SlackMessage message = new SlackMessage(slackBotName, url); 20 | message.setUnfurlLinks(true); 21 | message.setUnfurlMedia(true); 22 | api.call(message); 23 | } 24 | } 25 | 26 | private boolean validParameters(String webhook, String slackBotName) { 27 | return ((null != webhook && null != slackBotName) && (webhook != "" && slackBotName != "")); 28 | } 29 | 30 | } 31 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to get patches from you! 4 | 5 | ## Getting Started 6 | 7 | We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/) 8 | 9 | 1. Fork the project 10 | 1. Check out the `master` branch 11 | 1. Create a feature branch 12 | 1. Write code and tests for your change 13 | 1. From your branch, make a pull request against `twitter/tweet-notifier/master` 14 | 1. Work with repo maintainers to get your change reviewed 15 | 1. Wait for your change to be pulled into `twitter/notifier/master` 16 | 1. Delete your feature branch 17 | 18 | # License 19 | 20 | By contributing your code, you agree to license your contribution under the 21 | terms of the APLv2: https://github.com/twitterdev/tweet-notifier/blob/master/LICENSE 22 | 23 | # Code of Conduct 24 | 25 | Read our [Code of Conduct](https://github.com/twitterdev/tweet-notifier/blob/master/CODE_OF_CONDUCT.md) for the project. 26 | -------------------------------------------------------------------------------- /src/main/java/service/TwilioService.java: -------------------------------------------------------------------------------- 1 | package service; 2 | 3 | import com.twilio.Twilio; 4 | import com.twilio.rest.api.v2010.account.Message; 5 | import com.twilio.type.PhoneNumber; 6 | 7 | public class TwilioService { 8 | 9 | private String accountSid; 10 | private String authToken; 11 | private String from; 12 | private String to; 13 | 14 | public TwilioService(String sid, String token, String fromNumber, String toNumber) { 15 | accountSid = sid; 16 | authToken = token; 17 | from = fromNumber; 18 | to = toNumber; 19 | } 20 | 21 | public void sendMessage(String url) { 22 | if (validParameters(accountSid, authToken, from, to)) { 23 | 24 | Twilio.init(accountSid, authToken); 25 | 26 | Message.creator(new PhoneNumber(to), new PhoneNumber(from), url) 27 | .create(); 28 | } 29 | } 30 | 31 | private boolean validParameters(String accountSid, String authToken, String from, String to) { 32 | return ((null != accountSid && null != authToken && null != from && null != to) && (accountSid != "" && authToken != "" && from != "" && to != "")); 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/service/ChimeService.java: -------------------------------------------------------------------------------- 1 | package service; 2 | 3 | import java.io.IOException; 4 | 5 | import org.apache.http.client.HttpClient; 6 | import org.apache.http.client.config.CookieSpecs; 7 | import org.apache.http.client.config.RequestConfig; 8 | import org.apache.http.client.methods.HttpPost; 9 | import org.apache.http.entity.StringEntity; 10 | import org.apache.http.impl.client.HttpClients; 11 | 12 | public class ChimeService { 13 | 14 | private String webhook; 15 | 16 | public ChimeService(String url) { 17 | webhook = url; 18 | } 19 | 20 | public void postMessage(String url) throws IOException { 21 | if (validParameters(webhook)) { 22 | HttpClient httpClient = HttpClients.custom() 23 | .setDefaultRequestConfig(RequestConfig.custom() 24 | .setCookieSpec(CookieSpecs.STANDARD).build()) 25 | .build(); 26 | 27 | HttpPost request = new HttpPost(webhook); 28 | StringEntity params = new StringEntity(String.format("{\"Content\":\"%s\"}", url)); 29 | request.addHeader("content-type", "application/json"); 30 | request.setEntity(params); 31 | httpClient.execute(request); 32 | } 33 | } 34 | 35 | private boolean validParameters(String webhook) { 36 | return null != webhook && webhook != ""; 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/service/DynamoService.java: -------------------------------------------------------------------------------- 1 | package service; 2 | 3 | import java.util.HashMap; 4 | import java.util.Map; 5 | 6 | import com.amazonaws.services.dynamodbv2.AmazonDynamoDB; 7 | import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClientBuilder; 8 | import com.amazonaws.services.dynamodbv2.model.AttributeValue; 9 | import com.amazonaws.services.dynamodbv2.model.PutItemRequest; 10 | 11 | public class DynamoService { 12 | 13 | private AmazonDynamoDB amazonDynamoDB; 14 | private String tableName; 15 | private String primaryKey; 16 | 17 | public DynamoService(String name, String key, String region) { 18 | tableName = name; 19 | primaryKey = key; 20 | amazonDynamoDB = AmazonDynamoDBClientBuilder.standard() 21 | .withRegion(region) 22 | .build(); 23 | } 24 | 25 | public void storeTweetIds(String tweetId) { 26 | if (validParameters(tableName, primaryKey)) { 27 | Map attributeValues = new HashMap<>(); 28 | attributeValues.put(primaryKey, new AttributeValue().withS(tweetId)); 29 | PutItemRequest putItemRequest = new PutItemRequest() 30 | .withTableName(tableName) 31 | .withItem(attributeValues); 32 | amazonDynamoDB.putItem(putItemRequest); 33 | } 34 | } 35 | 36 | private boolean validParameters(String tableName, String primaryKey) { 37 | return ((null != tableName && null != primaryKey) && (tableName != "" && primaryKey != "")); 38 | } 39 | 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/service/SecretsManagerService.java: -------------------------------------------------------------------------------- 1 | package service; 2 | 3 | import java.util.HashMap; 4 | import java.util.Map; 5 | 6 | import com.amazonaws.services.secretsmanager.AWSSecretsManager; 7 | import com.amazonaws.services.secretsmanager.AWSSecretsManagerClientBuilder; 8 | import com.amazonaws.services.secretsmanager.model.GetSecretValueRequest; 9 | import com.amazonaws.services.secretsmanager.model.GetSecretValueResult; 10 | import com.amazonaws.services.secretsmanager.model.InvalidParameterException; 11 | import com.amazonaws.services.secretsmanager.model.InvalidRequestException; 12 | import com.amazonaws.services.secretsmanager.model.ResourceNotFoundException; 13 | import com.fasterxml.jackson.core.JsonProcessingException; 14 | import com.fasterxml.jackson.databind.JsonNode; 15 | import com.fasterxml.jackson.databind.ObjectMapper; 16 | 17 | public class SecretsManagerService { 18 | 19 | private AWSSecretsManager awsSecretsManager; 20 | 21 | public SecretsManagerService(String region) { 22 | awsSecretsManager = AWSSecretsManagerClientBuilder.standard() 23 | .withRegion(region) 24 | .build(); 25 | } 26 | 27 | public Map getSecrets(String secret) { 28 | Map map = new HashMap<>(); 29 | 30 | GetSecretValueRequest getSecretValueRequest = new GetSecretValueRequest().withSecretId(secret); 31 | GetSecretValueResult getSecretValueResponse = null; 32 | try { 33 | getSecretValueResponse = awsSecretsManager.getSecretValue(getSecretValueRequest); 34 | } catch (ResourceNotFoundException e) { 35 | System.out.println("The requested secret " + secret + " was not found"); 36 | } catch (InvalidRequestException e) { 37 | System.out.println("The request was invalid due to: " + e.getMessage()); 38 | } catch (InvalidParameterException e) { 39 | System.out.println("The request had invalid params: " + e.getMessage()); 40 | } 41 | 42 | ObjectMapper objectMapper = new ObjectMapper(); 43 | 44 | JsonNode secretsJson = null; 45 | 46 | if (null != getSecretValueResponse) { 47 | String s = getSecretValueResponse.getSecretString(); 48 | try { 49 | secretsJson = objectMapper.readTree(s); 50 | } catch (JsonProcessingException e) { 51 | System.out.println(e.getMessage()); 52 | } 53 | if (null != secretsJson) { 54 | Map result = objectMapper.convertValue(secretsJson, Map.class); 55 | for (Map.Entry entry : result.entrySet()) { 56 | String key = (String) entry.getKey(); 57 | String value = (String) entry.getValue(); 58 | map.put(key, value); 59 | } 60 | } 61 | } 62 | return map; 63 | } 64 | 65 | } 66 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | twitter-notification-sample 8 | tweet-notifier 9 | 1.0 10 | A sample app that publishes Tweets of interest to various channels 11 | 12 | 13 | 14 | 15 | com.amazonaws 16 | aws-java-sdk-dynamodb 17 | 1.11.761 18 | 19 | 20 | 21 | com.amazonaws 22 | aws-lambda-java-core 23 | 1.2.0 24 | 25 | 26 | 27 | com.amazonaws 28 | aws-lambda-java-events 29 | 2.2.7 30 | 31 | 32 | 33 | junit 34 | junit 35 | 4.13 36 | test 37 | 38 | 39 | 40 | net.gpedro.integrations.slack 41 | slack-webhook 42 | 1.4.0 43 | 44 | 45 | 46 | com.twilio.sdk 47 | twilio 48 | 7.49.0 49 | 50 | 51 | 52 | com.amazonaws 53 | aws-java-sdk-secretsmanager 54 | 1.11.761 55 | 56 | 57 | 58 | 59 | src/main/java 60 | 61 | 62 | src/main/resources 63 | 64 | 65 | 66 | 67 | 68 | org.apache.maven.plugins 69 | maven-compiler-plugin 70 | 3.7.0 71 | 72 | 1.8 73 | 1.8 74 | true 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | -------------------------------------------------------------------------------- /src/main/java/LambdaHandler.java: -------------------------------------------------------------------------------- 1 | import java.text.SimpleDateFormat; 2 | import java.util.Date; 3 | import java.util.List; 4 | import java.util.Locale; 5 | import java.util.Map; 6 | import java.util.TimeZone; 7 | 8 | import com.amazonaws.services.lambda.runtime.Context; 9 | import com.amazonaws.services.lambda.runtime.RequestHandler; 10 | import com.amazonaws.services.lambda.runtime.events.ScheduledEvent; 11 | 12 | import service.ChimeService; 13 | import service.DynamoService; 14 | import service.SecretsManagerService; 15 | import service.SlackService; 16 | import service.TwilioService; 17 | import service.TwitterService; 18 | 19 | public class LambdaHandler implements RequestHandler { 20 | 21 | private TwitterService twitterService; 22 | private ChimeService chimeService; 23 | private DynamoService dynamoService; 24 | private SlackService slackService; 25 | private TwilioService twilioService; 26 | private static final String BOT_NAME = System.getenv("BOT_NAME"); 27 | private static final String SECRET_NAME = System.getenv("SECRET_NAME"); 28 | private static final String REGION = System.getenv("REGION"); 29 | private static final String SEARCH_STRING = System.getenv("SEARCH_STRING"); 30 | 31 | public Void handleRequest(ScheduledEvent event, Context context) { 32 | 33 | SecretsManagerService secretsManagerService = new SecretsManagerService(REGION != null ? REGION : "us-east-1"); 34 | Map secrets = secretsManagerService.getSecrets(SECRET_NAME != null ? SECRET_NAME : "tweet-notifier"); 35 | if (null != secrets && secrets.size() > 0) { 36 | setup(secrets); 37 | if (null != twitterService) { 38 | List tweetIds = null; 39 | try { 40 | tweetIds = twitterService.getTweets(SEARCH_STRING != null ? SEARCH_STRING : "(from:@CNN OR from:@BBCWorld) lang:en \"breaking news\" -is:retweet", getTime()); 41 | } catch (Exception e) { 42 | System.out.println(e.getLocalizedMessage()); 43 | } 44 | if (null != tweetIds && tweetIds.size() > 0) { 45 | if (null != twilioService) { 46 | twilioService.sendMessage(tweetUrlsAsString(tweetIds)); 47 | } 48 | for (String id : tweetIds) { 49 | String url = tweetAsUrl(id); 50 | if (null != dynamoService) { 51 | dynamoService.storeTweetIds(id); 52 | } 53 | if (null != slackService) { 54 | slackService.postMessage(url); 55 | } 56 | if (null != chimeService) { 57 | try { 58 | chimeService.postMessage(url); 59 | } catch (Exception e) { 60 | System.out.println(e.getLocalizedMessage()); 61 | } 62 | } 63 | } 64 | } 65 | } 66 | } 67 | return null; 68 | } 69 | 70 | private void setup(Map secrets) { 71 | if (secrets.containsKey("twitter-api-key") && secrets.containsKey("twitter-api-secret")) { 72 | twitterService = new TwitterService(secrets.get("twitter-api-key"), secrets.get("twitter-api-secret")); 73 | if (secrets.containsKey("slack-webhook-url")) { 74 | slackService = new SlackService(secrets.get("slack-webhook-url"), BOT_NAME != null ? BOT_NAME : "Twitter Bot"); 75 | } 76 | if (secrets.containsKey("chime-webhook-url")) { 77 | chimeService = new ChimeService(secrets.get("chime-webhook-url")); 78 | } 79 | if (secrets.containsKey("dynamo-table-name") && secrets.containsKey("dynamo-table-pk")) { 80 | dynamoService = new DynamoService(secrets.get("dynamo-table-name"), secrets.get("dynamo-table-pk"), REGION != null ? REGION : "us-east-1"); 81 | } 82 | if (secrets.containsKey("twilio-sid") && secrets.containsKey("twilio-token") && secrets.containsKey("twilio-from-number") && secrets.containsKey("twilio-to-number")) { 83 | twilioService = new TwilioService(secrets.get("twilio-sid"), secrets.get("twilio-token"), secrets.get("twilio-from-number"), secrets.get("twilio-to-number")); 84 | } 85 | } 86 | } 87 | 88 | private String tweetAsUrl(String id) { 89 | return String.format("https://twitter.com/s/status/%s", id); 90 | } 91 | 92 | private String tweetUrlsAsString(List tweetsIds) { 93 | StringBuilder sb = new StringBuilder(); 94 | for (String id : tweetsIds) { 95 | sb.append(tweetAsUrl(id)); 96 | sb.append("\n\n"); 97 | } 98 | return sb.toString(); 99 | } 100 | 101 | private String getTime() { 102 | SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US); 103 | sdf.setTimeZone(TimeZone.getTimeZone("GMT")); 104 | return sdf.format(new Date(System.currentTimeMillis() - 3600 * 1000)); 105 | } 106 | 107 | } 108 | -------------------------------------------------------------------------------- /src/main/java/service/TwitterService.java: -------------------------------------------------------------------------------- 1 | package service; 2 | 3 | import java.io.IOException; 4 | import java.io.InputStream; 5 | import java.net.URISyntaxException; 6 | import java.nio.charset.StandardCharsets; 7 | import java.util.ArrayList; 8 | import java.util.Base64; 9 | import java.util.List; 10 | import java.util.Map; 11 | 12 | import com.fasterxml.jackson.databind.ObjectMapper; 13 | 14 | import org.apache.http.HttpEntity; 15 | import org.apache.http.HttpResponse; 16 | import org.apache.http.NameValuePair; 17 | import org.apache.http.client.HttpClient; 18 | import org.apache.http.client.config.CookieSpecs; 19 | import org.apache.http.client.config.RequestConfig; 20 | import org.apache.http.client.methods.HttpGet; 21 | import org.apache.http.client.methods.HttpPost; 22 | import org.apache.http.client.utils.URIBuilder; 23 | import org.apache.http.impl.client.HttpClients; 24 | import org.apache.http.message.BasicNameValuePair; 25 | 26 | public class TwitterService { 27 | 28 | private String apiKey; 29 | private String apiSecret; 30 | 31 | public TwitterService(String key, String secret) { 32 | apiKey = key; 33 | apiSecret = secret; 34 | } 35 | 36 | public List getTweets(String searchString, String startTime) throws IOException, URISyntaxException { 37 | List tweets = new ArrayList<>(); 38 | if (validParameters(apiKey, apiSecret)) { 39 | Map map = search(searchString, startTime); 40 | if (null != map) { 41 | ArrayList data = (ArrayList) map.get("data"); 42 | for (int i = 0; i < data.size(); i++) { 43 | Map item = (Map) data.get(i); 44 | String id = (String) item.get("id"); 45 | tweets.add(id); 46 | } 47 | } 48 | } 49 | return tweets; 50 | } 51 | 52 | /* 53 | * This method calls the recent search endpoint with a the search term passed to it as a query parameter 54 | * */ 55 | private Map search(String searchString, String startTime) throws IOException, URISyntaxException { 56 | 57 | ObjectMapper mapper = new ObjectMapper(); 58 | 59 | HttpClient httpClient = HttpClients.custom() 60 | .setDefaultRequestConfig(RequestConfig.custom() 61 | .setCookieSpec(CookieSpecs.STANDARD).build()) 62 | .build(); 63 | 64 | URIBuilder uriBuilder = new URIBuilder("https://api.twitter.com/labs/2/tweets/search"); 65 | ArrayList queryParameters; 66 | queryParameters = new ArrayList<>(); 67 | queryParameters.add(new BasicNameValuePair("query", searchString)); 68 | queryParameters.add(new BasicNameValuePair("start_time", startTime)); 69 | queryParameters.add(new BasicNameValuePair("expansions", "author_id")); 70 | uriBuilder.addParameters(queryParameters); 71 | 72 | HttpGet httpGet = new HttpGet(uriBuilder.build()); 73 | httpGet.setHeader("Authorization", String.format("Bearer %s", getAccessToken())); 74 | httpGet.setHeader("Content-Type", "application/json"); 75 | httpGet.setHeader("User-Agent", "LabsRecentSearchQuickStartJava"); 76 | 77 | HttpResponse response = httpClient.execute(httpGet); 78 | HttpEntity entity = response.getEntity(); 79 | return mapper.readValue(entity.getContent(), Map.class); 80 | } 81 | 82 | /* 83 | * 84 | * Helper method that generates bearer token by calling the /oauth2/token endpoint 85 | * */ 86 | private String getAccessToken() throws IOException, URISyntaxException { 87 | String accessToken = null; 88 | 89 | HttpClient httpClient = HttpClients.custom() 90 | .setDefaultRequestConfig(RequestConfig.custom() 91 | .setCookieSpec(CookieSpecs.STANDARD).build()) 92 | .build(); 93 | 94 | URIBuilder uriBuilder = new URIBuilder("https://api.twitter.com/oauth2/token"); 95 | ArrayList postParameters; 96 | postParameters = new ArrayList<>(); 97 | postParameters.add(new BasicNameValuePair("grant_type", "client_credentials")); 98 | uriBuilder.addParameters(postParameters); 99 | 100 | HttpPost httpPost = new HttpPost(uriBuilder.build()); 101 | httpPost.setHeader("Authorization", String.format("Basic %s", getBase64EncodedString())); 102 | httpPost.setHeader("Content-Type", "application/json"); 103 | 104 | HttpResponse response = httpClient.execute(httpPost); 105 | HttpEntity entity = response.getEntity(); 106 | 107 | if (null != entity) { 108 | try (InputStream inputStream = entity.getContent()) { 109 | ObjectMapper mapper = new ObjectMapper(); 110 | Map jsonMap = mapper.readValue(inputStream, Map.class); 111 | accessToken = jsonMap.get("access_token").toString(); 112 | } 113 | } 114 | return accessToken; 115 | } 116 | 117 | /* 118 | * Helper method that generates the Base64 encoded string to be used to obtain bearer token 119 | * */ 120 | private String getBase64EncodedString() { 121 | String s = String.format("%s:%s", apiKey, apiSecret); 122 | return Base64.getEncoder().encodeToString(s.getBytes(StandardCharsets.UTF_8)); 123 | } 124 | 125 | private boolean validParameters(String apiKey, String apiSecret) { 126 | return ((null != apiKey && null != apiSecret) && (apiKey != "" && apiSecret != "")); 127 | } 128 | 129 | } 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Building a serverless app for publishing Tweets of interest to your favorite communication channels 2 | 3 | A sample serverless app that periodically gets Tweets of interest using the Twitter Recent Search APIs and publishes those tweets to Slack, Amazon Chime and sends SMS using Twilio 4 | 5 | # Demo Features 6 | 7 | This app demonstrates: 8 | 9 | - Use of Twitter Recent Search APIs 10 | - AWS Lambda, DynamoDB, Secrets Manager 11 | - Publishing messages to Slack & Amazon Chime 12 | - Sending SMS using Twilio using Java SDK 13 | 14 | # Architecture 15 | 16 | ![image info](./images/architecture.png) 17 | 18 | # Setting up a Twitter App 19 | In order to use the Twitter APIs in this app, you will need the following: 20 | 21 | * A Twitter developer account. Click [here](https://developer.twitter.com/en/apply-for-access) to apply. 22 | * A Twitter [app](https://developer.twitter.com/en/apps) 23 | * Your Twitter API keys. Please review the documentation about obtaining your keys [here](https://developer.twitter.com/en/docs/basics/apps/overview). 24 | * Enroll the app in [Twitter Developer Labs](https://developer.twitter.com/en/labs). 25 | 26 | # Capturing Tweets of interest 27 | In your Lambda function, make sure to add the SEARCH_STRING as an environment variable with your own search string value to capture the Tweets of interest to you. You can search by Tweets from a particular account, Tweets that include images, media etc. and also filter on excluding certain Tweets or conditions. More information on building queries for recent search can be found on our [documentation page](https://developer.twitter.com/en/docs/labs/recent-search/guides/search-queries). 28 | 29 | In this project, currently SEARCH_STRING is set to 30 | 31 | "(from:@CNN OR from:@BBCWorld) lang:en \\"breaking news\\" -is:retweet" 32 | 33 | which means we are looking for all tweets from the CNN or BBCWorld account that are not a retweet, in the english language and contain the words Breaking News. 34 | 35 | # Setting up the Slack webhook 36 | 37 | In order to send Tweets of interest to a slack channel, you will need to create as shown [here](https://api.slack.com/messaging/webhooks). You will need the webhook url and a name for your bot that will publish Tweets of interest to channels. 38 | 39 | # Setting up the Chime webhook 40 | 41 | In order to send Tweets of interest to a chime channel, you will need to add a webhook to your chat room as shown [here](https://docs.aws.amazon.com/chime/latest/dg/webhooks.html). You will need the webhook url that will publish Tweets of interest to the channel. 42 | 43 | # Setting up Twilio to receive SMS 44 | 45 | In order to send SMS using Twilio, you will need to create and account and set up an app. Please refer to the Twilio [documentation](https://www.twilio.com/docs/sms/quickstart/java) on getting started in Java. You will need the sid, token and the phone numbers to which you want to send and receive messages from. 46 | 47 | # AWS Configurations 48 | 49 | ## Storing keys in AWS Secrets Manager 50 | Instead of storing API Keys, Secrets, Webhooks etc in properties files, we will store these in AWS Secrets Manager and use them in our code programmatically. More information on adding secrets to Secrets Manager can be found [here](https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html). You will need to add the following key value pair: 51 | * twitter-api-key 52 | * twitter-api-secret 53 | * slack-webhook-url 54 | * chime-webhook-url 55 | * dynamo-table-name 56 | * dynamo-table-pk 57 | * twilio-sid 58 | * twilio-token 59 | * twilio-from-number 60 | * twilio-to-number 61 | 62 | ## Storing data in DynamoDB 63 | In this tutorial, we will storing the tweet ids of the published Tweets. In order to that, you will have to create a table in Dynamo with a primary key (String) to store the Tweet ids. More information on creating tables in DynamoDB can be found [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SampleData.CreateTables.html). 64 | 65 | ## Creating a CloudWatch Trigger 66 | In order to invoke the lambda function periodically, we will need to create a CloudWatch Trigger rule that will invoke the lambda function (every hour in this example). Information on creating a CloudWatch rule can be found [here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/RunLambdaSchedule.html). Make sure to set the trigger interval to 1 hour. 67 | 68 | ## Deploying the app to AWS Lambda 69 | 1. Go to the [AWS Console](http://console.aws.amazon.com/) and create a Lambda function. 70 | 2. Select author from scratch and give your function a name (e.g. twitter-notifier) and select Java 8 as the runtime. 71 | 3. Select appropriate role and click create function. 72 | 4. Build a jar file to upload it into the lambda function: 73 | - Make sure to add the SEARCH_STRING as an environment variable with your own search string value to capture the Tweets of interest to you. 74 | - Make sure to add the REGION string as an environment variable with the value for your AWS region if you are using a region other than us-east-1. 75 | - Make sure to add the BOT_NAME string as an environment variable with a name for your slack bot 76 | - Make sure to add the SECRET_NAME string as an environment variable with the value of your secret that holds your different keys 77 | - Using maven: go to the directory containing pom.xml, and run 'mvn assembly:assembly -DdescriptorId=jar-with-dependencies package'. This will generate a zip file named "tweet-buddy-1.0-jar-with-dependencies.jar" in the target directory. 78 | 5. For Code entry type, select "Upload a .ZIP file" and then upload the jar file created in the previous step from the build directory to Lambda. 79 | 6. Set the Handler as LambdaHandler 80 | 7. Increase the Timeout to 30 seconds and make sure memory is set to at least 512 MB under Basic Settings. 81 | 8. Click add trigger, and select Cloudwatch Events/EventBridge. Under rules, click on the rule you created above and click add. 82 | 9. Click save to complete setting up the lambda function. 83 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------