hudu 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6de79a28de35dea4c3ac9ebd26823427f839192e44113fe67f9d5f5e845cade1
-  data.tar.gz: 1bada2b529ac16cc376b85f33b953a451a23f8e955dcc2068814171bcbf0509c
+  metadata.gz: d1e4245c0dce3f094901ea8fdfbcf9b4c2d395b702968d5b869e60dad16adfc5
+  data.tar.gz: 2e44553c6bbac29f51fae2453a55c36b5fdeb26745cabf73c4cb6cfcc97e2eea
 SHA512:
-  metadata.gz: 59adb93ef27db882adc800a183ffbe1b7297e96a11014492ff61774395d0969a79603bd442c452f028fae38fc2b6a9ac591f66151276b94bc4d9b154bddda8f6
-  data.tar.gz: bdf2dfd500420081eb4b530f3621f90ae21f3204e0c817e7e33da8c1baae660425e2c844059693c5f5048d7ee1d16e26159987a7ff1d6562dbc716453e06ea97
+  metadata.gz: 9bc275aebd8cb6dbf89be44e4fdd59eb24761ab5d7b63c8687cf480f5ad6a3074dc911850705881e1bc2b173979393b6a0a859c6e13c7077e151d1853c71fe2d
+  data.tar.gz: c50428e0ec1922c8cc11fc1710ce82d99af88e1ac110c2a559da7b6baeed3c3183b5e8a28087e79e8bc40434baabb3ac9aef90d548b57941ce371152866b1bbd

data/CHANGELOG.md

@@ -1,8 +1,21 @@
-## [Unreleased]
+# Changelog
 
 ## [0.1.0] - 2024-02-20
+
 - Initial release
 
 ## [0.2.0] - 2024-03-13
+
 - update_company_asset added
 
+## [0.3.0] - 2024-03-13
+
+- throtling connection rate
+
+## [0.3.1] - 2024-03-13
+
+- rubocop fixes
+
+## [0.3.2] - 2025-03-20
+
+- update wrapi dependency

data/Gemfile

@@ -8,4 +8,4 @@ gemspec
 gem 'rake', '~> 13.0'
 gem 'rubocop', '~> 1.7'
 gem 'simplecov', require: false, group: :test
-gem 'wrapi'
+gem 'wrapi'

data/README.md

@@ -1,4 +1,5 @@
 # Hudu API
