throttling 0.3.1 → 0.4.1

data/lib/throttling.rb

@@ -1,5 +1,5 @@
-require 'logger'
-require 'yaml'
+require "logger"
+require "yaml"
 
 # Simple throttling library to limit number of actions in time.
 module Throttling
@@ -8,7 +8,7 @@ module Throttling
     # (if it is a Rails application).
     def storage
       @@storage ||= (defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache) || nil
-      raise ArgumentError, 'Throttling.storage is not specified' unless @@storage
+      raise ArgumentError, "Throttling.storage is not specified" unless @@storage
       @@storage
     end
 
@@ -25,7 +25,7 @@ module Throttling
 
     # Gets the logger used to output errors or warnings.
     def logger
-      @@logger ||= (defined?(Rails) && Rails.respond_to(:logger) && Rails.logger) || Logger.new(STDOUT)
+      @@logger ||= (defined?(Rails) && Rails.respond_to(:logger) && Rails.logger) || Logger.new($stdout)
     end
 
     # Sets the logger used to output errors or warnings.
@@ -52,14 +52,14 @@ module Throttling
 
     # Sets current throttling limits.
     def limits=(limits)
-      @@limits = limits && limits.with_indifferent_access
+      @@limits = limits&.with_indifferent_access
     end
 
     # Get the value indicating whether throttling is enabled.
     def enabled?
       !!@@enabled
     end
-    alias :enabled :enabled?
+    alias_method :enabled, :enabled?
 
     # Sets the value indicating whether throttling is enabled.
     def enabled=(enabled)
@@ -83,20 +83,20 @@ module Throttling
 
     # Resets all values to their default state (mostly for testing purpose).
     def reset_defaults!
-      @@enabled       = true
-      @@logger        = nil
-      @@storage       = nil
+      @@enabled = true
+      @@logger = nil
+      @@storage = nil
       @@limits_config = nil
 
       # Internal variables
-      @@instances     = {}
-      @@config        = nil
+      @@instances = {}
+      @@config = nil
     end
 
     private
 
     def load_config(path)
-      return nil unless File.exists?(path)
+      return nil unless File.exist?(path)
       YAML.load_file(path).with_indifferent_access
     end
   end
@@ -104,6 +104,6 @@ module Throttling
   reset_defaults!
 end
 
-require 'throttling/indifferent_access'
-require 'throttling/base'
+require "throttling/indifferent_access"
+require "throttling/base"
 require "throttling/version"

data/throttling.gemspec

@@ -1,24 +1,39 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/throttling/version', __FILE__)
+require File.expand_path("../lib/throttling/version", __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Dmytro Shteflyuk", "Oleksiy Kovyrin"]
-  gem.email         = ["kpumuk@kpumuk.info"]
-  gem.description   = %q{Throttling gem provides basic, but very powerful way to throttle various user actions in your application}
-  gem.summary       = %q{Easy throttling for Ruby applications}
-  gem.homepage      = "https://github.com/kpumuk/throttling"
+Gem::Specification.new do |spec|
+  spec.name = "throttling"
+  spec.version = Throttling::VERSION
+  spec.authors = ["Dmytro Shteflyuk", "Oleksiy Kovyrin"]
+  spec.email = ["kpumuk@kpumuk.info"]
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'timecop'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rb-fsevent'
-  gem.add_development_dependency 'growl'
+  spec.summary = "Easy throttling for Ruby applications"
+  spec.description = "Throttling gem provides basic, but very powerful way to throttle various user actions in your application"
+  spec.homepage = "https://github.com/kpumuk/throttling"
+  spec.license = "MIT"
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = ">= 2.7.0"
 
-  gem.files         = `git ls-files`.split($\) - %w[.travis.yml]
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/}) + %w[Guardfile]
-  gem.name          = "throttling"
-  gem.require_paths = ["lib"]
-  gem.version       = Throttling::VERSION
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.|(bin|test|spec|features)/)}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.13.0"
+  spec.add_development_dependency "timecop", "~> 0.9.6"
+  spec.add_development_dependency "standard", "~> 1.51.0"
+
+  spec.add_runtime_dependency "logger"
+
+  spec.cert_chain = ["certs/kpumuk.pem"]
+  spec.signing_key = File.expand_path("~/.gem/gem-private_key.pem") if $PROGRAM_NAME.end_with?("gem")
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/kpumuk/throttling/issues/",
+    "changelog_uri" => "https://github.com/kpumuk/throttling/blob/main/CHANGELOG.md",
+    "documentation_uri" => "https://rubydoc.info/github/kpumuk/throttling/",
+    "homepage_uri" => "https://github.com/kpumuk/throttling/",
+    "source_code_uri" => "https://github.com/kpumuk/throttling/",
+    "rubygems_mfa_required" => "true"
+  }
 end

