berater 0.0.1 → 0.1.4

data/spec/rate_limiter_spec.rb

@@ -0,0 +1,166 @@
+describe Berater::RateLimiter do
+  before { Berater.mode = :rate }
+
+  describe '.new' do
+    let(:limiter) { described_class.new(1, :second) }
+
+    it 'initializes' do
+      expect(limiter.count).to eq 1
+      expect(limiter.interval).to eq 1
+    end
+
+    it 'has default values' do
+      expect(limiter.key).to eq described_class.to_s
+      expect(limiter.redis).to be Berater.redis
+    end
+  end
+
+  describe '#count' do
+    def expect_count(count)
+      limiter = described_class.new(count, :second)
+      expect(limiter.count).to eq count
+    end
+
+    it { expect_count(0) }
+    it { expect_count(1) }
+    it { expect_count(100) }
+
+    context 'with erroneous values' do
+      def expect_bad_count(count)
+        expect do
+          described_class.new(count, :second)
+        end.to raise_error ArgumentError
+      end
+
+      it { expect_bad_count(0.5) }
+      it { expect_bad_count(-1) }
+      it { expect_bad_count('1') }
+      it { expect_bad_count(:one) }
+    end
+  end
+
+  describe '#interval' do
+    def expect_interval(interval, expected)
+      limiter = described_class.new(1, interval)
+      expect(limiter.interval).to eq expected
+    end
+
+    context 'with ints' do
+      it { expect_interval(0, 0) }
+      it { expect_interval(1, 1) }
+      it { expect_interval(33, 33) }
+    end
+
+    context 'with symbols' do
+      it { expect_interval(:sec, 1) }
+      it { expect_interval(:second, 1) }
+      it { expect_interval(:seconds, 1) }
+
+      it { expect_interval(:min, 60) }
+      it { expect_interval(:minute, 60) }
+      it { expect_interval(:minutes, 60) }
+
+      it { expect_interval(:hour, 3600) }
+      it { expect_interval(:hours, 3600) }
+    end
+
+    context 'with strings' do
+      it { expect_interval('sec', 1) }
+      it { expect_interval('minute', 60) }
+      it { expect_interval('hours', 3600) }
+    end
+
+    context 'with erroneous values' do
+      def expect_bad_interval(interval)
+        expect do
+          described_class.new(1, interval)
+        end.to raise_error(ArgumentError)
+      end
+
+      it { expect_bad_interval(-1) }
+      it { expect_bad_interval(:secondz) }
+      it { expect_bad_interval('huor') }
+    end
+  end
+
+  describe '#limit' do
+    let(:limiter) { described_class.new(3, :second) }
+
+    it 'works' do
+      expect(limiter.limit).to eq 1
+    end
+
+    it 'counts' do
+      expect(limiter.limit).to eq 1
+      expect(limiter.limit).to eq 2
+      expect(limiter.limit).to eq 3
+    end
+
+    it 'yields' do
+      expect {|b| limiter.limit(&b) }.to yield_control
+      expect(limiter.limit { 123 }).to eq 123
+    end
+
+    it 'limits excessive calls' do
+      3.times { limiter.limit }
+
+      expect { limiter.limit }.to be_overrated
+    end
+
+    it 'limit resets over time' do
+      expect(limiter.limit).to eq 1
+      expect(limiter.limit).to eq 2
+      expect(limiter.limit).to eq 3
+      expect(limiter).to be_overrated
+
+      # travel forward a second
+      Timecop.freeze(1)
+
+      expect(limiter.limit).to eq 1
+      expect(limiter.limit).to eq 2
+      expect(limiter.limit).to eq 3
+      expect(limiter).to be_overrated
+    end
+  end
+
+  context 'with same key, different limiters' do
+    let(:limiter_one) { described_class.new(1, :second) }
+    let(:limiter_two) { described_class.new(1, :second) }
+
+    it 'works as expected' do
+      expect(limiter_one.limit).to eq 1
+
+      expect { limiter_one }.to be_overrated
+      expect { limiter_two }.to be_overrated
+    end
+  end
+
+  context 'with different keys, same limiter' do
+    let(:limiter) { described_class.new(1, :second) }
+
+    it 'works as expected' do
+      expect { limiter.limit(key: :one) }.not_to be_overrated
+      expect { limiter.limit(key: :one) }.to be_overrated
+
+      expect { limiter.limit(key: :two) }.not_to be_overrated
+      expect { limiter.limit(key: :two) }.to be_overrated
+    end
+  end
+
+  context 'with different keys, different limiters' do
+    let(:limiter_one) { described_class.new(1, :second, key: :one) }
+    let(:limiter_two) { described_class.new(2, :second, key: :two) }
+
+    it 'works as expected' do
+      expect(limiter_one.limit).to eq 1
+      expect(limiter_two.limit).to eq 1
+
+      expect { limiter_one.limit }.to be_overrated
+      expect(limiter_two.limit).to eq 2
+
+      expect { limiter_one.limit }.to be_overrated
+      expect { limiter_two.limit }.to be_overrated
+    end
+  end
+
+end

