throttling 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 466a505eb343b4cd8c1a37f125064bebe09ded2c6a586f1cb191a29d0b786732
+  data.tar.gz: 58db8ff3fd65eeec71b4f767e629780719e2b9e0e99b944dbdacb3a6653d0527
+SHA512:
+  metadata.gz: ff7d8ec51b2a910a44455a6267859f0310adbb57b55ac0ac8239ed3ea99ebe9cfe7102191cf6c78b11f8bd82e724ab1998f1cc7d554318ce2402bbe22a46d8b4
+  data.tar.gz: cecbbd774a4f80f98c976f0dd8151900004532ba3cfb25ae945816f589282e3fbaa0045edb3cbe4b1e3732a990dcd60706cb184aab88d48d9ffe1fdc98e13359

data/CHANGELOG.md

@@ -1,30 +1,37 @@
+# Changelog
+
+## 0.4.0 (July 6, 2023)
+
+- Bump minimum Ruby requirement to 2.7.0
+- Updated codebase to match StandardRB style guide
+
 ## 0.3.1 (April 13, 2012)
 
 Features:
 
-  - When limit is omitted, no limits will be enforced (`check` always returns true)
+- When limit is omitted, no limits will be enforced (`check` always returns true)
 
 Bugfixes:
 
-  - Fixed bug when action was allowed `limit + 1` times
-  - When limit is 0, `check` should always return `false`
+- Fixed bug when action was allowed `limit + 1` times
+- When limit is 0, `check` should always return `false`
 
 ## 0.3.0 (April 13, 2012)
 
 Features:
 
-  - Added ability to retrieve custom value based on number of actions performed in a period of time
+- Added ability to retrieve custom value based on number of actions performed in a period of time
 
 ## 0.2.0 (April 12, 2012)
 
 Bugfixes:
 
-  - Fixed bug when occurrences where increased for larger periods, when smaller ones did not pass
+- Fixed bug when occurrences where increased for larger periods, when smaller ones did not pass
 
 ## 0.1.0 (April 12, 2012)
 
 Features:
 
-  - Allows to throttle actions occurred in period of time
-  - Allows to specify limits inline or in external configuration file
-  - 100% test coverage
+- Allows to throttle actions occurred in period of time
+- Allows to specify limits inline or in external configuration file
+- 100% test coverage

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in throttling.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    throttling (0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    timecop (0.9.6)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin
+  arm64-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.12.0)
+  standard (~> 1.29.0)
+  throttling!
+  timecop (~> 0.9.6)
+
+BUNDLED WITH
+   2.3.26

data/README.md

@@ -1,74 +1,79 @@
 # Throttling
 
