ddapi 0.14.3__tar.gz → 2.0.1__tar.gz

ddapi-2.0.1/.ai/rules.md

@@ -0,0 +1,35 @@
+# Project rules for AI coding tools
+
+## Project
+
+ddapi-rs — Rust client library for the DDNet and DDStats APIs (Teeworlds).
+`src/scheme/` — serde structs mirroring the live APIs; `src/api/` — request
+layer; `tests/` — schema-consistency tests.
+
+## Commands
+
+- Build/test: `cargo test --all-features`
+- Strict clippy (mandatory, CI-enforced):
+  `cargo clippy --all-targets --all-features -- -D clippy::pedantic -D clippy::unwrap_used -D clippy::expect_used -D warnings`
+- Format: `cargo fmt`
+- Typos: `typos .` (fixtures excluded via `typos.toml`)
+
+## Conventions
+
+- Zero style: no `unwrap`/`expect`/panic in library code; propagate errors,
+  use `assert!` in tests.
+- `#[must_use]` on value-returning public methods.
+- When the live schema check fails, update structs to match the API — do not
+  weaken the test.
+
+## Live schema tests
+
+Ignored by default; run with `cargo test --all-features -- --ignored`.
+Weekly CI job (`schema_check.yml`) catches upstream drift: new fields the
+structs do not model yet. Player-dependent tests use a candidate list and
+pass on the first clean payload.
+
+## Source of truth for DDStats
+
+`ddstats-web` repo (https://git.ddstats.tw/ddstats/ddstats-web), `src/models/`
+— structs must mirror it (field names, types, Option-ness).

ddapi-2.0.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+Thanks for the pull request 🎉!
+
+# What does this PR try to resolve?
+Explain the motivation behind this change. A clear overview along with an in-depth explanation are helpful.

ddapi-2.0.1/.github/dependabot.yml

@@ -0,0 +1,40 @@
+# Dependabot
+version: 2
+
+updates:
+  - package-ecosystem: cargo
+    directory: /
+    schedule:
+      interval: weekly
+      day: friday
+    allow:
+      - dependency-type: all
+    groups:
+      patch-updates:
+        patterns:
+          - "*"
+        update-types:
+          - "patch"
+      minor-updates:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+      major-updates:
+        patterns:
+          - "*"
+        update-types:
+          - "major"
+    ignore:
+      - dependency-name: "rand"
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    groups:
+      github-actions-updates:
+        patterns:
+          - "*"
+    ignore:
+      - dependency-name: "rand"

ddapi-2.0.1/.github/workflows/crate_type.yaml

@@ -0,0 +1,35 @@
+name: Crate Type
+
+on:
+  workflow_call:
+    outputs:
+      is_lib:
+        value: ${{ jobs.check-crate-type.outputs.is_lib }}
+      is_bin:
+        value: ${{ jobs.check-crate-type.outputs.is_bin }}
+
+jobs:
+  check-crate-type:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      - name: Install jql
+        uses: taiki-e/install-action@v2
+        with:
+          tool: jql
+
+      - name: Searching for lib
+        id: searching
+        run: |
+          result=$(cargo metadata --format-version=1 --no-deps | jql '"packages"|>"targets"<|[0]|>"kind"' | jql '..' -i);
+          echo "targets=$result" >> "$GITHUB_OUTPUT";
+          echo kind of targets $result;
+
+    outputs:
+      is_lib: ${{ contains(steps.searching.outputs.targets, 'lib') }}
+      is_bin: ${{ contains(steps.searching.outputs.targets, 'bin') }}

ddapi-2.0.1/.github/workflows/rust.yml

@@ -0,0 +1,98 @@
+name: Rust
+
+on: [push, pull_request]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  cargo-build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      - name: cargo build
+        run: cargo b --workspace --all-targets --all-features
+
+  cargo-fmt:
+    name: Cargo fmt
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          components: rustfmt
+
+      - name: Rustfmt Check
+        run: cargo fmt --all --check
+
+  cargo-clippy:
+    name: Cargo clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - run: rustup component add clippy
+      - name: Clippy
+        run: RUSTFLAGS="-C target-cpu=haswell" cargo clippy --all-targets --all-features -- -D clippy::pedantic -D clippy::unwrap_used -D clippy::expect_used -D warnings
+
+  cargo-doc:
+    name: Cargo doc
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      - name: Cargo doc test
+        run: cargo doc --workspace --all-features
+
+  typos:
+    name: Typos
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install typos
+        uses: taiki-e/install-action@v2
+        with:
+          tool: typos
+
+      - name: Check typos
+        run: typos .
+
+  check-crate-type:
+    uses: ./.github/workflows/crate_type.yaml
+
+  cargo-test-doc:
+    needs: check-crate-type
+    if: ${{ needs.check-crate-type.outputs.is_lib == 'true' }}
+    name: Cargo test doc
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      - name: Cargo test doc
+        run: cargo test --doc --workspace --all-features

ddapi-2.0.1/.github/workflows/schema_check.yml

@@ -0,0 +1,26 @@
+name: Schema Check
+
+on:
+  schedule:
+    - cron: "0 0 * * 1"
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  schema-drift-check:
+    name: Live schema drift check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch Repository
+        uses: actions/checkout@v6
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+
+      - name: Check fixture schemas
+        run: cargo test --all-features --test schema_ddnet --test schema_ddstats
+
+      - name: Check live API schemas
+        run: cargo test --all-features --test schema_ddnet --test schema_ddstats -- --ignored

ddapi-2.0.1/.gitignore

@@ -0,0 +1,31 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Python / maturin
+.env/
+venv/
+dist/
+build/
+*.egg-info/
+__pycache__/
+.pytest_cache/
+python/ddapi/*.so