EasyThrottle 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f50c56588d5ab29db2d607f2907c5d936cff56b9a6d4b4b2ec46befecc908427
-  data.tar.gz: 3917275880a09753c25c8487d2fb9094b690a01ab52f28e300fbe141d6cc6524
+  metadata.gz: 9332a078cd5d2315222eb5c21cb7b962eab5675fc37dcb3b735a363965df105e
+  data.tar.gz: 68bb1a74c62fb3c6a7fbaf9e943c7b1bca0c825c39c6a15b85ddd2c8349f3692
 SHA512:
-  metadata.gz: 85e43902ecef6ead3303c67a7fe05d7fa804fcad9eb8509eb89e85a2ff334a8ceb2e06dbf5426065bf9021ccb8edcba15addfa7253875e9af76e2c02142062a6
-  data.tar.gz: 85ea1906fcb738199be91c8bc1115e709647d63d7f543802a5786dbba1638affa15af9c9a76db574f3e972a0f74e5804719d22c26fca5e320e6f5115c7419256
+  metadata.gz: 42612634bbab62c840994e2f5b4593211cce22d19c69efe1ded7e6ed2b82a21e6209b725b1db71852a3175298824899dee5af6d6825de64ec34cb3c109346239
+  data.tar.gz: 8395d6b5e34d5db37b530a5805fb8696c88fb9e13600aa9d6537570c24ea601687446f30af4986ee24b09df37396852fd71dc4c0a4dfdc8b7b93f6874d71aa18

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.tool-versions
+EasyThrottle-*.gem

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'redis', '>= 4.0'

data/easy_throttle.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'easy_throttle/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'EasyThrottle'
+  s.version     = EasyThrottle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Damian Szalbierz"]
+  s.email       = ['szalbierz.d.k@gmail.com']
+  s.homepage    = 'https://github.com/Szalbik/easy_throttle'
+  s.summary     = "Allows you to throttle requests to an API."
+  s.licenses    = ['MIT']
+  
+  s.add_runtime_dependency 'redis', '~> 4.0'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/easy_throttle/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EasyThrottle
+  class Configuration
+    attr_accessor :interval, :limit, :burst, :errors, :limits
+
+    def initialize
+      @interval = 60
+      @limit = 1
+      @burst = 20
+      @errors = [AmzSpApi::ApiError]
+      @limits = {}
+    end
+
+    def add_error(error)
+      @errors << error
+    end
+
+    # Options example: { interval: 10, limit: 1, burst: 1 }
+    def add_limit(endpoint, options = {})
+      @limits[endpoint] = options
+    end
+  end
+end

data/lib/easy_throttle/easy_throttle.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EasyThrottle
+  class << self
+    # Instantiate the Configuration singleton
+    # or return it. Remember that the instance
+    # has attribute readers so that we can access
+    # the configured values
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # This is the configure block definition.
+    # The configuration method will return the
+    # Configuration singleton, which is then yielded
+    # to the configure block. Then it's just a matter
+    # of using the attribute accessors we previously defined
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/easy_throttle/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module EasyThrottle
+  class Error < StandardError
+    def initialize(msg: 'Rate limit exceeded', error: nil)
+      super
+    end
+  end
+end

data/lib/easy_throttle/version.rb

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

data/lib/{throttler.rb → easy_throttle.rb}

@@ -1,24 +1,19 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'redis'
 
-class Throttler
+class EasyThrottle
   DEFAULT_OPTIONS = { interval: 60, limit: 1, burst: 20 }.freeze
-  LIMITS = {
-  #   'endpointName' => { interval: 10, limit: 1, burst: 1 },
-  }.freeze
 
   def self.with_throttling(endpoint, prefix, options = DEFAULT_OPTIONS, &block)
     new(endpoint, prefix, options).with_throttling { block.call }
   end
 
   def initialize(endpoint, prefix, options = DEFAULT_OPTIONS)
-    @config = YAML.load_file('lib/config.yml')
     @endpoint = endpoint
     @prefix = prefix
     @redis = Redis.new
-    @options = LIMITS.fetch(endpoint, options)
+    @options = EasyThrottle.configuration.limits.fetch(endpoint, options)
   end
 
   def with_throttling(&block)
@@ -34,7 +29,7 @@ class Throttler
       end
     end
     result
-  rescue *config['errors'].map(&:constantize) => e
+  rescue EasyThrottle.configuration.errors => e
     if e.code == 429
       extend_key_duration
       retry
@@ -46,7 +41,7 @@ class Throttler
       retry
     end
 
-    raise
+    raise EasyThrottle::Error.new(msg: e.message, error: e)
   end
 
   def pool

data/test/test_easy_throttle.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require_relative '../lib/throttler'
+
+class ThrottlerTest < Minitest::Test
+  def setup
+    @endpoint = 'getItemOffers'
+    @prefix = 'US'
+    @redis = Minitest::Mock.new
+    @options = Throttler::DEFAULT_OPTIONS
+    @burst_key = "#{@prefix}:#{@endpoint}:burst"
+    @subject = Throttler.new(@endpoint, @prefix, @options)
+  end
+
+  def test_initialize
+    assert_equal @endpoint, @subject.instance_variable_get(:@endpoint)
+    assert_equal @prefix, @subject.instance_variable_get(:@prefix)
+    assert_equal @options, @subject.instance_variable_get(:@options)
+  end
+
+  def test_with_throttling
+    block = proc { 'result' }
+    @redis.expect(:pttl, 0)
+    @redis.expect(:psetex, true)
+    assert_equal 'result', @subject.with_throttling(&block)
+  end
+
+  def test_with_throttling_when_api_error_with_code_429_occurs
+    block = proc { raise StandardError.new(code: 429) }
+    assert_raises(StandardError) { @subject.with_throttling(&block) }
+    assert_mock @redis
+  end
+
+  def test_with_throttling_when_api_error_with_code_500_occurs
+    block = proc { raise StandardError.new(code: 500) }
+    assert_raises(StandardError) { @subject.with_throttling(&block) }
+    assert_mock @redis
+  end
+end

metadata

@@ -1,38 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: EasyThrottle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Damian Szalbierz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 description:
-email: szalbierz.d.k@gmail.com
+email:
+- szalbierz.d.k@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/config.yml
-- lib/throttler.rb
-homepage:
+- ".gitignore"
+- Gemfile
+- easy_throttle.gemspec
+- lib/easy_throttle.rb
+- lib/easy_throttle/configuration.rb
+- lib/easy_throttle/easy_throttle.rb
+- lib/easy_throttle/error.rb
+- lib/easy_throttle/version.rb
+- test/test_easy_throttle.rb
+homepage: https://github.com/Szalbik/easy_throttle
 licenses:
 - MIT
 metadata: {}
@@ -51,8 +59,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Allows you to throttle requests to an API.
-test_files: []
+test_files:
+- test/test_easy_throttle.rb

data/lib/config.yml

@@ -1,3 +0,0 @@
-errors:
-  - 'AmzSpApi::ApiError'
-