-[![Travis-CI build status](https://secure.travis-ci.org/kpumuk/throttling.png)](http://travis-ci.org/kpumuk/throttling)
+[![Tests](https://github.com/kpumuk/throttling/actions/workflows/tests.yml/badge.svg)](https://github.com/kpumuk/throttling/actions/workflows/tests.yml)
+[![Gem Version](https://badge.fury.io/rb/throttling.svg)](https://badge.fury.io/rb/throttling)
+[![Gem Downloads](https://img.shields.io/gem/dt/throttling.svg)](https://badge.fury.io/rb/throttling)
+[![Changelog](https://img.shields.io/badge/Changelog-latest-blue.svg)](https://github.com/kpumuk/throttling/blob/main/CHANGELOG.md)
 
 Throttling gem provides basic, but very powerful way to throttle various user actions in your application. Basically you can specify how many times some action could be performed over a specified period(s) of time.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
-    gem 'throttling'
+```ruby
+gem "throttling"
+```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install throttling
+And run `bundle install` command.
 
 ## Configuration
 
-You can configure Throttling parameters by accessing attributes of `Throttling` module. Currently it supports only Memcached through `Rails.cache`.
+You can configure Throttling parameters by accessing attributes of `Throttling` module. Currently it supports only Memcached and Redis through `Rails.cache`.
 
-    Throttling.storage = Rails.cache
-    Throttling.logger = Rails.logger
+```ruby
+Throttling.storage = Rails.cache
+Throttling.logger = Rails.logger
+```
 
 Throttling limits could be stored in a configuration file in `config/throttling.yml`. You can also specify another file to read limits from:
 
-    Throttling.limits_config = "#{Rails.root}/config/throttling.yml"
+```ruby
+Throttling.limits_config = "#{Rails.root}/config/throttling.yml"
+```
 
 The basic structure of the file is:
 
-    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
+```yaml
+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
+```
 
 This example covers three different scenarios:
 
-1. Single period. In this case only 20 actions will be allowed in a period of
+1. **Single period**. In this case only 20 actions will be allowed in a period of
    one hour (3600 seconds).
 
-2. Multiple periods. Action will be allowed to perform 300 times in 10 minutes,
+2. **Multiple periods**. Action will be allowed to perform 300 times in 10 minutes,
    1000 times an hour, and 10000 times a day.
 
-3. This special case covers following scenario: based on the number of actions,
+3. **Complex scenario**. This special case covers following scenario: based on the number of actions,
    it returns a value, or default value when largest limit is reached. In this
    case it will return 10, when there were 5 or less requests (including current one),
    15 for up to 15 requests, 20 for up to 100 requests, and 25 when there were
@@ -76,110 +81,132 @@ This example covers three different scenarios:
 
 You can also specify limits as a Hash:
 
-    Throttling.limits = {
-      :user_signup => {
-        :limit  => 20,
-        :period => 3600
-      },
-      :search_requests => {
-        :minutely => {
-          :limit  => 20,
-          :period => 3600
-        },
-        :hourly => {
-          :limit  => 1000,
-          :period => 3600
-        },
-        :daily =>
-          :limit  => 10000,
-          :period => 86400
-        }
-      }
+```ruby
+Throttling.limits = {
+  user_signup: {
+    limit: 20,
+    period: 3600
+  },
+  search_requests: {
+    minutely: {
+      limit: 20,
+      period: 3600
+    },
+    hourly: {
+      limit: 1000,
+      period: 3600
+    },
+    daily: {
+      limit: 10000,
+      period: 86400
     }
+  }
+}
+```
 
 You can completely disable throttling by setting `enabled` to `false`:
 
-    Throttling.enabled = false
+```ruby
+Throttling.enabled = false
+```
 
 ## Usage
 
 The basic usage of Throttling gem is following:
 
-    Throttling.for(:user_signup).check(:user_id, current_user.id) do
-      # Do your stuff here
-    end
+```ruby
+Throttling.for(:user_signup).check(:user_id, current_user.id) do
+  # Do your stuff here
+end
 
-    if Throttling.for(:user_signup).check(:user_id, current_user.id)
-      # Action allowed
-    else
-      # Action denied
-    end
+if Throttling.for(:user_signup).check(:user_id, current_user.id)
+  # Action allowed
+else
+  # Action denied
+end
+```
 
 For convenience, there are some simplified methods:
 
-    Throttling.for(:user_signup).check_ip(request.remote_ip)
-    Throttling.for(:user_signup).check_user_id(current_user.id)
+```ruby
+Throttling.for(:user_signup).check_ip(request.remote_ip)
+Throttling.for(:user_signup).check_user_id(current_user.id)
+```
 
 You can add more helpers like this:
 
-    Throttling::Base.class_eval do
-      def check_user_id_and_document_id(user_id, doc_id)
-        check("user_id:doc_id", "#{user_id}:#{doc_id}")
-      end
-    end
+```ruby
+Throttling::Base.class_eval do
+  def check_user_id_and_document_id(user_id, doc_id)
+    check("user_id:doc_id", "#{user_id}:#{doc_id}")
+  end
+end
+```
 
 ## Use cases
 
 ### Limiting number of sign-ups
 
-    user_signup:
-      limit: 20
-      period: 3600
+```yaml
+user_signup:
+  limit: 20
+  period: 3600
+```
 
 Limit the number of sign-ups to 20 per hour per IP address:
 
-    Throttling.for('user_signup').check_ip(request.remote_ip)
+```ruby
+Throttling.for("user_signup").check_ip(request.remote_ip)
+```
 
 ### Limiting number of document uploads
 
-    document_uploads:
-      minutely:
-        limit: 5
-        period: 600
-      hourly:
-        limit: 10
-        period: 3600
-      daily:
-        limit: 50
-        period: 86400
+```yaml
+document_uploads:
+  minutely:
+    limit: 5
+    period: 600
+  hourly:
+    limit: 10
+    period: 3600
+  daily:
+    limit: 50
+    period: 86400
+```
 
 In this case user will be allowed to upload 5 documents in 10 minutes, 10 documents
 in an hour, or 50 documents a day:
 
-    Throttling.for('document_uploads').check_user_id(current_user.id)
+```ruby
+Throttling.for("document_uploads").check_user_id(current_user.id)
+```
 
 ### Prioritizing uploads based on number of uploads
 
-    document_priorities:
-      period: 86400
-      default_value: 25
-      values:
-        high_priority:
-          limit: 5
-          value: 10
-        medium_priority:
-          limit: 15
-          value: 15
-        low_priority:
-          limit: 100
-          value: 20
+```yaml
+document_priorities:
+  period: 86400
+  default_value: 25
+  values:
+    high_priority:
+      limit: 5
+      value: 10
+    medium_priority:
+      limit: 15
+      value: 15
+    low_priority:
+      limit: 100
+      value: 20
+```
 
 All documents could be prioritized based on the number of uploads: if user uploads
 less than 5 documents a day, they all will have priority 10. Next 10 documents
 (first five keep their original priority) will receive priority 15. Documents
 16 to 100 will get priority 20, and everything else will get priority 25.
 
-    Throttling.for('document_priorities').check_user_id(current_user.id)
+```ruby
+Throttling.for("document_priorities").check_user_id(current_user.id)
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,8 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
+task test: :spec
+task default: :spec

data/lib/throttling/base.rb

@@ -15,7 +15,7 @@ module Throttling
         if @limits[:values]
           @limits[:values] = @limits[:values].sort_by { |name, params| params && params[:limit] }
         end
-        @limits = [[ 'global', @limits ]]
+        @limits = [["global", @limits]]
       else
         @limits = @limits.sort_by { |name, params| params && params[:period] }
       end
@@ -35,7 +35,7 @@ module Throttling
 
       limits.each do |period_name, params|
         period = params[:period].to_i
-        limit  = params[:limit].nil? ? nil : params[:limit].to_i
+        limit = params[:limit]&.to_i
         values = params[:values]
 
         raise ArgumentError, "Invalid or no 'period' parameter in the limits[#{action}][#{period_name}] config: #{limit.inspect}" if period < 1
@@ -44,7 +44,7 @@ module Throttling
         key = hits_store_key(check_type, check_value, period_name, period)
 
         # Retrieve current value
-        hits = Throttling.storage.fetch(key, :expires_in => hits_store_ttl(period), :raw => true) { '0' }.to_i
+        hits = Throttling.storage.fetch(key, expires_in: hits_store_ttl(period), raw: true) { "0" }.to_i
 
         if values
           value = params[:default_value] || false
@@ -54,16 +54,16 @@ module Throttling
               break
             end
           end
-        else
+        elsif !limit.nil? && hits >= limit
           # Over limit?
-          return false if !limit.nil? && hits >= limit
+          return false
         end
 
         Throttling.storage.increment(key) if auto_increment
         return value if values
       end
 
-      return true
+      true
     end
 
     private

data/lib/throttling/indifferent_access.rb

@@ -84,7 +84,7 @@ module Throttling
       #   hash.values_at("a", "b") # => ["x", "y"]
       #
       def values_at(*indices)
-        indices.collect {|key| self[convert_key(key)]}
+        indices.collect { |key| self[convert_key(key)] }
       end
 
       # Returns an exact copy of the hash.
@@ -95,7 +95,7 @@ module Throttling
       # Merges the instantized and the specified hashes together, giving precedence to the values from the second hash
       # Does not overwrite the existing hash.
       def merge(hash)
-        self.dup.update(hash)
+        dup.update(hash)
       end
 
       # Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.
@@ -109,9 +109,17 @@ module Throttling
         super(convert_key(key))
       end
 
-      def stringify_keys!; self end
-      def symbolize_keys!; self end
-      def to_options!; self end
+      def stringify_keys!
+        self
+      end
+
+      def symbolize_keys!
+        self
+      end
+
+      def to_options!
+        self
+      end
 
       # Convert to a Hash with String keys.
       def to_hash
@@ -119,31 +127,32 @@ module Throttling
       end
 
       protected
-        def convert_key(key)
-          key.kind_of?(Symbol) ? key.to_s : key
-        end
 
-        def convert_value(value)
-          case value
-          when Hash
-            value.with_indifferent_access
-          when Array
-            value.collect { |e| e.is_a?(Hash) ? e.with_indifferent_access : e }
-          else
-            value
-          end
+      def convert_key(key)
+        key.is_a?(Symbol) ? key.to_s : key
+      end
+
+      def convert_value(value)
+        case value
+        when Hash
+          value.with_indifferent_access
+        when Array
+          value.collect { |e| e.is_a?(Hash) ? e.with_indifferent_access : e }
+        else
+          value
         end
+      end
     end
 
-    module HashIndifferentAccess #:nodoc:
+    module HashIndifferentAccess # :nodoc:
       def with_indifferent_access
         hash = HashWithIndifferentAccess.new(self)
-        hash.default = self.default
+        hash.default = default
         hash
       end
     end
 
-    class ::Hash #:nodoc:
+    class ::Hash # :nodoc:
       unless respond_to?(:with_indifferent_access)
         include Throttling::HashIndifferentAccess
       end

data/lib/throttling/version.rb

@@ -1,3 +1,3 @@
 module Throttling
-  VERSION = '0.3.1'
+  VERSION = "0.4.0"
 end

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,38 @@
-# -*- 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.12.0"
+  spec.add_development_dependency "timecop", "~> 0.9.6"
+  # Code style
+  spec.add_development_dependency "standard", "~> 1.29.0"
+
+  spec.cert_chain = ["certs/kpumuk.pem"]
+  spec.signing_key = File.expand_path("~/.ssh/gem-kpumuk.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

metadata

@@ -1,83 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: throttling
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Dmytro Shteflyuk
 - Oleksiy Kovyrin
-autorequire: 
-bindir: bin
-cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+autorequire:
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MQ8wDQYDVQQDDAZrcHVt
+  dWsxFjAUBgoJkiaJk/IsZAEZFgZrcHVtdWsxFDASBgoJkiaJk/IsZAEZFgRpbmZv
+  MB4XDTIzMDcwNjEyMjY0MVoXDTI0MDcwNTEyMjY0MVowPzEPMA0GA1UEAwwGa3B1
+  bXVrMRYwFAYKCZImiZPyLGQBGRYGa3B1bXVrMRQwEgYKCZImiZPyLGQBGRYEaW5m
+  bzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALw2YroZc+IT+rs8NuPu
+  c13DelrxrpAgPEu1zuRb3l7WaHRNWA4TyS8Z6Aa1G2O+FdUZNMW1n7IwP/QMJ9Mz
+  ahRBiTmhik5kasJ9s0h1lq5/hZiycm0o5OtGioUzCkvk+UEMpzMHbLmVSZCzYciy
+  NDRDbXB0rLLu1eJk+gKgn6Qf5vj93h1w28BdWdaA7YegtbmipZ+pjmzCQAfPActT
+  6uXHG4dSo7Lz9jiFRI5dUizFbGXcRqkQ2b5AB8FFmfcvbqERvzQKBICnybjsKP0N
+  pJ3vGgO2sh5GvJFOPk1Vlur2nX9ZFznPEP1CEAQ+NFrmKRt355Z5sgOkAojSGnIL
+  /1sCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFPa4
+  VFc1YOlV1u/7EGTwMCAk8YE9MB0GA1UdEQQWMBSBEmtwdW11a0BrcHVtdWsuaW5m
+  bzAdBgNVHRIEFjAUgRJrcHVtdWtAa3B1bXVrLmluZm8wDQYJKoZIhvcNAQELBQAD
+  ggEBALwivjTzGErFzBtgPEQe7uO6DMysgm/OIF5jLFkvRiuFbuueHM2cUZZBx2Rd
+  2R5uQS4uiZ5KA+3SkgWQOFOzpFlo7ywS5264ULCcvfix6NQpb2aIDsZuzWGBIDbs
+  ixS+8wYslrzsOgUSn/RjF0sVB0dw4wv6G8YnVrR/Jf2SaO+Q2lYuKEOKfj52I+Yt
+  TdFiOjR+WwXSxs/XdSdFtqK2q/THbZdk+HkAe8guvXYtD/fzO2mBlk2AQ0hV1Pxu
+  ovz1LEphwrX/6v635mteXvl+OKWrNo1Q78sU364BgY5MvJMxFytmUrKMgO6RAiIM
+  N9+lhJiLa7+h0LrvPPDZRhV8ze0=
+  -----END CERTIFICATE-----
+date: 2023-07-06 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.12.0
   type: :development
   prerelease: false
-  version_requirements: *70097466943660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.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
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70097466942820 !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: *70097466942820
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: &70097466942400 !ruby/object:Gem::Requirement
-    none: false
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.29.0
   type: :development
   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
+        version: 1.29.0
 description: Throttling gem provides basic, but very powerful way to throttle various
   user actions in your application
 email:
@@ -86,10 +97,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - Gemfile
-- Guardfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -97,38 +107,34 @@ files:
 - 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'
+post_install_message:
 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.4.10
+signing_key:
+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

data/spec/throttling_spec.rb

@@ -1,103 +0,0 @@
-require 'spec_helper'
-
-describe Throttling do
-  after :each do
-    Throttling.reset_defaults!
-  end
-
-  context 'with defaults' do
-    it 'should create logger' do
-      Throttling.logger.should be_a(Logger)
-    end
-
-    it 'should be enabled' do
-      Throttling.enabled?.should be_true
-      Throttling.enabled.should be_true
-    end
-
-    it 'should set config file path' do
-      Throttling.limits_config.should == "#{Dir.pwd}/config/throttling.yml"
-    end
-  end
-
-  context 'setters' do
-    it 'should allow to enabled and disable client' do
-      Throttling.enabled = false
-      Throttling.should_not be_enabled
-
-      Throttling.enable!
-      Throttling.should be_enabled
-
-      Throttling.disable!
-      Throttling.should_not be_enabled
-
-      Throttling.enabled = true
-      Throttling.should be_enabled
-    end
-
-    it 'should allow to change logger' do
-      mock = Throttling.logger = mock('Logger')
-      Throttling.logger.should be(mock)
-    end
-
-    it 'should allow to set limits' do
-      limits = { 'foo' => {'limit' => 5, 'period' => 2} }
-      Throttling.limits = limits
-      Throttling.limits.should == limits
-    end
-
-    it 'should allow to change config file path' do
-      path = File.expand_path('../fixtures/throttling.yml', __FILE__)
-      Throttling.limits_config = path
-      Throttling.limits_config.should == path
-    end
-  end
-
-  describe '.for' do
-    it "should return a throttling class instance" do
-      Throttling.limits = { 'foo' => {'limit' => 5, 'period' => 2} }
-      Throttling.for('foo').should be_instance_of(Throttling::Base)
-    end
-
-    it "should raise an exception if no throttling_limits found in config" do
-      Throttling.limits = nil
-      lambda { Throttling.for('foo') }.should raise_error(ArgumentError)
-    end
-
-    it "should raise an exception if no throttling_limits[action] found in config" do
-      Throttling.limits = { 'foo' => nil }
-      lambda { Throttling.for('foo') }.should raise_error(ArgumentError)
-    end
-  end
-
-  describe 'limits' do
-    context 'when set using .limits' do
-      it 'should convert Hash to HashWithIndifferentAccess' do
-        Throttling.limits = { 'foo' => {'limit' => 5, 'period' => 2} }
-        Throttling.limits.should have_key(:foo)
-        Throttling.limits.should have_key('foo')
-        Throttling.limits[:foo].should have_key(:limit)
-        Throttling.limits[:foo].should have_key('limit')
-      end
-    end
-
-    context 'when set using .limits_config' do
-      before do
-        Throttling.limits_config = File.expand_path('../fixtures/throttling.yml', __FILE__)
-      end
-
-      it 'should load limits from configuration file' do
-        Throttling.limits.should be_kind_of(Hash)
-        Throttling.limits.should have_key('search_requests')
-        Throttling.limits.should have_key('user_signup')
-      end
-
-      it 'should convert Hash to HashWithIndifferentAccess' do
-        Throttling.limits.should have_key(:search_requests)
-        Throttling.limits.should have_key('search_requests')
-        Throttling.limits[:search_requests].should have_key(:daily)
-        Throttling.limits[:search_requests].should have_key('daily')
-      end
-    end
-  end
-end