[project] add 'gateway'

Information about the gateway can be read about here:

<https://dawn.valley.cafe/chapter_1_crates/section_3_gateway.html>

Signed-off-by: Zeyla Hellyer <zeyla@hellyer.dev>

Cargo.toml

@@ -5,6 +5,8 @@ members = [
     "cache/trait",
     "command-parser",
     "dawn",
+    "gateway",
+    "gateway/examples/shard",
     "http",
     "http/examples/get-message",
     "http/examples/proxy",

dawn/Cargo.toml

@@ -15,13 +15,19 @@ version = "0.1.0"
 [dependencies]
 dawn-cache = { optional = true, path = "../cache/base" }
 dawn-command-parser = { optional = true, path = "../command-parser" }
+dawn-gateway = { optional = true, path = "../gateway" }
 dawn-http = { optional = true, path = "../http" }
 dawn-model = { optional = true, path = "../model" }
 
+[dev-dependencies]
+futures-preview = "0.3.0-alpha.19"
+tokio = "0.2.0-alpha.6"
+
 [features]
-default = ["cache", "command-parser", "http", "model"]
+default = ["cache", "command-parser", "gateway", "http", "model"]
 
 cache = ["dawn-cache"]
 command-parser = ["dawn-command-parser"]
+gateway = ["dawn-gateway"]
 http = ["dawn-http"]
 model = ["dawn-model"]

dawn/src/lib.rs

@@ -91,39 +91,42 @@
 //!
 //! ## Examples
 //!
-//! ```rust,ignore
-//! use futures::StreamExt;
+//! ```no_run
 //! use dawn::{
-//!     gateway::{Config, Event, Shard},
+//!     gateway::shard::{Config, Event, Shard},
 //!     http::Client as HttpClient,
 //! };
+//! use futures::StreamExt;
 //! use std::{
 //!     env,
 //!     error::Error,
 //! };
 //!
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
 //! let token = env::var("DISCORD_TOKEN")?;
 //!
 //! let http = HttpClient::new(&token);
 //!
-//! let config = Config::builder(&token).build();
-//! let mut shard = Shard::new(config);
-//! shard.connect().await?;
-//! let mut events = shard.events();
+//! let shard = Shard::new(token).await?;
+//! let mut events = shard.events().await;
 //!
 //! while let Some(event) = events.next().await {
-//!     runtime::spawn(handle_event(event));
+//!     let http = http.clone();
+//!
+//!     tokio::spawn(async {
+//!         let _ = handle_event(event, http);
+//!     });
 //! }
+//! # Ok(()) }
 //!
-//! async fn handle_event(event: Event) -> Result<(), Box<dyn Error>> {
+//! async fn handle_event(event: Event, http: HttpClient) -> Result<(), Box<dyn Error>> {
 //!     match event {
-//!         Event::Connected(connected) => {
-//!             println!("Connected on shard {}", connected.shard_id);
+//!         Event::MessageCreate(msg) if msg.content == "!ping" => {
+//!             http.create_message(msg.channel_id).content("Pong!").await?;
 //!         },
-//!         Event::Message(msg) => {
-//!             if msg.content == "!ping" {
-//!                 http.send_message(msg.channel_id).content("Pong!").await?;
-//!             }
+//!         Event::ShardConnected(connected) => {
+//!             println!("Connected on shard {}", connected.shard_id);
 //!         },
 //!         _ => {},
 //!     }
@@ -135,10 +138,10 @@
 //! Maintaining a cache of guilds, users, channels, and more sent by the
 //! gateway:
 //!
-//! ```rust,ignore
+//! ```ignore
 //! use futures::StreamExt;
 //! use dawn::{
-//!     cache::InMemoryCache,
+//!     cache::{InMemoryCache, UpdateCache},
 //!     gateway::{Config, Event, Shard},
 //! };
 //! use std::{
@@ -148,10 +151,8 @@
 //!
 //! let token = env::var("DISCORD_TOKEN")?;
 //!
-//! let config = Config::builder(&token).build();
-//! let mut shard = Shard::new(config);
-//! shard.connect().await?;
-//! let mut events = shard.events();
+//! let shard = Shard::new(token).await?;
+//! let mut events = shard.events().await;
 //!
 //! let cache = InMemoryCache::new();
 //!
@@ -199,6 +200,9 @@ pub extern crate dawn_cache as cache;
 #[cfg(feature = "command-parser")]
 pub extern crate dawn_command_parser as command_parser;
 
+#[cfg(feature = "gateway")]
+pub extern crate dawn_gateway as gateway;
+
 #[cfg(feature = "http")]
 pub extern crate dawn_http as http;
 

gateway/Cargo.toml

@@ -0,0 +1,39 @@
+[package]
+authors = ["Zeyla Hellyer <zeyla@hellyer.dev>"]
+documentation = "https://docs.rs/dawn-gateway"
+edition = "2018"
+homepage = "https://dawn.valley.cafe"
+include = ["src/*.rs", "Cargo.toml"]
+keywords = ["discord", "discord-api", "dawn"]
+license = "ISC"
+name = "dawn-gateway"
+publish = false
+readme = "README.md"
+repository = "https://github.com/dawn-rs/dawn.git"
+version = "0.1.0"
+
+[dependencies]
+async-trait = "0.1"
+bitflags = "1"
+dawn-cache-trait = { optional = true, path = "../cache/trait" }
+dawn-http = { path = "../http" }
+dawn-model = { path = "../model" }
+futures-channel-preview = "0.3.0-alpha.19"
+futures-util-preview = "0.3.0-alpha.19"
+log = "0.4"
+serde = { features = ["derive"], version = "1" }
+serde_json = "1"
+snafu = "0.5"
+tokio-executor = "0.2.0-alpha.6"
+tokio-net = "0.2.0-alpha.6"
+tokio-timer = "0.3.0-alpha.6"
+tokio-tungstenite = { git = "https://github.com/dbcfd/tokio-tungstenite", branch = "tokio2" }
+url = "2"
+
+[dev-dependencies]
+futures-preview = "0.3.0-alpha.19"
+tokio = "0.2.0-alpha.6"
+
+[features]
+default = ["cache"]
+cache = ["dawn-cache-trait"]

gateway/LICENSE.md

@@ -0,0 +1 @@
+../LICENSE.md

gateway/examples/shard/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+authors = ["Zeyla Hellyer <zeyla@hellyer.dev>"]
+edition = "2018"
+name = "dawn-gateway-example-shard"
+version = "0.1.0"
+
+[dependencies]
+dawn-gateway = { path = "../.." }
+futures-preview = "0.3.0-alpha.19"
+pretty_env_logger = "0.3"
+tokio = "0.2.0-alpha.6"

gateway/examples/shard/src/main.rs

@@ -0,0 +1,19 @@
+use dawn_gateway::Shard;
+use futures::StreamExt;
+use std::{env, error::Error};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn Error + Send + Sync>> {
+    pretty_env_logger::init_timed();
+
+    let shard = Shard::new(env::var("DISCORD_TOKEN")?).await?;
+    println!("Created shard");
+
+    let mut events = shard.events().await;
+
+    while let Some(event) = events.next().await {
+        println!("Event: {:?}", event);
+    }
+
+    Ok(())
+}