direkuta 0.1.2-beta

A fast REST focused web framework
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
//! A web framework built around Hyper.
//!
//! # Examples
//!
//! ```rust,ignore
//! # use direkuta::prelude::*;
//! // Not tested due to the fact that its a web server.
//! Direkuta::new()
//!     .route(|r| {
//!         r.get("/", |_, _, _| {
//!             Response::new().with_body("Hello World!")
//!         });
//!     })
//!     .run("0.0.0.0:3000");
//! ```

#![deny(
    missing_docs,
    single_use_lifetimes,
    trivial_casts,
    trivial_numeric_casts,
    unsafe_code,
    unstable_features,
    unused_import_braces,
    unused_qualifications,
    unreachable_pub,
    unused_results
)]

extern crate futures;
extern crate http;
extern crate hyper;
extern crate indexmap;
extern crate regex;
extern crate smallvec;

#[cfg(feature = "json")]
extern crate serde;
#[cfg(feature = "json")]
#[macro_use]
extern crate serde_derive;
#[cfg(feature = "json")]
extern crate serde_json;

#[cfg(feature = "html")]
extern crate tera;

use std::any::{Any, TypeId};
use std::borrow::Cow;
use std::fs::File;
use std::io::prelude::*;
use std::sync::Arc;

use futures::{future, Future};
use http::{request, response};
use hyper::header::{self, HeaderMap, HeaderValue};
use hyper::service::{NewService, Service};
use hyper::{rt, Body, Method, Server, StatusCode, Uri, Version};
use indexmap::IndexMap;
use regex::Regex;
use smallvec::SmallVec;

#[cfg(feature = "json")]
use serde::Serialize;

#[cfg(feature = "html")]
use tera::Tera;

/// The Direkuta web server itself.
pub struct Direkuta {
    /// Store state as its own type.
    state: Arc<State>,
    /// Stores middleware, to be later used in [Service::call](Service::call).
    middle: Arc<IndexMap<TypeId, Box<Middle + Send + Sync + 'static>>>,
    /// The router, it knows where a url is meant to go.
    routes: Arc<Router>,
}

impl Direkuta {
    /// Constructs a new [Direkuta](Direkuta).
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new();
    /// ```
    pub fn new() -> Self {
        Direkuta::default()
    }

    /// Insert a state into [Direkuta](Direkuta).
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .state(String::from("Hello World!"));
    /// ```
    ///
    /// # Panics
    /// Do not use this from anywhere else but the main constructor.
    /// Using this from any else will cause a thread panic.
    pub fn state<T: Any + Send + Sync + 'static>(mut self, state: T) -> Self {
        Arc::get_mut(&mut self.state)
            .expect("Cannot get_mut on state")
            .set(state);
        self
    }

    /// Insert a middleware into [Direkuta](Direkuta).
    ///
    /// Middleware is anything that impliments the trait [Middle](Middle).
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .middle(Logger::new());
    /// ```
    ///
    /// # Panics
    ///
    /// Do not use this from anywhere else but the main constructor.
    /// Using this from any else will cause a thread panic.
    pub fn middle<T: Middle + Send + Sync + 'static>(mut self, middle: T) -> Self {
        let _ = Arc::get_mut(&mut self.middle)
            .expect("Cannot get_mut on middle")
            .insert(TypeId::of::<T>(), Box::new(middle));
        self
    }

    /// Create new router as a closure.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         // handlers here
    ///     });
    /// ```
    pub fn route<R: Fn(&mut Router) + Send + Sync + 'static>(mut self, route: R) -> Self {
        let mut route_builder = Router::new();

        route(&mut route_builder);
        self.routes = Arc::new(route_builder);

        self
    }

    /// Run [Direkuta](Direkuta) as a Hyper server.
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// # use direkuta::prelude::*;
    /// // Not tested due to the fact that its a web server.
    /// Direkuta::new()
    ///     .run("0.0.0.0:3000");
    /// ```
    ///
    /// # Errors
    ///
    /// If any errors come from the server they will be printed to the console.
    pub fn run(self, addr: &str) {
        let address = addr.parse().expect("Address not a valid socket address");
        let server = Server::bind(&address)
            .serve(self)
            .map_err(|e| eprintln!("server error: {}", e));

        println!("Direkuta listening on http://{}", addr);

        rt::run(server);
    }
}