data.tar.gz.sig

@@ -0,0 +1,2 @@
+!�����
+Y؞�5G<7�����?����)��f�U{*�F�hsd���Y���D*�)�Ax
�JW�0Tz�F1%����p�uY��������f�TB�p�v*��I| �m7_e o�� <ѣJ��Sq�@�0�ԁ���Y�l&KIy�>f�}7�mc�T�0�n;���w.@�4��&�2@�ycQ���m��3Ģj2�#���'�|��&z�`l��>c=(�]|�M

metadata

@@ -1,83 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: throttling
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Dmytro Shteflyuk
 - Oleksiy Kovyrin
-autorequire: 
-bindir: bin
-cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MQ8wDQYDVQQDDAZrcHVt
+  dWsxFjAUBgoJkiaJk/IsZAEZFgZrcHVtdWsxFDASBgoJkiaJk/IsZAEZFgRpbmZv
+  MB4XDTI1MDkyOTE1MDM1M1oXDTI2MDkyOTE1MDM1M1owPzEPMA0GA1UEAwwGa3B1
+  bXVrMRYwFAYKCZImiZPyLGQBGRYGa3B1bXVrMRQwEgYKCZImiZPyLGQBGRYEaW5m
+  bzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALw2YroZc+IT+rs8NuPu
+  c13DelrxrpAgPEu1zuRb3l7WaHRNWA4TyS8Z6Aa1G2O+FdUZNMW1n7IwP/QMJ9Mz
+  ahRBiTmhik5kasJ9s0h1lq5/hZiycm0o5OtGioUzCkvk+UEMpzMHbLmVSZCzYciy
+  NDRDbXB0rLLu1eJk+gKgn6Qf5vj93h1w28BdWdaA7YegtbmipZ+pjmzCQAfPActT
+  6uXHG4dSo7Lz9jiFRI5dUizFbGXcRqkQ2b5AB8FFmfcvbqERvzQKBICnybjsKP0N
+  pJ3vGgO2sh5GvJFOPk1Vlur2nX9ZFznPEP1CEAQ+NFrmKRt355Z5sgOkAojSGnIL
+  /1sCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFPa4
+  VFc1YOlV1u/7EGTwMCAk8YE9MB0GA1UdEQQWMBSBEmtwdW11a0BrcHVtdWsuaW5m
+  bzAdBgNVHRIEFjAUgRJrcHVtdWtAa3B1bXVrLmluZm8wDQYJKoZIhvcNAQELBQAD
+  ggEBAFz/6+efHFEomTCA8V/eMpzaMkbj04cTmFxm28KiUO1F4vgbSIBx0bsMoJkH
+  KI956sPVVJMykwOdDUhRWBrHOVTBCGdkYWdb38KQKfwtkdGd8b/Afrxs5GuPME9r
+  TdfDc1aXCAPdLCajhpmuzfa1g8/W7ORdxwNQidYSSPJ5OvcAGSfxTHJsFseHjrBK
+  9hdoXZgqc4a5defxoOZFD9Im9AUwFqwR8njCBST6FbCGmHIYNHj2hxbwrU/1I2Kg
+  pPzkBOwQl2p1ykAEUe7cwoqJcO+1rPeTHjudNqhOfc3VnMA8A7uXOkTtYNVhvApn
+  oW4hE/8SnZkQm8jzdi0iX9nWxo8=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70097466944080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
-  version_requirements: *70097466944080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70097466943660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.13.0
   type: :development
   prerelease: false
-  version_requirements: *70097466943660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70097466943240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.6
   type: :development
   prerelease: false
-  version_requirements: *70097466943240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70097466942820 !ruby/object:Gem::Requirement
-    none: false
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.51.0
   type: :development
   prerelease: false
-  version_requirements: *70097466942820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.51.0
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: &70097466942400 !ruby/object:Gem::Requirement
-    none: false
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *70097466942400
-- !ruby/object:Gem::Dependency
-  name: growl
-  requirement: &70097466941980 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70097466941980
 description: Throttling gem provides basic, but very powerful way to throttle various
   user actions in your application
 email:
@@ -86,49 +110,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - Gemfile
-- Guardfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- certs/kpumuk.pem
 - lib/throttling.rb
 - lib/throttling/base.rb
 - lib/throttling/indifferent_access.rb
 - lib/throttling/version.rb
