EasyThrottle 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f426466c8bb697b331c603be2d79d73da8d19c5d50fdcb5af75081c8f508eae
-  data.tar.gz: 503b7e3980210f7de6bea6d66b8d2a974fcc14abbaf2e02e8dda668cf5fdf744
+  metadata.gz: 9332a078cd5d2315222eb5c21cb7b962eab5675fc37dcb3b735a363965df105e
+  data.tar.gz: 68bb1a74c62fb3c6a7fbaf9e943c7b1bca0c825c39c6a15b85ddd2c8349f3692
 SHA512:
-  metadata.gz: f35adeade221e897e0bc6a6a00306bdea290c737ab0cb27eadc1b3321744fec3fc547cabdb4681abf9b0e91e0885239f3eaf6d8db30745b5d233fff98100b807
-  data.tar.gz: 482cc0a5e109f9938e04031dc5dc7a793aea47d0cb769e112824252375dd71a7d887331efdd6b4ff7a8aadea1a0f9684d1659b230dffb0e4edfd6dd73a5373eb
+  metadata.gz: 42612634bbab62c840994e2f5b4593211cce22d19c69efe1ded7e6ed2b82a21e6209b725b1db71852a3175298824899dee5af6d6825de64ec34cb3c109346239
+  data.tar.gz: 8395d6b5e34d5db37b530a5805fb8696c88fb9e13600aa9d6537570c24ea601687446f30af4986ee24b09df37396852fd71dc4c0a4dfdc8b7b93f6874d71aa18

data/.gitignore

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

data/easy_throttle.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   
   s.add_runtime_dependency 'redis', '~> 4.0'
   
-  s.files       = `git ls-files`.split("\n")
+  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

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

data/lib/easy_throttle.rb

@@ -1,24 +1,19 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'redis'
 
 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 EasyThrottle
       end
     end
     result
-  rescue StandardError => e
+  rescue EasyThrottle.configuration.errors => e
     if e.code == 429
       extend_key_duration
       retry
@@ -46,7 +41,7 @@ class EasyThrottle
       retry
     end
 
-    raise e
+    raise EasyThrottle::Error.new(msg: e.message, error: e)
   end
 
   def pool
@@ -70,10 +65,4 @@ class EasyThrottle
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: EasyThrottle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Damian Szalbierz
@@ -31,13 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".tool-versions"
-- EasyThrottle-0.0.1.gem
+- ".gitignore"
 - Gemfile
-- Gemfile.lock
 - easy_throttle.gemspec
-- lib/config.yml
 - 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

data/.tool-versions

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

data/Gemfile.lock

@@ -1,18 +0,0 @@
-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/lib/config.yml

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