aboutsummaryrefslogtreecommitdiff
path: root/lockchain-http/src/lib.rs
blob: 382ee8647212e2915ec6ae93757dd4c03a671b93 (plain)
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
//! A plug and play http interface layer for various lockchain components
//!
//! The way this is done is by shimming a common REST interface (via actix-web) in
//! between common `lockchain-core` types and the `lockchain-client` library which
//! is a base wrapper around `reqwest` which uses this API.
//!
//! You can of course also use whatever other library, in whatever language you want
//! to access this API. Doing so via the *official* client gives you the ability to
//! negotiate version numbers and have more advanced error handling built-in.
//!
//! Ideally this shim-layer version should be the same as the `lockchain-core` it binds
//! against, however especially during development this won't always be the case.
//!
//! **Note**: API endpoint documentation can be found
//! [here](https://github.com/spacekookie/lockchain/tree/master/lockchain-http#api-reference)

#![feature(core_intrinsics)]

#[macro_use]
extern crate serde_derive;
extern crate env_logger;
extern crate serde;

extern crate actix_web;
extern crate lockchain_core as lockchain;

mod handlers;
mod state;
mod model;
pub use model::CarrierMessage;

use actix_web::{http, server, App};
use lockchain::traits::{Body, Vault};
use std::sync::{Arc, Mutex};

/// Create a new lockchain-http server for a vault state
///
/// Lifetime wise, vault needs to long as long as the server, which is returned to
/// call `run()` on. Make sure this is done in a thread, to not block your
/// mainapplication context
///
/// Additionally, provide a address bind and port string to bind to.
///
/// ## Example
///
/// ```norun
/// use lockchain_core::{traits::*, EncryptedBody};
/// use lockchain_http::create_server;
/// use lockchain_files::DataVault;
///
/// let server = create_server(
///     "localhost",
///     "8080",
///     DataVault::<EncryptedBody>::new("name", "some-location"),
/// ).run();
/// ```
pub fn create_server<B: Body + 'static>(
    bind: &str,
    port: &str,
    state: impl Vault<B> + 'static,
) -> server::HttpServer<App<Arc<Mutex<impl Vault<B> + 'static>>>> {
    let state = Arc::new(Mutex::new(state));

    server::new(move || {
        vec![
            App::with_state(Arc::clone(&state))
                .resource("/vaults", |r| {
                    r.method(http::Method::GET).with(handlers::get_vaults)
                })
                .resource("/vaults", |r| {
                    r.method(http::Method::PUT).with(handlers::create_vault)
                })
                .resource("/vaults/{vaultid}", |r| r.f(handlers::update_vault))
                .resource("/vaults/{vaultid}", |r| r.f(handlers::delete_vault))
                .resource("/vaults/{vaultid}/records/{recordid}", |r| {
                    r.f(handlers::get_record)
                })
                .resource("/vaults/{vaultid}/records", |r| {
                    r.f(handlers::create_record)
                })
                .resource("/vaults/{vaultid}/records/{recordid}", |r| {
                    r.f(handlers::update_record)
                })
                .resource("/vaults/{vaultid}/records/{recordid}", |r| {
                    r.f(handlers::delete_record)
                })
                .resource("/authenticate", |r| r.f(handlers::authenticate))
                .resource("/deauthenticate", |r| r.f(handlers::deauthenticate))
                .resource("/api", |r| r.f(handlers::api_data)),
        ]
    }).bind(format!("{}:{}", bind, port))
        .expect("Oh no!")
}