Integrate ruma-client-api
This commit is contained in:
Jonas Platte
parent
6329cd471e
commit
1df77c2c19
@ -1,30 +0,0 @@
|
|||||||
image: archlinux
|
|
||||||
packages:
|
|
||||||
- rustup
|
|
||||||
sources:
|
|
||||||
- https://github.com/ruma/ruma-client-api
|
|
||||||
tasks:
|
|
||||||
- rustup: |
|
|
||||||
# We specify --profile minimal because we'd otherwise download docs
|
|
||||||
rustup toolchain install beta --profile minimal -c rustfmt -c clippy
|
|
||||||
rustup default beta
|
|
||||||
- test: |
|
|
||||||
cd ruma-client-api
|
|
||||||
|
|
||||||
# We don't want the build to stop on individual failure of independent
|
|
||||||
# tools, so capture tool exit codes and set the task exit code manually
|
|
||||||
set +e
|
|
||||||
|
|
||||||
cargo fmt -- --check
|
|
||||||
fmt_exit=$?
|
|
||||||
|
|
||||||
cargo clippy --all-targets --all-features -- -D warnings
|
|
||||||
clippy_exit=$?
|
|
||||||
|
|
||||||
cargo test --no-default-features --verbose
|
|
||||||
test1_exit=$?
|
|
||||||
|
|
||||||
cargo test --all-features --verbose
|
|
||||||
test2_exit=$?
|
|
||||||
|
|
||||||
exit $(( $fmt_exit || $clippy_exit || $test1_exit || $test2_exit ))
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
image: archlinux
|
|
||||||
packages:
|
|
||||||
- rustup
|
|
||||||
sources:
|
|
||||||
- https://github.com/ruma/ruma-client-api
|
|
||||||
tasks:
|
|
||||||
- rustup: |
|
|
||||||
# We specify --profile minimal because we'd otherwise download docs
|
|
||||||
rustup toolchain install 1.40.0 --profile minimal
|
|
||||||
rustup default 1.40.0
|
|
||||||
- test: |
|
|
||||||
cd ruma-client-api
|
|
||||||
|
|
||||||
# We don't want the build to stop on individual failure of independent
|
|
||||||
# tools, so capture tool exit codes and set the task exit code manually
|
|
||||||
set +e
|
|
||||||
|
|
||||||
# Only make sure the code builds with the MSRV. Tests can require later
|
|
||||||
# Rust versions, don't compile or run them.
|
|
||||||
cargo build --no-default-features --verbose
|
|
||||||
build1_exit=$?
|
|
||||||
|
|
||||||
cargo build --all-features --verbose
|
|
||||||
build2_exit=$?
|
|
||||||
|
|
||||||
exit $(( $build1_exit || $build2_exit ))
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
image: archlinux
|
|
||||||
packages:
|
|
||||||
- rustup
|
|
||||||
sources:
|
|
||||||
- https://github.com/ruma/ruma-client-api
|
|
||||||
tasks:
|
|
||||||
- rustup: |
|
|
||||||
rustup toolchain install nightly --profile minimal
|
|
||||||
rustup default nightly
|
|
||||||
|
|
||||||
# Try installing rustfmt & clippy for nightly, but don't fail the build
|
|
||||||
# if they are not available
|
|
||||||
rustup component add rustfmt || true
|
|
||||||
rustup component add clippy || true
|
|
||||||
- test: |
|
|
||||||
cd ruma-client-api
|
|
||||||
|
|
||||||
# We don't want the build to stop on individual failure of independent
|
|
||||||
# tools, so capture tool exit codes and set the task exit code manually
|
|
||||||
set +e
|
|
||||||
|
|
||||||
if ( rustup component list | grep -q rustfmt ); then
|
|
||||||
cargo fmt -- --check
|
|
||||||
fi
|
|
||||||
fmt_exit=$?
|
|
||||||
|
|
||||||
if ( rustup component list | grep -q clippy ); then
|
|
||||||
cargo clippy --all-targets --all-features -- -D warnings
|
|
||||||
fi
|
|
||||||
clippy_exit=$?
|
|
||||||
|
|
||||||
exit $(( $fmt_exit || $clippy_exit ))
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
image: archlinux
|
|
||||||
packages:
|
|
||||||
- rustup
|
|
||||||
sources:
|
|
||||||
- https://github.com/ruma/ruma-client-api
|
|
||||||
tasks:
|
|
||||||
- rustup: |
|
|
||||||
# We specify --profile minimal because we'd otherwise download docs
|
|
||||||
rustup toolchain install stable --profile minimal -c rustfmt -c clippy
|
|
||||||
rustup default stable
|
|
||||||
- test: |
|
|
||||||
cd ruma-client-api
|
|
||||||
|
|
||||||
# We don't want the build to stop on individual failure of independent
|
|
||||||
# tools, so capture tool exit codes and set the task exit code manually
|
|
||||||
set +e
|
|
||||||
|
|
||||||
cargo fmt -- --check
|
|
||||||
fmt_exit=$?
|
|
||||||
|
|
||||||
cargo clippy --all-targets --all-features -- -D warnings
|
|
||||||
clippy_exit=$?
|
|
||||||
|
|
||||||
cargo test --no-default-features --verbose
|
|
||||||
test1_exit=$?
|
|
||||||
|
|
||||||
cargo test --all-features --verbose
|
|
||||||
test2_exit=$?
|
|
||||||
|
|
||||||
exit $(( $fmt_exit || $clippy_exit || $test1_exit || $test2_exit ))
|
|
||||||
# TODO: Add audit task once cargo-audit binary releases are available.
|
|
||||||
# See https://github.com/RustSec/cargo-audit/issues/66
|
|
||||||
@ -1,203 +0,0 @@
|
|||||||
Welcome! Thanks for looking into contributing to our project!
|
|
||||||
|
|
||||||
# Table of Contents
|
|
||||||
|
|
||||||
- [Looking for Help?](#looking-for-help)
|
|
||||||
- [Documentation](#documentation)
|
|
||||||
- [Chat Rooms](#chat-rooms)
|
|
||||||
- [Reporting Issues](#reporting-issues)
|
|
||||||
- [Submitting Code](#submitting-code)
|
|
||||||
- [Coding Style](#coding-style)
|
|
||||||
- [Modifying Endpoints](#modifying-endpoints)
|
|
||||||
- [Submitting PRs](#submitting-prs)
|
|
||||||
- [Where do I start?](#where-do-i-start)
|
|
||||||
- [Testing](#testing)
|
|
||||||
- [Contact](#contact)
|
|
||||||
|
|
||||||
# Looking for Help?
|
|
||||||
|
|
||||||
Here is a list of helpful resources you can consult:
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
- [Matrix spec Documentation](https://matrix.org/docs/spec/client_server/latest)
|
|
||||||
- Documentation to other Ruma modules:
|
|
||||||
- [ruma-events](https://docs.rs/ruma-events/)
|
|
||||||
- [ruma-api](https://docs.rs/ruma-api/)
|
|
||||||
- [ruma-client](https://docs.rs/ruma-client/)
|
|
||||||
|
|
||||||
## Chat Rooms
|
|
||||||
|
|
||||||
- Ruma Matrix room: [#ruma:matrix.org](https://matrix.to/#/#ruma:matrix.org)
|
|
||||||
- Matrix Developer room: [#matrix-dev:matrix.org](https://matrix.to/#/#matrix-dev:matrix.org)
|
|
||||||
|
|
||||||
# Reporting Issues
|
|
||||||
|
|
||||||
If you find any bugs, inconsistencies or other problems, feel free to submit
|
|
||||||
a GitHub [issue](issues).
|
|
||||||
|
|
||||||
If you have a quick question, it may be easier to leave a message on
|
|
||||||
[#ruma:matrix.org](https://matrix.to/#/#ruma:matrix.org).
|
|
||||||
|
|
||||||
Also, if you have trouble getting on board, let us know so we can help future
|
|
||||||
contributors to the project overcome that hurdle too.
|
|
||||||
|
|
||||||
# Submitting Code
|
|
||||||
|
|
||||||
Ready to write some code? Great! Here are some guidelines to follow to
|
|
||||||
help you on your way:
|
|
||||||
|
|
||||||
## Coding Style
|
|
||||||
|
|
||||||
### Common types
|
|
||||||
|
|
||||||
When writing endpoint definitions, use the following mapping from request /
|
|
||||||
response field types listed in the specification to Rust types:
|
|
||||||
|
|
||||||
Specification type | Rust type
|
|
||||||
-------------------|---------------------------------------------------------------------------------------------------------------------
|
|
||||||
`boolean` | `bool`
|
|
||||||
`integer` | `js_int::UInt` (unless denoted as signed, then `js_int::Int`)
|
|
||||||
`string` | If for an identifier (e.g. user ID, room ID), use one of the types from `ruma-identifiers`. Otherwise, use `String`.
|
|
||||||
`object` | `serde_json::Value`
|
|
||||||
`[…]` | `Vec<…>`
|
|
||||||
`{string: …}` | `BTreeMap<String, …>` (or `BTreeMap<SomeId, …>`)
|
|
||||||
|
|
||||||
### Import Formatting
|
|
||||||
|
|
||||||
Organize your imports into three groups separated by blank lines:
|
|
||||||
|
|
||||||
1. `std` imports
|
|
||||||
1. External imports (from other crates)
|
|
||||||
1. Local imports (`self::`, `super::`, `crate::` and things like `LocalType::*`)
|
|
||||||
|
|
||||||
For example,
|
|
||||||
|
|
||||||
```rust
|
|
||||||
use std::collections::BTreeMap;
|
|
||||||
|
|
||||||
use ruma_api::ruma_api;
|
|
||||||
|
|
||||||
use super::MyType;
|
|
||||||
```
|
|
||||||
|
|
||||||
Also, group imports by module. For example, do this:
|
|
||||||
|
|
||||||
```rust
|
|
||||||
use std::{
|
|
||||||
collections::BTreeMap,
|
|
||||||
convert::TryFrom,
|
|
||||||
fmt::{self, Debug, Display, Formatter},
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
as opposed to:
|
|
||||||
|
|
||||||
```rust
|
|
||||||
use std::collections::BTreeMap;
|
|
||||||
use std::convert::TryFrom;
|
|
||||||
use std::fmt::{self, Debug, Display, Formatter};
|
|
||||||
```
|
|
||||||
|
|
||||||
### Serde Imports
|
|
||||||
|
|
||||||
When importing methods and types from `serde_json`, methods should be such as
|
|
||||||
`serde_json::{from,to}_{slice,string,value,vec}` should be imported as
|
|
||||||
`{from,to}_json_{slice,string,value,vec}`.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```rust
|
|
||||||
use serde_json::{
|
|
||||||
from_value as from_json_value,
|
|
||||||
to_str as to_json_str,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
Also, `serde_json::Value` should be imported as `JsonValue`.
|
|
||||||
|
|
||||||
### Code Formatting and Linting
|
|
||||||
|
|
||||||
Use `rustfmt` to format your code and `clippy` to lint your code. Before
|
|
||||||
committing your changes, go ahead and run `cargo fmt` and `cargo clippy
|
|
||||||
--all-targets --all-features` on the repository to make sure that the
|
|
||||||
formatting and linting checks pass in CI. Note that `clippy` warnings are
|
|
||||||
reported as errors in CI builds, so make sure to handle those before
|
|
||||||
comitting as well. (To install the tools, run `rustup component add rustfmt
|
|
||||||
clippy`.)
|
|
||||||
|
|
||||||
### Commit Messages
|
|
||||||
|
|
||||||
Write commit messages using the imperative mood, as if completing the sentence:
|
|
||||||
"If applied, this commit will \_\_\_." For example, use "Fix some bug" instead
|
|
||||||
of "Fixed some bug" or "Add a feature" instead of "Added a feature".
|
|
||||||
|
|
||||||
(Take a look at this
|
|
||||||
[blog post](https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/)
|
|
||||||
for more information on writing good commit messages.)
|
|
||||||
|
|
||||||
## Modifying Endpoints
|
|
||||||
|
|
||||||
### Matrix Spec Version
|
|
||||||
|
|
||||||
Use the latest r0.x.x documentation when adding or modifying code. We target
|
|
||||||
the latest minor version of the Matrix specification. (Note: We might
|
|
||||||
reconsider this when the Client-Server API hits r1.0.0.)
|
|
||||||
|
|
||||||
### Endpoint Documentation Header
|
|
||||||
|
|
||||||
Add a comment to the top of each endpoint file that includes the path
|
|
||||||
and a link to the documentation of the spec. You can use the latest
|
|
||||||
version at the time of the commit. For example:
|
|
||||||
|
|
||||||
```rust
|
|
||||||
//! [GET /.well-known/matrix/client](https://matrix.org/docs/spec/client_server/r0.4.0#get-well-known-matrix-client)
|
|
||||||
```
|
|
||||||
|
|
||||||
### Naming Endpoints
|
|
||||||
|
|
||||||
When adding new endpoints, select the module that fits the purpose of the
|
|
||||||
endpoint. When naming the endpoint itself, you can use the following
|
|
||||||
guidelines:
|
|
||||||
- The name should be a verb describing what the client is requesting, e.g.
|
|
||||||
`get_some_resource`.
|
|
||||||
- Endpoints which are basic CRUD operations should use the prefixes
|
|
||||||
`create`, `get`, `update`, and `delete`.
|
|
||||||
- The prefix `set` is preferred to create if the resource is a singleton.
|
|
||||||
In other words, when there's no distinction between `create` and `update`.
|
|
||||||
- Try to use names that are as descriptive as possible and distinct from
|
|
||||||
other endpoints in all other modules. (For example, instead of
|
|
||||||
`r0::room::get_event`, use `r0::room::get_room_event`).
|
|
||||||
- If you're not sure what to name it, pick any name and we can help you
|
|
||||||
with it.
|
|
||||||
|
|
||||||
### Tracking Changes
|
|
||||||
|
|
||||||
Add your changes to the [change log](CHANGELOG.md). If possible, try to
|
|
||||||
find and denote the version of the spec that included the change you are
|
|
||||||
making.
|
|
||||||
|
|
||||||
## Submitting PRs
|
|
||||||
|
|
||||||
Once you're ready to submit your code, create a pull request, and one of our
|
|
||||||
maintainers will review it. Once your PR has passed review, a maintainer will
|
|
||||||
merge the request and you're done! 🎉
|
|
||||||
|
|
||||||
## Where do I start?
|
|
||||||
|
|
||||||
If this is your first contribution to the project, we recommend taking a look
|
|
||||||
at one of the [open issues][] we've marked for new contributors.
|
|
||||||
|
|
||||||
It may be helpful to peruse some of the documentation for `ruma-events` and
|
|
||||||
`ruma-api` listed above for some context.
|
|
||||||
|
|
||||||
[open issues]: https://github.com/ruma/ruma-client-api/issues?q=is%3Aopen+is%3Aissue+label%3Aeffort%2Feasy
|
|
||||||
|
|
||||||
# Testing
|
|
||||||
|
|
||||||
Before committing, run `cargo check` to make sure that your changes can build, as well as running the formatting and linting tools [mentioned above](#code-formatting-and-linting).
|
|
||||||
|
|
||||||
# Contact
|
|
||||||
|
|
||||||
Thanks again for being a contributor! If you have any questions, join us at
|
|
||||||
[#ruma:matrix.org](https://matrix.to/#/#ruma:matrix.org).
|
|
||||||
@ -7,7 +7,7 @@ authors = [
|
|||||||
categories = ["api-bindings", "web-programming"]
|
categories = ["api-bindings", "web-programming"]
|
||||||
description = "Types for the endpoints in the Matrix client-server API."
|
description = "Types for the endpoints in the Matrix client-server API."
|
||||||
documentation = "https://docs.rs/ruma-client-api"
|
documentation = "https://docs.rs/ruma-client-api"
|
||||||
homepage = "https://github.com/ruma/ruma-client-api"
|
homepage = "https://www.ruma.io/"
|
||||||
keywords = ["matrix", "chat", "messaging", "ruma"]
|
keywords = ["matrix", "chat", "messaging", "ruma"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
name = "ruma-client-api"
|
name = "ruma-client-api"
|
||||||
@ -19,11 +19,11 @@ edition = "2018"
|
|||||||
[dependencies]
|
[dependencies]
|
||||||
http = "0.2.1"
|
http = "0.2.1"
|
||||||
js_int = { version = "0.1.5", features = ["serde"] }
|
js_int = { version = "0.1.5", features = ["serde"] }
|
||||||
ruma-api = "0.16.1"
|
ruma-api = { version = "0.16.1", path = "../ruma-api" }
|
||||||
ruma-common = "0.1.3"
|
ruma-common = { version = "0.1.3", path = "../ruma-common" }
|
||||||
ruma-events = { git = "https://github.com/ruma/ruma-events", rev = "c1ee72d" }
|
ruma-events = { git = "https://github.com/ruma/ruma-events", rev = "c1ee72d" }
|
||||||
ruma-identifiers = "0.16.2"
|
ruma-identifiers = "0.16.2"
|
||||||
ruma-serde = "0.2.2"
|
ruma-serde = { version = "0.2.2", path = "../ruma-serde" }
|
||||||
serde = { version = "1.0.111", features = ["derive"] }
|
serde = { version = "1.0.111", features = ["derive"] }
|
||||||
serde_json = "1.0.53"
|
serde_json = "1.0.53"
|
||||||
strum = { version = "0.18.0", features = ["derive"] }
|
strum = { version = "0.18.0", features = ["derive"] }
|
||||||
|
|||||||
@ -26,5 +26,5 @@ ruma-signatures = { version = "0.5.0", optional = true }
|
|||||||
|
|
||||||
ruma-api = { version = "0.16.1", optional = true }
|
ruma-api = { version = "0.16.1", optional = true }
|
||||||
ruma-appservice-api = { version = "0.1.0", path = "../ruma-appservice-api", optional = true }
|
ruma-appservice-api = { version = "0.1.0", path = "../ruma-appservice-api", optional = true }
|
||||||
ruma-client-api = { version = "0.9.0", optional = true }
|
ruma-client-api = { version = "0.9.0", path = "../ruma-client-api", optional = true }
|
||||||
ruma-federation-api = { version = "0.0.2", optional = true }
|
ruma-federation-api = { version = "0.0.2", optional = true }
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user