EasyThrottle 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f50c56588d5ab29db2d607f2907c5d936cff56b9a6d4b4b2ec46befecc908427
-  data.tar.gz: 3917275880a09753c25c8487d2fb9094b690a01ab52f28e300fbe141d6cc6524
+  metadata.gz: 8f426466c8bb697b331c603be2d79d73da8d19c5d50fdcb5af75081c8f508eae
+  data.tar.gz: 503b7e3980210f7de6bea6d66b8d2a974fcc14abbaf2e02e8dda668cf5fdf744
 SHA512:
-  metadata.gz: 85e43902ecef6ead3303c67a7fe05d7fa804fcad9eb8509eb89e85a2ff334a8ceb2e06dbf5426065bf9021ccb8edcba15addfa7253875e9af76e2c02142062a6
-  data.tar.gz: 85ea1906fcb738199be91c8bc1115e709647d63d7f543802a5786dbba1638affa15af9c9a76db574f3e972a0f74e5804719d22c26fca5e320e6f5115c7419256
+  metadata.gz: f35adeade221e897e0bc6a6a00306bdea290c737ab0cb27eadc1b3321744fec3fc547cabdb4681abf9b0e91e0885239f3eaf6d8db30745b5d233fff98100b807
+  data.tar.gz: 482cc0a5e109f9938e04031dc5dc7a793aea47d0cb769e112824252375dd71a7d887331efdd6b4ff7a8aadea1a0f9684d1659b230dffb0e4edfd6dd73a5373eb

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.4.1)
+    redis (5.1.0)
+      redis-client (>= 0.17.0)
+    redis-client (0.21.0)
+      connection_pool
+
+PLATFORMS
+  ruby
+  x86_64-darwin-23
+
+DEPENDENCIES
+  redis (>= 4.0)
+
+BUNDLED WITH
+   2.5.6

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/version.rb

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

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

@@ -3,7 +3,7 @@
 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 },
@@ -34,7 +34,7 @@ class Throttler
       end
     end
     result
-  rescue *config['errors'].map(&:constantize) => e
+  rescue StandardError => e
     if e.code == 429
       extend_key_duration
       retry
@@ -46,7 +46,7 @@ class Throttler
       retry
     end
 
-    raise
+    raise e
   end
 
   def pool
@@ -70,4 +70,10 @@ class Throttler
   def extend_key_duration
     redis.psetex(burst_key, (options[:interval] + 1) * options[:burst] * 1000, true)
   end
+
+  def constantize(str)
+    str.split('::').inject(Object) do |mod, class_name|
+      mod.const_get(class_name)
+    end
+  end
 end

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.0.2
 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:
+- ".tool-versions"
+- EasyThrottle-0.0.1.gem
+- Gemfile
+- Gemfile.lock
+- easy_throttle.gemspec
 - lib/config.yml
-- lib/throttler.rb
-homepage:
+- lib/easy_throttle.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