fine_tune 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 084b2f0a33fb235fae26629c06c4d3ea49832456
+  data.tar.gz: 36428f60b499e91fca15c2208edbb93b2ae21ec2
+SHA512:
+  metadata.gz: ef657f44b8ccc3516998568101b3192103f0591a81171875bf626718137d88ae2a79c804ac47893fa0d42abad4f34cebf3ee0dcad12db9ebfc52c2ed9d57d130
+  data.tar.gz: e41b1821a9e08b4d3323e7fc52a66ce353a3669946444c8316997a2988e5bca99dc0f93ef807f9a3c5e1131e7a98d4367f1555a6d2d2f6fb21829f304c9f3367

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+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 fine_tune.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Laknath
+
+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,41 @@
+# FineTune
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fine_tune`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fine_tune'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fine_tune
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/fine_tune. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+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/fine_tune.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fine_tune/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fine_tune"
+  spec.version       = FineTune::VERSION
+  spec.authors       = ["Laknath Semage"]
+  spec.email         = ["blaknath@gmail.com"]
+
+  spec.summary       = %q{Limits rate of a given event sequence with defined strategies.}
+  spec.description   = %q{A rate limiter without the worst case throttling of two times the defined threshold.}
+  spec.homepage      = "https://github.com/vesess/fine_tune"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1.9"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
+end

data/lib/fine_tune/base.rb

@@ -0,0 +1,83 @@
+module FineTune
+  class Base
+    include Singleton
+
+    class << self; attr_accessor :default_strategy; end
+
+    @@registry = {
+      :leaky_bucket => ::FineTune::Strategies::LeakyBucket,
+      :sliding_window => ::FineTune::Strategies::SlidingWindow
+    }
+    @default_strategy = ::FineTune::Strategies::LeakyBucket
+
+    def throttle(name, id, options)
+      strategy, key, options = current_strategy(name, id, options)
+      count = strategy.increment(key, options)
+      comp = strategy.compare?(count, options)
+
+      yield(count, comp, key, strategy, options) if block_given?
+
+      comp >= 0
+    end
+
+    def throttle!(name, id, options)
+      block = Proc.new if block_given?
+
+      throttle(name, id, options) do |count, comp, key, strategy, options|
+        block.call(count, comp, key, strategy, options) if block
+
+        raise MaxRateError.new(key, count, comp, strategy, options) if comp >= 0
+      end
+    end
+
+    def rate_exceeded?(name, id, options)
+      strategy, key, options = current_strategy(name, id, options)
+      strategy.compare?(strategy.count(key, options), options) >= 0
+    end
+
+    def count(name, id, options)
+      strategy, key, options = current_strategy(name, id, options)
+      strategy.count(key, options)
+    end
+
+    def reset(name, id, options)
+      strategy, key, options = current_strategy(name, id, options)
+      strategy.reset(key, options)
+    end
+
+    def add_limit(name, options = {})
+      limits[name] ||= {}
+      limits[name].merge!(options)
+    end
+
+    def remove_limit(name)
+      limits.delete(name)
+    end
+
+    def limits
+      @limits ||= {}
+    end
+
+    private
+    def current_strategy(name, id, options)
+      options = (limits[name] || {}).merge(options)
+      strategy = self.class.find_strategy(options[:strategy])
+
+      if strategy.validate?(options)
+        key = strategy.build_key(name, id, options)
+      end
+
+      raise "resource key undefined" unless key
+
+      [strategy, key, options]
+    end
+
+    def self.find_strategy(strategy)
+      registry.fetch(strategy, default_strategy).instance
+    end
+
+    def self.registry
+      @@registry
+    end
+  end
+end

data/lib/fine_tune/max_rate_error.rb

@@ -0,0 +1,15 @@
+module FineTune
+  class MaxRateError < StandardError
+    attr_accessor :key, :comparison, :count, :strategy, :options  
+
+    def initialize(key, count, comp, strategy, options)
+      @key = key
+      @count = count
+      @comparison = comp
+      @strategy = strategy
+      @options = options
+
+      super("Rate limited with strategy #{strategy} for key #{key}")
+    end
+  end
+end

data/lib/fine_tune/strategies/base.rb

@@ -0,0 +1,31 @@
+module FineTune
+  module Strategies
+    class Base
+      include Singleton
+
+      def compare?(count, options)
+        count <=> options[:limit]
+      end
+
+      def build_key(name, id, options)
+        [name, id].flatten.join('-')
+      end
+
+      def increment(key, options)
+        raise "not defined"
+      end
+
+      def count(key, options)
+        raise "not defined"
+      end
+
+      def validate?(options)
+        false
+      end
+
+      def reset(key, options)
+        raise "not defined"
+      end
+    end
+  end
+end

data/lib/fine_tune/strategies/leaky_bucket.rb

@@ -0,0 +1,6 @@
+module FineTune
+  module Strategies
+    class LeakyBucket < Base
+    end
+  end
+end

data/lib/fine_tune/strategies/sliding_window.rb

@@ -0,0 +1,6 @@
+module FineTune
+  module Strategies
+    class SlidingWindow < Base
+    end
+  end
+end

data/lib/fine_tune/version.rb

@@ -0,0 +1,3 @@
+module FineTune
+  VERSION = "0.1.0"
+end

data/lib/fine_tune.rb

@@ -0,0 +1,18 @@
+require "fine_tune/version"
+require 'singleton'
+require "forwardable"
+require "fine_tune/strategies/base"
+Dir[File.dirname(__FILE__) + "/fine_tune/strategies/*.rb"].each do |filename|
+  require filename
+end
+require "fine_tune/base"
+require "fine_tune/max_rate_error"
+
+module FineTune
+  class << self
+    extend Forwardable
+    def_delegators :"FineTune::Base.instance", :adapter, :adapter=, :count,
+                    :reset, :throttle, :throttle!, :add_limit, :remove_limit, :rate_exceeded?
+  end
+end
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fine_tune
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laknath Semage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-27 00:00:00.000000000 Z
+dependencies:
+- !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: 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: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: A rate limiter without the worst case throttling of two times the defined
+  threshold.
+email:
+- blaknath@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fine_tune.gemspec
+- lib/fine_tune.rb
+- lib/fine_tune/base.rb
+- lib/fine_tune/max_rate_error.rb
+- lib/fine_tune/strategies/base.rb
+- lib/fine_tune/strategies/leaky_bucket.rb
+- lib/fine_tune/strategies/sliding_window.rb
+- lib/fine_tune/version.rb
+homepage: https://github.com/vesess/fine_tune
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Limits rate of a given event sequence with defined strategies.
+test_files: []