JarCasting
JarCasting JarCasting

com.github.eladb:cdk-tweet-queue

Defines an SQS queue with tweet stream from a search

License

License
GroupId

GroupId

com.github.eladb
ArtifactId

ArtifactId

cdk-tweet-queue
Last Version

Last Version

1.0.3
Release Date

Release Date
Type

Type

jar
Description

Description

com.github.eladb:cdk-tweet-queue
Defines an SQS queue with tweet stream from a search
Project URL

Project URL

https://github.com/eladb/cdk-tweet-queue.git
Source Code Management

Source Code Management

https://github.com/eladb/cdk-tweet-queue.git

Download cdk-tweet-queue

Filename Size
cdk-tweet-queue-1.0.3.pom
cdk-tweet-queue-1.0.3.jar 1 MB
cdk-tweet-queue-1.0.3-sources.jar 1 MB
cdk-tweet-queue-1.0.3-javadoc.jar 47 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.eladb/cdk-tweet-queue/ -->
<dependency>
    <groupId>com.github.eladb</groupId>
    <artifactId>cdk-tweet-queue</artifactId>
    <version>1.0.3</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.eladb/cdk-tweet-queue/
implementation 'com.github.eladb:cdk-tweet-queue:1.0.3'
// https://jarcasting.com/artifacts/com.github.eladb/cdk-tweet-queue/
implementation ("com.github.eladb:cdk-tweet-queue:1.0.3")
'com.github.eladb:cdk-tweet-queue:jar:1.0.3'
<dependency org="com.github.eladb" name="cdk-tweet-queue" rev="1.0.3">
  <artifact name="cdk-tweet-queue" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.eladb', module='cdk-tweet-queue', version='1.0.3')
)
libraryDependencies += "com.github.eladb" % "cdk-tweet-queue" % "1.0.3"
[com.github.eladb/cdk-tweet-queue "1.0.3"]

Dependencies

compile (9)

Group / Artifact Type Version
software.amazon.awscdk : dynamodb jar [1.24.0,2.0.0)
software.amazon.awscdk : events jar [1.24.0,2.0.0)
software.amazon.awscdk : events-targets jar [1.24.0,2.0.0)
software.amazon.awscdk : iam jar [1.24.0,2.0.0)
software.amazon.awscdk : lambda jar [1.24.0,2.0.0)
software.amazon.awscdk : sqs jar [1.24.0,2.0.0)
software.amazon.awscdk : core jar [1.24.0,2.0.0)
software.amazon.jsii : jsii-runtime jar [0.22.0,0.23.0)
org.jetbrains : annotations jar [18.0.0,19.0.0)

Project Modules

There are no modules declared in this project.

Tweet Queue for AWS CDK

This is an AWS CDK construct library which allows you to get a feed of Twitter search results into an SQS queue. It works by periodically polling the freely available Twitter Standard Search API and sending all new tweets to an SQS queue.

Inspired by @jlhood's aws-serverless-twitter-event-source

Architecture

  1. A CloudWatch Event Rule triggers the poller AWS Lambda function periodically
  2. The poller reads the last checkpoint from a DynamoDB table (if exists)
  3. The poller issues a Twitter search query for all new tweets
  4. The poller enqueues all tweets to an SQS queue
  5. The poller stores the ID of the last tweet into the DynamoDB checkpoint table.
  6. Rinse & repeat.

Twitter API Keys

To issue a Twitter search request, you will need to apply for a Twitter developer account, and obtain API keys through by defining a new application.

The Twitter API keys are read by the poller from an AWS Secrets Manager entry. The entry must contain the following attributes: consumer_key, consumer_secret, access_token_key and access_token_secret (exact names).

  1. Create a new AWS Secrets Manager entry for your API keys
  2. Fill in the key values as shown below:
  3. Store the key
  4. Obtain the ARN of the secret (you will need it soon).

Usage

Use npm to install the module in your CDK project. This will also add it to your package.json file.

$ npm install cdk-tweet-queue

Add a TweetQueue to your CDK stack:

import { TweetQueue } from 'cdk-tweet-queue';

const queue = new TweetQueue(this, 'TweetStream', {
  // this is the ARN of the secret you stored
  secretArn: 'arn:aws:secretsmanager:us-east-1:1234567891234:secret:xxxxxxxxx'

  // twitter search query
  // see https://developer.twitter.com/en/docs/tweets/search/guides/standard-operators
  query: '#awscdk',

  // optional properties
  intervalMin: 60,          // optional: polling interval in minutes
  retentionPeriodSec: 60,   // optional: queue retention period
  visibilityTimeoutSec: 60, // optional: queue visilibity timeout
});

Now, queue is an sqs.Queue object and can be used anywhere a queue is accepted. For example, you could process the queue messages using an AWS Lambda function by setting up an SQS event source mapping.

Development

This is a mono-repo which uses lerna. Here are some useful commands:

  • lerna run build - builds all code
  • lerna run watch --stream -- runs tsc -w in all modules (in parallel)
  • lerna run test - tests all code

There is also an integration test that can be executed from the cdk-tweet-queue package by running the following commands. You will need to set the TWEET_QUEUE_SECRET_ARN environment variable in order for the test to be able to use your Twitter API keys.

$ npm run integ deploy
...

Don't forget to destroy:

$ npm run integ destroy
...

License

Apache-2.0

Versions

Version
1.0.3
1.0.2