gitter-rs

Gitter API in Rust

WIP

https://developer.gitter.im

Building

sh cargo build

Install

Current version

toml [dependencies] gitter = "0.4.0"

Development version

toml [dependencies] gitter = { git = "https://github.com/shmutalov/gitter-rs" }

• Initialize
• Users
• Rooms
• Messages
• Documentation
• Roadmap
• License

Initialize

```rust extern crate gitter; use gitter::Gitter;

...

let api = Gitter::new("YOURACCESSTOKEN").unwrap(); ```

Following code snippets did not updated yet

Users

• Get current user

rust let user = api.get_user().unwrap();

Rooms

```rust // Get all rooms let rooms = api.get_rooms().unwrap();

// Get room by id let room = api.get_room("roomID").unwrap();

// Get rooms of some user let rooms = api.get_rooms("userID").unwrap();

// Join room let room = api.join_room("roomID", "userID").unwrap();

// Leave room let room = api.leave_room("roomID", "userID").unwrap();

// Get room id let roomid = api.getroom_id("room/uri").unwrap();

// Search gitter rooms let rooms = api.search_rooms("search/string").unwrap(); ```

Messages

```rust // Get messages of room let messages = api.get_messages("roomID", None).unwrap();

// Get one message let message = api.get_message("roomID", "messageID").unwrap();

// Send message api.send_message("roomID", "free chat text").unwrap(); ```

Roadmap

This project is a work in progress.

• [x] Implement base Rest API's and add some tests
• [x] Test send_message method
• [x] Implement all Rest API methods
• [ ] Add support for Streaming API
• [ ] Add support for Faye [Optional]
• [ ] Add support for automated access token retreive via Github authentification
• [ ] Cover with tests
• [ ] Add examples

License

gitter-rs is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.