cleverbotfreeapi 0.1.2

Interact with a washed down version of the Cleverbot API for free
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

use std::sync::Arc;
use ringbuffer::{RingBuffer, AllocRingBuffer};
use crate::{cookie_generation::get_cookie, helpers::pythonic_encode};
use std::str;
use parking_lot::RwLock;  // these bastards lied to me, theres no holding-across-an-await-point detection here
// actually there's the send_guard feature that allows clippy to detect such issues


/// A struct representing a Cleverbot instance.
///
/// # Examples
/// 
/// Basic usage:
/// 
/// ```no_run
/// let cleverbot = CleverbotBuilder::default().build().await?;
/// ```
/// 
/// Custom usage:
/// ```no_run
/// let client = reqwest::Client::new();
/// let cleverbot = CleverbotBuilder::default()
///     .with_client(client)
///     .with_custom_history_size(100)
///     .with_retries(false)
///     .build()
///     .await?;
/// ```
#[derive(Debug, Clone)]
pub struct Cleverbot {
    pub cookie: Arc<RwLock<String>>,
    pub history: Arc<RwLock<AllocRingBuffer<String>>>,
    pub client: reqwest::Client,
    pub with_retries: bool,
}


impl Cleverbot {
    /// Responses like these indicate that something went wrong, most likely the cookie expired.
    const BAD_RESPONSES: &'static [&'static str] = &["Hello from Cleverbot\n", "<html", "<html>"];

    /// Get a response from Cleverbot.
    ///
    /// # Examples
    /// 
    /// ```no_run
    /// let response = cleverbot.get_response("are you a bot?").await?;
    /// println!("response: {}", response);
    /// // would return something like "no, I'm a human"
    /// ```
    pub async fn get_response(&self, message: &str) -> Result<String, crate::Error> {
        let payload = self.build_payload(message).await;

        match self.send_and_handle_response(&payload, message).await {
            Ok(answer) => return Ok(answer),
            Err(why) if !self.with_retries => return Err(why),
            _ => {}  // when there's an err and with_retries is true
        }

        let new_cookie = get_cookie(&self.client).await?;

        *self.cookie.write() = new_cookie;

        self.send_and_handle_response(&payload, message).await
            .map_err(|e| match e {
                crate::Error::BadResponse(why) => crate::Error::BadResponseAfterRetrying(why),
                other => other
            })
    }

    /// Returns the conversation history as a `Vec<String>`.
    ///
    /// # Examples
    /// 
    /// ```no_run
    /// let history = cleverbot.get_history();
    /// println!("conversation history: {:?}", history);
    /// ```
    pub fn get_history(&self) -> Vec<String> {
        (*self.history.read()).iter().cloned().collect::<Vec<_>>()
    }

    /// Clears the messaging history.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// cleverbot.clear_history();
    /// println!("history cleared");
    /// ```
    pub fn clear_history(&self) {
        (*self.history.write()).clear()
    }

    // ok nah i aint making this 💀
    // pub fn get_history_iter(&self) -> impl Iterator<Item = String> + '_ {
    //     // let history = (*self.history.read()).iter().cloned().collect::<Vec<_>>();
    //     // history.into_iter()
    //     (*self.history.read()).iter().cloned()
    // }

    /// Manually reset the cookie.
    ///
    /// # Examples
    /// 
    /// ```no_run
    /// cleverbot.recookie().await?;
    /// ```
    pub async fn recookie(&self) -> Result<(), crate::Error> {
        let new_cookie = get_cookie(&self.client).await?;
        *self.cookie.write() = new_cookie;
        Ok(())
    }

    /// helper for sending and handling responses from the api
    async fn send_and_handle_response(&self, payload: &str, message: &str) -> Result<String, crate::Error> {
        let answer = self.send_cleverbot_request(payload).await?;

        if Self::BAD_RESPONSES.contains(&&*answer) {
            return Err(crate::Error::BadResponse(answer.clone()))
        }

        let mut history = self.history.write();
        history.push(message.to_string());
        history.push(answer.clone());

        Ok(answer)
    }

    /// stimulus - user's input message, question to cleverbot
    async fn build_payload(&self, stimulus: &str) -> String {
        let stimulus_str = format!("stimulus={}", pythonic_encode(stimulus));

        let context_str = self.history.read()
            .iter()
            .rev()
            .enumerate()
            .fold(String::new(), |mut acc, (i, text)| {
                use std::fmt::Write;
                write!(acc, "&vText{}={}", i + 2, pythonic_encode(text)).unwrap();
                acc
            });
        let cb_settings_str = "&cb_settings_scripting=no&islearning=1&icognoid=wsf&icognocheck=";

        let partial_payload = format!("{}{}{}", stimulus_str, context_str, cb_settings_str);

        // i dont know why, i dont wanna know why, but this is just needed at the end (the variable name speaks for itself)
        let magic_ingredient = format!("{:x}", md5::compute(&partial_payload[7..33]));

        let payload = format!("{}{}", partial_payload, magic_ingredient);

        tracing::debug!("payload: {payload}");

        payload
    }

    async fn send_cleverbot_request(&self, payload: &str) -> Result<String, crate::Error> {
        let cookie = self.cookie.read().clone();
        let bytes_res = self.client.post("https://www.cleverbot.com/webservicemin?uc=UseOfficialCleverbotAPI")
            .body(payload.to_string())
            .header("cookie", cookie)
            // .header("accept-encoding", "gzip, deflate")
            .header("user-agent", "python-requests/2.32.3")
            .send()
            .await?
            .bytes()
            .await?;

        tracing::debug!("bytes_res: {:?}", bytes_res);
        
        let text = str::from_utf8(&bytes_res)?;
        let response = text.split('\r').next().ok_or(crate::Error::InvalidResponseFromCleverbotApi)?;

        Ok(response.into())
    }
}

