fakehub-server 0.0.8

// The MIT License (MIT)
//
// Copyright (c) 2024 Aliaksei Bialiauski
//
// 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 NON-INFRINGEMENT. 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.
use crate::objects::user::User;
use crate::ServerConfig;
use axum::extract::State;
use axum::http::StatusCode;
use axum::Json;
use log::info;
use serde::Deserialize;

/// Rq Login.
#[derive(Deserialize)]
pub struct RqLogin {
    /// Login.
    login: String,
}

/// Register user.
///
/// # Fields
///
/// * `payload`: JSON payload
pub async fn register_user(
    State(config): State<ServerConfig>,
    Json(payload): Json<RqLogin>,
) -> Result<StatusCode, (StatusCode, String)> {
    let mut newcomer = User::new(payload.login);
    let fakehub = &config.fakehub;
    let github = fakehub.main();
    let mut github = github
        .lock()
        .map_err(|e| format!("Mutex lock failed: {}", e))
        .expect("Failed to get GitHub");
    match newcomer.register_in(&mut github, fakehub) {
        Ok(_) => {
            info!("New user is here. Hello @{}", newcomer.login);
            Ok(StatusCode::CREATED)
        }
        Err(e) => Err((
            StatusCode::CONFLICT,
            format!("Can't register user @{}: {}", newcomer.login, e),
        )),
    }
}

#[cfg(test)]
mod tests {
    use crate::handlers::register_user::{register_user, RqLogin};
    use crate::objects::fakehub::FakeHub;
    use crate::ServerConfig;
    use anyhow::Result;
    use axum::extract::State;
    use axum::http::StatusCode;
    use axum::Json;
    use hamcrest::{equal_to, is, HamcrestMatcher};

    #[tokio::test]
    async fn registers_user() -> Result<()> {
        let server = ServerConfig {
            fakehub: FakeHub::default(),
        };
        let state = State(server.clone());
        let registration = "new1234";
        let status = register_user(
            state,
            Json::from(RqLogin {
                login: String::from(registration),
            }),
        )
        .await
        .expect("Failed to register user");
        let fakehub = server.fakehub;
        let github = fakehub.main();
        let locked = github.lock().expect("Failed to lock GitHub");
        let users = locked.clone().users();
        let created = locked.user(registration).expect("Failed to get user");
        assert_that!(created.login.as_str(), is(equal_to(registration)));
        assert_that!(users.len(), is(equal_to(3)));
        assert_that!(status.as_u16(), is(equal_to(201)));
        Ok(())
    }

    #[tokio::test]
    async fn registers_with_extra_fields() -> Result<()> {
        let server = ServerConfig {
            fakehub: FakeHub::default(),
        };
        let state = State(server.clone());
        let registration = "new1234";
        register_user(
            state,
            Json::from(RqLogin {
                login: String::from(registration),
            }),
        )
        .await
        .expect("Failed to register user");
        let fakehub = server.fakehub;
        let github = fakehub.main();
        let locked = github.lock().expect("Failed to lock GitHub");
        let created = locked.user(registration).expect("Failed to get user");
        let expected = format!("localhost/users/{}", registration);
        assert_that!(
            created
                .extra
                .get("url")
                .expect("Failed to get url")
                .as_str(),
            is(equal_to(Some(expected.as_str())))
        );
        assert_that!(created.extra.len(), is(equal_to(31)));
        Ok(())
    }

    #[should_panic(expected = "Failed to register user")]
    #[tokio::test]
    async fn panics_when_user_exists() {
        let server = ServerConfig {
            fakehub: FakeHub::default(),
        };
        let state = State(server);
        register_user(
            state,
            Json::from(RqLogin {
                login: String::from("jeff"),
            }),
        )
        .await
        .expect("Failed to register user");
    }

    #[tokio::test]
    async fn returns_409_when_user_exists() -> Result<()> {
        let server = ServerConfig {
            fakehub: FakeHub::default(),
        };
        let state = State(server);
        let result = register_user(
            state,
            Json::from(RqLogin {
                login: String::from("jeff"),
            }),
        )
        .await;
        match result {
            Err((status, _)) => {
                assert_that!(status, is(equal_to(StatusCode::CONFLICT)));
                Ok(())
            }
            Ok(_) => panic!("Expected conflict but got success"),
        }
    }
}