limiter-ruby 0.1.6 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 485bbca55de62c9f4f26acd63a54be1ac0f4f98fab77ad9a6611be7b04913d6b
-  data.tar.gz: b6e3974fb4233c543dba8642d2cb53744b3786a46dff6bbc9371ed7e6d432b33
+  metadata.gz: 2ec1028bbed03695ce7f6722da569723cbe4dbe54a692c8b3b161dde3aa9b3e7
+  data.tar.gz: 954bf67ede37fad7012f0b82e375901db14e2ed7f63ca5b7421f286810cba977
 SHA512:
-  metadata.gz: f0ce5be7e224522c5bd6c1a8402422bc705ee87d0f500d5f6447326f28713c7d3ba0929683f1a1447dfca43ce1ff55c3e1dd7ee73f521f9746517be2200759f7
-  data.tar.gz: 2e174243e3fbf40de0f7b4f726ffd3523ead0defe09275abf18dabb35e6eba984f86530d39d8d4461cb052283210170ad6353750d5c8a3c7b466ca437fe23307
+  metadata.gz: 7e5b789e9516d90cf049e2027b9bac3c0967ccac67445ba5a1856cfcc21ef22e5d0b63a2dc56da3bc055c2d0a4cece9291638ee42655ad579de39ad68af30d16
+  data.tar.gz: 4599777458c083480cc0aff6c2a181e7043090d445f1b514cea6afa68a91df1188ad8fca58bf9b8b26e9e4966d635ce806dfaf829b27226102bd6f39fe2386d5

data/README.md

@@ -25,49 +25,24 @@ gem "limiter-ruby"
 Assuming this is a Ruby on Rails app within ActiveJob
 
 ```ruby
-class ExpensiveJob < ApplicationJob
+class ApiController < ApplicationController
+  before_action :rate_limit
 
-  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
-    # ...
+  def index
+    # Good to continue
   end
 
   private
-  def limiter
-    Limiter::Client.new(namespace: "openai", limit: 60, period: 1.minute)
-  end
-end
-```
-
-## Point Based Rate Limit Example
-
-```ruby
-class ExpensiveJob < ApplicationJob
-
-  def perform
-    rate_limit = limiter.check(shop.id) # A unique identifier
+  def rate_limit
+    rate_limit = limiter.check(user.id)
 
-    if rate_limit.exhausted? # Rate limit got hit
-      self.class.set(wait: rate_limit.resets_in).perform_later(..args)
-      return
-    else
-      # Good to continue expensive operation
-      # ...
-      # Perform query
-      limiter.used(250) # Points deducted for last query
+    if rate_limit.exhausted?
+      render json: { error: "Rate limit exceeded" }, status: :too_many_requests
     end
   end
 
-  private
   def limiter
-    Limiter::Points.new(namespace: "shopify", limit: 1000, period: 1.minute)
+    Limiter::Client.new(token: ENV["LIMITER_TOKEN"], namespace: "openai", limit: 60, interval: 1.minute)
   end
 end
 ```

data/lib/limiter/client.rb

@@ -5,15 +5,15 @@ module Limiter
 
     BASE_DOMAIN = "https://api.limiter.dev".freeze
 
-    attr_reader :namespace, :limit, :period, :identifier, :token
+    attr_reader :namespace, :limit, :interval, :identifier, :token
 
-    def initialize(namespace:, limit:, period:)
+    def initialize(namespace:, limit:, interval:, token: ENV["LIMITER_TOKEN"])
       @namespace = namespace
       @limit = limit
-      @period = period.to_i
-      @token = ENV["LIMITER_TOKEN"]
+      @interval = interval.to_i
+      @token = token || ENV["LIMITER_TOKEN"]
 
-      ErrorHandler.error("LIMITER_TOKEN environment variable is not set") if @token.nil?
+      ErrorHandler.error("token is not set") if @token.nil?
     end
 
     def check(identifier)
@@ -21,27 +21,34 @@ module Limiter
       RateLimitResponse.new(request)
     end
 
-    def formatted_period
-      case @period
+    def formatted_interval
+      case @interval
       when 1..59
-        (@period).to_s + "s"
+        (@interval).to_s + "s"
       when 60..3599
-        (@period / 60).to_s + "m"
+        (@interval / 60).to_s + "m"
       when 3600..86_399
-        (@period / 3600).to_s + "h"
+        (@interval / 3600).to_s + "h"
       when 86_400..1_209_599
-        (@period / 86_400).to_s + "d"
+        (@interval / 86_400).to_s + "d"
       else
-        ErrorHandler.error("Invalid period")
+        ErrorHandler.error("Invalid interval")
       end
     end
 
-    def url
-      "#{BASE_DOMAIN}/ns/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
+    def limiter_path
+      "/rl/#{namespace}/#{limit}/#{formatted_interval}/#{identifier}"
     end
 
     def request(params = {})
-      HTTP.get(url, params: { token: token}.merge(params))
+      @_conn ||= Faraday.new(url: BASE_DOMAIN) do |conn|
+        conn.request :authorization, :Bearer, token
+        conn.response :json
+        conn.adapter Faraday.default_adapter
+        conn.headers["User-Agent"] = "Limiter-Ruby/#{Limiter::VERSION}"
+      end
+
+      @_conn.get(limiter_path, params)
     end
   end
 end

data/lib/limiter/version.rb

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

data/lib/limiter.rb

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

data/limiter.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary = "Toolkit for building rate limits for your application"
+  spec.description = "Limiter is a toolkit for building rate limits for your application. 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"
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "http", "~> 5.0"
+  spec.add_dependency "faraday", "~> 2.0"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: limiter-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.10
 platform: ruby
 authors:
 - Bilal Budhani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: http
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.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.
+        version: '2.0'
+description: Limiter is a toolkit for building rate limits for your application. It
+  provides a simple interface to define rate limits and track usage.
 email:
 - bilal@bilalbudhani.com
 executables: []
@@ -66,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
-summary: Easily Build & Track Rate Limits
+summary: Toolkit for building rate limits for your application
 test_files: []