impl Default for Direkuta {
    fn default() -> Self {
        #[allow(unused_mut)]
        let mut state = State::new();

        #[cfg(feature = "html")]
        state.set(match Tera::parse("templates/**/*") {
            Ok(t) => t,
            Err(e) => {
                println!("Parsing error(s): {}", e);
                ::std::process::exit(1);
            }
        });

        Self {
            state: Arc::new(state),
            middle: Arc::new(IndexMap::new()),
            routes: Arc::new(Router::default()),
        }
    }
}

impl NewService for Direkuta {
    type ReqBody = Body;
    type ResBody = Body;
    type Error = hyper::Error;
    type InitError = hyper::Error;
    type Service = Direkuta;
    type Future = Box<Future<Item = Self::Service, Error = Self::InitError> + Send>;

    fn new_service(&self) -> Self::Future {
        Box::new(future::ok(Self {
            state: self.state.clone(),
            middle: self.middle.clone(),
            routes: self.routes.clone(),
        }))
    }
}

impl Service for Direkuta {
    type ReqBody = Body;
    type ResBody = Body;
    type Error = hyper::Error;
    type Future = Box<Future<Item = response::Response<Self::ReqBody>, Error = Self::Error> + Send>;

    fn call(&mut self, req: request::Request<Self::ReqBody>) -> Self::Future {
        let method = req.method().clone();
        let path = req.uri().path().to_owned();
        let (parts, body) = req.into_parts();
        let mut req = Request::new(body, parts);

        for (_, before) in self.middle.iter() {
            before.before(&mut req);
        }

        let mut res: Response = match self.routes.recognize(&method, &path) {
            Ok((handler, cap)) => handler(&req, &self.state.clone(), &cap),
            Err(code) => {
                let mut res = Response::new();
                res.set_status(code.as_u16());
                res
            }
        };

        for (_, after) in self.middle.iter() {
            after.after(&mut req, &mut res);
        }

        Box::new(future::ok(res.into_hyper()))
    }
}

/// All middleware must implement this trait.
///
/// # Examples
///
/// ```rust
/// # use direkuta::prelude::{Middle, Request, Response};
/// struct Logger {}
///
/// impl Logger {
///     pub fn new() -> Self {
///         Self { }
///     }
/// }
///
/// impl Middle for Logger {
///     fn before(&self, req: &mut Request) {
///         println!("[{}] `{}`", req.method(), req.uri());
///     }
///
///     fn after(&self, req: &mut Request, res: &mut Response) {
///         println!("[{}] `{}`", res.status(), req.uri());
///     }
/// }
/// ```
pub trait Middle {
    /// Called before a request is sent through [RouteRecognizer](RouteRecognizer)
    fn before(&self, &mut Request);
    /// Called after a request is sent through [RouteRecognizer](RouteRecognizer)
    fn after(&self, &mut Request, &mut Response);
}

/// A simple logger middleware.
///
/// # Examples
///
/// ```rust
/// # use direkuta::prelude::*;
/// Direkuta::new()
///     .middle(Logger::new());
/// ```
#[derive(Clone, Copy, Debug)]
pub struct Logger {}

impl Logger {
    /// Constructs a new [Logger](Logger).
    pub fn new() -> Self {
        Logger::default()
    }
}

impl Middle for Logger {
    fn before(&self, req: &mut Request) {
        println!("[{}] `{}`", req.method(), req.uri());
    }

    fn after(&self, req: &mut Request, res: &mut Response) {
        println!("[{}] `{}`", res.status(), req.uri());
    }
}

impl Default for Logger {
    fn default() -> Logger {
        Logger {}
    }
}

/// A wrapper around [HashMap](std::collections::HashMap)<[TypeId](std::any::TypeId), [Any](std::any::Any)>, used to store [Direkuta](Direkuta) state.
///
/// Stored state cannot be dynamically create and must be static.
pub struct State {
    inner: IndexMap<TypeId, Box<Any + Send + Sync + 'static>>,
}

impl State {
    /// Constructs a new [State](State)
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let state = State::new();
    /// ```
    pub fn new() -> Self {
        State::default()
    }

