wrapi 0.4.9 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e286bb60b10c6964d096b595813d5b464abf5e5d2c62df74345ccaa245ae63e3
-  data.tar.gz: 1397184086158310cd556160f15baa0aac53223199bb9eb15736c8d47eab83af
+  metadata.gz: e5de57aabdb5677515c6b65d9bbb49ad959aa4e27869603375df4768c2f6c2a4
+  data.tar.gz: e7dd3571378f5d4c9dc5005121e747e19acaa66d6090b64472eac38474d71a76
 SHA512:
-  metadata.gz: 84629f489398f9f9e1529938d2ccdbda64440b2c3888a3e8a95370100fca09f9f2209fbe185d9e9dee45ddd5a4fbb53f3b0ca624ff97ad564aed576e4f909a0a
-  data.tar.gz: dc242fb476458d3aa411f18df6d4907e9ab1791aa7e430f5ff420f04257a4356b3de0a07ee8e0614d436caf27f5730c96b11c7f6a16160270c0c24bd3fbed246
+  metadata.gz: 240a5ec0a2fe02c506d9079805fb7031c663d4fed78a0f93a703d00ba5102725764f166fbf9945fee68926b3f6875a28e339e338219e68b712683447aeef4dca
+  data.tar.gz: dfb2abce78abdc97ba8e5270e40bf27c68571b96b48655dc6f3d76f86f7ae067e17afa5b8b34462c09d9f1491ffc51bfe07e89f89c6148105d91f54b5a788937

data/CHANGELOG.md

@@ -68,3 +68,12 @@
 ## [0.4.9] - 2025-03-20
 
 - freeze causes issue so connection options can't be merged!
+
+## [0.5.0] - 2025-10-20
+
+- generic use of token type
+
+## [0.5.1] - 2025-11-10
+
+- do not assign token type when empty
+- add rate throttling depending parameters

data/Rakefile

@@ -6,15 +6,10 @@ require 'rake/testtask'
 
 Dotenv.load
 
-system './bin/cc-test-reporter before-build'
-
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
-  at_exit do
-    system './bin/cc-test-reporter after-build'
-  end
 end
 
 require 'rubocop/rake_task'

data/lib/wrapi/api.rb

@@ -23,7 +23,7 @@ module WrAPI
   # @see WrAPI::Request
   # @see WrAPI::Authentication
   class API
-    attr_accessor *WrAPI::Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*WrAPI::Configuration::VALID_OPTIONS_KEYS)
 
     # Initializes a new API object with the given options.
     #

data/lib/wrapi/authentication.rb

@@ -62,10 +62,10 @@ module WrAPI
     def api_process_token(response)
       raise ArgumentError.new("Response cannot be nil") if response.nil?
 
-      token = self.access_token = response['accessToken']
-      self.token_type        = response['tokenType']
-      self.refresh_token     = response['refreshToken']
-      self.token_expires     = response['expiresIn']
+      token = self.access_token = response['accessToken'] if response['accessToken']
+      self.token_type        = response['tokenType'] if response['tokenType']
+      self.refresh_token     = response['refreshToken'] if response['refreshToken']
+      self.token_expires     = response['expiresIn'] if response['expiresIn']
       raise StandardError.new("Could not find valid accessToken; response #{response}") if token.to_s.empty?
 
       token

data/lib/wrapi/configuration.rb

@@ -58,12 +58,18 @@ module WrAPI
       :format,
       :page_size,
       :user_agent,
-      :pagination_class
+      :pagination_class,
+      :rate_limit,
+      :rate_period
     ].freeze
 
     # By default, don't set any connection options
     DEFAULT_CONNECTION_OPTIONS = {}
 
+
+    # By default token type used in authorizaion header
+    DEFAULT_TOKEN_TYPE = 'Bearer'
+
     # The response format appended to the path and sent in the 'Accept' header if none is set
     #
     # @note JSON is the only available format at this time
@@ -81,7 +87,7 @@ module WrAPI
     # It uses the DefaultPager class from the WrAPI::RequestPagination module.
     DEFAULT_PAGINATION = WrAPI::RequestPagination::DefaultPager
 
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
     # When this module is extended, set all configuration options to their default values
     def self.extended(base)
@@ -103,7 +109,6 @@ module WrAPI
     # Reset all configuration options to defaults
     def reset
       self.access_token       = nil
