make pub

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Sam Shih
+
+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 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.

README.md

@@ -0,0 +1,23 @@
+# GCRA: A basic implementation
+
+This library implements the core GCRA functionality in rust.
+
+## Usage
+
+```rust
+use ::gcra::{GcraState, RateLimit};
+
+fn check_rate_limit() {
+  const LIMIT: u32 = 1;
+  const PERIOD: Duration = Duration::from_secs(1);
+  // Create a rate limit that allows `5/1s`
+  let rate_limit = RateLimit::new(LIMIT, PERIOD);
+
+  let mut user_state = GcraState::default();
+  assert!(user_state.check_and_modify(&rate_limit, 1).is_ok());
+  assert!(
+      !assert!(user_state.check_and_modify(&rate_limit, 1).is_err(),
+      "We should be over the limit now"
+  );
+}
+```

examples/rate_limit_check.rs

@@ -0,0 +1,34 @@
+use gcra::{GcraState, RateLimit};
+
+fn check_rate_limit(rate_limit: &RateLimit, gcra_state: &mut GcraState) -> bool {
+    const COST: u32 = 1;
+    match gcra_state.check_and_modify(rate_limit, COST) {
+        Ok(_) => {
+            println!("allowed");
+            true
+        }
+        Err(next_allowed_at) => {
+            println!("denied. Try again at {:?}", next_allowed_at);
+            false
+        }
+    }
+}
+
+fn main() {
+    const LIMIT: u32 = 3;
+    // Create a rate limit that allows `3/1s`
+    let rate_limit = RateLimit::per_sec(LIMIT);
+
+    let mut user_state = GcraState::default();
+    for i in 0..LIMIT {
+        assert!(
+            check_rate_limit(&rate_limit, &mut user_state),
+            "Attempt #{} should be allowed",
+            i + 1
+        );
+    }
+    assert!(
+        !check_rate_limit(&rate_limit, &mut user_state),
+        "We should be over the limit now"
+    );
+}

src/lib.rs

@@ -1,2 +1,5 @@
 mod gcra;
 mod rate_limit;
+
+pub use crate::gcra::GcraState;
+pub use crate::rate_limit::RateLimit;