Merge pull request #2 from aoyagikouhei/feature-user-connection-status

Feature user connection status

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changes
 
+### v0.10.0 (2024/01/22)
+* add user filed connection_status and most_recent_tweet_id
+
 ### v0.9.0 (2023/12/16)
 * add get /2/users/search
 - add get /2/trend/by/woeid/:woeid

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "twapi-v2"
-version = "0.9.0"
+version = "0.10.0"
 authors = ["aoyagikouhei <aoyagi.kouhei@gmail.com>"]
 license = "MIT"
 edition = "2021"

maker/fields/user.yaml

@@ -1,3 +1,3 @@
 ---
 
-value: created_at, description, entities, id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, verified_type, withheld
+value: connection_status, created_at, description, entities, id, location, most_recent_tweet_id, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, verified_type, withheld

maker/responses/jobs.yaml

@@ -8,7 +8,7 @@ response:
     created_at: 
       type: date
     type: 
-      type: enum_string
+      type: enum_single
       value: tweets, users
     name: 
       type: string

maker/responses/users.yaml

@@ -3,6 +3,10 @@
 response:
   type: object
   properties:
+    connection_status:
+      type: array
+      items:
+        type: string
     created_at:
       type: date
     description:
@@ -15,6 +19,8 @@ response:
       required: true
     location:
       type: string
+    most_recent_tweet_id:
+      type: string
     name:
       type: string
       required: true

src/api/get_2_trends_by_woeid_woeid.rs

@@ -1,14 +1,14 @@
-use serde::{Serialize, Deserialize};
-use crate::responses::{trends::Trends};
+use crate::responses::trends::Trends;
+use crate::{
+    api::{execute_twitter, Authentication},
+    error::Error,
+    rate_limit::RateLimit,
+};
 use reqwest::RequestBuilder;
-use crate::{error::Error, rate_limit::RateLimit, api::{execute_twitter, Authentication}};
+use serde::{Deserialize, Serialize};
 
 const URL: &str = "https://api.twitter.com/2/trends/by/woeid/:woeid";
 
-
-
-
-
 #[derive(Debug, Clone, Default)]
 pub struct Api {
     woeid: String,
@@ -20,38 +20,40 @@ impl Api {
             woeid: woeid.to_owned(),
         }
     }
-    
+
     pub fn build(self, authentication: &impl Authentication) -> RequestBuilder {
-
         let client = reqwest::Client::new();
         let url = URL.replace(":woeid", &self.woeid);
-        let builder = client
-            .get(&url)
-        ;
+        let builder = client.get(&url);
         authentication.execute(builder, "GET", &url, &[])
     }
 
-    pub async fn execute(self, authentication: &impl Authentication) -> Result<(Response, Option<RateLimit>), Error> {
+    pub async fn execute(
+        self,
+        authentication: &impl Authentication,
+    ) -> Result<(Response, Option<RateLimit>), Error> {
         execute_twitter(self.build(authentication)).await
     }
 }
 
