Define module layout and fill in types for a few APIs.

Cargo.toml

@@ -1,5 +1,4 @@
 [package]
-
 authors = ["Jimmy Cuadra <jimmy@jimmycuadra.com>"]
 description = "Serializable request and response types for the Matrix client API."
 documentation = "https://docs.rs/ruma-client-api"
@@ -12,3 +11,6 @@ repository = "https://github.com/ruma/ruma-client-api"
 version = "0.1.0"
 
 [dependencies]
+ruma-identifiers = "0.4.1"
+serde = "0.8.10"
+serde_derive = "0.8.10"

src/lib.rs

@@ -0,0 +1,39 @@
+//! Crate ruma_client_api contains serializable types for the requests and responses for each
+//! endpoint in the [Matrix](https://matrix.org/) client API specification. These types can be
+//! shared by client and server code.
+
+#![feature(rustc_macro)]
+
+extern crate ruma_identifiers;
+extern crate serde;
+#[macro_use] extern crate serde_derive;
+
+/// Endpoints for the r0.x.x versions of the client API specification.
+pub mod r0 {
+    pub mod account;
+    pub mod alias;
+    pub mod config;
+    pub mod contact;
+    pub mod context;
+    pub mod directory;
+    pub mod filter;
+    pub mod media;
+    pub mod membership;
+    pub mod presence;
+    pub mod profile;
+    pub mod push;
+    pub mod receipt;
+    pub mod redact;
+    pub mod room;
+    pub mod search;
+    pub mod send;
+    pub mod server;
+    pub mod session;
+    pub mod sync;
+    pub mod tag;
+    pub mod typing;
+    pub mod voip;
+}
+
+/// GET /_matrix/client/versions
+pub mod version;

src/r0/account.rs

@@ -0,0 +1,57 @@
+//! Endpoints for account registration and management.
+
+/// POST /_matrix/client/r0/register
+pub mod register {
+    pub const HTTP_METHOD: &'static str = "POST";
+    pub const PATH: &'static str = "/_matrix/client/r0/register";
+
+    /// The kind of account being registered.
+    #[derive(Copy, Clone, Debug, Deserialize, Serialize)]
+    pub enum RegistrationKind {
+        #[serde(rename="guest")]
+        Guest,
+        #[serde(rename="user")]
+        User,
+    }
+
+    /// The request type.
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    pub struct Request {
+        pub bind_email: Option<bool>,
+        pub kind: Option<RegistrationKind>,
+        pub password: String,
+        pub username: Option<String>,
+    }
+
+    /// The response type.
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    pub struct Response {
+        pub access_token: String,
+        pub home_server: String,
+        pub user_id: String,
+    }
+}
+
+/// POST /_matrix/client/r0/account/password/email/requestToken
+pub mod request_password_change_token {
+}
+
+/// POST /_matrix/client/r0/account/deactivate
+pub mod deactivate {
+}
+
+/// POST /_matrix/client/r0/account/password
+pub mod change_password {
+    pub const HTTP_METHOD: &'static str = "POST";
+    pub const PATH: &'static str = "/_matrix/client/r0/account/password";
+
+    /// The request type.
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    pub struct Request {
+        pub new_password: String,
+    }
+}
+
+/// POST /_matrix/client/r0/register/email/requestToken
+pub mod request_register_token {
+}

src/r0/alias.rs

@@ -0,0 +1 @@
+//! Endpoints for room aliases.

src/r0/config.rs

@@ -0,0 +1 @@
+//! Endpoints for client configuration.

src/r0/contact.rs

@@ -0,0 +1 @@
+//! Endpoints for account contact information.

src/r0/context.rs

@@ -0,0 +1 @@
+//! Endpoints for event context.

src/r0/directory.rs

@@ -0,0 +1 @@
+//! Endpoints for the public room directory.

src/r0/filter.rs

@@ -0,0 +1 @@
+//! Endpoints for event filters.

src/r0/media.rs

@@ -0,0 +1 @@
+//! Endpoints for the media repository.

src/r0/membership.rs

@@ -0,0 +1 @@
+//! Endpoints for room membership.