+
 [![Version](https://img.shields.io/gem/v/hudu.svg)](https://rubygems.org/gems/hudu)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e02c3f2cd2f13261597d/maintainability)](https://codeclimate.com/github/jancotanis/hudu/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/e02c3f2cd2f13261597d/test_coverage)](https://codeclimate.com/github/jancotanis/hudu/test_coverage)
@@ -17,15 +18,20 @@ gem 'hudu'
 
 And then execute:
 
-    $ bundle install
+```console
+> bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install hudu
+```console
+> gem install hudu
+```
 
 ## Usage
 
-Before you start making the requests to API provide the endpoint and api key using the configuration wrapping.
+Before you start making the requests to API provide the endpoint and
+api key using the configuration wrapping.
 
 ```ruby
 require 'hudu'
@@ -44,20 +50,23 @@ client.login
 ```
 
 ## Resources
+
 ### Authentication
-```
+
+```ruby
 # setup 
 #
 client.login
 ```
+
 |Resource|API endpoint|Description|
 |:--|:--|:--|
 |.login| none |uses api_info to check if credentials are correct. Raises Hudu:AuthenticationError incase this fails|
 
-
-
 ### Data resources
+
 Endpoint for data related requests 
+
 ```ruby
 
 # list all asset layouts/fields for a company
@@ -99,17 +108,20 @@ end
 2. Add release to [CHANGELOG.md](CHANGELOG.md)
 3. Commit.
 4. Test build.
-```
-> rake build
 
+```console
+> rake build
 ```
+
 5. Release
-```
+
+```console
 > rake release
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/hudu.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/jancotanis/hudu).
 
 ## License
 

data/hudu.gemspec

@@ -29,9 +29,9 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.platform = Gem::Platform::RUBY
   s.add_runtime_dependency 'faraday'
-  s.add_runtime_dependency 'wrapi', ">= 0.3.0"
+  s.add_runtime_dependency 'wrapi', '>= 0.4.9'
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
-  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
 end

data/lib/hudu/api.rb

@@ -1,4 +1,6 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('authentication', __dir__)
 require File.expand_path('configuration', __dir__)
 require File.expand_path('connection', __dir__)
@@ -6,9 +8,8 @@ require File.expand_path('connection', __dir__)
 module Hudu
   # @private
   class API
-
     # @private
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
     # Creates a new API and copies settings from singleton
     def initialize(options = {})

data/lib/hudu/asset_helper.rb

@@ -1,32 +1,65 @@
-module Hudu
+# frozen_string_literal: true
 
+module Hudu
+  # The AssetHelper class contains helper methods for constructing and creating asset data.
   class AssetHelper
-    # Construct asset for updates, assuem it is an entity
-    def self.construct_asset asset
-      custom_asset = asset.attributes.slice( *%w(
-        id company_id asset_layout_id slug name 
-        primary_serial primary_model primary_mail 
-        primary_manufacturer ) 
+    # Constructs an asset for updates by extracting key attributes and formatting custom fields.
+    #
+    # @param asset [Object] An Hudu entity that represents an asset, expected to respond to `attributes` and `fields`.
+    # @return [Hash] A formatted hash representing the asset for update operations.
+    #
+    # @example
+    #   asset = SomeAssetEntity.new(attributes: { id: 1, name: "Asset 1", company_id: 101 }, fields: [field1, field2])
+    #   Hudu::AssetHelper.construct_asset(asset)
+    #   # => { asset: 
+    #   #      { id: 1, company_id: 101, asset_layout_id: nil, slug: nil, name: "Asset 1", custom_fields: [...]
+    #   #      }
+    #   #    }
+    def self.construct_asset(asset)
+      custom_asset = asset.attributes.slice(
+        *%w[
+          id company_id asset_layout_id slug name
+          primary_serial primary_model primary_mail
+          primary_manufacturer
+        ]
       )
-      custom_asset['custom_fields'] = self.custom_fields(asset.fields)
+      custom_asset['custom_fields'] = custom_fields(asset.fields)
       { asset: custom_asset }
     end
 
-    # create new asset from layout
-    def self.create_asset name, asset_layout_id, fields
-      custom_asset = { 
+    # Creates a new asset from the given layout and fields.
+    #
+    # @param name [String] The name of the new asset.
+    # @param asset_layout_id [Integer] The ID of the asset layout to use.
+    # @param fields [Array<Object>] A collection of field objects representing the asset's custom fields.
+    # @return [Hash] A formatted hash representing the new asset.
+    #
+    # @example
+    #   fields = [Field.new(label: "Warranty", value: "2025"), Field.new(label: "Location", value: "NYC")]
+    #   Hudu::AssetHelper.create_asset("New Asset", 10, fields)
+    #   # => { asset: { name: "New Asset", asset_layout_id: 10, custom_fields: [...] } }
+    def self.create_asset(name, asset_layout_id, fields)
+      {
         asset: {
           name: name,
           asset_layout_id: asset_layout_id,
-          custom_fields: self.custom_fields(fields)
+          custom_fields: custom_fields(fields)
         }
       }
     end
-  
-  private
+
+    # Formats custom fields into a standardized hash structure.
+    #
+    # @param fields [Array<Object>] A collection of field objects, each expected to respond to `label` and `value`.
+    # @return [Array<Hash>] An array containing a single hash mapping field labels 
+    #                       (downcased and underscored) to their values.
+    #
+    # @example
+    #   fields = [Field.new(label: "Warranty", value: "2025"), Field.new(label: "Location", value: "NYC")]
+    #   Hudu::AssetHelper.custom_fields(fields)
+    #   # => [{ "warranty" => "2025", "location" => "NYC" }]
     def self.custom_fields(fields)
-      [fields.map{|field| [field.label.downcase.gsub(' ','_'),field.value]}.to_h]
+      [fields.map { |field| [field.label.downcase.gsub(' ', '_'), field.value] }.to_h]
     end
-
   end
-end
+end

data/lib/hudu/authentication.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
+
 require File.expand_path('error', __dir__)
 
 module Hudu
   # Deals with authentication flow and stores it within global configuration
   module Authentication
-
-    # 
+    #
     # Authorize to the Hudu portal and return access_token
     def login(options = {})
-      raise ArgumentError, "Accesstoken/api-key not set" unless api_key
-      connection_options.merge!({ headers: { "x-api-key": api_key }})
-      # only api key needed 
+      raise ArgumentError, 'Accesstoken/api-key not set' unless api_key
+
+      connection_options.merge!({ headers: { "x-api-key": api_key } })
+      # only api key needed
       # will do sanitty check if token if valid
-      get('/api/v1/api_info')
+      get('/api/v1/api_info', options)
     rescue Faraday::Error => e
       raise AuthenticationError, e
     end
-
   end
 end

data/lib/hudu/client.rb

@@ -1,53 +1,74 @@
+# frozen_string_literal: true
+
 require File.expand_path('api', __dir__)
 require File.expand_path('asset_helper', __dir__)
 
 module Hudu
-  # Wrapper for the Hudu REST API
+  # The Client class serves as a wrapper for the Hudu REST API, providing methods to interact
+  # with various Hudu resources.
+  #
+  # This class dynamically defines methods to fetch, create, update, and manipulate Hudu resources
+  # such as companies, articles, assets, and more.
   #
-  # @see 
+  # @example Basic Usage
+  #   client.companies # Fetch all companies
+  #   client.company(1) # Fetch a company by ID
+  #   client.update_company(1, { name: "Updated Company" }) # Update a company
+  #   client.create_company({ name: "New Company" }) # Create a new company
   class Client < API
-
-  private
+    # Dynamically defines methods for interacting with Hudu API resources.
+    #
+    # Depending on the arguments, this will define methods to:
+    # - Fetch all records for a resource
+    # - Fetch a specific record by ID
+    # - Update a record
+    # - Create a new record
+    #
+    # @param method [Symbol] The method name for fetching all records.
+    # @param singular_method [Symbol, nil] The method name for fetching a single record by ID. Optional.
+    # @param path [String] The API path for the resource. Defaults to the method name.
+    #
+    # @example Defining endpoints
+    #   api_endpoint :companies, :company
+    #   # Defines:
+    #   # - `companies(params = {})` to fetch all companies.
+    #   # - `company(id, params = {})` to fetch a single company by ID.
+    #   # - `update_companies(id, params = {})` to update a company.
+    #   # - `create_companies(params = {})` to create a new company.
     def self.api_endpoint(method, singular_method = nil, path = method)
-      # generate all and by id
       if singular_method
-        # all records
-        self.send(:define_method, method) do |params = {}|
+        # Define method to fetch all records and one by id
+        send(:define_method, method) do |params = {}|
           r = get_paged(api_url(path), params)
-          r = hudu_data(r,method)
+          hudu_data(r, method)
         end
-        # record by id
-        self.send(:define_method, singular_method) do |id, params = {}|
+        # Define method to fetch a single record by ID
+        send(:define_method, singular_method) do |id, params = {}|
           r = get(api_url("#{path}/#{id}"), params)
-          r = hudu_data(r,singular_method)
+          hudu_data(r, singular_method)
         end
       else
-        # normal method, return result
-        self.send(:define_method, method) do |params = {}|
+        # Define simple method to fetch data
+        send(:define_method, method) do |params = {}|
           get(api_url(path), params)
         end
       end
-      # update
-      self.send(:define_method, "update_#{method}") do |id=nil,params = {}|
+
+      # Define method to update a record
+      send(:define_method, "update_#{method}") do |id = nil, params = {}|
         r = put(api_url("#{path}/#{id}"), params)
-        r = hudu_data(r,method)
+        hudu_data(r, method)
       end
-      # create
-      self.send(:define_method, "create_#{method}") do |id=nil,params = {}|
+
+      # Define method to create a record
+      send(:define_method, "create_#{method}") do |id = nil, params = {}|
         r = post(api_url("#{path}/#{id}"), params)
-        r = hudu_data(r,method)
+        hudu_data(r, method)
       end
-      
     end
 
-  public
+    # Define API endpoints for various resources
     api_endpoint :api_info
-    
-    # Activity logs can be filtered on
-    #  user_id, user_email
-    #  resource_id, resource_type
-    #  action_message
-    #  start_date - Must be in ISO 8601 format
     api_endpoint :activity_logs
     api_endpoint :companies, :company
     api_endpoint :articles, :article
@@ -61,31 +82,75 @@ module Hudu
     api_endpoint :relations
     api_endpoint :magic_dashes, :magic_dash, 'magic_dash'
 
-    def company_articles( company_id, params = {} )
-      articles({company_id: company_id}.merge(params))
+    # Fetches all articles for a specific company.
+    #
+    # @param company_id [Integer] The ID of the company.
+    # @param params [Hash] Additional query parameters.
+    # @return [Array<Hash>] A list of articles.
+    def company_articles(company_id, params = {})
+      articles({ company_id: company_id }.merge(params))
     end
-    def company_assets(id,params={})
+
+    # Fetches all assets for a specific company.
+    #
+    # @param id [Integer] The ID of the company.
+    # @param params [Hash] Additional query parameters.
+    # @return [Array<Hash>] A list of assets.
+    def company_assets(id, params = {})
       get_paged(api_url("companies/#{id}/assets"), params)
     end
-    def company_asset(company_id,asset_id,params={})
+
+    # Fetches a specific asset for a company.
+    #
+    # @param company_id [Integer] The ID of the company.
+    # @param asset_id [Integer] The ID of the asset.
+    # @param params [Hash] Additional query parameters.
+    # @return [Hash] The asset details.
+    def company_asset(company_id, asset_id, params = {})
       get(api_url("companies/#{company_id}/assets/#{asset_id}"), params)
     end
 
+    # Updates an existing company asset.
+    #
+    # @param asset [Object] The asset object to update.
+    # @return [Hash] The updated asset data.
     def update_company_asset(asset)
-      hudu_data(put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset),false),:asset)
+      hudu_data(
+        put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset), false),
+        :asset
+      )
     end
 
