rocket_sunset

Crates.io	rocket_sunset
lib.rs	rocket_sunset
version
source	src
created_at	2024-12-02 22:22:56.765125
updated_at	2024-12-02 22:22:56.765125
description	A procedural macro crate for Rocket that provides functionality for HTTP deprecation headers.
homepage
repository	https://github.com/Bentebent/rocket_sunset
max_upload_size
id	1469329
Cargo.toml error:	TOML parse error at line 17, column 1 \| 17 \| autolib = false \| ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size	0

(Bentebent)

documentation

README

Rocket Sunset

Proc macros for handling HTTP deprecation headers for Rocket applications. Based on the draft proposal The Deprecation HTTP Header Field.

Usage

Add this crate to your Cargo.toml alongside Rocket 0.5:

[dependencies]
rocket = "0.5.1"
rocket_sunset = "0.1.0"

Define your endpoints as usual in Rocket. Apply the macro deprecationwith the relevant information.

use rocket_sunset::{
    deprecation,
    DeprecatedResponder,
};

#[get("/ts_only")]
#[deprecation("2024-12-31T23:59:59Z")]
pub fn ts_only() -> &'static str {
    "Hello, timestamp!"
}

#[get("/with_link")]
#[deprecation("2024-12-31T23:59:59Z", link = "https://api.example.com/docs")]
pub fn with_link() -> &'static str {
    "Hello, link!"
}

#[get("/with_sunset")]
#[deprecation("2024-12-31T23:59:59Z", sunset = "2025-12-31T23:59:59Z")]
pub fn with_sunset() -> &'static str {
    "Hello, sunset!"
}

#[get("/full")]
#[deprecation(
    "2024-12-31T23:59:59Z",
    link = "https://api.example.com/docs",
    sunset = "2025-12-31T23:59:59Z"
)]
pub fn full() -> &'static str {
    "Hello, world!"
}

This will wrap your endpoint response in a DeprecatedResponder that adds HTTP headers for deprecation, depreaction link and sunset. This showcases the added headers for the /full endpoint above.

Name	Value
deprecation	"@1735689599"
link	"https://api.example.com/docs; rel="deprecation"; type="text/html"
sunset	"Wed, 31 Dec 2025 23:59:59 GMT"

TODO

Deprecation proc macro support
Sunset proc macro support (automatically disable endpoints past sunset timestamp)
Documentation
Proc macro build unit tests
Tests

License

You can choose between MIT License or Apache License 2.0.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Apache License 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Commit count: 23