https://github.com/multimeric/rustlangretweet

Rust bot that runs periodically on AWS Lambda and retweets any Tweets matching a query
https://github.com/multimeric/rustlangretweet

Last synced: about 1 year ago
JSON representation

Rust bot that runs periodically on AWS Lambda and retweets any Tweets matching a query

• Host: GitHub
• URL: https://github.com/multimeric/rustlangretweet
• Owner: multimeric
• Created: 2022-01-20T14:45:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-24T11:36:34.000Z (about 3 years ago)
• Last Synced: 2025-03-01T00:18:11.757Z (about 1 year ago)
• Language: Rust
• Homepage:
• Size: 91.8 KB
• Stars: 17
• Watchers: 2
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Rust Retweet Bot

This repo contains a rust project that can be used to create a Twitter retweet bot in AWS, using pure Rust. The bot uses

AWS Lambda and DynamoDB, so will likely cost you nothing. The steps below will show you how to set up the bot.

## Setting it Up

### Environment Variables

Here is a table of all the environment variables used by this application. Export them in your terminal as soon as you

have the appropriate information.

| Env Variable              | Value                                                                   |

|---------------------------|-------------------------------------------------------------------------|

| `TWITTER_CLIENT_ID`       | Twitter app client ID                                                   |

| `TWITTER_CLIENT_SECRET`   | Twitter app client secret                                               |

| `TWITTER_REDIRECT_URL`    | Twitter app redirect URL                                                |

| `TWITTER_SCRAPE_INTERVAL` | Number of minutes between each execution, e.g. `5`                      |

| `TWITTER_QUERY`           | Twitter search term for Tweets to retweet. e.g. `#rustlang -is:retweet` |

| `AWS_PROFILE`    | AWS Profile                                                             |

| `AWS_TABLE_NAME` | DynamoDB table name                                                     |

| `AWS_EXECUTION_ROLE` | ARN of the execution role for the lambda                                |

### Twitter Setup

* Go to the [Twitter Developer Portal](https://developer.twitter.com/) and set up a new project

* Generate an OAuth 2.0 token, and note down the Client ID and Client Secret

* Do the same for the redirect URL. Note that you **do not** need it to point to a website you control. Feel free to

  use `localhost` or 

* Export all the `TWITTER_` variables for later (see above)

* Make a new Twitter user, and sign up for it the normal way.

* Ensure you currently have this new Twitter user selected in Twitter

### AWS Setup

* Make sure you have an AWS account, and you have a profile setup for that account

* Make a new DynamoDB table with the default settings, and store the name under `export AWS_TABLE_NAME=XXX`

* Create a new Role with Lambda execution and DynamoDB write permissions.

* Export the relevant `AWS_` variables (see above)

### Rust Setup

* First [make sure Rust is installed](https://www.rust-lang.org/tools/install)

* Clone the repo and `cd` into it

### Compile and Build Lambda

* Run `./push.sh`

    * Open the lambda in the AWS console, and set the following environment variables to the corresponding values on

      your local machine:

    * `AWS_TABLE_NAME`

    * `TWITTER_CLIENT_ID`

    * `TWITTER_CLIENT_SECRET`

    * `TWITTER_REDIRECT_URL`

    * `TWITTER_SCRAPE_INTERVAL`

### Authenticate Your Account

* Run `cargo run --bin login`

* The app will print out a Twitter URL, open this in your browser

* Approve the API request, and **make sure you are using your bot accout to do this** (see above)

* You will then be redirected to the redirect URL you have specified

* Inspect the URL, and extract the token which is the part of the URL after `code=`

* Paste the token into the console and press enter

### Test the Lambda

* Run `aws lambda invoke --function-name YOUR_LAMBDA_ARN - `

* Your account should then retweet the appropriate tweets

### Schedule the Lambda

* Open the lambda function in the console, and select "Add trigger"

* Add an EventBridge trigger, using a rate such as `rate(15 minutes)` to make it run regularly

## Technical Info

### Build Step

* The `push.sh` script builds the binary in the official Rust docker image.

* This may not be necessary on all machines, but is done like this because even if you are running Linux, you may have a

  newer glibc version, which will then cause the binary to fail to run on Lambda. Refer

  to [this post](https://kobzol.github.io/rust/ci/2021/05/07/building-rust-binaries-in-ci-that-work-with-older-glibc.html)

  for more info.