limiter-ruby 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba0ddf343988f20e25bf09cd9e8d79d07df1012733709dca66742098f9f31a1
-  data.tar.gz: 35418ed42f3e2d435f872e964f5738343d2b2b25c9cccf270c7060161bddca0a
+  metadata.gz: adbf765b7ef3aa5873ed8a1ad83b70b23dc1169b447d389f6757f88f83dbc031
+  data.tar.gz: 7d36b0b18a42fba6d217c131a2d8c52441fd42927071330a9a4af94ab504db5a
 SHA512:
-  metadata.gz: 1b54697bbfecb6e03df15fb14e6e4ed35de4a4c56c69f2d1197e47e1d31616b00a8f4f305e1d6af81c90fdfb39e6181d25a8c05e2b12bc920459060202a0054d
-  data.tar.gz: 223a007534acba31fd0ae706d5ba8d17be190b898e1963b2a436dc130f0c86a5191b8ca5f3d0f97ebd78e1c9074495ca5bc2f4b4d1cfe94b60f8804cccfe20d3
+  metadata.gz: 98feb4fc57be513ba79d1f37050dada93f4e877d31f358acdc8ea42a3e607fc6c04a5cbb1a7fed2b50e34f4b75ce07b0372b3c40fa80b02bfc2e5febecc9d42f
+  data.tar.gz: 79d8b18d6a7c6e4648caa3973e59cbe292ecf4ba3f493d5391e8b271e80a60e2d5a04f510bb7bc203ca9f20d8bc681e531b21657a64a8685d29fe20663ebc3ec

data/README.md

@@ -33,7 +33,7 @@ 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
@@ -62,28 +62,28 @@ 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
+Sample ActiveJob that checks the rate limit for the shop and updates the request count
 
-  private
-  def rate_limit
-    rate_limit = limiter.check(current_user.id)
+```ruby
+class DataSyncJob < ApplicationJob
+  queue_as :default
 
+  def perform
+    rate_limit = limiter.check(shop.id)
     if rate_limit.exhausted?
-      render json: { error: "Rate limit exceeded" }, status: :too_many_requests
+      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: 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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Limiter
-  VERSION = "0.2.6"
+  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.6
+  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