ruby-limiter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17d71e42e079a0ce7f9b5c9a093e742976998db2
+  data.tar.gz: 1fc5d17c9e2abf2034deebb98f8da7179bc49701
+SHA512:
+  metadata.gz: '0618773b6259592f784ec8e6d982e8772984757319bba95e83a4a8a5706d5f6732f90514774783f8fec51d2a1b593e3c8f74cccbdf5d3755484227b8f0a3f376'
+  data.tar.gz: e70732cd382c742a3f33674c2ee4392d38b322879fa8afdc21a3b9b1fb62107ced1b2fe4487a2de164c9f0d99d42540af8f133e8def0be2b0484da3597d06a68

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rubocop-https*
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v1.0.0
+
+- initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 S. Brent Faulkner
+
+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,87 @@
+# Limiter [![Build Status](https://travis-ci.org/Shopify/limiter.svg?branch=master)](https://travis-ci.org/Shopify/limiter)
+
+This gem implements a simple mechanism to throttle or rate-limit operations in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'limiter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limiter
+
+## 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 Limiter::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 Limiter::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 `RateQueue` 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 = RateQueue.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 test` 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/Shopify/limiter.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

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

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

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/dev.yml

@@ -0,0 +1,10 @@
+# dev.yml - for internal shopify tooling
+
+name: limiter
+
+up:
+  - ruby: 2.4.4
+  - bundler
+
+commands:
+  test: bin/rake test

data/lib/limiter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'limiter/mixin'
+require 'limiter/rate_queue'
+require 'limiter/version'

data/lib/limiter/mixin.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Limiter
+  module Mixin
+    def limit_method(method, rate:, interval: 60)
+      queue = RateQueue.new(rate, interval: interval)
+
+      mixin = Module.new do
+        define_method(method) do
+          queue.shift
+          super()
+        end
+      end
+
+      prepend mixin
+    end
+  end
+end

data/lib/limiter/rate_queue.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Limiter
+  class RateQueue
+    EPOCH = Time.at(0)
+
+    def initialize(size, interval: 60)
+      @size = size
+      @interval = interval
+
+      @ring = Array.new(size, EPOCH)
+      @head = 0
+      @mutex = Mutex.new
+    end
+
+    def shift
+      time = nil
+
+      @mutex.synchronize do
+        time = @ring[@head]
+
+        sleep_until(time + @interval)
+
+        @ring[@head] = Time.now
+        @head = (@head + 1) % @size
+      end
+
+      time
+    end
+
+    private
+
+    def sleep_until(time)
+      interval = time - Time.now
+      return unless interval.positive?
+      sleep(interval)
+    end
+  end
+end

data/lib/limiter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Limiter
+  VERSION = '1.0.0'
+end

data/limiter.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'limiter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-limiter'
+  spec.version       = Limiter::VERSION
+  spec.authors       = ['S. Brent Faulkner']
+  spec.email         = ['brent.faulkner@shopify.com']
+
+  spec.summary       = 'Simple Ruby rate limiting mechanism.'
+  spec.homepage      = 'https://github.com/Shopify/limiter'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.56'
+  spec.add_development_dependency 'timecop', '~> 0.8.0'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: ruby-limiter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- S. Brent Faulkner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: 
+email:
+- brent.faulkner@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- dev.yml
+- lib/limiter.rb
+- lib/limiter/mixin.rb
+- lib/limiter/rate_queue.rb
+- lib/limiter/version.rb
+- limiter.gemspec
+homepage: https://github.com/Shopify/limiter
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Simple Ruby rate limiting mechanism.
+test_files: []