-    def create_company_asset(company_id,asset_layout, fields)
-      hudu_data(post(api_url("companies/#{company_id}/assets"), AssetHelper.create_asset(asset_layout.name,asset_layout.id,fields),false),:asset)
+    # Creates a new asset for a company.
+    #
+    # @param company_id [Integer] The ID of the company.
+    # @param asset_layout [Object] The asset layout object.
+    # @param fields [Array<Hash>] The custom fields for the asset.
+    # @return [Hash] The newly created asset data.
+    def create_company_asset(company_id, asset_layout, fields)
+      hudu_data(
+        post(
+          api_url("companies/#{company_id}/assets"),
+          AssetHelper.create_asset(asset_layout.name, asset_layout.id, fields),
+          false
+        ), :asset
+      )
     end
 
-    # return api path
-    def api_url path
+    # Constructs the full API URL for a given path.
+    #
+    # @param path [String] The API path.
+    # @return [String] The full API URL.
+    def api_url(path)
       "/api/v1/#{path}"
     end
 
-    # hudu returns data as {resource:{}} or {resource:[]} 
-    def hudu_data(result,resource)
+    # Extracts resource data from the API response.
+    #
+    # @param result [Hash, Object] The API response.
+    # @param resource [Symbol] The name of the resource to extract.
+    # @return [Object] The resource data.
+    def hudu_data(result, resource)
       if result.is_a?(WrAPI::Request::Entity) && result.attributes[resource.to_s]
         result.send resource.to_s
       else