-- spec/base_spec.rb
-- spec/fixtures/throttling.yml
-- spec/spec_helper.rb
-- spec/throttling_spec.rb
 - throttling.gemspec
 homepage: https://github.com/kpumuk/throttling
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/kpumuk/throttling/issues/
+  changelog_uri: https://github.com/kpumuk/throttling/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/github/kpumuk/throttling/
+  homepage_uri: https://github.com/kpumuk/throttling/
+  source_code_uri: https://github.com/kpumuk/throttling/
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.15
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.9
+specification_version: 4
 summary: Easy throttling for Ruby applications
-test_files:
-- spec/base_spec.rb
-- spec/fixtures/throttling.yml
-- spec/spec_helper.rb
-- spec/throttling_spec.rb
-- Guardfile
+test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.idea
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Guardfile

@@ -1,6 +0,0 @@
-guard 'rspec', :version => 2, :cli => '--color --fail-fast --drb' do
-  watch(%r{^spec/.+_spec\.rb})
-  watch('lib/throttling.rb')          { 'spec'}
-  watch('spec/spec_helper.rb')        { 'spec'}
-  watch(%r{^lib/throttling/(.+)\.rb}) { |m| "spec/#{m[1]}_spec.rb" }
-end

data/spec/base_spec.rb

@@ -1,181 +0,0 @@
-require 'spec_helper'
-
-describe Throttling do
-  before do
-    Throttling.reset_defaults!
-    @storage = Throttling.storage = TestStorage.new
-  end
-
-  describe 'instance methods' do
-    before do
-      Throttling.limits = { 'foo' => {'limit' => 5, 'period' => 2} }
-      @t = Throttling.for('foo')
-    end
-
-    { :check_ip => '127.0.0.1', :check_user_id => 123 }.each do |check_method, valid_value|
-      describe check_method do
-        it 'should return true for nil check_values' do
-          @t.send(check_method, nil).should be_true
-        end
-
-        it 'should return true if no limit specified in configs' do
-          Throttling.limits['foo']['limit'] = nil
-          @storage.should_receive(:fetch).and_return(1000)
-          @t.send(check_method, valid_value).should be_true
-        end
-
-        it 'should return false if limit is 0' do
-          Throttling.limits['foo']['limit'] = 0
-          @storage.should_receive(:fetch).and_return(0)
-          @t.send(check_method, valid_value).should be_false
-        end
-
-        it 'should raise an exception if no period specified in configs' do
-          Throttling.limits['foo']['period'] = nil
-          lambda { @t.send(check_method, valid_value) }.should raise_error(ArgumentError)
-        end
-
-        it 'should raise an exception if invalid period specified in configs' do
-          Throttling.limits['foo']['period'] = -1
-          lambda { @t.send(check_method, valid_value) }.should raise_error(ArgumentError)
-
-          Throttling.limits['foo']['period'] = 'foo'
-          lambda { @t.send(check_method, valid_value) }.should raise_error(ArgumentError)
-        end
-
-        it 'should return true if throttling limit is not passed' do
-          @storage.should_receive(:fetch).and_return(1)
-          @t.send(check_method, valid_value).should be_true
-        end
-
-        it 'should return false if throttling limit is passed' do
-          @storage.should_receive(:fetch).and_return(Throttling.limits['foo']['limit'] + 1)
-          @t.send(check_method, valid_value).should be_false
-        end
-
-        context 'around limit' do
-          it 'should increase hit counter when values equals to limit - 1' do
-            @storage.should_receive(:fetch).and_return(Throttling.limits['foo']['limit'] - 1)
-            @storage.should_receive(:increment)
-            @t.send(check_method, valid_value)
-          end
-
-          it 'should not increase hit counter when values equals to limit' do
-            @storage.should_receive(:fetch).and_return(Throttling.limits['foo']['limit'])
-            @storage.should_not_receive(:increment)
-            @t.send(check_method, valid_value)
-          end
-
-          it 'should not increase hit counter when values equals to limit + 1' do
-            @storage.should_receive(:fetch).and_return(Throttling.limits['foo']['limit'] + 1)
-            @storage.should_not_receive(:increment)
-            @t.send(check_method, valid_value)
-          end
-
-          it 'should allow exactly limit actions' do
-            5.times { @t.send(check_method, valid_value).should be_true }
-            @storage.should_not_receive(:increment)
-            @t.send(check_method, valid_value).should be_false
-          end
-        end
-      end
-    end
-  end
-
-  describe 'with multi-level limits' do
-    before do
-      Throttling.limits = { 'foo' => { 'two' => { 'limit' => 10, 'period' => 20 }, 'one' => { 'limit' => 5, 'period' => 2 } } }
-    end
-
-    it 'should return false if at least one limit is reached' do
-      @storage.should_receive(:fetch).and_return(1, 100)
-      Throttling.for('foo').check_ip('127.0.0.1').should be_false
-    end
-
-    it 'should return true if none limits reached' do
-      @storage.should_receive(:fetch).and_return(1, 2)
-      Throttling.for('foo').check_ip('127.0.0.1').should be_true
-    end
-
-    it 'should sort limits by period' do
-      @storage.should_receive(:fetch).ordered.with(/\:one\:/, anything).and_return(0)
-      @storage.should_receive(:fetch).ordered.with(/\:two\:/, anything).and_return(0)
-      Throttling.for('foo').check_ip('127.0.0.1').should be_true
-    end
-
-    it 'should return as soon as limit reached' do
-      @storage.should_receive(:fetch).ordered.with(/\:one\:/, anything).and_return(10)
-      @storage.should_not_receive(:fetch).with(/\:two\:/)
-      Throttling.for('foo').check_ip('127.0.0.1').should be_false
-    end
-  end
-
-  context 'with values specified' do
-    before do
-      Throttling.limits_config = File.expand_path('../fixtures/throttling.yml', __FILE__)
-    end
-
-    it 'should return value when limit is not reached' do
-      @storage.should_receive(:fetch).and_return(0)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 10
-      @storage.should_receive(:fetch).and_return(4)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 10
-
-      @storage.should_receive(:fetch).and_return(5)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 15
-      @storage.should_receive(:fetch).and_return(14)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 15
-
-      @storage.should_receive(:fetch).and_return(15)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 20
-      @storage.should_receive(:fetch).and_return(99)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 20
-
-      @storage.should_receive(:fetch).and_return(100)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 25
-      @storage.should_receive(:fetch).and_return(1000)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should == 25
-    end
-
-    it 'should increase hit counter' do
-      @storage.should_receive(:fetch).and_return(4)
-      @storage.should_receive(:increment)
-      Throttling.for('request_priority').check_ip('127.0.0.1')
-
-      @storage.should_receive(:fetch).and_return(1000)
-      @storage.should_receive(:increment)
-      Throttling.for('request_priority').check_ip('127.0.0.1')
-    end
-
-    it 'should return false when highest limit reached' do
-      Throttling.limits['request_priority'].delete('default_value')
-      @storage.should_receive(:fetch).and_return(1000)
-      Throttling.for('request_priority').check_ip('127.0.0.1').should be_false
-    end
-  end
-
-  context do
-    before do
-      Throttling.limits = { 'foo' => {'limit' => 5, 'period' => 86400} }
-      @timestamp = 1334261569
-    end
-
-    describe 'key name' do
-      it 'should include type, value, name, and period start' do
-        Timecop.freeze(Time.at(@timestamp)) do
-          Throttling.for('foo').check_ip('127.0.0.1')
-        end
-        @storage.values.keys.first.should == 'throttle:foo:ip:127.0.0.1:global:15442'
-      end
-    end
-
-    describe 'key expiration' do
-      it 'should calculate expiration time' do
-        Timecop.freeze(Time.at(@timestamp)) do
-          Throttling.for('foo').check_ip('127.0.0.1')
-        end
-        @storage.values.values.first[:expires_in].should == 13631
-      end
-    end
-  end
-end

data/spec/fixtures/throttling.yml

@@ -1,28 +0,0 @@
-user_signup:
-  limit: 20
-  period: 3600
-
-search_requests:
-  minutely:
-    limit: 300
-    period: 600
-  hourly:
-    limit: 1000
-    period: 3600
-  daily:
-    limit: 10000
-    period: 86400
-
-request_priority:
-  period: 86400
-  default_value: 25
-  values:
-    high_priority:
-      limit: 5
-      value: 10
-    medium_priority:
-      limit: 15
-      value: 15
-    low_priority:
-      limit: 100
-      value: 20

data/spec/spec_helper.rb

@@ -1,21 +0,0 @@
-require 'bundler/setup'
-require 'throttling'
-require 'timecop'
-
-class TestStorage
-  attr_reader :values
-
-  def fetch(key, options = {}, &block)
-    @values ||= {}
-    value = @values.fetch(key, &block)
-    value = { :value => value.to_s } unless Hash === value
-    @values[key] = value.merge(options)
-    value[:value]
-  end
-
-  def increment(key)
-    @values ||= {}
-    @values[key] ||= { :value => 0 }
-    @values[key][:value] = (@values[key][:value].to_i + 1).to_s
-  end
-end