rolling-limit 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca1642a98f230734665f4bb94a0ef43f234eeed9
-  data.tar.gz: ed5845dbd3829e8f944224caa61d9634c59e7da5
+SHA256:
+  metadata.gz: fc44e4fe6e5308274bb2a0a4f19f9ddb937c5dae2a2fae267ccbf14485acb682
+  data.tar.gz: 9942164196f7c49908ab3565714f4e7204d831e3c903937b6ddaa213ab39d891
 SHA512:
-  metadata.gz: 85a03de41fb244b4b338a62a0662484b8f5a95ddb3a90c725f3f29ad89304b5a0925927c72057dda67bcbc088181e0b78fcf4ca3dc6fa5fa9359db49cc492ab4
-  data.tar.gz: 973bc7f1e6d104d3ecd6a0b6cd5babdb6710d0188a2fbfab62dad044cc5a1d7db82ce489934bbe7c08ca7efbd1d6d3c1625512adc622b06b334d2e1b3df2b6b5
+  metadata.gz: 524aa999b157efa01494a54f1092ff4fe467845c5958315ec78adde8b14adef059477409847b867e5a593a5fc69c65defb1937f32e7df308c6e662adc269a0bb
+  data.tar.gz: 6ce018c6f166c526ab99b0ecb858b3cea52593afe21f9b033dfd43509644e9432ee71d21e70f8a6b0ceb05d4bc8dd4a7337cf132c90a05bcafddf72a1c08e323

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:3.0
+
+WORKDIR /usr/local/src/rolling-limit
+
+COPY lib/rolling/limit/version.rb ./lib/rolling/limit/
+# Preinstall latest gems specified by gemspec; note that they may be overwritten by Gemfile.lock from mounted app dir
+COPY Gemfile rolling-limit.gemspec ./
+
+RUN bundle install

data/README.md

@@ -2,21 +2,7 @@
 
 A redis-backed rate limiter, using redis sorted sets.
 
-````ruby
-require 'rolling/limit'
-
-rl = Rolling::Limit.new(redis: connection, key: "unique key",
-                        max_operations: 5, timespan: 60)
-
-rl.remaining # => 4
-rl.remaining # => 3
-rl.remaining # => 2
-rl.remaining # => 1
-rl.remaining # => 0
-rl.remaining # => false
-# ... 61s later
-rl.remaining # => 4
-````
+The operations are not guaranteed to be atomic, so this will be subject to race conditions - but it should be good enough for most uses where the intent is to prevent high usage, rather than to accurately count the exact number of operations within a particular time period.
 
 ## Installation
 
@@ -36,15 +22,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Instantiate a `Rolling::Limit` object and then use `#remaining` to determine if an operation may be performed within the specified limits.
+
+e.g.
+```ruby
+require 'rolling/limit'
+
+
+limit = Rolling::Limit.new(redis: redis, key: "u:#{user.id}:api", max_operations: 100, timespan: 60)
+
+if limit.remaining
+  perform_api_operation(user)
+else
+  raise "Limit exceeded - try again soon"
+end
+
+```
+
+or
+
+e.g
+
+```ruby
+require 'rolling/limit'
+
+limit = Rolling::Limit.new(redis: connection, key: "unique key",
+                        max_operations: 5, timespan: 60)
+
+limit.remaining # => 4
+limit.remaining # => 3
+limit.remaining # => 2
+limit.remaining # => 1
+limit.remaining # => 0
+limit.remaining # => false
+# ... 61s later
+limit.remaining # => 4
+
+```
+
+```ruby
+  # Rolling::Limit is a class that maintains a rolling limit of no more than
+  # <max_operations> operations for a given <key> within <timespan> seconds.
+  class Rolling::Limit
+    def initialize(redis:, key:, max_operations:, timespan:)
+
+    # Increments the counter and returns truthy (with number of remaining
+    # operations)
+    def remaining
+
+    # Resets this counter
+    def reset!
+
+    # Returns true if there are remaining operations, without incrementing
+    def remaining?
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Run `docker-compose build` to build a Docker image. You can then run `docker-compose run --rm app bundle exec rspec` to run automated tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/livelink/rolling-limit.
-

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3"
+
+services:
+  app:
+    build: .
+    environment:
+      - REDIS_HOST=redis
+    volumes:
+      - .:/usr/local/src/rolling-limit
+    depends_on:
+      - redis
+
+  redis:
+    image: redis:6

data/lib/rolling/limit/version.rb

@@ -1,5 +1,5 @@
 module Rolling
   class Limit
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/rolling-limit.gemspec

@@ -27,8 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "redis", "~> 3.0"
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_dependency "redis", '~> 5.0'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,69 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rolling-limit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Geoff Youngs
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Uses redis sorted sets to allow easy rate limiting
@@ -73,15 +59,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Dockerfile
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - lib/rolling/limit.rb
 - lib/rolling/limit/version.rb
 - rolling-limit.gemspec
@@ -90,24 +78,23 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A redis-based rolling rate limiter
 test_files: []