    /// Sets the value of whatever type is passed.
    ///
    /// Please note that you cannot have two states of the same types, one will overwrite the other.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::State;
    /// let mut state = State::new();
    ///
    /// state.set(String::from("Hello World!"));
    /// ```
    pub fn set<T: Any + Send + Sync + 'static>(&mut self, ctx: T) {
        let _ = self.inner.insert(TypeId::of::<T>(), Box::new(ctx));
    }

    /// Attempt to get a value based on type.
    ///
    /// Use this if you are not sure if the type exists.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let mut state = State::new();
    ///
    /// state.set(String::from("Hello World!"));
    ///
    /// match state.try_get::<String>() {
    ///     Some(s) => {
    ///         println!("{}", s);
    ///     },
    ///     None => {
    ///         println!("String not found in state");
    ///     },
    /// }
    /// ```
    pub fn try_get<T: Any + Send + Sync + 'static>(&self) -> Option<&T> {
        self.inner
            .get(&TypeId::of::<T>())
            .and_then(|b| b.downcast_ref::<T>())
    }

    /// Get a value based on type.
    ///
    /// This is a wrapper around [try_get](State::try_get).
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let mut state = State::new();
    ///
    /// state.set(String::from("Hello World!"));
    ///
    /// println!("{}", state.get::<String>());
    /// ```
    ///
    /// # Panics
    ///
    /// If the key does not exist the function will panic
    ///
    /// If you do not know if the type exists use `try_get`.
    pub fn get<T: Any + Send + Sync + 'static>(&self) -> &T {
        self.try_get::<T>()
            .unwrap_or_else(|| panic!("Key not found in state: {:?}", &TypeId::of::<T>()))
    }
}

impl Default for State {
    fn default() -> State {
        State {
            inner: IndexMap::new(),
        }
    }
}

type Handler = Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static;

enum Mode {
    Id,
    Regex,
    Look,
}

/// Router.
///
/// This is not to be used directly, it is only used for [Direkuta.route](Direkuta::route).
struct Route {
    handler: Box<Handler>,
    ids: SmallVec<[String; 64]>,
    path: String,
    pattern: Regex,
}

/// Router.
///
/// This is not to be used directly, it is only used for [Direkuta.route](Direkuta::route).
///
/// All examples for routing are shown with 'output' or what the paths will look like
/// and what the response would look like when called.
///
/// The format is as shown.
///
/// ```rust,ignore
/// URL : { Parameter => Capture } {
///     Method => Response
/// }
/// ```
pub struct Router {
    inner: IndexMap<Method, SmallVec<[Route; 128]>>,
}

impl Router {
    fn new() -> Router {
        Router::default()
    }

