Merge pull request #116 from 06chaynes/feat/ureq

feat: ureq

Author: 06chaynes

.github/workflows/coverage.yml

@@ -27,6 +27,8 @@ jobs:
           cargo llvm-cov --no-report --no-default-features --package http-cache --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol
           cargo llvm-cov --no-report --no-default-features --package http-cache --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio
           cargo llvm-cov --no-report --package http-cache-surf --all-features
+          cargo llvm-cov --no-report --package http-cache-ureq --no-default-features --features manager-cacache
+          cargo llvm-cov --no-report --package http-cache-ureq --all-features
           cargo llvm-cov --no-report --package http-cache-reqwest --all-features
           cargo llvm-cov --no-report --package http-cache-tower --all-features
           cargo llvm-cov --no-report --package http-cache-quickcache --all-features

.github/workflows/http-cache-ureq.yml

@@ -0,0 +1,73 @@
+name: http-cache-ureq
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+concurrency:
+  group: ${{ github.ref }}-http-cache-ureq
+  cancel-in-progress: true
+
+defaults:
+ run:
+  working-directory: ./http-cache-ureq
+
+jobs:
+  fmt:
+    name: Check formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: "rustfmt"
+      - run: cargo fmt -- --check
+
+  test:
+    name: Test stable on ${{ matrix.os }}
+    needs: [fmt]
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: |
+          cargo test --all-targets --no-default-features --features manager-cacache
+          cargo test --all-targets --all-features
+
+  clippy:
+    name: Check clippy
+    needs: [fmt, test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: "clippy"
+      - run: |
+          cargo clippy --lib --tests --all-targets --no-default-features --features manager-cacache -- -D warnings
+          cargo clippy --lib --tests --all-targets --all-features -- -D warnings
+
+  docs:
+    name: Build docs
+    needs: [fmt, test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+        env:
+          RUSTFLAGS: --cfg docsrs
+          RUSTDOCFLAGS: --cfg docsrs -Dwarnings
+      - run: |
+          cargo doc --no-deps --document-private-items
+          cargo test --doc --all-features

.github/workflows/http-cache.yml

@@ -44,6 +44,8 @@ jobs:
       - run: |
           cargo test --all-targets --no-default-features --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol
           cargo test --all-targets --no-default-features --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio
+          cargo test --all-targets --no-default-features --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol,rate-limiting
+          cargo test --all-targets --no-default-features --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio,rate-limiting
 
   clippy:
     name: Check clippy
@@ -57,6 +59,8 @@ jobs:
       - run: |
           cargo clippy --lib --tests --all-targets --no-default-features --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol -- -D warnings
           cargo clippy --lib --tests --all-targets --no-default-features --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio -- -D warnings
+          cargo clippy --lib --tests --all-targets --no-default-features --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol,rate-limiting -- -D warnings
+          cargo clippy --lib --tests --all-targets --no-default-features --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio,rate-limiting -- -D warnings
 
   docs:
     name: Build docs
@@ -72,3 +76,5 @@ jobs:
           cargo doc --no-deps --document-private-items
           cargo test --doc --no-default-features --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol
           cargo test --doc --no-default-features --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio
+          cargo test --doc --no-default-features --features manager-cacache,cacache-smol,with-http-types,manager-moka,streaming-smol,rate-limiting
+          cargo test --doc --no-default-features --features manager-cacache,cacache-tokio,with-http-types,manager-moka,streaming-tokio,rate-limiting

.github/workflows/msrv.yml

@@ -23,6 +23,7 @@ jobs:
           - http-cache
           - http-cache-reqwest
           - http-cache-surf
+          - http-cache-ureq
           - http-cache-tower
           - http-cache-quickcache
     steps:

Cargo.toml

@@ -5,5 +5,6 @@ members = [
     "http-cache-reqwest",
     "http-cache-surf",
     "http-cache-quickcache",
-    "http-cache-tower"
+    "http-cache-tower",
+    "http-cache-ureq"
 ]

docs/src/SUMMARY.md

@@ -2,12 +2,14 @@
 
 - [Introduction](./introduction.md)
 - [Cache Modes](./cache-modes.md)
+- [Rate Limiting](./rate-limiting.md)
 - [Development](./development/development.md)
   - [Supporting a Backend Cache Manager](./development/supporting-a-backend-cache-manager.md)
   - [Supporting an HTTP Client](./development/supporting-an-http-client.md)
 - [Client Implementations](./clients/clients.md)
   - [reqwest](./clients/reqwest.md)
   - [surf](./clients/surf.md)
+  - [ureq](./clients/ureq.md)
   - [tower](./clients/tower.md)
 - [Backend Cache Manager Implementations](./managers/managers.md)
   - [cacache](./managers/cacache.md)