limiter-ruby 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442bbfcc13722e3bbffe3edc6bb8ea56bfd19d84e4c13ba76dcd941b3bcdcb78
-  data.tar.gz: 6c931ecf9b1a4ac9395e651b624e86fb1e6c2e5ee206be86f8f302bef554e706
+  metadata.gz: 0ba0ddf343988f20e25bf09cd9e8d79d07df1012733709dca66742098f9f31a1
+  data.tar.gz: 35418ed42f3e2d435f872e964f5738343d2b2b25c9cccf270c7060161bddca0a
 SHA512:
-  metadata.gz: 3328f0aa9e901c793feeb41a39ada21502a1e3edfb2960a5d8c18d7548e53e976fcb8bfb279c942a80a1514ee5d05aa431d17e0cd502b5c371ffca6aeab603e6
-  data.tar.gz: dc5ec8dfa8ac8ffc85888a4b9b18c88cddde408cff24f4df83cd1612b789b6d8e9705b1ecff0b309d337f3d694d0269d5d02247f9ce8e715a12abc009a6e387d
+  metadata.gz: 1b54697bbfecb6e03df15fb14e6e4ed35de4a4c56c69f2d1197e47e1d31616b00a8f4f305e1d6af81c90fdfb39e6181d25a8c05e2b12bc920459060202a0054d
+  data.tar.gz: 223a007534acba31fd0ae706d5ba8d17be190b898e1963b2a436dc130f0c86a5191b8ca5f3d0f97ebd78e1c9074495ca5bc2f4b4d1cfe94b60f8804cccfe20d3

data/README.md

@@ -20,6 +20,17 @@ 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
@@ -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.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
+
+```ruby
+class ApiController < ApplicationController
+  before_action :rate_limit
+
+  def index
+    # continue the action
+
+    limiter.used(100) # mark 100 points used
+  end
+
+  private
+  def rate_limit
+    rate_limit = limiter.check(current_user.id)
 
     if rate_limit.exhausted?
       render json: { error: "Rate limit exceeded" }, status: :too_many_requests
     end
   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: 1.minute)
   end
 end
 ```

data/lib/limiter/points.rb

@@ -6,7 +6,7 @@ module Limiter
     delegate :remaining, :points, :to => :response
 
     def limiter_path
-      "/pts/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
+      "/pts/#{namespace}/#{limit}/#{formatted_interval}/#{identifier}"
     end
 
     def used(points)

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.4"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: limiter-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Bilal Budhani