    /// Adds route to routing map.
    ///
    /// Its easier to the the helper functions.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// # use direkuta::prelude::hyper::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.route(Method::GET, "/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" {
    ///     GET => "Hello World!"
    /// }
    /// ```
    ///
    /// ## Regex
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// # use direkuta::prelude::hyper::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.route(Method::GET, "/<name:(.*)>", |_, _, c| {
    ///             Response::new().with_body(c.get("name").unwrap().as_str())
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/txuritan" : { "name" => "txuritan" } {
    ///     GET => "txuritan"
    /// }
    /// ```ignore
    pub fn route<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        method: Method,
        path: S,
        handler: H,
    ) {
        let path = path.into();

        // Transform the path in to ids and regex
        let reader = self.read(&path);

        self.inner
            .entry(method)
            .or_insert(SmallVec::new())
            .push(Route {
                handler: Box::new(handler),
                ids: reader.0,
                path: path,
                pattern: reader.1,
            });
    }

    /// Adds a [GET](Method::GET) request handler.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.get("/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" : {  } {
    ///     GET => "Hello World!"
    /// }
    /// ```
    ///
    /// ## Regex
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// # use direkuta::prelude::hyper::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.route(Method::GET, "/<name:(.*)>", |_, _, c| {
    ///             Response::new().with_body(c.get("name").unwrap().as_str())
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/txuritan" : { "name" => "txuritan" } {
    ///     GET => "txuritan"
    /// }
    /// ```
    pub fn get<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        path: S,
        handler: H,
    ) {
        self.route(Method::GET, path, handler);
    }

    /// Adds a [POST](Method::POST) request handler.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.post("/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" : {  } {
    ///     POST => "Hello World!"
    /// }
    /// ```
    pub fn post<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        path: S,
        handler: H,
    ) {
        self.route(Method::POST, path, handler);
    }

    /// Adds a [PUT](Method::PUT) request handler.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.put("/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" : {  } {
    ///     PUT => "Hello World!"
    /// }
    /// ```
    pub fn put<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        path: S,
        handler: H,
    ) {
        self.route(Method::PUT, path, handler);
    }

    /// Adds a [DELETE](Method::DELETE) request handler.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.delete("/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" : {  } {
    ///     DELETE => "Hello World!"
    /// }
    /// ```
    pub fn delete<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        path: S,
        handler: H,
    ) {
        self.route(Method::DELETE, path, handler);
    }

    /// Adds a [HEAD](Method::HEAD) request handler.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.head("/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" : {  } {
    ///     HEAD => "Hello World!"
    /// }
    /// ```
    pub fn head<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        path: S,
        handler: H,
    ) {
        self.route(Method::HEAD, path, handler);
    }

    /// Adds a [OPTIONS](Method::OPTIONS) request handler.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.options("/", |_, _, _| {
    ///             Response::new().with_body("Hello World!")
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/" : {  } {
    ///     OPTIONS => "Hello World!"
    /// }
    /// ```
    pub fn options<
        S: Into<String>,
        H: Fn(&Request, &State, &IndexMap<String, String>) -> Response + Send + Sync + 'static,
    >(
        &mut self,
        path: S,
        handler: H,
    ) {
        self.route(Method::OPTIONS, path, handler);
    }

    /// Create a path for multiple request types.
    ///
    /// # Examples
    ///
    /// ## Simple
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// Direkuta::new()
    ///     .route(|r| {
    ///         r.path("/parent", |r| {
    ///             r.get("/child", |_, _, _| {
    ///                 Response::new().with_body("Hello World!")
    ///             });
    ///         });
    ///     });
    /// ```
    ///
    /// ```rust,ignore
    /// "/parent/child" : {  } {
    ///     GET => "Hello World!"
    /// }
    /// ```
    pub fn path<
        S: Into<String>,
        F: Fn(&mut Router) + Send + Sync + 'static
    >(
        &mut self,
        path: S,
        sub: F
    ) {
        let mut builder = Router::new();

        sub(&mut builder);

        let path = path.into();

        // Loop through new methods
        for (method, routes) in builder.inner {
            // Loop through new routes
            for route in routes {
                // Concat paths
                let npath = format!("{}{}", path, route.path);

                // Transform the path in to ids and regex
                let reader = self.read(&npath);

                self.inner
                    .entry(method.clone())
                    .or_insert(SmallVec::new())
                    .push(Route {
                        handler: route.handler,
                        ids: reader.0,
                        path: npath,
                        pattern: reader.1,
                    });
            }
        }
    }

    /// When a request is recived this is called to find a handler.
    fn recognize(
        &self,
        method: &Method,
        path: &str,
    ) -> Result<(&Handler, IndexMap<String, String>), StatusCode> {
        // Get method
        let routes = self.inner.get(method).ok_or(StatusCode::NOT_FOUND)?;

        // Loop through all routes of method
        for route in routes.iter() {
            // Make sure the route matches
            if route.pattern.is_match(path) {
                // Get the capture map
                if let Some(map) = self.captures(&route, &route.pattern, path) {
                    return Ok((&*route.handler, map));
                }
            }
        }

        Err(StatusCode::NOT_FOUND)
    }

    /// Takes each capture and transfroms it into a map of ids and captures.
    fn captures(&self, route: &Route, re: &Regex, path: &str) -> Option<IndexMap<String, String>> {
        // Get captures
        re.captures(path).map(|caps| {
            let mut res: IndexMap<String, String> = IndexMap::new();

            // Loop through each capture
            for (i, _) in caps.iter().enumerate() {
                // We dont want the frist whole capture
                if i != 0 {
                    // Insert the capture to its id
                    let _ = res.insert(
                        // An id exists so the unwrap is safe
                        route.ids.get(i - 1).unwrap().to_string(),
                        // The capture exists so the unwrap is safe
                        caps.get(i).unwrap().as_str().to_string(),
                    );
                }
            }

            res
        })
    }

    /// Parse each path into a vector of ids and a regex pattern
    fn read(&self, path: &str) -> (SmallVec<[String; 64]>, Regex) {
        let mut ids: SmallVec<[String; 64]> = SmallVec::new();
        let mut pattern = String::new();

        let mut mode = Mode::Look;
        let mut id = String::new();

        for c in path.chars() {
            match c {
                '<' => mode = Mode::Id,
                ':' => {
                    mode = Mode::Regex;
                    ids.push(id.clone());
                    id.clear();
                }
                '>' => mode = Mode::Look,
                _ => match mode {
                    Mode::Id => id.push(c),
                    Mode::Regex | Mode::Look => pattern.push(c),
                },
            }
        }

        (ids, Regex::new(&self.normalize(&pattern)).unwrap())
    }

    /// Normalizes the regex paths.
    ///
    /// Removes the beginning `^` and ending `$` and `/`, if the exist.
    /// Then adds them even if they weren't there.
    fn normalize(&self, pattern: &str) -> Cow<str> {
        let pattern = pattern
            .trim()
            .trim_left_matches('^')
            .trim_right_matches('$')
            .trim_right_matches('/');
        match pattern {
            "" => "^/$".into(),
            s => format!("^{}/?$", s).into(),
        }
    }
}

