Skip to content

Commit 91c78ed

Browse files
authored
chore!: remove deprecated items (#349)
1 parent 61ec0d6 commit 91c78ed

11 files changed

Lines changed: 241 additions & 417 deletions

File tree

cot/src/auth.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ use std::borrow::Cow;
1414
use std::sync::{Arc, Mutex, MutexGuard};
1515

1616
/// backwards compatible shim for form Password type.
17-
#[deprecated(since = "0.3.0", note = "use `cot::common_types::Password` instead")]
18-
pub type Password = crate::common_types::Password;
1917
use async_trait::async_trait;
2018
use chrono::{DateTime, FixedOffset};
2119
use derive_more::with_trait::Debug;
@@ -175,7 +173,8 @@ pub trait User {
175173
/// ```
176174
/// use std::borrow::Cow;
177175
///
178-
/// use cot::auth::{Password, SessionAuthHash, User, UserId};
176+
/// use cot::auth::{SessionAuthHash, User, UserId};
177+
/// use cot::common_types::Password;
179178
/// use cot::config::SecretKey;
180179
/// use hmac::{Hmac, Mac};
181180
/// use sha2::Sha512;
@@ -343,7 +342,8 @@ impl User for AnonymousUser {}
343342
/// ```
344343
/// use std::borrow::Cow;
345344
///
346-
/// use cot::auth::{Password, SessionAuthHash, User, UserId};
345+
/// use cot::auth::{SessionAuthHash, User, UserId};
346+
/// use cot::common_types::Password;
347347
/// use cot::config::SecretKey;
348348
/// use hmac::{Hmac, Mac};
349349
/// use sha2::Sha512;
@@ -484,7 +484,8 @@ impl PasswordHash {
484484
/// # Examples
485485
///
486486
/// ```
487-
/// use cot::auth::{Password, PasswordHash};
487+
/// use cot::auth::PasswordHash;
488+
/// use cot::common_types::Password;
488489
///
489490
/// let hash = PasswordHash::from_password(&Password::new("password"));
490491
/// let stored_hash = hash.into_string();

cot/src/auth/db.rs

Lines changed: 49 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -76,24 +76,20 @@ impl DatabaseUser {
7676
/// # Example
7777
///
7878
/// ```
79-
/// use cot::auth::Password;
8079
/// use cot::auth::db::DatabaseUser;
80+
/// use cot::common_types::Password;
81+
/// use cot::html::Html;
8182
/// use cot::request::{Request, RequestExt};
82-
/// use cot::response::{Response, ResponseExt};
83-
/// use cot::{Body, StatusCode};
8483
///
85-
/// async fn view(request: &Request) -> cot::Result<Response> {
84+
/// async fn view(request: &Request) -> cot::Result<Html> {
8685
/// let user = DatabaseUser::create_user(
8786
/// request.db(),
8887
/// "testuser".to_string(),
8988
/// &Password::new("password123"),
9089
/// )
9190
/// .await?;
9291
///
93-
/// Ok(Response::new_html(
94-
/// StatusCode::OK,
95-
/// Body::fixed("User created!"),
96-
/// ))
92+
/// Ok(Html::new("User created!"))
9793
/// }
9894
///
9995
/// # #[tokio::main]
@@ -141,13 +137,13 @@ impl DatabaseUser {
141137
/// # Example
142138
///
143139
/// ```
140+
/// use cot::auth::UserId;
144141
/// use cot::auth::db::DatabaseUser;
145-
/// use cot::auth::{Password, UserId};
142+
/// use cot::common_types::Password;
143+
/// use cot::html::Html;
146144
/// use cot::request::{Request, RequestExt};
147-
/// use cot::response::{Response, ResponseExt};
148-
/// use cot::{Body, StatusCode};
149145
///
150-
/// async fn view(request: &Request) -> cot::Result<Response> {
146+
/// async fn view(request: &Request) -> cot::Result<Html> {
151147
/// let user = DatabaseUser::create_user(
152148
/// request.db(),
153149
/// "testuser".to_string(),
@@ -157,10 +153,7 @@ impl DatabaseUser {
157153
///
158154
/// let user_from_db = DatabaseUser::get_by_id(request.db(), user.id()).await?;
159155
///
160-
/// Ok(Response::new_html(
161-
/// StatusCode::OK,
162-
/// Body::fixed("User created!"),
163-
/// ))
156+
/// Ok(Html::new("User created!"))
164157
/// }
165158
///
166159
/// # #[tokio::main]
@@ -196,38 +189,28 @@ impl DatabaseUser {
196189
/// # Example
197190
///
198191
/// ```
192+
/// use cot::auth::UserId;
199193
/// use cot::auth::db::DatabaseUser;
200-
/// use cot::auth::{Password, UserId};
201-
/// use cot::request::{Request, RequestExt};
202-
/// use cot::response::{Response, ResponseExt};
203-
/// use cot::{Body, StatusCode};
194+
/// use cot::common_types::Password;
195+
/// use cot::html::Html;
196+
/// use cot::request::extractors::RequestDb;
204197
///
205-
/// async fn view(request: &Request) -> cot::Result<Response> {
206-
/// let user = DatabaseUser::create_user(
207-
/// request.db(),
208-
/// "testuser".to_string(),
209-
/// &Password::new("password123"),
210-
/// )
211-
/// .await?;
198+
/// async fn view(RequestDb(db): RequestDb) -> cot::Result<Html> {
199+
/// let user =
200+
/// DatabaseUser::create_user(&db, "testuser".to_string(), &Password::new("password123"))
201+
/// .await?;
212202
///
213-
/// let user_from_db = DatabaseUser::get_by_username(request.db(), "testuser").await?;
203+
/// let user_from_db = DatabaseUser::get_by_username(&db, "testuser").await?;
214204
///
215-
/// Ok(Response::new_html(
216-
/// StatusCode::OK,
217-
/// Body::fixed("User created!"),
218-
/// ))
205+
/// Ok(Html::new("User created!"))
219206
/// }
220207
///
221208
/// # #[tokio::main]
222209
/// # async fn main() -> cot::Result<()> {
223210
/// # use cot::test::{TestDatabase, TestRequestBuilder};
224211
/// # let mut test_database = TestDatabase::new_sqlite().await?;
225212
/// # test_database.with_auth().run_migrations().await;
226-
/// # let request = TestRequestBuilder::get("/")
227-
/// # .with_db_auth(test_database.database())
228-
/// # .await
229-
/// # .build();
230-
/// # view(&request).await?;
213+
/// # view(RequestDb(test_database.database())).await?;
231214
/// # test_database.cleanup().await?;
232215
/// # Ok(())
233216
/// # }
@@ -298,36 +281,32 @@ impl DatabaseUser {
298281
/// # Example
299282
///
300283
/// ```
284+
/// use cot::auth::UserId;
301285
/// use cot::auth::db::DatabaseUser;
302-
/// use cot::auth::{Password, UserId};
303-
/// use cot::request::{Request, RequestExt};
304-
/// use cot::response::{Response, ResponseExt};
305-
/// use cot::{Body, StatusCode};
286+
/// use cot::common_types::Password;
287+
/// use cot::html::Html;
288+
/// use cot::request::extractors::RequestDb;
306289
///
307-
/// async fn view(request: &Request) -> cot::Result<Response> {
308-
/// let user = DatabaseUser::create_user(
309-
/// request.db(),
310-
/// "testuser".to_string(),
311-
/// &Password::new("password123"),
312-
/// )
313-
/// .await?;
290+
/// async fn view(RequestDb(db): RequestDb) -> cot::Result<Html> {
291+
/// let user =
292+
/// DatabaseUser::create_user(&db, "testuser".to_string(), &Password::new("password123"))
293+
/// .await?;
314294
///
315-
/// Ok(Response::new_html(
316-
/// StatusCode::OK,
317-
/// Body::fixed(format!("User ID: {}", user.id())),
318-
/// ))
295+
/// Ok(Html::new(format!("User ID: {}", user.id())))
319296
/// }
320-
///
297+
/// #
321298
/// # #[tokio::main]
322299
/// # async fn main() -> cot::Result<()> {
323300
/// # use cot::test::{TestDatabase, TestRequestBuilder};
301+
/// # use cot::request::Request;
302+
/// # use cot::RequestHandler;
324303
/// # let mut test_database = TestDatabase::new_sqlite().await?;
325304
/// # test_database.with_auth().run_migrations().await;
326305
/// # let request = TestRequestBuilder::get("/")
327306
/// # .with_db_auth(test_database.database())
328307
/// # .await
329308
/// # .build();
330-
/// # view(&request).await?;
309+
/// # view.handle(request).await?;
331310
/// # test_database.cleanup().await?;
332311
/// # Ok(())
333312
/// # }
@@ -345,36 +324,32 @@ impl DatabaseUser {
345324
/// # Example
346325
///
347326
/// ```
327+
/// use cot::auth::UserId;
348328
/// use cot::auth::db::DatabaseUser;
349-
/// use cot::auth::{Password, UserId};
350-
/// use cot::request::{Request, RequestExt};
351-
/// use cot::response::{Response, ResponseExt};
352-
/// use cot::{Body, StatusCode};
329+
/// use cot::common_types::Password;
330+
/// use cot::html::Html;
331+
/// use cot::request::extractors::RequestDb;
353332
///
354-
/// async fn view(request: &Request) -> cot::Result<Response> {
355-
/// let user = DatabaseUser::create_user(
356-
/// request.db(),
357-
/// "testuser".to_string(),
358-
/// &Password::new("password123"),
359-
/// )
360-
/// .await?;
333+
/// async fn view(RequestDb(db): RequestDb) -> cot::Result<Html> {
334+
/// let user =
335+
/// DatabaseUser::create_user(&db, "testuser".to_string(), &Password::new("password123"))
336+
/// .await?;
361337
///
362-
/// Ok(Response::new_html(
363-
/// StatusCode::OK,
364-
/// Body::fixed(user.username().to_string()),
365-
/// ))
338+
/// Ok(Html::new(format!("Username: {}", user.username())))
366339
/// }
367-
///
340+
/// #
368341
/// # #[tokio::main]
369342
/// # async fn main() -> cot::Result<()> {
370343
/// # use cot::test::{TestDatabase, TestRequestBuilder};
344+
/// # use cot::request::Request;
345+
/// # use cot::RequestHandler;
371346
/// # let mut test_database = TestDatabase::new_sqlite().await?;
372347
/// # test_database.with_auth().run_migrations().await;
373348
/// # let request = TestRequestBuilder::get("/")
374349
/// # .with_db_auth(test_database.database())
375350
/// # .await
376351
/// # .build();
377-
/// # view(&request).await?;
352+
/// # view.handle(request).await?;
378353
/// # test_database.cleanup().await?;
379354
/// # Ok(())
380355
/// # }
@@ -439,8 +414,8 @@ impl DatabaseUserCredentials {
439414
/// # Example
440415
///
441416
/// ```
442-
/// use cot::auth::Password;
443417
/// use cot::auth::db::DatabaseUserCredentials;
418+
/// use cot::common_types::Password;
444419
///
445420
/// let credentials =
446421
/// DatabaseUserCredentials::new(String::from("testuser"), Password::new("password123"));
@@ -455,8 +430,8 @@ impl DatabaseUserCredentials {
455430
/// # Example
456431
///
457432
/// ```
458-
/// use cot::auth::Password;
459433
/// use cot::auth::db::DatabaseUserCredentials;
434+
/// use cot::common_types::Password;
460435
///
461436
/// let credentials =
462437
/// DatabaseUserCredentials::new(String::from("testuser"), Password::new("password123"));
@@ -472,8 +447,8 @@ impl DatabaseUserCredentials {
472447
/// # Example
473448
///
474449
/// ```
475-
/// use cot::auth::Password;
476450
/// use cot::auth::db::DatabaseUserCredentials;
451+
/// use cot::common_types::Password;
477452
///
478453
/// let credentials =
479454
/// DatabaseUserCredentials::new(String::from("testuser"), Password::new("password123"));

cot/src/common_types.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ const MAX_EMAIL_LENGTH: u32 = 254;
5757
/// # Examples
5858
///
5959
/// ```
60-
/// use cot::auth::Password;
60+
/// use cot::common_types::Password;
6161
///
6262
/// let password = Password::new("pass");
6363
/// assert_eq!(&format!("{:?}", password), "Password(\"**********\")");

0 commit comments

Comments
 (0)