-
-
 #[derive(Serialize, Deserialize, Debug, Clone, Default)]
 pub struct Response {
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub data: Option<Trends>, 
+    pub data: Option<Trends>,
     #[serde(flatten)]
     pub extra: std::collections::HashMap<String, serde_json::Value>,
 }
 
 impl Response {
     pub fn is_empty_extra(&self) -> bool {
-        let res = self.extra.is_empty() &&
-        self.data.as_ref().map(|it| it.is_empty_extra()).unwrap_or(true);
+        let res = self.extra.is_empty()
+            && self
+                .data
+                .as_ref()
+                .map(|it| it.is_empty_extra())
+                .unwrap_or(true);
         if !res {
-          println!("Response {:?}", self.extra);
+            println!("Response {:?}", self.extra);
         }
         res
     }

src/fields/user_fields.rs

@@ -3,6 +3,8 @@ use std::collections::HashSet;
 
 #[derive(Serialize, Deserialize, Debug, Eq, Hash, PartialEq, Clone)]
 pub enum UserFields {
+    #[serde(rename = "connection_status")]
+    ConnectionStatus,
     #[serde(rename = "created_at")]
     CreatedAt,
     #[serde(rename = "description")]
@@ -13,6 +15,8 @@ pub enum UserFields {
     Id,
     #[serde(rename = "location")]
     Location,
+    #[serde(rename = "most_recent_tweet_id")]
+    MostRecentTweetId,
     #[serde(rename = "name")]
     Name,
     #[serde(rename = "pinned_tweet_id")]
@@ -38,11 +42,13 @@ pub enum UserFields {
 impl UserFields {
     pub fn all() -> HashSet<Self> {
         let mut result = HashSet::new();
+        result.insert(Self::ConnectionStatus);
         result.insert(Self::CreatedAt);
         result.insert(Self::Description);
         result.insert(Self::Entities);
         result.insert(Self::Id);
         result.insert(Self::Location);
+        result.insert(Self::MostRecentTweetId);
         result.insert(Self::Name);
         result.insert(Self::PinnedTweetId);
         result.insert(Self::ProfileImageUrl);
@@ -60,11 +66,13 @@ impl UserFields {
 impl std::fmt::Display for UserFields {
     fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
         match self {
+            Self::ConnectionStatus => write!(f, "connection_status"),
             Self::CreatedAt => write!(f, "created_at"),
             Self::Description => write!(f, "description"),
             Self::Entities => write!(f, "entities"),
             Self::Id => write!(f, "id"),
             Self::Location => write!(f, "location"),
+            Self::MostRecentTweetId => write!(f, "most_recent_tweet_id"),
             Self::Name => write!(f, "name"),
             Self::PinnedTweetId => write!(f, "pinned_tweet_id"),
             Self::ProfileImageUrl => write!(f, "profile_image_url"),
@@ -81,6 +89,6 @@ impl std::fmt::Display for UserFields {
 
 impl Default for UserFields {
     fn default() -> Self {
-        Self::CreatedAt
+        Self::ConnectionStatus
     }
 }

src/responses/jobs.rs

@@ -8,7 +8,7 @@ pub struct Jobs {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub created_at: Option<DateTime<Utc>>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub r#type: Option<String>,
+    pub r#type: Option<Type>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub name: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -41,6 +41,29 @@ impl Jobs {
     }
 }
 
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub enum Type {
+    #[serde(rename = "tweets")]
+    Tweets,
+    #[serde(rename = "users")]
+    Users,
+}
+
+impl std::fmt::Display for Type {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        match self {
+            Self::Tweets => write!(f, "tweets"),
+            Self::Users => write!(f, "users"),
+        }
+    }
+}
+
+impl Default for Type {
+    fn default() -> Self {
+        Self::Tweets
+    }
+}
+
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub enum Status {
     #[serde(rename = "created")]

src/responses/users.rs

@@ -4,6 +4,8 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Serialize, Deserialize, Debug, Clone, Default)]
 pub struct Users {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub connection_status: Option<Vec<String>>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub created_at: Option<DateTime<Utc>>,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -13,6 +15,8 @@ pub struct Users {
     pub id: String,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub location: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub most_recent_tweet_id: Option<String>,
     pub name: String,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub pinned_tweet_id: Option<String>,

tests/get_2_users.rs

@@ -1,7 +1,7 @@
 use anyhow::Result;
 use twapi_v2::api::{execute_twitter, get_2_users, BearerAuthentication};
 
-// BEARER_CODE=XXXXX cargo test test_get_2_users_users -- --nocapture --test-threads=1
+// BEARER_CODE=XXXXX cargo test test_get_2_users_users --all-features -- --nocapture --test-threads=1
 
 #[tokio::test]
 async fn test_get_2_users_users() -> Result<()> {

tests/get_2_users_by_oauth.rs

@@ -0,0 +1,22 @@
+use anyhow::Result;
+use twapi_v2::api::{execute_twitter, get_2_users_by};
+use twapi_v2::oauth10a::OAuthAuthentication;
+
+// CONSUMER_KEY=XXXX CONSUMER_SECRET=XXXX ACCESS_KEY=XXXX ACCESS_SECRET=XXXX cargo test test_get_2_users_by_by_oauth  --all-features -- --nocapture --test-threads=1
+
+#[tokio::test]
+async fn test_get_2_users_by_by_oauth() -> Result<()> {
+    let auth = OAuthAuthentication::new(
+        std::env::var("CONSUMER_KEY").unwrap_or_default(),
+        std::env::var("CONSUMER_SECRET").unwrap_or_default(),
+        std::env::var("ACCESS_KEY").unwrap_or_default(),
+        std::env::var("ACCESS_SECRET").unwrap_or_default(),
+    );
+    let builder =
+        get_2_users_by::Api::open("retrip_gourmet,uv_technology,barley_tea_0522").build(&auth);
+    let (res, _rate_limit) = execute_twitter::<serde_json::Value>(builder).await?;
+    println!("{}", serde_json::to_string(&res).unwrap());
+    let response = serde_json::from_value::<get_2_users_by::Response>(res)?;
+    assert_eq!(response.is_empty_extra(), true);
+    Ok(())
+}

tests/get_2_users_oauth.rs

@@ -0,0 +1,21 @@
+use anyhow::Result;
+use twapi_v2::api::{execute_twitter, get_2_users};
+use twapi_v2::oauth10a::OAuthAuthentication;
+
+// CONSUMER_KEY=XXXX CONSUMER_SECRET=XXXX ACCESS_KEY=XXXX ACCESS_SECRET=XXXX  cargo test test_get_2_users_users_oauth --all-features -- --nocapture --test-threads=1
+
+#[tokio::test]
+async fn test_get_2_users_users_oauth() -> Result<()> {
+    let auth = OAuthAuthentication::new(
+        std::env::var("CONSUMER_KEY").unwrap_or_default(),
+        std::env::var("CONSUMER_SECRET").unwrap_or_default(),
+        std::env::var("ACCESS_KEY").unwrap_or_default(),
+        std::env::var("ACCESS_SECRET").unwrap_or_default(),
+    );
+    let builder = get_2_users::Api::open("1660518823991336966,1524979284024078336").build(&auth);
+    let (res, _rate_limit) = execute_twitter::<serde_json::Value>(builder).await?;
+    println!("{}", serde_json::to_string(&res).unwrap());
+    let response = serde_json::from_value::<get_2_users::Response>(res)?;
+    assert_eq!(response.is_empty_extra(), true);
+    Ok(())
+}