/// A builder for creating a Cleverbot client.
///
/// # Examples
///
/// Basic usage:
///
/// ```no_run
/// let cleverbot = CleverbotBuilder::default().build().await?;
/// ```
/// 
/// Custom usage:
/// ```no_run
/// let client = reqwest::Client::new();
/// let cleverbot = CleverbotBuilder::default()
///     .with_client(client)
///     .with_custom_history_size(100)
///     .with_retries(false)
///     .build()
///     .await?;
/// ```
pub struct CleverbotBuilder {
    client: reqwest::Client,
    with_retries: bool,
    history_size: usize,
}

impl Default for CleverbotBuilder {
    fn default() -> Self {
        Self { 
            client: reqwest::Client::new(), 
            with_retries: true, 
            history_size: Self::DEFAULT_HISTORY_SIZE 
        }
    }
}



impl CleverbotBuilder {
    const DEFAULT_HISTORY_SIZE: usize = 50;

    /// Set a custom reqwest client.
    pub fn with_client(mut self, client: reqwest::Client) -> Self {
        self.client = client;
        self
    }

    /// Enable or disable retries.
    ///
    /// By default, `with_retries` is set to `true`.
    pub fn with_retries(mut self, with_retries: bool) -> Self {
        self.with_retries = with_retries;
        self
    }

    /// Set a custom history size.
    /// 
    /// By default it's set to 50. 
    pub fn with_custom_history_size(mut self, history_size: usize) -> Self {
        self.history_size = history_size;
        self
    }

    /// Build the Cleverbot client.
    pub async fn build(self) -> Result<Cleverbot, crate::Error> {
        let cookie = get_cookie(&self.client).await?;
        tracing::debug!("cookie: {cookie}");

        Ok(Cleverbot {
            cookie: Arc::new(RwLock::new(cookie)),
            history: Arc::new(RwLock::new(AllocRingBuffer::<String>::new(self.history_size))),
            client: self.client,
            with_retries: self.with_retries
        })
    }
}