rolling-limit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f170a253aa712039baf7c2b5e8ffe46d053debf3
+  data.tar.gz: 328cef9090ecb66f75a88a0c8df5906084fb3c19
+SHA512:
+  metadata.gz: 7866c7cd9ab62f77ab78ea56040426f8c8402e10b4099dda72aa1cc21a50b2e6380cad82ccc5e18c42ffea62d4fecd35c55f370f32331f56fd2f1f485cf12f65
+  data.tar.gz: 339d23968de457e8a63b0713bf729355499a76b760f1aca71f19d85dd67315db3918e4fe468a9033f2f457b35d547c9faa14d726ab08b92c321b371197a06d02

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-11 22:14:45 +0100 using RuboCop version 0.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+# Offense count: 6
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 104
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Exclude:
+    - 'spec/rolling/limit_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, no_empty_lines
+Style/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/rolling/limit_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+# SupportedStyles: ruby19, ruby19_no_mixed_keys, hash_rockets
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/rolling/limit/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'rolling-limit.gemspec'
+
+# Offense count: 18
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'rolling-limit.gemspec'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rolling-limit.gemspec
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# Rolling::Limit
+
+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
+````
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rolling-limit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rolling-limit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/livelink/rolling-limit.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rolling/limit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rolling/limit/version.rb

@@ -0,0 +1,5 @@
+module Rolling
+  class Limit
+    VERSION = "0.1.0"
+  end
+end

data/lib/rolling/limit.rb

@@ -0,0 +1,67 @@
+require 'rolling/limit/version'
+require 'redis'
+
+module Rolling
+  # 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 Limit
+    def initialize(redis:, key:, max_operations:, timespan:)
+      @redis = redis
+      @key = "rlmt:#{key}"
+      @timespan = timespan
+      @max_operations = max_operations.to_i
+    end
+
+    # Increments the counter and returns truthy (with number of remaining
+    # operations)
+    def remaining
+      cleanup
+      return false if count >= max_operations
+      increment
+      max_operations - count
+    end
+
+    # Resets this counter
+    def reset!
+      redis.del(key)
+    end
+
+    # Shows numbers of remaining operations without incrementing
+    def remaining?
+      cleanup
+      return false if count >= max_operations
+      true
+    end
+
+    private
+
+    attr_reader :key, :timespan, :max_operations, :redis
+
+    # Ensure this key lives for at least <timespan>
+    def autoexpire
+      redis.expire(key, timespan)
+    end
+
+    # Delete operations that are older than time - timespan
+    def cleanup
+      redis.zremrangebyscore(key, '-inf', time - timespan)
+    end
+
+    def time
+      Time.now.to_i
+    end
+
+    def unique_key
+      "#{Time.now.to_f}.#{rand}"
+    end
+
+    def count
+      redis.zcard(key)
+    end
+
+    def increment
+      redis.zadd(key, time, unique_key)
+      autoexpire
+    end
+  end
+end

data/rolling-limit.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rolling/limit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rolling-limit"
+  spec.version       = Rolling::Limit::VERSION
+  spec.authors       = ["Geoff Youngs"]
+  spec.email         = ["git@intersect-uk.co.uk"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{A redis-based rolling rate limiter}
+  spec.description   = %q{Uses redis sorted sets to allow easy rate limiting}
+  spec.homepage      = "https://github.com/livelink/rolling-limit"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis", "~> 1.12"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rolling-limit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Youngs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !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
+email:
+- git@intersect-uk.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rolling/limit.rb
+- lib/rolling/limit/version.rb
+- rolling-limit.gemspec
+homepage: https://github.com/livelink/rolling-limit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A redis-based rolling rate limiter
+test_files: []