limiter-ruby 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89a952e1a844303c615335021b9d5b8dc63d02ef09036f73aa28cd16b191875f
-  data.tar.gz: 8475379bf65884d9376d2d37544900847712c8434b0ef1197d3427d7d5ccc276
+  metadata.gz: 718993a35bb1f7a95a16d2a6a17af233d9d0909fc070895172c80e5afbfbb7d0
+  data.tar.gz: '026853b283dddcd996539c3d255250e25ee4871e4cccf8ac424707ffac18ea77'
 SHA512:
-  metadata.gz: d035c3075ca83f56ecd77afa1f190e0ea76bfdb7266fcf934f50b49e72be0e5c3ad7bd3440d16ad4b4177a7d3b92060f082dea62345afd4a9968f2ed9e3e199b
-  data.tar.gz: 0604d0feffafebcb9462424fc24160ffd025f695d7a4b8e4237a34f93ba1fcb50cf2e075784e9ce1a59fcbecdda60abde265c2f58c15582fe4a1dfc7aba510c0
+  metadata.gz: a45d10cd11eb9500f9dc7fb77f379e509d49d1f91bd59ffe0f0bba698b88fba2f3a9edf57a1e5020ffa803032cf7d436d3bf166768c3e79fa8a65ae4a0159ca9
+  data.tar.gz: 9c3d29e2a42422b4bc02767e7c7f3248f462bab8d228fee536732481e5a737081a8aa99e512f37a199031ec2fbd139f904f05bdc6a5c4fbb84c0bd208ba211e9

data/README.md

@@ -17,10 +17,10 @@ LIMITER_TOKEN: [GENERATED TOKEN]
 In the `Gemfile` add the following
 
 ```ruby
-gem "limiter"
+gem "limiter-ruby"
 ```
 
-## Integrate
+## Simple Rate Limit Example
 
 Assuming this is a Ruby on Rails app within ActiveJob
 
@@ -45,3 +45,29 @@ class ExpensiveJob < ApplicationJob
   end
 end
 ```
+
+## Point Based Rate Limit Example
+
+```ruby
+class ExpensiveJob < ApplicationJob
+
+  def perform
+    rate_limit = limiter.check(shop.id) # A unique identifier
+
+    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
+    end
+  end
+
+  private
+  def limiter
+    Limiter::Points.new(namespace: "shopify", limit: 1000, period: 1.minute)
+  end
+end
+```

data/lib/limiter/client.rb

@@ -35,11 +35,11 @@ module Limiter
     end
 
     def url
-      "#{BASE_DOMAIN}/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
+      "#{BASE_DOMAIN}/ns/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
     end
 
-    def request
-      HTTP.get(url, params: { token: token})
+    def request(params = {})
+      HTTP.get(url, params: { token: token}.merge(params))
     end
   end
 end

data/lib/limiter/points.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Limiter
+  class Points < Client
+
+    def url
+      "#{BASE_DOMAIN}/points/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
+    end
+
+    def used(points)
+      RateLimitResponse.new(request({ used: points.to_i }))
+    end
+  end
+end

data/lib/limiter/version.rb

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

data/lib/limiter.rb

@@ -2,6 +2,7 @@
 
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limiter-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Bilal Budhani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -40,6 +40,7 @@ files:
 - lib/limiter.rb
 - lib/limiter/client.rb
 - lib/limiter/error_handler.rb
+- lib/limiter/points.rb
 - lib/limiter/rate_limit_response.rb
 - lib/limiter/version.rb
 - limiter.gemspec