limiter-ruby 0.1.15 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95cbfb0b951d027b39acd6a8a4a00acaac5fd57ba799c4e90ae9d81160a80955
-  data.tar.gz: a32b6eb90650b7dcd98af36b97ce663fe424f13e252a51d9feff291f1665c8fe
+  metadata.gz: be6797974aa664c4b6dcc7db96803ca1f09dddec82ae5d4e8399b0c765b405c9
+  data.tar.gz: d9f651b84e46d8548bdf165aa87b9bd354b4fb99f0539ae6f998d9af4c1727ac
 SHA512:
-  metadata.gz: 761359a7844639c497dac6136693d82704eb118ba5d915a6227f4b52a70d0932fa93f09a4d2216543fdbcf69c7ee42c96edd7674adc56bff65442e0751317e56
-  data.tar.gz: 2390594ac176924ed4ea9bae0412ebeccb54af4d6019c3ee1523b45926e3da352c3cd9ed7749d28ebf0f6bb1f638fe2cb7890f3f7580d694bd471eb557a132b6
+  metadata.gz: 36fff074641761c6d1503f27c8e776b49c0516265b1a3d3b9ac8cc04b2a2ab9f2aa8024365ae26bae0a94a561a6a88b94e3c64f5fa5401e721f4fbc472eda890
+  data.tar.gz: e304ec1299c69c11b908bcfc31c79a1850296ab054dace630337baa9f7fe1f4022e32f577944313a5a2ee1b477c38e33eb2ea2e3ed2dc4af429168d96405a7cc

data/lib/limiter/client.rb

@@ -3,24 +3,26 @@
 module Limiter
   class Client
 
-    BASE_DOMAIN = "https://api.limiter.dev".freeze
+    attr_reader :namespace, :limit, :interval, :identifier, :token, :response
+    delegate :exhausted?, :allowed?, :exceeded?, :resets_in, :to => :response
 
-    attr_reader :namespace, :limit, :interval, :identifier, :token
-
-    def initialize(namespace:, limit:, interval:, token: ENV["LIMITER_TOKEN"])
+    def initialize(namespace:, limit:, interval:)
       @namespace = namespace
       @limit = limit
       @interval = interval.to_i
-      @token = token || ENV["LIMITER_TOKEN"]
       @logger = Limiter.logger
 
-      ErrorHandler.error("token is not set") if @token.nil?
+      ErrorHandler.error("API Token is not set") if Limiter.configuration.api_token.nil?
     end
 
     def check(identifier)
       @identifier = identifier
-      @logger.info("Limiter performing request: #{namespace}/#{limit}/#{interval}/#{identifier}")
-      RateLimitResponse.new(request)
+      @logger.info("check: #{namespace}/#{limit}/#{interval}/#{identifier}")
+      @response = ResponseHandler.new(request)
+      self
+    rescue => e
+      ErrorHandler.error("check failed: #{e.message}")
+      self
     end
 
     def formatted_interval
@@ -39,18 +41,11 @@ module Limiter
     end
 
     def limiter_path
-      "/rl/#{namespace}/#{limit}/#{formatted_interval}/#{identifier}"
+      "/ctr/#{namespace}/#{limit}/#{formatted_interval}/#{identifier}"
     end
 
     def request(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)
+      HTTP.auth("Bearer #{Limiter.configuration.api_token}").get(url, params: params)
     end
   end
 end

data/lib/limiter/configuration.rb

@@ -0,0 +1,16 @@
+module Limiter
+  class Configuration
+    API_BASE_URL = "https://api.limiter.dev"
+
+    attr_reader :api_token, :raise_errors
+
+    def initialize
+      @api_token = ENV["LIMITER_TOKEN"]
+      @raise_errors = true
+    end
+
+    def raise_errors?
+      @raise_errors
+    end
+  end
+end

data/lib/limiter/error_handler.rb

@@ -13,24 +13,11 @@ module Limiter
     end
 
     def handle_error
-      if !production?
+      if Limiter.configuration.raise_errors?
         raise Error, @error
       else
-        log @error
+        Limiter.logger.error(@error)
       end
     end
-
-    def production?
-      if defined?(Rails)
-        Rails.env.production?
-      else
-        (ENV["RACK_ENV"] || ENV["RAILS_ENV"] ) == "production"
-      end
-    end
-
-    def log(error)
-      @logger ||= Limiter.logger
-      @logger.error(error)
-    end
   end
 end

data/lib/limiter/points.rb

@@ -3,12 +3,15 @@
 module Limiter
   class Points < Client
 
-    def url
-      "#{BASE_DOMAIN}/points/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
+    delegate :remaining, :points, :to => :response
+
+    def limiter_path
+      "/pts/#{namespace}/#{limit}/#{formatted_period}/#{identifier}"
     end
 
     def used(points)
-      RateLimitResponse.new(request({ used: points.to_i }))
+      @response = ResponseHandler.new(request({ used: points.to_i }))
+      self
     end
   end
 end

data/lib/limiter/{rate_limit_response.rb → response_handler.rb}

@@ -1,23 +1,20 @@
 # frozen_string_literal: true
 
 module Limiter
-  class RateLimitResponse
+  class ResponseHandler
 
     attr_reader :response
 
     def initialize(response)
       @response = response
-      @logger = Limiter.logger
     end
 
     def exhausted?
-      @logger.info("Limiter response: #{@response.status}")
       signed_request? && @response.status == 429
     end
     alias_method :exceeded?, :exhausted?
 
     def allowed?
-      @logger.info("Limiter response: #{@response.status}")
       signed_request? && @response.status == 200
     end
 
@@ -29,17 +26,25 @@ module Limiter
       end
     end
 
+    def remaining
+      response_data["remaining"]
+    end
+
+    def points
+      response_data["points"]
+    end
+
     def signed_request?
       @response.headers["X-Limiter-Signed"].to_s == "true"
     end
 
     private
-    def rate_limit_data
+    def response_data
       @_body ||= @response.parse
     end
 
     def resets_at
-      rate_limit_data["resetsAt"]
+      response_data["resetsAt"]
     end
   end
 end

data/lib/limiter/version.rb

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

data/lib/limiter.rb

@@ -1,19 +1,31 @@
 # frozen_string_literal: true
 
+require_relative "limiter/configuration"
 require_relative "limiter/client"
 require_relative "limiter/points"
-require_relative "limiter/rate_limit_response"
+require_relative "limiter/response_handler"
 require_relative "limiter/error_handler"
 require_relative "limiter/version"
+require "logger"
 
 module Limiter
   class Error < StandardError; end
 
   class << self
-    attr_writer :logger
+    attr_writer :logger, :configuration
   end
 
   def self.logger
-    @logger ||= Logger.new(STDOUT)
+    @logger ||= Logger.new($stdout).tap do |logger|
+      logger.progname = "Limiter"
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
   end
 end

data/limiter.gemspec

@@ -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 "faraday"
+  spec.add_dependency "http"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: limiter-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.2.1
 platform: ruby
 authors:
 - Bilal Budhani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -37,13 +37,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/limiter-ruby.rb
 - lib/limiter.rb
 - lib/limiter/client.rb
+- lib/limiter/configuration.rb
 - lib/limiter/error_handler.rb
 - lib/limiter/points.rb
-- lib/limiter/rate_limit_response.rb
+- lib/limiter/response_handler.rb
 - lib/limiter/version.rb
-- lib/limiter_ruby.rb
 - limiter.gemspec
 homepage: https://limiter.dev
 licenses: