Limiter

Limiter.dev enables building rate limits for your application with ease. It provides a simple interface to define rate limits and track usage.

Usage

Generate API Token

Before using the gem you must register at https://limiter.dev and generate an token to interact with the api. Thereafter, add the token to app's environment variable

LIMITER_TOKEN: [GENERATED TOKEN]

Install the gem

In the Gemfile add the following

gem "limiter-ruby"

Configure the gem

In the config/initializers/limiter.rb file add the following

Limiter.configure do |config|
  config.api_token = ENV["LIMITER_TOKEN"]
  config.raise_errors = true
end

Simple Rate Limit Example

Sample API controller that checks the rate limit for the current user and increments the request count

class ApiController < ApplicationController
  before_action :rate_limit

  def index
    # Good to continue
  end

  private
  def rate_limit
    # check the rate limit for the current user and increment the request count
    rate_limit = limiter.check(current_user.id)

    if rate_limit.exceeded?
      render json: { error: "Rate limit exceeded" }, status: :too_many_requests
    end
  end

  # Allow 120 requests per minute
  def limiter
    Limiter::Client.new(namespace: "openai", limit: 120, interval: 1.minute)
  end
end

Points Rate Limit Example

Sample ActiveJob that checks the rate limit for the shop and updates the request count

class DataSyncJob < ApplicationJob
  queue_as :default

  def perform
    rate_limit = limiter.check(shop.id)
    if rate_limit.exhausted?
      self.class.set(wait: rate_limit.resets_in).perform_later
      return
    end

    # continue the action
    response = ... # query_cost = 100

    limiter.used(response.query_cost) # mark 100 points used
  end

 # Allow 1000 points per minute
  def limiter
    Limiter::Points.new(namespace: "shopify", limit: 1000, interval: 20.seconds)
  end
end

limiter-ruby