data/lib/hudu/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'wrapi'
 require File.expand_path('version', __dir__)
 require File.expand_path('pagination', __dir__)
@@ -11,11 +13,11 @@ module Hudu
     VALID_OPTIONS_KEYS = (WrAPI::Configuration::VALID_OPTIONS_KEYS + [:api_key]).freeze
 
     # @private
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
-    DEFAULT_UA         = "Ruby Hudu API wrapper #{Hudu::VERSION}".freeze
+    DEFAULT_UA         = "Ruby Hudu API wrapper #{Hudu::VERSION}"
     DEFAULT_PAGINATION = RequestPagination::PagingInfoPager
-    DEFAULT_PAGE_SIZE  = 25
+    DEFAULT_PAGE_SIZE  = 100
 
     # When this module is extended, set all configuration options to their default values
     def self.extended(base)
@@ -40,4 +42,3 @@ module Hudu
     end
   end
 end
-

data/lib/hudu/connection.rb

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 require File.expand_path('rate_throttle_middleware', __dir__)
 
 module Hudu
-  # Create connection including authorization parameters with default Accept format and User-Agent
-  # By default
-  # - Bearer authorization is access_token is not nil override with @setup_authorization
-  # - Headers setup for client-id and client-secret when client_id and client_secret are not nil @setup_headers
-  # @private
+  # Create connection including and keep it persistent so we add the rate throtling middleware only once
   module Connection
     private
 

data/lib/hudu/error.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Hudu
-	
   # Generic error to be able to rescue all Hudu errors
   class HuduError < StandardError; end
 
   # Error when authentication fails
   class AuthenticationError < HuduError; end
-end
+end

data/lib/hudu/pagination.rb

@@ -1,42 +1,82 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'json'
 
 module Hudu
-
   # Defines HTTP request methods
   # @see https://support.hudu.com/hc/en-us/articles/11422780787735-REST-API#pagination-0-5
   module RequestPagination
-
+    # The PagingInfoPager class provides a mechanism to handle pagination information for API responses.
+    #
+    # It manages the current page, page size, and provides utilities for determining if there are more pages to fetch.
+    #
+    # @example Basic Usage
+    #   pager = PagingInfoPager.new(50)
+    #   while pager.more_pages?
+    #     response = api_client.get_data(pager.page_options)
+    #     pager.next_page!(response.body)
+    #   end
     class PagingInfoPager
       attr_reader :offset, :limit, :total