-      self.token_type         = nil
       self.refresh_token      = nil
       self.token_expires      = nil
       self.client_id          = nil
@@ -111,8 +116,11 @@ module WrAPI
       self.username           = nil
       self.password           = nil
       self.endpoint           = nil
-
+      self.rate_limit         = nil
+      self.rate_period        = nil
       self.logger             = nil
+
+      self.token_type         = DEFAULT_TOKEN_TYPE
       self.connection_options = DEFAULT_CONNECTION_OPTIONS
       self.format             = DEFAULT_FORMAT
       self.page_size          = DEFAULT_PAGE_SIZE

data/lib/wrapi/connection.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require File.expand_path('middleware/rate_throttle_middleware', __dir__)
 
 module WrAPI
   # @private
@@ -42,8 +43,8 @@ module WrAPI
         setup_headers(connection)
         connection.response :json, content_type: /\bjson$/
         connection.use Faraday::Request::UrlEncoded
-
         setup_logger_filtering(connection, logger) if logger
+        connection.use WrAPI::RateThrottleMiddleware, limit: rate_limit, period: rate_period if rate_limit && rate_period
       end
     end
 
@@ -73,7 +74,7 @@ module WrAPI
     # @return [void]
     # @note The authorization header will only be set if the access_token is present.
     def setup_authorization(connection)
-      connection.headers['Authorization'] = "Bearer #{access_token}" if access_token
+      connection.headers['Authorization'] = "#{token_type} #{access_token}" if access_token && token_type
     end
 
     # Sets up the headers for the given connection. Override to set own headers.

data/lib/wrapi/middleware/rate_throttle_middleware.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module WrAPI
+  # A Faraday middleware for rate limiting requests.
+  #
+  # This middleware ensures that the number of requests made through a Faraday connection
+  # does not exceed a specified limit within a given time period.
+  #
+  # @example Add middleware to a Faraday connection
+  #   connection = Faraday.new(url: 'https://api.example.com') do |faraday|
+  #     faraday.use RateThrottleMiddleware, limit: 300, period: 60
+  #     faraday.adapter Faraday.default_adapter
+  #   end
+  #
+  # @see https://github.com/lostisland/faraday Faraday Documentation
+  #
+  class RateThrottleMiddleware < Faraday::Middleware
+    # Initializes the RateThrottleMiddleware.
+    #
+    # @param app [#call] The next middleware or the actual Faraday adapter.
+    # @param limit [Integer] The maximum number of requests allowed within the specified period. Default is 300.
+    # @param period [Integer] The time period in seconds over which the limit applies. Default is 60 seconds.
+    #
+    # @example
+    #   middleware = RateThrottleMiddleware.new(app, limit: 300, period: 60)
+    #
+    def initialize(app, limit: 300, period: 60)
+      super(app)
+      @limit = limit
+      @period = period
+      @requests = []
+      @mutex = Mutex.new
+      @condition = ConditionVariable.new
+    end
+
+    def call(env)
+      throttle_request
+      @app.call(env)
+    end
+
+    private
+
+    def throttle_request
+      @mutex.synchronize do
+        now = Time.now.to_f
+        remove_expired_requests(now)
+
+        rate_limited(now)
+
+        # Record the new request
+        @requests.push(Time.now.to_f)
+        @condition.broadcast
+      end
+    end
+
+    def remove_expired_requests(now)
+      # Clear requests older than the rate limit period
+      @requests.pop while !@requests.empty? && @requests[0] < (now - @period)
+    end
+
+    def rate_limited(now)
+      # Wait if the request limit is reached
+      while @requests.size >= @limit
+        sleep_time = @requests[0] + @period - now
+        @condition.wait(@mutex, sleep_time) if sleep_time.positive?
+        remove_expired_requests(Time.now.to_f)
+      end
+    end
+  end
+end

data/lib/wrapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WrAPI
-  VERSION = '0.4.9'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: wrapi
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.1
 platform: ruby
 authors:
 - Janco Tanis
 bindir: exe
 cert_chain: []
-date: 2025-03-20 00:00:00.000000000 Z
+date: 2025-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -96,6 +96,7 @@ files:
 - lib/wrapi/configuration.rb
 - lib/wrapi/connection.rb
 - lib/wrapi/entity.rb
+- lib/wrapi/middleware/rate_throttle_middleware.rb
 - lib/wrapi/pagination.rb
 - lib/wrapi/request.rb
 - lib/wrapi/respond_to.rb