impl Default for Router {
    fn default() -> Router {
        Router {
            inner: IndexMap::new(),
        }
    }
}

/// A wrapper around [Hyper Response](hyper::Response).
#[derive(Debug)]
pub struct Response {
    body: Body,
    parts: response::Parts,
}

impl Response {
    /// Constructs a new `Response`.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let res = Response::new();
    /// ```
    pub fn new() -> Self {
        Response::default()
    }

    /// Return Response HTTP version.
    pub fn version(&self) -> Version {
        self.parts.version
    }

    /// Return Response HTTP headers.
    pub fn headers(&self) -> &HeaderMap<HeaderValue> {
        &self.parts.headers
    }

    /// Return Response HTTP headers.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// # use direkuta::prelude::hyper::*;
    /// let mut res = Response::new();
    /// res.headers_mut().insert(
    ///     header::CONTENT_TYPE,
    ///     HeaderValue::from_static("text/plain")
    /// );
    /// ```
    pub fn headers_mut(&mut self) -> &mut HeaderMap<HeaderValue> {
        &mut self.parts.headers
    }

    /// Set Response's HTTP headers.
    pub fn set_headers(&mut self, headers: HeaderMap<HeaderValue>) {
        self.parts.headers.extend(headers);
    }

    /// Return Response HTTP status code.
    pub fn status(&self) -> StatusCode {
        self.parts.status
    }

    /// Get mutable reference to Response's status code.
    pub fn status_mut(&mut self) -> &mut StatusCode {
        &mut self.parts.status
    }

    /// Set Response's HTTP status code.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let mut res = Response::new();
    /// res.set_status(404);
    /// ```
    pub fn set_status(&mut self, status: u16) {
        self.parts.status =
            StatusCode::from_u16(status).expect("Given status is not a valid status code");
    }

    /// Set Response's HTTP status code.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let res = Response::new()
    ///     .with_status(404);
    /// ```
    pub fn with_status(mut self, status: u16) -> Self {
        self.set_status(status);
        self
    }

    /// Return Response HTTP body.
    pub fn body(self) -> Body {
        self.body
    }

    /// Get mutable reference to Response's body.
    pub fn body_mut(&mut self) -> &mut Body {
        &mut self.body
    }

    /// Set Response's HTTP body.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let mut res = Response::new();
    /// res.set_body("Hello World!");
    /// ```
    pub fn set_body<T: Into<String>>(&mut self, body: T) {
        let body = body.into();
        let _ = self.headers_mut().insert(
            header::CONTENT_LENGTH,
            HeaderValue::from_str(&body.len().to_string())
                .expect("Given value for CONTENT_LENGTH is not valid"),
        );
        self.body = Body::from(body);
    }