+
+      # Initializes a new PagingInfoPager instance.
+      #
+      # @param page_size [Integer] The number of records to fetch per page.
       def initialize(page_size)
         @page = 1
         @page_total = @page_size = page_size
       end
 
+      # Provides the current pagination parameter options for each rest request.
+      #
+      # @return [Hash] A hash containing the current page and page size.
+      #
+      # @example
+      #   pager.page_options # => { page: 1, page_size: 50 }
       def page_options
         { page: @page, page_size: @page_size }
       end
 
+      # Advances to the next page based on the response body and updates internal pagination state.
+      #
+      # @param body [Hash] The response body from the API, expected to contain a paginated resource.
+      # @return [Integer] The updated page total, typically the count of items on the current page.
+      #
+      # @example
+      #   response_body = { "items" => [...] }
+      #   pager.next_page!(response_body)
       def next_page!(body)
         @page += 1
         a = PagingInfoPager.data(body)
         @page_total = a.is_a?(Array) ? a.count : 1
       end
 
+      # Determines whether there are more pages to fetch.
+      #
+      # @return [Boolean] Returns `true` if the current page is full, indicating another page might exist.
+      #
+      # @example
+      #   pager.more_pages? # => true or false
       def more_pages?
         # while full page we have next page
         @page_total == @page_size
       end
 
-      def self.data(body) 
+      # Extracts paginated data from the response body.
+      #
+      # @param body [Hash] The response body containing resource data, expected to be in a hash format.
+      # @return [Array, Hash, Object] Returns the extracted data, which could be an array, hash, or other object.
+      #
+      # @example
+      #   response_body = { "items" => [1, 2, 3] }
+      #   PagingInfoPager.data(response_body) # => [1, 2, 3]
+      def self.data(body)
         # assume hash {"resource":[...]}, get first key and return array data
-        result = body 
-        if result && result.respond_to?(:first)
-          k,v = body.first
-          if v.is_a?(Array) || v.is_a?(Hash)
-            result = v
-          end
+        result = body
+        if result.respond_to?(:first)
+          _k, v = body.first
+          result = v if v.is_a?(Array) || v.is_a?(Hash)
         end
         result
       end

data/lib/hudu/rate_throttle_middleware.rb

@@ -1,67 +1,72 @@
+# frozen_string_literal: true
+
 require 'faraday'
-require 'thread'
 
-# 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.
+module Hudu
+  # A Faraday middleware for rate limiting requests.
   #
-  # @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.
+  # 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
-  #   middleware = RateThrottleMiddleware.new(app, limit: 300, period: 60)
+  # @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
   #
-  def initialize(app, limit: 300, period: 60)
-    super(app)
-    @limit = limit
-    @period = period
-    @requests = []
-    @mutex = Mutex.new
-    @condition = ConditionVariable.new
-  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
+    def call(env)
+      throttle_request
+      @app.call(env)
+    end
 
-private
+    private
 
-  def throttle_request
-    @mutex.synchronize do
-      now = Time.now.to_f
-      # Clear requests older than the rate limit period
-      while !@requests.empty? && @requests[0] < (now - @period)
-        @requests.pop
+    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
-puts "<#{sleep_time}>"
-        @condition.wait(@mutex, sleep_time) if sleep_time > 0
-        now = Time.now.to_f
-        while !@requests.empty? && @requests[0] < (now - @period)
-          @requests.pop
-        end
+        @condition.wait(@mutex, sleep_time) if sleep_time.positive?
+        remove_expired_requests(Time.now.to_f)
       end
-
-      # Record the new request
-      @requests.push(Time.now.to_f)
-      @condition.broadcast
     end
   end
 end

data/lib/hudu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hudu
-  VERSION = '0.3.0'
+  VERSION = '0.3.2'
 end

data/lib/hudu.rb

@@ -1,7 +1,10 @@
-require "wrapi"
+# frozen_string_literal: true
+
+require 'wrapi'
 require File.expand_path('hudu/configuration', __dir__)
 require File.expand_path('hudu/client', __dir__)
 
+# The Hudu module provides utilities to manage and manipulate assets within the Hudu api
 module Hudu
   extend Configuration
   extend WrAPI::RespondTo
@@ -11,9 +14,4 @@ module Hudu
   def self.client(options = {})
     Hudu::Client.new(options)
   end
-
-  def self.reset
-    super
-
-  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hudu
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Janco Tanis
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.9
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -125,7 +123,6 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/hudu
   source_code_uri: https://github.com/jancotanis/hudu
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby wrapper for the Hudu APIs (readonly)
 test_files: []