redrate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17be9b2352cd8fc522f23f0d1960a2cc68faf7f9558855c3865106e8d5156dc4
+  data.tar.gz: 66b57b5b79aa2a0c1516b0309a659e1a9cd72c71336a8b13cd44388335dfb933
+SHA512:
+  metadata.gz: 4890aa4e150cac89204ccffe758a66a9310ad6a0e5d9ddce0cd8169500ca6a9feb3c8363770bc8d0f5f3121ffa63d9ae8335a6bc709b03179e26bd5a81f33ba9
+  data.tar.gz: 4d20d7e6adca159fe5942304c40fade9f1a554646cb193c5900719edc68fed986aac78aafb1488b27f1bfe5ce7757cc706af5a130eb014450e10be9372226f16

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  Exclude:
+    - 'vendor/**/*'
+
+Rails:
+  Enabled: true
+Rails/FilePath:
+  Exclude:
+
+Metrics/ClassLength:
+  Max: 130
+  Exclude:
+Metrics/LineLength:
+  Max: 400
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/javascripts/**/*'
+    
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/NumericLiterals:
+  MinDigits: 7
+
+Layout/IndentationConsistency:
+  EnforcedStyle: rails
+
+Naming/FileName:
+  Exclude:
+    - 'browse-everything.gemspec'
+    - 'Gemfile'

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+services:
+  - redis-server
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redrate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    redrate (0.1.0)
+      redis
+      redlock
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    bixby (1.0.0)
+      rubocop (~> 0.50, <= 0.52.1)
+      rubocop-rspec (~> 1.22, <= 1.22.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (4.1.0)
+    redlock (1.0.0)
+      redis (>= 3.0.0, < 5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.22.2)
+      rubocop (>= 0.52.1)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bixby
+  bundler (~> 1.17)
+  pry-byebug
+  rake (~> 10.0)
+  redrate!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Michael Klein
+
+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.

data/README.md

@@ -0,0 +1,97 @@
+# Redrate [![Build Status](https://travis-ci.com/nulib/redrate.svg?branch=master)](https://travis-ci.com/nulib/redrate)
+
+A distributed rate limiter for Ruby, based on [ruby-limiter](https://github.com/Shopify/limiter).
+By using redis as the ring store, `Redrate` can enforce the rate limit across multiple 
+running instances of the same code, e.g., to enforce limits on shared use of a common
+rate-limited API or other resource.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redrate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redrate
+
+## Usage
+
+### Basic Usage
+
+To rate limit calling an instance method, a mixin is provided. Simply specify 
+the method to me limited, and the maximum rate that the method can be called. 
+This rate is (by default) a number of requests per minute.
+
+``` ruby
+class Widget
+  extend Redrate::Mixin
+
+  # limit the rate we can call tick to 300 times per minute
+  #
+  # when the rate has been exceeded, a call to tick will block 
+  # until the rate limit would not be exceeded
+  limit_method :tick, rate: 300
+
+  ...
+end
+```
+
+To specify the rate in terms of an interval shorter (or longer) than 1 minute, an 
+optional `interval` parameter can be provided to specify the throttling period in seconds.
+
+``` ruby
+class Widget
+  extend Redrate::Mixin
+
+  # limit the rate we can call tick to 5 times per second
+  #
+  # when the rate has been exceeded, a call to tick will block 
+  # until the rate limit would not be exceeded
+  limit_method :tick, rate: 5, interval: 1
+
+  ...
+end
+```
+
+### Advanced Usage
+
+In cases where the mixin is not appropriate the `RedRate::Queue` class can be used 
+directly. As in the mixin examples above, the `interval` parameter is optional (and 
+defaults to 1 minute).
+
+``` ruby
+class Widget
+  def initialize
+    # create a rate-limited queue which allows 10000 operations per hour
+    @queue = RedRate::Queue.new(10000, interval: 3600)
+  end
+
+  def tick
+    # this operation will block until less than 10000 shift calls have been 
+    # made within the last hour
+    @queue.shift
+    # do something
+  end
+end
+```
+
+## 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/nulib/redrate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'redrate'
+
+# 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(__FILE__)

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/redrate.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'redrate/ring'
+require 'redrate/queue'
+require 'redrate/mixin'
+require 'redrate/version'
+
+module Redrate
+end

data/lib/redrate/mixin.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Redrate
+  module Mixin
+    def limit_method(method, rate:, interval: 60)
+      queue = Queue.new(rate, interval: interval, key: "#{self.name}##{method}")
+
+      mixin = Module.new do
+        define_method(method) do |*args|
+          queue.shift
+          super(*args)
+        end
+      end
+
+      prepend mixin
+    end
+  end
+end

data/lib/redrate/queue.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Redrate
+  class Queue
+    EPOCH = 0
+
+    def initialize(size, interval: 60, key: 'queue')
+      @ring = Ring.new(size, key, EPOCH)
+      @interval = interval
+    end
+
+    def shift
+      time = nil
+
+      @ring.lock do
+        sleep_until(@ring.current + @interval)
+        @ring.rotate!
+      end
+
+      time
+    end
+
+    private
+
+      def sleep_until(time)
+        interval = time - @ring.now
+        return unless interval.positive?
+        sleep(interval)
+      end
+  end
+end

data/lib/redrate/ring.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'redis'
+require 'redlock'
+
+module Redrate
+  class Ring
+    def initialize(size, key, default)
+      @redis = Redis.current
+      @redlock = Redlock::Client.new([@redis])
+      @size = size
+      @key = key
+      @default = default
+
+      initialize_ring
+    end
+
+    def head
+      @redis.get(head_key).to_i
+    end
+
+    def current
+      (@redis.lindex(ring_key, head) || @default).to_i
+    end
+
+    def rotate!
+      current_head = head
+      current_time = now
+      @redis.pipelined do
+        @redis.lset(ring_key, current_head, current_time.to_s)
+        @redis.set(head_key, (current_head + 1) % @size)
+      end
+    end
+
+    def lock
+      completed = false
+      timeout_time = monotonic_time + 2000
+      while !completed && (monotonic_time < timeout_time)
+        @redlock.lock(lock_key, 2000) do |locked|
+          if locked
+            yield
+            completed = true
+          end
+        end
+      end
+    end
+
+    def now
+      @redis.time[0]
+    end
+
+    private
+
+      def head_key
+        @head_key ||= key_for(:head)
+      end
+
+      def ring_key
+        @ring_key ||= key_for(:ring)
+      end
+
+      def lock_key
+        @lock_key ||= key_for(:lock)
+      end
+
+      def key_for(thing)
+        ['rate', @key, thing].join(':')
+      end
+
+      def initialize_ring
+        return unless @redis.llen(ring_key).zero?
+
+        @redis.pipelined do
+          1.upto(@size) do
+            @redis.lpush(ring_key, @default)
+          end
+          @redis.set(head_key, 0)
+        end
+      end
+
+      def monotonic_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+  end
+end

data/lib/redrate/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Redrate
+  VERSION = '0.1.0'
+end

data/redrate.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redrate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redrate'
+  spec.version       = Redrate::VERSION
+  spec.authors       = ['Michael B. Klein']
+  spec.email         = ['mbklein@gmail.com']
+
+  spec.summary       = 'An easy, distributed rate limiter using Redis'
+  spec.homepage      = 'https://github.com/nulib/redrate.git'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis'
+  spec.add_dependency 'redlock'
+  spec.add_development_dependency 'bixby'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: redrate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael B. Klein
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 
+email:
+- mbklein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redrate.rb
+- lib/redrate/mixin.rb
+- lib/redrate/queue.rb
+- lib/redrate/ring.rb
+- lib/redrate/version.rb
+- redrate.gemspec
+homepage: https://github.com/nulib/redrate.git
+licenses:
+- MIT
+metadata: {}
+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.7.3
+signing_key: 
+specification_version: 4
+summary: An easy, distributed rate limiter using Redis
+test_files: []