Feedback

Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "twitter-na-pewno-bot"
+version = "0.1.0"
+edition = "2021"
+license = "MIT"
+readme = "README.md"
+authors = ["mskwr <[email protected]>"]
+homepage = "https://github.com/mimuw-jnp2-rust/project-na-pewno-twitter-bot.git"
+repository = "https://github.com/mimuw-jnp2-rust/project-na-pewno-twitter-bot.git"
+description = "A bot drawing the attention of Poles to the most common spelling mistake they make."
+keywords = ["twitter", "bot", "rust", "na-pewno"]
+
+[dependencies]
+twitter-v2 = "0.1.8"
+tokio = { version = "1.24.2", features = ["macros"] }
+time = "0.3.17"
+rand = "0.8.5"
+dotenv = "0.15.0"

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Michał Skwarek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,24 +1,40 @@
-# Frobnicator (this is a template)
+# na pewno bot for Twitter ([@napewnobot](https://twitter.com/napewnobot))
+[![Twitter URL](https://i.imgur.com/DPXcjpZ.png)](https://twitter.com/napewnobot)
 
 ## Authors
-- Andrzej Głuszak (@agluszak on GitHub)
-- Linus Torvalds (@torvalds on GitHub)
+- Michał Skwarek ([@mskwr](https://github.com/mskwr))
 
 ## Description
-Frobnicator is going to be a platformer game similar to Super Mario Bros made using Bevy game engine.
+Statistics show that for many years, by far the most common spelling mistake made by Poles online is the phrase "na pewno" (which means "certainly"), incorrectly spelled as "napewno". On Twitter, this mistake is made by up to 1000 unique users every day. The job of the na pewno bot for Twitter is to improve these terrible statistics.
 
-## Features
-- map generator
-- shooting
-- enemy AI
-- game state saving and loading
-- scores
+The bot provides the following features:
+* finding all tweets containing "napewno"
+* correcting spelling by automatically replying to these tweets
+* maintaining statistics, including how many people per day made this mistake
+* providing daily reports on the profile, including comparing results with the previous day
 
-## Plan
-In the first part we're going to implement the basics: movement, physics and shooting. The enemies will simply bounce from one edge of the platform to the other. There will be only a single map.
+## Getting started
+1. Sign up for the Twitter API to get the keys and tokens necessary for authorization. Set them as an environment variables.
+2. Clone the repository.
+   ```sh
+   git clone https://github.com/mimuw-jnp2-rust/twitter-na-pewno-bot.git
+   cd twitter-na-pewno-bot
+   ```
+3. Build the project.
+   ```sh
+   cargo build --release
+   ```
+4. Run the project.
+   ```sh
+   cargo run
+   ```
 
-In the second part we're going to add random map generator, saving/loading, scores and a more sophisticated AI.
+## License
+Distributed under the MIT License. See `LICENSE.txt` for more information.
 
 ## Libraries
-- Bevy
-- Serde (for serialization)
+- [twitter_v2](https://docs.rs/twitter-v2/latest/twitter_v2/)
+- [tokio](https://docs.rs/tokio/latest/tokio/)
+- [rand](https://docs.rs/rand/latest/rand/)
+- [time](https://docs.rs/time/latest/time/)
+- [dotenv](https://docs.rs/dotenv/latest/dotenv/)

src/auth.rs

@@ -0,0 +1,40 @@
+use std::env::var;
+use twitter_v2::authorization::{BearerToken, Oauth1aToken};
+use twitter_v2::TwitterApi;
+
+// Gets api from app context (Read).
+pub fn get_api_app_context() -> TwitterApi<BearerToken> {
+    TwitterApi::new(BearerToken::new(
+        var("BEARER_TOKEN").expect("BEARER_TOKEN not found"),
+    ))
+}
+
+// Gets api from user context (Read and Write).
+pub fn get_api_user_context() -> TwitterApi<Oauth1aToken> {
+    TwitterApi::new(Oauth1aToken::new(
+        var("API_KEY").expect("API_KEY not found"),
+        var("API_SECRET").expect("API_SECRET not found"),
+        var("ACCESS_TOKEN").expect("ACCESS_TOKEN not found"),
+        var("ACCESS_SECRET").expect("ACCESS_SECRET not found"),
+    ))
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use twitter_v2::Result;
+
+    #[tokio::test]
+    async fn test_get_api_app_context() -> Result<()> {
+        dotenv::dotenv().expect(".env file should be readable");
+        assert!(get_api_app_context().with_user_ctx().await.is_err());
+        Ok(())
+    }
+
+    #[tokio::test]
+    async fn test_get_api_user_context() -> Result<()> {
+        dotenv::dotenv().expect(".env file should be readable");
+        assert!(get_api_user_context().with_user_ctx().await.is_ok());
+        Ok(())
+    }
+}

src/main.rs

@@ -0,0 +1,79 @@
+mod auth;
+mod requests;
+mod strings;
+
+use crate::requests::{
+    count_tweets_with_mistake, get_initial_tweet, get_latest_tweet, get_my_user_id,
+    get_my_username, get_name_by_id, get_tweets_with_mistake, get_username_by_id,
+    post_reply_with_message, post_tweet_with_message,
+};
+use crate::strings::{
+    extract_statistics, generate_reply, generate_tweet, print_end_message, print_reply_message,
+    print_start_message, print_update_message,
+};
+
+use std::thread::sleep;
+use std::time::Duration;
+use time::OffsetDateTime;
+
+// Due to the limit of 100 Tweets per hour.
+const REQUEST_TIMEOUT_SECS: u64 = 60;
+
+#[tokio::main]
+async fn main() {
+    // Load environment variables from .env file.
+    dotenv::dotenv().expect(".env file should be readable");
+    print_start_message();
+
+    let my_id = get_my_user_id().await.expect("invalid authorization");
+    let my_username = get_my_username().await.expect("invalid authorization");
+    let my_latest_tweet = get_latest_tweet(my_id).await;
+
+    // All time variables are in UTC.
+    let cur_date = OffsetDateTime::now_utc().date();
+    let prev_date = cur_date.previous_day().expect("invalid date");
+
+    // Post daily updates with statistics on the profile.
+    if let Some(tweet) = my_latest_tweet {
+        let last_date = tweet.created_at.map(|t| t.date());
+
+        // Do not post anything if update was already made today.
+        if last_date != Some(cur_date) {
+            let cur_stat = count_tweets_with_mistake(&prev_date).await;
+            // Only extract previous stats if update was made on the previous day.
+            let prev_stat = if last_date == cur_date.previous_day() {
+                extract_statistics(tweet.text.as_str()).unwrap_or(0)
+            } else {
+                0
+            };
+
+            let msg = generate_tweet(prev_stat, cur_stat);
+            post_tweet_with_message(msg).await;
+            print_update_message(my_username);
+        }
+    } else {
+        // No updates on the profile yet.
+        let cur_stat = count_tweets_with_mistake(&prev_date).await;
+        let msg = generate_tweet(0, cur_stat);
+        post_tweet_with_message(msg).await;
+        print_update_message(my_username);
+    }
+
+    let initial_tweet_id = get_initial_tweet(my_id).await;
+    let tweets_with_mistake = get_tweets_with_mistake(initial_tweet_id).await;
+
+    // Can not use iterator here because of instability of async closures.
+    for tweet in tweets_with_mistake {
+        let id = tweet.author_id.expect("invalid user");
+        let username = get_username_by_id(id).await.expect("invalid user");
+        let name = get_name_by_id(id).await.expect("invalid user");
+        let msg = generate_reply(name.as_str());
+        post_reply_with_message(tweet.id, msg).await;
+        print_reply_message(tweet.id, username);
+
+        // Avoid shadowban and never exceed the limit of posts.
+        sleep(Duration::from_secs(REQUEST_TIMEOUT_SECS));
+    }
+
+    print_end_message();
+}