    /// Set Response's HTTP body.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let res = Response::new()
    ///     .with_body("Hello World!");
    /// ```
    pub fn with_body<T: Into<String>>(mut self, body: T) -> Self {
        self.set_body(body);
        self
    }

    /// Set Response's redirect location as status code.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let mut res = Response::new();
    /// res.redirect("/example/moved");
    /// ```
    pub fn redirect(&mut self, url: &'static str) {
        self.set_status(301);
        let _ = self
            .headers_mut()
            .insert(header::LOCATION, HeaderValue::from_static(url));
    }

    /// Set Response's redirect location as status code.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use direkuta::prelude::*;
    /// let res = Response::new()
    ///     .with_redirect("/example/moved");
    /// ```
    pub fn with_redirect(mut self, url: &'static str) -> Self {
        self.redirect(url);
        self
    }

    // TODO: Change this into a builder closure, with string, file, and template functions.
    /// Wrapper around [Response.set_body](Response::set_body) for the HTML context type.
    pub fn html<T: Into<String>>(&mut self, html: T) {
        let _ = self
            .headers_mut()
            .insert(header::CONTENT_TYPE, HeaderValue::from_static("text/html"));

        self.set_body(html);
    }

    /// Wrapper around [Response.set_body](Response::set_body) for the CSS context type.
    pub fn css<F: Fn(&mut CssBuilder)>(&mut self, css: F) {
        let _ = self
            .headers_mut()
            .insert(header::CONTENT_TYPE, HeaderValue::from_static("text/css"));

        let mut builder = CssBuilder::new();

        css(&mut builder);

        self.set_body(builder.get_body());
    }

    /// Wrapper around [Response.set_body](Response::set_body) for the CSS context type.
    pub fn with_css<F: Fn(&mut CssBuilder)>(mut self, css: F) -> Self {
        self.css(css);
        self
    }

    /// Wrapper around [Response.set_body](Response::set_body) for the JS context type.
    pub fn js<F: Fn(&mut JsBuilder)>(&mut self, js: F) {
        let _ = self.headers_mut().insert(
            header::CONTENT_TYPE,
            HeaderValue::from_static("application/javascript"),
        );

        let mut builder = JsBuilder::new();

        js(&mut builder);

        self.set_body(builder.get_body());
    }

    /// Wrapper around [Response.set_body](Response::set_body) for the JS context type.
    pub fn with_js<F: Fn(&mut JsBuilder)>(mut self, js: F) -> Self {
        self.js(js);
        self
    }

    /// Wrapper around [Response.set_body](Response::set_body) for the JSON context type.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # extern crate direkuta;
    /// # #[macro_use] extern crate serde_derive;
    ///
    /// use direkuta::prelude::*;
    ///
    /// #[derive(Serialize)]
    /// struct Example {
    ///     hello: String,
    /// }
    /// # fn main() {
    /// let mut res = Response::new();
    /// res.json(|j| {
    ///     j.body(Example {
    ///         hello: String::from("world"),
    ///     });
    /// });
    /// # }
    /// ```
    #[cfg(feature = "json")]
    pub fn json<T: Serialize + Send + Sync, F: Fn(&mut JsonBuilder<T>)>(&mut self, json: F) {
        let mut builder = JsonBuilder::new::<T>();

        let _ = self.headers_mut().insert(
            header::CONTENT_TYPE,
            HeaderValue::from_static("application/json"),
        );

        json(&mut builder);

        self.set_body(builder.get_body());
    }

    /// Builder function for Json responses
    ///
    /// # Examples
    ///
    /// ```rust
    /// # extern crate direkuta;
    /// # #[macro_use] extern crate serde_derive;
    ///
    /// use direkuta::prelude::*;
    ///
    /// #[derive(Serialize)]
    /// struct Example {
    ///     hello: String,
    /// }
    /// # fn main() {
    /// let res = Response::new()
    ///     .with_json(|j| {
    ///         j.body(Example {
    ///             hello: String::from("world"),
    ///         });
    ///     });
    /// # }
    /// ```
    #[cfg(feature = "json")]
    pub fn with_json<T: Serialize + Send + Sync, F: Fn(&mut JsonBuilder<T>)>(
        mut self,
        json: F,
    ) -> Self {
        self.json(json);
        self
    }

