rare 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f044f03406077df891070c59a3695ae6f36a7343
4
+ data.tar.gz: 67ecb50ae4c082243d7ddb6865e65a6f65b2e7df
5
+ SHA512:
6
+ metadata.gz: b8ad1bb18d943618337fc7857e9cc24d503c9ffa8b43464629e456cdfbb7a6a9998326c9901d903d50f172a9cbcfdeb4df97012c3a6a75a61e7c91722fb905fb
7
+ data.tar.gz: ca8308150ae2be8dca6e3c9f017f0b9341dc9c47441ee724e6d565edd283be85506aa8f12742d74b87b83305781e42278ac8fd7aa427566dd13108f796b1ca49
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /*.gem
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ ruby-2.4.0
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+ source 'https://rubygems.org'
3
+
4
+ # Specify your gem's dependencies in rare.gemspec
5
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Rustam Sharshenov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # Simple rate limiter
2
+
3
+ ## Installation
4
+
5
+ Add this line to your application's Gemfile:
6
+
7
+ ```ruby
8
+ gem 'rare'
9
+ ```
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install rare
18
+
19
+ ## Usage
20
+
21
+ Basic usage
22
+
23
+ ```ruby
24
+ Rare.throttle rpm: 60 do
25
+ #do_request_to_api
26
+ end
27
+ ```
28
+
29
+ Using keys
30
+
31
+ ```ruby
32
+ threads = []
33
+
34
+ threads << Thread.new do
35
+ Rare.throttle rpm: 60, key: 'API1' do
36
+ #do_request_to_api_1
37
+ end
38
+ end
39
+
40
+ threads << Thread.new do
41
+ Rare.throttle rpm: 60, key: 'API2' do
42
+ #do_request_to_api_2
43
+ end
44
+ end
45
+
46
+ threads.each(&:join)
47
+ ```
48
+
49
+ ## Configuration
50
+
51
+ ```ruby
52
+ Rare.configure do |config|
53
+ config.storage = Redis.current # default is Hash.new
54
+ config.sleep_interval = 1 # default is 0.01
55
+ end
56
+ ```
57
+
58
+ ## Development
59
+
60
+ 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.
61
+
62
+ 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).
63
+
64
+ ## Contributing
65
+
66
+ Bug reports and pull requests are welcome on GitHub at https://github.com/sharshenov/rare.
67
+
68
+
69
+ ## License
70
+
71
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
72
+
data/Rakefile ADDED
@@ -0,0 +1,3 @@
1
+ # frozen_string_literal: true
2
+ require 'bundler/gem_tasks'
3
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'rare'
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require 'irb'
15
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/rare.rb ADDED
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+ require 'rare/throttler'
3
+ require 'rare/configuration'
4
+ require 'rare/version'
5
+
6
+ module Rare
7
+ class << self
8
+ def throttle(opts = {}, &block)
9
+ throttler.throttle opts, &block
10
+ end
11
+
12
+ def configuration
13
+ @configuration ||= Configuration.new
14
+ end
15
+
16
+ def configure
17
+ yield(configuration)
18
+ end
19
+
20
+ private
21
+
22
+ def throttler
23
+ @throttler ||= Throttler.new
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rare
4
+ class Configuration
5
+ attr_accessor :storage,
6
+ :sleep_interval
7
+
8
+ def initialize
9
+ @storage = {}
10
+ @sleep_interval = 0.01
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Rare
4
+ class Throttler
5
+ def initialize
6
+ @mutex = Mutex.new
7
+ end
8
+
9
+ def throttle(rpm:, key: 'default')
10
+ sleep sleep_interval until allowed?(seconds(rpm), key)
11
+
12
+ yield if block_given?
13
+ end
14
+
15
+ private
16
+
17
+ def seconds(rpm)
18
+ 60.0 / rpm
19
+ end
20
+
21
+ def allowed?(seconds, key)
22
+ @mutex.synchronize do
23
+ now = Time.now.to_f
24
+ timestamp = get(key)
25
+
26
+ if timestamp.nil? || timestamp < now - seconds
27
+ set(key, now)
28
+ return true
29
+ end
30
+
31
+ false
32
+ end
33
+ end
34
+
35
+ def get(key)
36
+ value = storage[key]
37
+
38
+ return value.to_f if value && !value.is_a?(Float)
39
+
40
+ value
41
+ end
42
+
43
+ def set(key, value)
44
+ storage[key] = value
45
+ end
46
+
47
+ def storage
48
+ Rare.configuration.storage
49
+ end
50
+
51
+ def sleep_interval
52
+ Rare.configuration.sleep_interval
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+ module Rare
3
+ VERSION = '0.1.0'
4
+ end
data/rare.gemspec ADDED
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ # frozen_string_literal: true
3
+ lib = File.expand_path('../lib', __FILE__)
4
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
+ require 'rare/version'
6
+
7
+ Gem::Specification.new do |spec|
8
+ spec.name = 'rare'
9
+ spec.version = Rare::VERSION
10
+ spec.authors = ['Rustam Sharshenov']
11
+ spec.email = ['rustam@sharshenov.com']
12
+
13
+ spec.summary = 'Simple throttler'
14
+ spec.description = 'RPM limiter'
15
+ spec.homepage = 'https://github.com/sharshenov/rare'
16
+ spec.license = 'MIT'
17
+
18
+ if spec.respond_to?(:metadata)
19
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
20
+ else
21
+ raise 'RubyGems 2.0 or newer is required to protect against ' \
22
+ 'public gem pushes.'
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
26
+ f.match(%r{^(test|spec|features)/})
27
+ end
28
+ spec.bindir = 'exe'
29
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
30
+ spec.require_paths = ['lib']
31
+
32
+ spec.add_development_dependency 'bundler', '~> 1.13'
33
+ spec.add_development_dependency 'rake', '~> 10.0'
34
+ end
metadata ADDED
@@ -0,0 +1,86 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rare
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Rustam Sharshenov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-01-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description: RPM limiter
42
+ email:
43
+ - rustam@sharshenov.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - ".ruby-version"
50
+ - Gemfile
51
+ - LICENSE.txt
52
+ - README.md
53
+ - Rakefile
54
+ - bin/console
55
+ - bin/setup
56
+ - lib/rare.rb
57
+ - lib/rare/configuration.rb
58
+ - lib/rare/throttler.rb
59
+ - lib/rare/version.rb
60
+ - rare.gemspec
61
+ homepage: https://github.com/sharshenov/rare
62
+ licenses:
63
+ - MIT
64
+ metadata:
65
+ allowed_push_host: https://rubygems.org/
66
+ post_install_message:
67
+ rdoc_options: []
68
+ require_paths:
69
+ - lib
70
+ required_ruby_version: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ required_rubygems_version: !ruby/object:Gem::Requirement
76
+ requirements:
77
+ - - ">="
78
+ - !ruby/object:Gem::Version
79
+ version: '0'
80
+ requirements: []
81
+ rubyforge_project:
82
+ rubygems_version: 2.6.8
83
+ signing_key:
84
+ specification_version: 4
85
+ summary: Simple throttler
86
+ test_files: []