# docs.rs - source
Source of the Rust file `src/docs.rs`.
Keywords: rust, rustlang, rust-lang

      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

    /*
    * Copyright (C) 2021  Aravinth Manivannan <realaravinth@batsense.net>
    *
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU Affero General Public License as
    * published by the Free Software Foundation, either version 3 of the
    * License, or (at your option) any later version.
    *
    * This program is distributed in the hope that it will be useful,
    * but WITHOUT ANY WARRANTY; without even the implied warranty of
    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    * GNU Affero General Public License for more details.
    *
    * You should have received a copy of the GNU Affero General Public License
    * along with this program.  If not, see <https://www.gnu.org/licenses/>.
    */
    use std::borrow::Cow;

    use actix_web::body::Body;
    use actix_web::{http::header, web, HttpResponse, Responder};
    use mime_guess::from_path;
    use rust_embed::RustEmbed;

    use crate::CACHE_AGE;

    pub const DOCS: routes::Docs = routes::Docs::new();

    pub mod routes {
        pub struct Docs {
            pub home: &'static str,
            pub spec: &'static str,
            pub assets: &'static str,
        }

        impl Docs {
            pub const fn new() -> Self {
                Docs {
                    home: "/docs/",
                    spec: "/docs/openapi.json",
                    assets: "/docs/{_:.*}",
                }
            }
        }
    }

    pub fn services(cfg: &mut web::ServiceConfig) {
        use crate::define_resource;
        define_resource!(cfg, &DOCS.home[0..DOCS.home.len() - 1], Methods::Get, index);
        define_resource!(cfg, DOCS.spec, Methods::Get, spec);
        define_resource!(cfg, DOCS.assets, Methods::Get, dist);
    }

    #[derive(RustEmbed)]
    #[folder = "static/openapi/"]
    struct Asset;

    pub fn handle_embedded_file(path: &str) -> HttpResponse {
        match Asset::get(path) {
            Some(content) => {
                let body: Body = match content {
                    Cow::Borrowed(bytes) => bytes.into(),
                    Cow::Owned(bytes) => bytes.into(),
                };
                HttpResponse::Ok()
                    .insert_header(header::CacheControl(vec![
                        header::CacheDirective::MaxAge(CACHE_AGE),
                    ]))
                    .content_type(from_path(path).first_or_octet_stream().as_ref())
                    .body(body)
            }
            None => HttpResponse::NotFound().body("404 Not Found"),
        }
    }

    async fn dist(path: web::Path<String>) -> impl Responder {
        handle_embedded_file(&path)
    }

    async fn spec() -> HttpResponse {
        HttpResponse::Ok()
            .content_type("appilcation/json")
            .body(&*crate::OPEN_API_DOC)
    }

    async fn index() -> HttpResponse {
        handle_embedded_file("index.html")
    }

    #[cfg(test)]
    mod tests {
        use actix_web::http::StatusCode;
        use actix_web::test;

        use super::*;
        use crate::*;

        #[actix_rt::test]
        async fn docs_works() {
            const FILE: &str = "favicon-32x32.png";

            let app = test::init_service(
                App::new()
                    .wrap(actix_middleware::NormalizePath::new(
                        actix_middleware::TrailingSlash::Trim,
                    ))
                    .configure(services),
            )
            .await;

            let resp = test::call_service(
                &app,
                test::TestRequest::get().uri(DOCS.home).to_request(),
            )
            .await;
            assert_eq!(resp.status(), StatusCode::OK);

            let resp = test::call_service(
                &app,
                test::TestRequest::get().uri(DOCS.spec).to_request(),
            )
            .await;
            assert_eq!(resp.status(), StatusCode::OK);

            let uri = format!("{}{}", DOCS.home, FILE);

            let resp =
                test::call_service(&app, test::TestRequest::get().uri(&uri).to_request())
                    .await;
            assert_eq!(resp.status(), StatusCode::OK);
        }
    }