    /// Transform the Response into a Hyper Response.
    fn into_hyper(self) -> hyper::Response<Body> {
        hyper::Response::from_parts(self.parts, self.body)
    }
}

impl Default for Response {
    fn default() -> Response {
        let (parts, body) = hyper::Response::new(Body::empty()).into_parts();
        Response { body, parts }
    }
}

/// A builder function for CSS Responses.
///
/// Do not directly use.
pub struct CssBuilder {
    inner: String,
}

impl CssBuilder {
    fn new() -> CssBuilder {
        CssBuilder::default()
    }

    fn get_body(&self) -> &str {
        self.inner.as_str()
    }

    /// Load from [File](std::fs::File).
    pub fn file(&mut self, mut file: File) {
        match file.read_to_string(&mut self.inner) {
            Ok(_) => {}
            Err(_) => println!("Unable to write file contents"),
        }
    }
}

impl Default for CssBuilder {
    fn default() -> CssBuilder {
        CssBuilder {
            inner: String::new(),
        }
    }
}

/// A builder function for JS Responses.
///
/// Do not directly use.
pub struct JsBuilder {
    inner: String,
}

impl JsBuilder {
    fn new() -> JsBuilder {
        JsBuilder::default()
    }

    fn get_body(&self) -> &str {
        self.inner.as_str()
    }

    /// Load from [File](std::fs::File).
    pub fn file(&mut self, mut file: File) {
        match file.read_to_string(&mut self.inner) {
            Ok(_) => {}
            Err(_) => println!("Unable to write file contents"),
        }
    }
}

impl Default for JsBuilder {
    fn default() -> JsBuilder {
        JsBuilder {
            inner: String::new(),
        }
    }
}

/// A builder for JSON responses.
///
/// Do not directly use.
#[cfg(feature = "json")]
pub struct JsonBuilder<T: Serialize + Send + Sync> {
    /// Json response wrapper to be sent.
    wrapper: Wrapper<T>,
}

#[cfg(feature = "json")]
impl JsonBuilder<()> {
    /// Creates a [JsonBuilder](JsonBuilder) with given type.
    fn new<T: Serialize + Send + Sync>() -> JsonBuilder<T> {
        JsonBuilder::default()
    }
}

#[cfg(feature = "json")]
impl<T: Serialize + Send + Sync> JsonBuilder<T> {
    /// Set the body of the wrapper.
    pub fn body(&mut self, body: T) {
        self.wrapper.set_result(body);
    }

    /// Set the body of the wrapper.
    pub fn with_body(mut self, body: T) -> Self {
        self.body(body);
        self
    }

    /// Added an error message to the wrapper.
    pub fn error(&mut self, message: &str) {
        self.wrapper.add_message(message);
    }

    /// Added an error message to the wrapper.
    pub fn errors(&mut self, messages: Vec<&str>) {
        for message in messages {
            self.wrapper.add_message(message);
        }
    }

    /// Set the status code of the Json response.
    ///
    /// This can be gotten with [StatusCode.as_u16](StatusCode::as_u16).
    pub fn code(&mut self, status: u16) {
        self.wrapper.set_code(status);
    }

    /// Set the status code of the Json response.
    ///
    /// This can be gotten with [StatusCode.as_u16](StatusCode::as_u16).
    pub fn with_code(mut self, status: u16) -> Self {
        self.code(status);
        self
    }

    /// Set the status string of the Json response.
    ///
    /// This can be gotten with [StatusCode.as_str](StatusCode::as_str).
    pub fn status(&mut self, status: &str) {
        self.wrapper.set_status(status);
    }

    /// Set the status string of the Json response.
    ///
    /// This can be gotten with [StatusCode.as_str](StatusCode::as_str).
    pub fn with_status(mut self, status: &str) -> Self {
        self.status(status);
        self
    }

    fn get_body(&self) -> String {
        serde_json::to_string(&self.wrapper).expect("Can not transform strcut into json")
    }
}