src/r0/presence.rs

@@ -0,0 +1 @@
+//! Endpoints for user presence.

src/r0/profile.rs

@@ -0,0 +1 @@
+//! Endpoints for user profiles.

src/r0/push.rs

@@ -0,0 +1 @@
+//! Endpoints for push notifications.

src/r0/receipt.rs

@@ -0,0 +1 @@
+//! Endpoints for event receipts.

src/r0/redact.rs

@@ -0,0 +1 @@
+//! Endpoints for event redaction.

src/r0/room.rs

@@ -0,0 +1,48 @@
+//! Endpoints for room creation.
+
+/// POST /_matrix/client/r0/createRoom
+pub mod create_room {
+    use ruma_identifiers::RoomId;
+
+    pub const HTTP_METHOD: &'static str = "POST";
+    pub const PATH: &'static str = "/_matrix/client/r0/createRoom";
+
+    /// Extra options to be added to the `m.room.create` event.
+    #[derive(Clone, Debug, Deserialize)]
+    pub struct CreationContent {
+        #[serde(rename="m.federate")]
+        pub federate: Option<bool>,
+    }
+
+    /// The request type.
+    #[derive(Clone, Debug, Deserialize)]
+    pub struct Request {
+        pub creation_content: Option<CreationContent>,
+        pub invite: Option<Vec<String>>,
+        pub name: Option<String>,
+        pub preset: Option<RoomPreset>,
+        pub room_alias_name: Option<String>,
+        pub topic: Option<String>,
+        pub visibility: Option<String>,
+    }
+
+    /// The response type.
+    #[derive(Debug, Serialize)]
+    pub struct Response {
+        room_id: RoomId,
+    }
+
+    /// A convenience parameter for setting a few default state events.
+    #[derive(Clone, Copy, Debug, Deserialize)]
+    pub enum RoomPreset {
+        /// `join_rules` is set to `invite` and `history_visibility` is set to `shared`.
+        #[serde(rename="private_chat")]
+        PrivateChat,
+        /// `join_rules` is set to `public` and `history_visibility` is set to `shared`.
+        #[serde(rename="public_chat")]
+        PublicChat,
+        /// Same as `PrivateChat`, but all initial invitees get the same power level as the creator.
+        #[serde(rename="trusted_private_chat")]
+        TrustedPrivateChat,
+    }
+}

src/r0/search.rs

@@ -0,0 +1 @@
+//! Endpoints for event searches.

src/r0/send.rs

@@ -0,0 +1 @@
+//! Endpoints for sending events.

src/r0/server.rs

@@ -0,0 +1 @@
+//! Endpoints for server administration.

src/r0/session.rs

@@ -0,0 +1,21 @@
+//! Endpoints for user session management.
+
+/// POST /_matrix/client/r0/login
+pub mod login {
+    pub const HTTP_METHOD: &'static str = "POST";
+    pub const PATH: &'static str = "/_matrix/client/r0/login";
+
+    /// The response type.
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    struct LoginResponse {
+        pub access_token: String,
+        pub home_server: String,
+        pub user_id: String,
+    }
+}
+
+/// POST /_matrix/client/r0/logout
+pub mod logout {
+    pub const HTTP_METHOD: &'static str = "POST";
+    pub const PATH: &'static str = "/_matrix/client/r0/logout";
+}

src/r0/sync.rs

@@ -0,0 +1 @@
+//! Endpoints for getting and synchronizing events.

src/r0/tag.rs

@@ -0,0 +1 @@
+//! Endpoints for tagging rooms.

src/r0/typing.rs

@@ -0,0 +1 @@
+//! Endpoints for typing notifications.

src/r0/voip.rs

@@ -0,0 +1 @@
+//! Endpoints for Voice over IP.

src/version.rs

@@ -0,0 +1,9 @@
+pub const HTTP_METHOD: &'static str = "GET";
+pub const PATH: &'static str = "/versions";
+
+/// The response type.
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct Response {
+    /// A list of Matrix client API protocol versions supported by the homeserver.
+    pub versions: Vec<String>,
+}