limiter-ruby 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96c4939d6e56cfa24e78beec860c0a19777d28af350de443db9c2c344a0f683f
-  data.tar.gz: c8e52e373ba57da0c3499ed5216003c193f55bf20fc3571ae106c8efd8ef22c8
+  metadata.gz: adbf765b7ef3aa5873ed8a1ad83b70b23dc1169b447d389f6757f88f83dbc031
+  data.tar.gz: 7d36b0b18a42fba6d217c131a2d8c52441fd42927071330a9a4af94ab504db5a
 SHA512:
-  metadata.gz: 61d1e3e3e19402fd2e198b7e6cbb0686e173c268dea99f95cacf34942b962e93098dd92e5748c2f9eb4083063c0ae51183005cf38d49fda8206bd607a996d5ad
-  data.tar.gz: 60bcdb87f03d1a80713fc0d1b50c92050b01dcd187a0d3743f234a56ee7b141b72ffe97a463b688474378ef6d465f57e916c4aee21a9fdc8efecf7cf428ac27c
+  metadata.gz: 98feb4fc57be513ba79d1f37050dada93f4e877d31f358acdc8ea42a3e607fc6c04a5cbb1a7fed2b50e34f4b75ce07b0372b3c40fa80b02bfc2e5febecc9d42f
+  data.tar.gz: 79d8b18d6a7c6e4648caa3973e59cbe292ecf4ba3f493d5391e8b271e80a60e2d5a04f510bb7bc203ca9f20d8bc681e531b21657a64a8685d29fe20663ebc3ec

data/README.md

@@ -20,9 +20,20 @@ In the `Gemfile` add the following
 gem "limiter-ruby"
 ```
 
+### Configure the gem
+
+In the `config/initializers/limiter.rb` file add the following
+
+```ruby
+Limiter.configure do |config|
+  config.api_token = ENV["LIMITER_TOKEN"]
+  config.raise_errors = true
+end
+```
+
 ## Simple Rate Limit Example
 
-Assuming this is a Ruby on Rails app within ActiveJob
+Sample API controller that checks the rate limit for the current user and increments the request count
 
 ```ruby
 class ApiController < ApplicationController
@@ -34,15 +45,45 @@ class ApiController < ApplicationController
 
   private
   def rate_limit
-    rate_limit = limiter.check(user.id)
+    # check the rate limit for the current user and increment the request count
+    rate_limit = limiter.check(current_user.id)
 
-    if rate_limit.exhausted?
+    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
+
+```ruby
+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::Client.new(token: ENV["LIMITER_TOKEN"], namespace: "openai", limit: 60, interval: 1.minute)
+    Limiter::Points.new(namespace: "shopify", limit: 1000, interval: 20.seconds)
   end
 end
 ```

data/lib/limiter/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "http"
+
 module Limiter
   class Client
 
@@ -47,7 +49,7 @@ module Limiter
     end
 
     def request(params = {})
-      HTTP
+      ::HTTP
         .auth("Bearer #{Limiter.configuration.api_token}")
         .headers("User-Agent" => "Limiter-Ruby/#{Limiter::VERSION}")
         .get(BASE_URL + limiter_path, params: params)

data/lib/limiter/response_handler.rb

@@ -20,12 +20,16 @@ module Limiter
 
     def resets_in
       if signed_request? && !resets_at.nil?
-        (Time.parse(resets_at) - Time.now).to_i
+        (Time.parse(resets_at) - Time.now)
       else
         0
       end
     end
 
+    def resets_at
+      response_data["resetsAt"]
+    end
+
     def remaining
       response_data["remaining"]
     end
@@ -42,9 +46,5 @@ module Limiter
     def response_data
       @_body ||= @response.parse
     end
-
-    def resets_at
-      response_data["resetsAt"]
-    end
   end
 end

data/lib/limiter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limiter-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Bilal Budhani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-14 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http