#[cfg(feature = "json")]
impl<T: Serialize + Send + Sync> Default for JsonBuilder<T> {
    fn default() -> JsonBuilder<T> {
        Self {
            wrapper: Wrapper::new(),
        }
    }
}

#[cfg(feature = "json")]
#[derive(Serialize)]
struct Wrapper<T: Serialize + Send + Sync> {
    code: u16,
    messages: Vec<String>,
    result: Option<T>,
    status: String,
}

#[cfg(feature = "json")]
impl<T: Serialize + Send + Sync> Wrapper<T> {
    /// Constructs a new `Wrapper<T>`
    fn new() -> Wrapper<T> {
        Wrapper::default()
    }

    fn add_message(&mut self, message: &str) {
        self.messages.push(String::from(message));
    }

    fn set_code(&mut self, code: u16) {
        self.code = code;
    }

    fn set_status(&mut self, status: &str) {
        self.status = String::from(status);
    }

    fn set_result(&mut self, result: T) {
        self.result = Some(result);
    }
}

#[cfg(feature = "json")]
impl<T: Serialize + Send + Sync> Default for Wrapper<T> {
    fn default() -> Wrapper<T> {
        Self {
            code: 200,
            messages: Vec::new(),
            result: None,
            status: String::from("OK"),
        }
    }
}

/// A wrapper around [Hyper Request](hyper::Request).
#[derive(Debug)]
pub struct Request {
    body: Body,
    parts: request::Parts,
}

impl Request {
    /// Constructs a new [Request](Request).
    pub fn new(body: Body, parts: request::Parts) -> Self {
        Self { body, parts }
    }

    /// Return Request HTTP version.
    pub fn version(&self) -> Version {
        self.parts.version
    }

    /// Return Request HTTP heads.
    pub fn headers(&self) -> &HeaderMap<HeaderValue> {
        &self.parts.headers
    }

    /// Return Request HTTP method.
    pub fn method(&self) -> &Method {
        &self.parts.method
    }

    /// Return Request uri.
    pub fn uri(&self) -> &Uri {
        &self.parts.uri
    }

    /// Return Request uri path.
    pub fn path(&self) -> &str {
        self.parts.uri.path()
    }

    /// Return Request body.
    pub fn body(&self) -> &Body {
        &self.body
    }
}

/// Creates a [HeaderMap](HeaderMap) from a list of key-value pairs.
///
/// # Examples
///
/// ```rust
/// #[macro_use]
/// extern crate direkuta;
///
/// use direkuta::prelude::*;
/// use direkuta::prelude::hyper::*;
///
/// # fn main() {
/// Direkuta::new()
///     .route(|r| {
///         r.get("/", |_, _, _| {
///             let mut res = Response::new().with_body("Hello World!");
///             res.set_headers(headermap! {
///                 header::CONTENT_TYPE => "text/plain",
///             });
///             res
///         });
///     });
/// # }
/// ```
#[macro_export]
macro_rules! headermap {
    (@single $($x:tt)*) => (());
    (@count $($rest:expr),*) => (<[()]>::len(&[$(headermap!(@single $rest)),*]));

    ($($key:expr => $value:expr,)+) => { headermap!($($key => $value),+) };
    ($($key:expr => $value:expr),*) => {
        {
            let _cap = headermap!(@count $($key),*);
            let mut _map = ::direkuta::prelude::hyper::HeaderMap::with_capacity(_cap);
            $(
                let _ = _map.insert($key, ::direkuta::prelude::hyper::HeaderValue::from_static($value));
            )*
            _map
        }
    };
}

/// Imports just the required parts of [Direkuta](Direkuta).
pub mod prelude {
    pub use super::{Direkuta, Logger, Middle, Request, Response, State};

    /// Imports the required parts from [Tera](Tera).
    ///
    /// You'll need to import this if you want to use Tera templates.
    #[cfg(feature = "html")]
    pub mod html {
        pub use tera::{Context, Tera};
    }

    /// Imports the required parts from [Hyper](Hyper).
    ///
    /// You'll need this if you want to create a handler that doesn't have a function
    /// or if you want to set response Headers.
    pub mod hyper {
        pub use hyper::header::{self, HeaderMap, HeaderValue};
        pub use hyper::Method;
    }
}