rate-limit 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b6d225525d8976ef1c3c8e7d0fdb1c71a48071357cff8f64633117a13ab714e
-  data.tar.gz: 057bf093d1271c83795c34472cf31e273353a24621bddebb86a901b48d451e8b
+  metadata.gz: 4b73af03f6ea918dd965b1f1d89b8f7131e1fbba2b94166a397c100510c4a426
+  data.tar.gz: fcd12f564f38c214a088032b9ee912337dac4a566a1cd97c39256180e2e8e8a5
 SHA512:
-  metadata.gz: 2e6a6fe077419b22d5dcc5357fdf127ab7c944aff6e1bf9d44ece39cf56f1fc1b6b12ac400aa1a2ffdeab9964f90f7739952cda796b3f23a82748410c64b324b
-  data.tar.gz: 19f68ffd995fca03b3c6787a208649b2c11c2206dd598a6b82feea25b51451817a3f354ca5de7fd9435a6fb6a61b8ac763db37a9dc2535425627eeccfc976333
+  metadata.gz: 2a9e190cda1984c96ffd6d93751e56a323d783778c170a492d0b67b151d4a85ef83c88907526f48dc0cc574bdb19880a09667f2472b4e5873d54262e8b7dd976
+  data.tar.gz: b0529be97de2244366f3ac99f6192e7e649ff8574e15b44f51e2d56030dbcb9163238a1a03d77ed3b49d67c5669cba865c674216aa83dfe73877ab837aae02dd

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog],
+and this project adheres to [Semantic Versioning].
+
+## [Unreleased]
+
+## [v0.1.0] - 2022-09-16
+
+
+### Added
+
+- [https://github.com/catawiki/rate-limit/pull/11] `RateLimit::Result` class
+- [https://github.com/catawiki/rate-limit/pull/12] `RateLimit::Worker` class
+- [https://github.com/catawiki/rate-limit/pull/13] `RateLimit::Config#on_success` and `RateLimit::Config#on_failure`
+
+### Changed
+
+- `RateLimit.throttle` to not accept block
+- `RateLimit.throttle` to return `RateLimit::Result` object
+- `RateLimit::Throttler` from class to module while moving responsibilities to `RateLimit::Worker` class
+- renamed `RateLimit.throttle!` to `RateLimit.throttle_with_block!`
+- renamed `RateLimit.throttle_only_failures` to `RateLimit.throttle_only_failures_with_block!`
+
+### Fixed
+
+- [https://github.com/catawiki/rate-limit/issues/7] Symbol topic names does not load the correct limits
+- [https://github.com/catawiki/rate-limit/issues/6] Main Module (RateLimit) fails to autoload
+
+
+## v0.0.1 - 2022-09-09
+
+- Initial gem release
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
+
+<!-- versions -->
+
+[Unreleased]: https://github.com/catawiki/rate-limit/compare/v0.1.0...HEAD
+[v0.1.0]: https://github.com/catawiki/rate-limit/compare/v0.0.1...v0.1.0

data/README.md

@@ -33,14 +33,18 @@ Or install it yourself as:
 #### Basic `RateLimit.throttle`
 
 ```ruby
-if RateLimit.throttle(topic: :login, namespace: :user_id, value: id)
+result = RateLimit.throttle(topic: :login, namespace: :user_id, value: id)
+
+if result.success?
   # Do something
 end
 ```
 or
 
 ```ruby
-if RateLimit.throttle(topic: :login, value: id)
+result = RateLimit.throttle(topic: :login, namespace: :user_id, value: id)
+
+if result.success?
   # Do something
 end
 ```
@@ -49,7 +53,7 @@ end
 
 ```ruby
 begin
-  RateLimit.throttle!(topic: :send_sms, namespace: :user_id, value: id) do
+  RateLimit.throttle_with_block!(topic: :send_sms, namespace: :user_id, value: id) do
     # Logic goes Here
   end
 rescue RateLimit::Errors::LimitExceededError => e
@@ -65,10 +69,10 @@ end
 #### Advanced
 
 ```ruby
-throttler = RateLimit::Throttler.new(topic: :login, namespace: :user_id, value: id)
+throttler = RateLimit::Worker.new(topic: :login, namespace: :user_id, value: id)
 
 begin
-  throttler.perform! do
+  throttler.throttle_with_block! do
     # Logic goes Here
   end
 rescue RateLimit::Errors::LimitExceededError => e
@@ -79,7 +83,7 @@ end
 #### Manual
 
 ```ruby
-throttler = RateLimit::Throttler.new(topic: :login, namespace: :user_id, value: id)
+throttler = RateLimit::Worker.new(topic: :login, namespace: :user_id, value: id)
 
 unless throttler.limit_exceeded?
   # Logic goes Here
@@ -92,8 +96,8 @@ end
 
 ```ruby
 begin
-  RateLimit.throttle!(topic: :send_sms, namespace: :user_id, value: id) do
-    RateLimit.throttle!(topic: :send_sms, namespace: :phone_number, value: number) do
+  RateLimit.throttle_with_block!(topic: :send_sms, namespace: :user_id, value: id) do
+    RateLimit.throttle_with_block!(topic: :send_sms, namespace: :phone_number, value: number) do
       # Logic goes Here
     end
   end
@@ -113,6 +117,14 @@ RateLimit.configure do |config|
   config.default_interval  = 60
   config.default_threshold = 2
   config.limits_file_path  = 'config/rate-limit.yml'
+  config.on_success = proc { |result|
+    # Success Logic Goes HERE
+    # result.topic, result.namespace, result.value
+  }
+  config.on_failure = proc { |result|
+    # Failure Logic Goes HERE
+    # result.topic, result.namespace, result.value,  result.threshold,  result.interval
+  }
 end
 ```
 

data/lib/rate-limit.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rate_limit'

data/lib/rate_limit/base.rb

@@ -3,29 +3,35 @@
 module RateLimit
   module Base
     def throttle(**args)
-      throttle!(**args) { yield if block_given? }
-    rescue Errors::LimitExceededError => _e
-      false
+      worker = Worker.new(**args)
+      worker.throttle
+      worker.result
     end
 
-    def throttle!(**args)
-      Throttler.new(**args).perform! { yield if block_given? }
+    def throttle_with_block!(**args, &block)
+      worker = Worker.new(**args)
+
+      worker.throttle_with_block!(&block)
+      worker.result
     end
 
-    def throttle_only_failures!(**args)
-      Throttler.new(**args).perform_only_failures! { yield if block_given? }
+    def throttle_only_failures_with_block!(**args, &block)
+      worker = Worker.new(**args)
+
+      worker.throttle_only_failures_with_block!(&block)
+      worker.result
     end
 
     def limit_exceeded?(**args)
-      Throttler.new(**args).limit_exceeded?
+      Worker.new(**args).reloaded_limit_exceeded?
     end
 
     def reset_counters(**args)
-      Throttler.new(**args).clear_cache_counter
+      Worker.new(**args).clear_cache_counter
     end
 
     def increment_counters(**args)
-      Throttler.new(**args).increment_cache_counter
+      Worker.new(**args).increment_cache_counter
     end
   end
 end

data/lib/rate_limit/config.rb

@@ -9,6 +9,8 @@ module RateLimit
     attr_accessor :default_interval,
                   :default_threshold,
                   :limits_file_path,
+                  :on_success,
+                  :on_failure,
                   :fail_safe,
                   :redis
 
@@ -24,6 +26,14 @@ module RateLimit
       raw_limits[topic] || Defaults.raw_limits
     end
 
+    def success_callback(*args)
+      on_success&.call(*args)
+    end
+
+    def failure_callback(*args)
+      on_failure&.call(*args)
+    end
+
     private
 
     def raw_limits

data/lib/rate_limit/result.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RateLimit
+  class Result
+    # Attributes
+    attr_accessor :topic, :namespace, :value, :threshold, :interval
+
+    # Methods
+    def initialize(worker, success)
+      @topic      = worker.topic
+      @namespace  = worker.namespace
+      @value      = worker.value
+      @threshold  = worker.exceeded_window&.threshold
+      @interval   = worker.exceeded_window&.interval
+      @success    = success
+    end
+
+    def success?
+      @success
+    end
+  end
+end

data/lib/rate_limit/throttler.rb

@@ -1,57 +1,33 @@
 # frozen_string_literal: true
 
 module RateLimit
-  class Throttler
-    attr_accessor :topic, :namespace, :value, :limits, :windows
+  module Throttler
+    def throttle
+      return failure! if reloaded_limit_exceeded?
 
-    def initialize(topic:, value:, namespace: nil)
-      @topic     = topic.to_s
-      @value     = value.to_i
-      @namespace = namespace&.to_s
-      @windows   = Limit.fetch(topic).map { |limit| Window.new(self, limit) }
+      success!
     end
 
-    def perform!
-      validate_limit!
-
-      yield if block_given?
+    def throttle_with_block!
+      if reloaded_limit_exceeded?
+        failure!
+        raise Errors::LimitExceededError, exceeded_window
+      end
 
-      increment_cache_counter
+      yield
 
-      true
+      success!
     end
 
-    def perform_only_failures!
-      validate_limit!
+    def throttle_only_failures_with_block!
+      return failure! if reloaded_limit_exceeded?
 
       begin
-        yield if block_given?
+        yield
       rescue StandardError => e
-        increment_cache_counter
+        success!
         raise e
       end
-
-      true
-    end
-
-    def limit_exceeded?
-      Window.find_exceeded(windows).present?
-    end
-
-    def increment_cache_counter
-      Window.increment_cache_counter(windows)
-    end
-
-    def clear_cache_counter
-      Window.clear_cache_counter(windows)
-    end
-
-    private
-
-    def validate_limit!
-      exceeded_window = Window.find_exceeded(windows)
-
-      raise Errors::LimitExceededError, exceeded_window if exceeded_window
     end
   end
 end

data/lib/rate_limit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RateLimit
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/rate_limit/window.rb

@@ -2,14 +2,14 @@
 
 module RateLimit
   class Window
-    attr_accessor :throttler, :limit
+    attr_accessor :worker, :limit
 
-    delegate :topic, :namespace, :value, to: :throttler
+    delegate :topic, :namespace, :value, to: :worker
     delegate :threshold, :interval, to: :limit
 
-    def initialize(throttler, limit)
-      @throttler = throttler
-      @limit     = limit
+    def initialize(worker, limit)
+      @worker = worker
+      @limit = limit
     end
 
     def key
@@ -21,6 +21,10 @@ module RateLimit
     end
 
     class << self
+      def find_all(topic:, worker:)
+        Limit.fetch(topic).map { |limit| Window.new(worker, limit) }
+      end
+
       def find_exceeded(windows)
         windows.find { |w| w.cached_counter >= w.threshold }
       end

data/lib/rate_limit/worker.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RateLimit
+  class Worker
+    include Throttler
+
+    attr_accessor :topic, :namespace, :value, :limits, :windows, :exceeded_window, :result
+
+    def initialize(topic:, value:, namespace: nil)
+      @topic     = topic.to_s
+      @value     = value.to_i
+      @namespace = namespace&.to_s
+      @windows   = Window.find_all(worker: self, topic: @topic)
+    end
+
+    def increment_cache_counter
+      Window.increment_cache_counter(windows)
+    end
+
+    def clear_cache_counter
+      Window.clear_cache_counter(windows)
+    end
+
+    def reloaded_limit_exceeded?
+      @exceeded_window = Window.find_exceeded(windows)
+
+      limit_exceeded?
+    end
+
+    def limit_exceeded?
+      exceeded_window.present?
+    end
+
+    def success!
+      increment_cache_counter
+      @result = Result.new(self, true)
+      RateLimit.config.success_callback(result)
+    end
+
+    def failure!
+      @result = Result.new(self, false)
+      RateLimit.config.failure_callback(result)
+    end
+  end
+end

data/lib/rate_limit.rb

@@ -2,9 +2,11 @@
 
 require 'active_support/core_ext/module'
 require_relative 'rate_limit/configurable'
+require_relative 'rate_limit/result'
 require_relative 'rate_limit/cache'
 require_relative 'rate_limit/window'
 require_relative 'rate_limit/throttler'
+require_relative 'rate_limit/worker'
 require_relative 'rate_limit/limit'
 require_relative 'rate_limit/errors/limit_exceeded_error'
 require_relative 'rate_limit/base'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rate-limit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mohamed Motaweh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,6 +60,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- lib/rate-limit.rb
 - lib/rate_limit.rb
 - lib/rate_limit/base.rb
 - lib/rate_limit/cache.rb
@@ -69,9 +70,11 @@ files:
 - lib/rate_limit/configurable.rb
 - lib/rate_limit/errors/limit_exceeded_error.rb
 - lib/rate_limit/limit.rb
+- lib/rate_limit/result.rb
 - lib/rate_limit/throttler.rb
 - lib/rate_limit/version.rb
 - lib/rate_limit/window.rb
+- lib/rate_limit/worker.rb
 homepage: https://github.com/catawiki/rate-limit
 licenses:
 - MIT
@@ -95,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A Rate Limiting Gem