data/spec/unlimiter_spec.rb

@@ -0,0 +1,61 @@
+describe Berater::Unlimiter do
+  before { Berater.mode = :unlimited }
+
+  describe '.new' do
+    it 'initializes without any arguments or options' do
+      expect(described_class.new).to be_a described_class
+    end
+
+    it 'initializes with any arguments and options' do
+      expect(described_class.new(:abc, x: 123)).to be_a described_class
+    end
+
+    it 'has default values' do
+      expect(described_class.new.key).to eq described_class.to_s
+      expect(described_class.new.redis).to be Berater.redis
+    end
+  end
+
+  describe '.limit' do
+    it 'works' do
+      expect(described_class.limit).to be_nil
+    end
+
+    it 'yields' do
+      expect {|b| described_class.limit(&b) }.to yield_control
+    end
+
+    it 'is never overloaded' do
+      10.times do
+        expect { described_class.limit }.not_to be_overloaded
+      end
+    end
+
+    it 'works with any arguments or options' do
+      expect(described_class.limit(:abc, x: 123)).to be_nil
+    end
+  end
+
+  describe '#limit' do
+    let(:limiter) { described_class.new }
+
+    it 'works' do
+      expect(limiter.limit).to be_nil
+    end
+
+    it 'yields' do
+      expect {|b| limiter.limit(&b) }.to yield_control
+    end
+
+    it 'is never overloaded' do
+      10.times do
+        expect { limiter.limit }.not_to be_overloaded
+      end
+    end
+
+    it 'works with any arguments or options' do
+      expect(limiter.limit(x: 123)).to be_nil
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berater
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Pepper
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: clockwork
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,42 +56,83 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: rate limiter
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/berater.rb
-homepage: https://github.com/dpep/berater
+- lib/berater/base_limiter.rb
+- lib/berater/concurrency_limiter.rb
+- lib/berater/inhibitor.rb
+- lib/berater/rate_limiter.rb
+- lib/berater/unlimiter.rb
+- lib/berater/version.rb
+- spec/berater_spec.rb
+- spec/concurrency_limiter_spec.rb
+- spec/concurrency_lock_spec.rb
+- spec/inhibitor_spec.rb
+- spec/matcher_spec.rb
+- spec/rate_limiter_spec.rb
+- spec/unlimiter_spec.rb
+homepage: https://github.com/dpep/berater_rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +147,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Berater
-test_files: []
+test_files:
+- spec/rate_limiter_spec.rb
+- spec/matcher_spec.rb
+- spec/concurrency_limiter_spec.rb
+- spec/concurrency_lock_spec.rb
+- spec/berater_spec.rb
+- spec/inhibitor_spec.rb
+- spec/unlimiter_spec.rb