ratelimitcop 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0be667d421af5154e7b84f403f06b8035155e7ee93f38a22bbeff92d022212
-  data.tar.gz: 350a30c2bee3c06f2b43f8926a34cd4f453a15787c31f74f595b7672aca1446b
+  metadata.gz: ac7981e5e89bda694b6285142af637d00500a08d5745e51b9306cbf4729d9049
+  data.tar.gz: d047720c407c6e7305f84ec9a3e812f39f964b2ab7038d04734eb8fea31b76e4
 SHA512:
-  metadata.gz: 2f604b755935a82868411aac1d95c5f6419c74ec0e047a3f7eee4d6734cf871dba6fc71f0cc89be001f098ea9bdfea27673aaef1fd14cbf6027f83781adef7ba
-  data.tar.gz: 3fd73c8d828bf2e1573d8611c33f1a532383c758ea5a2651ff6fa2d4b95741a948eea4aae28f739292e34653869d37fe5ad0a3c3a62c4a0b64f64f926366b639
+  metadata.gz: c485ff903fdb437b49bb809932298bc6bbd2a12cc5da6bd255096e742ba6429704ca70bb6463b3f3bc724db0e3d7c97852f80c4347b194b0fb754edeaae84346
+  data.tar.gz: 5f09f2e566e80108c54fbb3e77c915a7faae8f4c76897e0a7b40adf225165c28bb0e7adf7b616d298660212315e4f83058608f0f4c77388e98da8a736641fd29

data/.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+# v1.1.0
+ * [#5](https://github.com/koffeefinance/ratelimitcop/pull/5) Simplify `initialize` method to hide bucket configs in an `options` map - [@mathu97](https://github.com/mathu97).
+ * [#5](https://github.com/koffeefinance/ratelimitcop/pull/5) Add `execute` method that calls `add` and blocks if rate limit is exceeded before running user's code block - [@mathu97](https://github.com/mathu97).
+ * [#5](https://github.com/koffeefinance/ratelimitcop/pull/5) Add `DummyAPI` class for testing purposes, that can be used to simulate a rate limited API - [@mathu97](https://github.com/mathu97). 
+
 # v1.0.1
  * Renaming of classes to match gem name - [@mathu97](https://github.com/mathu97).
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ratelimitcop (1.0.1)
+    ratelimitcop (1.1.0)
       redis (~> 4.4)
       redis-namespace (~> 1.8.1)
 

data/README.md

@@ -1,8 +1,8 @@
 # Ratelimitcop
 
-[![Gem Version](https://badge.fury.io/rb/ratelimitcop.svg)](https://badge.fury.io/rb/ratelimitcop)
+[![Gem Version](https://badge.fury.io/rb/ratelimitcop.svg)](https://badge.fury.io/rb/ratelimitcop) ![Build Status](https://github.com/koffeefinance/ratelimitcop/actions/workflows/ruby.yml/badge.svg)
 
-Ratelimitcop is a redis backed rate limiter. Appropriate for use cases where in-memory rate limiting would not work (i.e rate limiting across multiple processes, servers, apps, etc).
+Ratelimitcop is a Redis backed rate limiter. Appropriate for use cases where in-memory rate limiting would not work (i.e rate limiting across multiple processes, servers, apps, etc).
 
 ## Installation
 
@@ -22,7 +22,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+
+To rate limit calling a block of code, simply initialize `Ratelimitcop` with a `threshold` and `interval`, then pass the block of code to the `execute` method. `threshold` is the maximum number of requests that can be made within a timed `interval`, where `interval` is in seconds. `execute` will automatically block if the execution of your code block will exceed the given rate limit.
+
+Note: You need let Ratelimitcop know how it can connect to your Redis instance (or it will default to `localhost`, port 6379, as per the [Redis gem docs](https://www.rubydoc.info/gems/redis#getting-started)). To do this pass your Redis connection config as a parameter when intializing Ratelimitcop. View the [Redis gem docs](https://www.rubydoc.info/gems/redis#getting-started) to see the different ways you can connect Ratelimitcop to your Redis instance.
+
+Here is an example of an API client that uses Ratelimitcop to ensure the API's rate limits are not exceeded.
+
+```ruby
+  require `iex-ruby-client`
+  require `ratelimitcop`
+
+  class IEXCloudAPIClient
+    def initialize
+      # rate limit 100 calls per second
+      @limiter = Ratelimitcop.new(
+        name: 'iex_cloud_api',
+        threshold: 100,
+        interval: 1,
+        redis: {
+          url: ENV['REDIS_URL']
+        }
+      )
+
+      @client = IEX::Api::Client.new
+    end
+
+    def quote(ticker:)
+      # regardless of how this method is called it will block if the rate limit is exceeded before trying to run the code block
+      @limiter.execute do
+        res = @client.quote(URI.encode(ticker))
+        res
+      end
+    end
+  end
+```
 
 ## Development
 

data/lib/errors.rb

@@ -0,0 +1 @@
+class InvalidBucketConfigError < StandardError; end

data/lib/ratelimitcop/version.rb

@@ -1,3 +1,3 @@
 class Ratelimitcop
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/ratelimitcop.rb

@@ -1,23 +1,25 @@
 require 'ratelimitcop/version'
 require 'redis'
 require 'redis-namespace'
+require_relative 'errors'
 
 class Ratelimitcop
-  attr_reader :name, :threshold, :interval, :time_span, :bucket_span
+  attr_reader :name, :threshold, :interval
 
-  def initialize(name:, threshold:, interval:, redis_connection: {}, time_span: 600, bucket_span: 5)
+  def initialize(name:, threshold:, interval:, redis: {}, options: {})
     @name = name
     @threshold = threshold
     @interval = interval
-    @time_span = time_span
-    @bucket_span = bucket_span
+    @bucket_interval = options[:bucket_interval] ||= 5
+    @bucket_time_span = options[:bucket_time_span] ||= 600
+    @bucket_span = options[:bucket_span] ||= @bucket_interval
 
-    raise ArgumentError if @interval > @time_span || @interval < @bucket_span
+    raise InvalidBucketConfigError if @bucket_interval > @bucket_time_span || @bucket_interval < @bucket_span
 
-    @redis ||= Redis::Namespace.new(:limiter, redis: Redis.new(redis_connection))
+    @redis ||= Redis::Namespace.new(:limiter, redis: Redis.new(redis))
 
-    @all_buckets_count = (@time_span / @bucket_span).floor
-    @sliding_window_buckets_count = (@interval.to_f / @bucket_span).floor
+    @all_buckets_count = (@bucket_time_span / @bucket_span).floor
+    @sliding_window_buckets_count = (@bucket_interval.to_f / @bucket_span).floor
   end
 
   def add(count: 1)
@@ -46,6 +48,13 @@ class Ratelimitcop
     end.map(&:to_i).sum
   end
 
+  def execute(&block)
+    add
+    exec_within_threshold do
+      block.call
+    end
+  end
+
   def exec_within_threshold
     sleep @bucket_span while exceeded?
     yield

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ratelimitcop
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Mathusan Selvarajah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -117,6 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -126,6 +127,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/errors.rb
 - lib/ratelimitcop.rb
 - lib/ratelimitcop/version.rb
 - ratelimitcop.gemspec