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

// Copyright 2017 Telefónica Germany Next GmbH. See the COPYRIGHT file at
// the top-level directory of this distribution
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

//! # Geeny Hub SDK
//!
//! ## Introduction
//!
//! The Geeny Hub SDK provides an abstraction over APIs and communication
//! interfaces necessary to connect physical or virtual devices to the Geeny
//! Cloud. The Hub SDK can be used in one of two ways: as a Rust library crate, or as
//! a standalone binary that can be used by applications written in other
//! languages by providing an interprocess communication (IPC) interface.
//!
//! For developers with an existing Hub Device, such as a Smart Home Gateway,
//! the standalone Geeny Hub Service may be used to provide a single local interface
//! to communicate with Geeny Cloud Services to enable device provisioning, sending
//! messages to the cloud, and receiving messages from the cloud. The Geeny Hub Service
//! may be installed as a package, or included as part of a firmware generation process
//! such as Buildroot or Yocto. When used as a service, no knowledge of Rust development
//! is necessary.
//!
//! For developers building a new Hub Device, the Geeny Hub SDK may be used as a library
//! (or crate), and can be tightly integrated into a Rust-based application. This allows
//! developers to interact with the Geeny Cloud through an idiomatic Rust library interface,
//! rather than having to implement REST, MQTT, and other communication protocols.
//!
//! ## Components
//!
//! ### Usage - As a Library Crate
//!
//! ```rust,no_run
//! extern crate hub_sdk;
//!
//! use hub_sdk::{HubSDK, HubSDKConfig};
//!
//! fn main() {
//!     let sdk_cfg = HubSDKConfig::default();
//!
//!     // Begin running the SDK. The hub_sdk handle may be used to interact with
//!     // the SDK. This handle may be cloned and given to multiple consumers.
//!     let hub_sdk = HubSDK::new(sdk_cfg);
//!
//!     let msgs = hub_sdk.receive_messages("ABC123")
//!         .expect("No known device with that serial number.");
//!
//!     println!("Messages: {:?}", msgs);
//! }
//! ```
//!
//! #### Documentation
//!
//! Full library documentation may be found on [Geeny's Documentation Site]
//! (https://docs.geeny.io/sdk/), or it can be generated and displayed locally
//! using `cargo doc --open`.
//!
//! ### Usage - As a standalone service
//!
//! ```bash
//! # (Optional) Install the recommended version of the Rust toolchain
//! rustup install nightly-2018-04-08
//!
//! # Move to Service Project directory
//! cd services/rest_api/rocket_api
//!
//! # Create a valid config file for this service
//! cp ./geeny_hub_service.mvdb.json.example ./geeny_hub_service.mvdb.json
//!
//! # Run the service, serving a REST IPC on localhost:9000
//! cargo +nightly-2018-04-08 run --release
//! ```
//!
//! #### Documentation
//!
//! For more information regarding the REST IPC interface, please see
//! [this Swagger API specification]
//! (https://github.com/geeny/linux-hub-sdk/blob/release/docs/rest-ipc/swagger.json)
//! for more information.
//!
//! ## Requirements
//!
//! The Geeny Hub SDK Library may be used on stable or nightly builds of Rust.
//! We currently test the library with stable version `1.25`, and with nightly
//! version `nightly-2018-04-08`.
//!
//! The Geeny Hub SDK Binary Service requires a nightly build of Rust.
//! We currently test the service with nightly version `nightly-2018-04-08`.
//!
//! ## Installation & Configuration
//!
//! ### As a library
//!
//! In your `Cargo.toml`, add the following lines:
//!
//! ```toml
//! [dependencies]
//! hub-sdk = "0.5"
//! ```
//!
//! In your main project file (likely `lib.rs` or `main.rs`), add the following line:
//!
//! ```rust,ignore
//! extern crate hub_sdk;
//! ```
//!
//! ### As a service
//!
//! See the `Usage - As a standalone service` section above.
//!
//! ## Testing
//!
//! Unit tests may be run with `cargo test`.
//!
//! ## License
//!
//! Copyright (C) 2017-2018 Telefónica Germany Next GmbH, Charlottenstraße 4, 10969 Berlin.
//!
//! This project is licensed under the terms of the
//! [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/).
//!
//! Contact: devsupport@geeny.io
//!
//! ### Third Party Components
//!
//! This crate makes use of the following third party components with the following licenses:
//!
//! | License | Count | Dependencies |
//! | :------ | :---- | :----------- |
//! | Apache-2.0 | 2 | openssl, thread-id |
//! | Apache-2.0/MIT | 76 | antidote, backtrace, backtrace-sys, base64, bitflags, bitflags, cfg-if, coco, cookie, core-foundation, core-foundation-sys, custom_derive, dtoa, either, env_logger, error-chain, foreign-types, futures, gcc, httparse, hyper-native-tls, idna, isatty, itoa, lazy_static, libc, log, mqtt-protocol, native-tls, num-traits, num_cpus, ordermap, pear, pear_codegen, percent-encoding, pkg-config, quick-error, quote, rand, rayon, rayon-core, regex, regex, regex-syntax, regex-syntax, reqwest, rocket, rocket_codegen, rocket_contrib, rustc-demangle, scopeguard, security-framework, security-framework-sys, serde, serde_derive, serde_derive_internals, serde_json, serde_urlencoded, state, syn, synom, tempdir, thread_local, thread_local, threadpool, time, toml, traitobject, unicode-bidi, unicode-normalization, unicode-xid, unreachable, url, uuid, vcpkg, yansi |
//! | BSD-3-Clause | 3 | adler32, magenta, magenta-sys |
//! | MIT | 21 | advapi32-sys, conv, crypt32-sys, dbghelp-sys, hyper, kernel32-sys, language-tags, libflate, matches, mime, mvdb, openssl-sys, redox_syscall, schannel, secur32-sys, typeable, unicase, version_check, void, winapi, winapi-build |
//! | MIT OR Apache-2.0 | 1 | safemem |
//! | MIT/Unlicense | 9 | aho-corasick, aho-corasick, byteorder, byteorder, memchr, memchr, rumqtt, utf8-ranges, utf8-ranges |
//! | MPL-2.0 | 2 | geeny-api, smallvec |
//! | Other`*` | 2 | ring, untrusted |
//!
//! `*` Please see [ring's license](https://github.com/briansmith/ring/blob/master/LICENSE)
//! for more information regarding `ring` and `untrusted`'s licensing.

#[macro_use]
extern crate log;

#[macro_use]
extern crate error_chain;

extern crate rumqtt;
#[macro_use]
extern crate serde_derive;
extern crate uuid;

// TODO DI-245
//   * Move to sqlite3 or diesel
//   * OR if still with mvdb, how do we handle poisoned mutexes (Antidote)
extern crate mvdb;

// Re-export
pub extern crate geeny_api;

mod interface;

pub use self::interface::{HubSDK, HubSDKConfig};
pub mod errors;

mod auth_manager;
mod things_db;

// This really needs a better home
pub use self::things_db::PartialThingMessage;