rare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f044f03406077df891070c59a3695ae6f36a7343
+  data.tar.gz: 67ecb50ae4c082243d7ddb6865e65a6f65b2e7df
+SHA512:
+  metadata.gz: b8ad1bb18d943618337fc7857e9cc24d503c9ffa8b43464629e456cdfbb7a6a9998326c9901d903d50f172a9cbcfdeb4df97012c3a6a75a61e7c91722fb905fb
+  data.tar.gz: ca8308150ae2be8dca6e3c9f017f0b9341dc9c47441ee724e6d565edd283be85506aa8f12742d74b87b83305781e42278ac8fd7aa427566dd13108f796b1ca49

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rare.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rustam Sharshenov
+
+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,72 @@
+# Simple rate limiter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rare'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rare
+
+## Usage
+
+Basic usage
+
+```ruby
+Rare.throttle rpm: 60 do
+  #do_request_to_api
+end
+```
+
+Using keys
+
+```ruby
+threads = []
+
+threads << Thread.new do
+  Rare.throttle rpm: 60, key: 'API1' do
+    #do_request_to_api_1
+  end
+end
+
+threads << Thread.new do
+  Rare.throttle rpm: 60, key: 'API2' do
+    #do_request_to_api_2
+  end
+end
+
+threads.each(&:join)
+```
+
+## Configuration
+
+```ruby
+Rare.configure do |config|
+  config.storage = Redis.current # default is Hash.new
+  config.sleep_interval = 1 # default is 0.01
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/sharshenov/rare.
+
+
+## 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,3 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'rare/throttler'
+require 'rare/configuration'
+require 'rare/version'
+
+module Rare
+  class << self
+    def throttle(opts = {}, &block)
+      throttler.throttle opts, &block
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    private
+
+    def throttler
+      @throttler ||= Throttler.new
+    end
+  end
+end

data/lib/rare/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rare
+  class Configuration
+    attr_accessor :storage,
+                  :sleep_interval
+
+    def initialize
+      @storage        = {}
+      @sleep_interval = 0.01
+    end
+  end
+end

data/lib/rare/throttler.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Rare
+  class Throttler
+    def initialize
+      @mutex = Mutex.new
+    end
+
+    def throttle(rpm:, key: 'default')
+      sleep sleep_interval until allowed?(seconds(rpm), key)
+
+      yield if block_given?
+    end
+
+    private
+
+    def seconds(rpm)
+      60.0 / rpm
+    end
+
+    def allowed?(seconds, key)
+      @mutex.synchronize do
+        now       = Time.now.to_f
+        timestamp = get(key)
+
+        if timestamp.nil? || timestamp < now - seconds
+          set(key, now)
+          return true
+        end
+
+        false
+      end
+    end
+
+    def get(key)
+      value = storage[key]
+
+      return value.to_f if value && !value.is_a?(Float)
+
+      value
+    end
+
+    def set(key, value)
+      storage[key] = value
+    end
+
+    def storage
+      Rare.configuration.storage
+    end
+
+    def sleep_interval
+      Rare.configuration.sleep_interval
+    end
+  end
+end

data/lib/rare/version.rb

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

data/rare.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rare/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rare'
+  spec.version       = Rare::VERSION
+  spec.authors       = ['Rustam Sharshenov']
+  spec.email         = ['rustam@sharshenov.com']
+
+  spec.summary       = 'Simple throttler'
+  spec.description   = 'RPM limiter'
+  spec.homepage      = 'https://github.com/sharshenov/rare'
+  spec.license       = 'MIT'
+
+  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 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 = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rare
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rustam Sharshenov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: RPM limiter
+email:
+- rustam@sharshenov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rare.rb
+- lib/rare/configuration.rb
+- lib/rare/throttler.rb
+- lib/rare/version.rb
+- rare.gemspec
+homepage: https://github.com/sharshenov/rare
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Simple throttler
+test_files: []