limiter-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89a952e1a844303c615335021b9d5b8dc63d02ef09036f73aa28cd16b191875f
+  data.tar.gz: 8475379bf65884d9376d2d37544900847712c8434b0ef1197d3427d7d5ccc276
+SHA512:
+  metadata.gz: d035c3075ca83f56ecd77afa1f190e0ea76bfdb7266fcf934f50b49e72be0e5c3ad7bd3440d16ad4b4177a7d3b92060f082dea62345afd4a9968f2ed9e3e199b
+  data.tar.gz: 0604d0feffafebcb9462424fc24160ffd025f695d7a4b8e4237a34f93ba1fcb50cf2e075784e9ce1a59fcbecdda60abde265c2f58c15582fe4a1dfc7aba510c0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at bilal@bilalbudhani.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 bilal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Limiter
+
+[Limiter.dev](https://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
+
+```ruby
+gem "limiter"
+```
+
+## Integrate
+
+Assuming this is a Ruby on Rails app within ActiveJob
+
+```ruby
+class ExpensiveJob < ApplicationJob
+
+  def perform
+    rate_limit = limiter.check(user.id) # A unique identifier
+
+    if rate_limit.exhausted? # Rate limit got hit
+      self.class.set(wait: rate_limit.resets_in).perform_later(..args)
+      return
+    end
+
+    # Good to continue expensive operation
+    # ...
+  end
+
+  private
+  def limiter
+    Limiter::Client.new(namespace: "openai", limit: 60, period: 1.minute)
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/limiter/client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Limiter
+  class Client
+
+    BASE_DOMAIN = "https://api.limiter.dev".freeze
+
+    attr_reader :namespace, :limit, :period, :identifier, :token
+
+    def initialize(namespace:, limit:, period:)
+      @namespace = namespace
+      @limit = limit
+      @period = period.to_i
+      @token = ENV["LIMITER_TOKEN"]
+
+      ErrorHandler.error("LIMITER_TOKEN environment variable is not set") if @token.nil?
+    end
+
+    def check(identifier)
+      @identifier = identifier
+      RateLimitResponse.new(request)
+    end
+
+    def formatted_period
+      case @period
+      when 60..3599
+        (@period / 60).to_s + "m"
+      when 3600..86_399
+        (@period / 3600).to_s + "h"
+      when 86_400..1_209_599
+        (@period / 86_400).to_s + "d"
+      else
+        ErrorHandler.error("Invalid period")
+      end
+    end
+
+    def url
+      "#{BASE_DOMAIN}/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
+    end
+
+    def request
+      HTTP.get(url, params: { token: token})
+    end
+  end
+end

data/lib/limiter/error_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require "logger"
+
+module Limiter
+  class ErrorHandler
+    def self.error(error)
+      new(error).handle_error
+    end
+
+    def initialize(error)
+      @error = error
+    end
+
+    def handle_error
+      if !production?
+        raise Error, @error
+      else
+        log @error
+      end
+    end
+
+    def production?
+      if defined?(Rails)
+        Rails.env.production?
+      else
+        (ENV["RACK_ENV"] || ENV["RAILS_ENV"] ) == "production"
+      end
+    end
+
+    def log(error)
+      @logger ||= Logger.new(STDOUT)
+      @logger.error(error)
+    end
+  end
+end

data/lib/limiter/rate_limit_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Limiter
+  class RateLimitResponse
+
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def exhausted?
+      signed_request? && @response.status == 429
+    end
+
+    def allowed?
+      signed_request? && @response.status == 200
+    end
+
+    def resets_in
+      if signed_request? && !resets_at.nil?
+        (Time.parse(resets_at) - Time.now).to_i
+      else
+        0
+      end
+    end
+
+    def signed_request?
+      @response.headers["X-Limiter-Signed"].to_s == "true"
+    end
+
+    private
+    def rate_limit_data
+      @_body ||= @response.parse
+    end
+
+    def resets_at
+      rate_limit_data["resetsAt"]
+    end
+  end
+end

data/lib/limiter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Limiter
+  VERSION = "0.1.0"
+end

data/lib/limiter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "http"
+require_relative "limiter/client"
+require_relative "limiter/rate_limit_response"
+require_relative "limiter/error_handler"
+require_relative "limiter/version"
+
+module Limiter
+  class Error < StandardError; end
+end

data/limiter.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/limiter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "limiter-ruby"
+  spec.version = Limiter::VERSION
+  spec.authors = ["Bilal Budhani"]
+  spec.email = ["bilal@bilalbudhani.com"]
+
+  spec.summary = "Easily Build & Track Rate Limits"
+  spec.description = "Limiter enables building rate limits for your application with ease. It provides a simple interface to define rate limits and track usage."
+  spec.homepage = "https://limiter.dev"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bilalbudhani/limiter-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/bilalbudhani/limiter-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "http", "~> 5.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: limiter-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bilal Budhani
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Limiter enables building rate limits for your application with ease.
+  It provides a simple interface to define rate limits and track usage.
+email:
+- bilal@bilalbudhani.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/limiter.rb
+- lib/limiter/client.rb
+- lib/limiter/error_handler.rb
+- lib/limiter/rate_limit_response.rb
+- lib/limiter/version.rb
+- limiter.gemspec
+homepage: https://limiter.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://limiter.dev
+  source_code_uri: https://github.com/bilalbudhani/limiter-ruby
+  changelog_uri: https://github.com/bilalbudhani/limiter-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Easily Build & Track Rate Limits
+test_files: []