getaround_utils 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b8f527ba9f0f5c93d0aa5f5898278230277ccbe435b690c03d0b79eceb277ab
-  data.tar.gz: 276a5197b07e3052fc813367d04ca0e04a84c1400da83c2487c83d22e8c43bce
+  metadata.gz: 197707c0b85b1de9d759389ce44867114b3a1e1bf231e72c23b40356040df563
+  data.tar.gz: 36109e28f921a5e8c97fd3f1512b0e2838f6416c2a7b1cd845d3e8784db14cd1
 SHA512:
-  metadata.gz: 66dcca84c67e6f7f030c359fce44e48e154b7fa1c2b780a1a6ef9b0f4d6dd9045d2da248f13ead1e04cea5ed9e523d50b5bd5b5e001703e3f3b1fef00151d48e
-  data.tar.gz: 327b48e801f84b263ae6be9d3e9c4535b3295e2a91634f77b39271d73d81a96ddc960dedc928d668513510f2701ac94da813f893510e11c4ae3769109d4b8677
+  metadata.gz: 451a09d17a3aa284e26c1b2700891a4a8df4e5d3a5f7819e7e425c7f6e4c0988471b1cb05df8fd4f1399e45f441e83674a3e3421d9e2b0239e9dace98981ca32
+  data.tar.gz: 8e0f3e45775ea0fd26f5d22603870f5f86f71963f0cbacbb88cf5fd46722a6202392825188cff9731a4202c8b85b52c849f23d7a61ce46aacaa0a9a0c349af1d

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+## [0.3.5] 2026-07-07
+
+### Fixed
+
+- `GetaroundUtils::Utils::HandleError`: notify Bugsnag only when `BUGSNAG_API_KEY` is configured, otherwise log.
+
+### Added
+
+- `GetaroundUtils::Utils::HealthCheckFile` ([#481](https://github.com/drivy/backend-configs/pull/481))
+    ```ruby
+    SIDEKIQ_HEALTH_FILE = GetaroundUtils::Utils::HealthCheckFile.new('sidekiq')
+    Sidekiq.configure_server do |config|
+      config.on(:startup) { SIDEKIQ_HEALTH_FILE.create }
+      config.on(:shutdown) { SIDEKIQ_HEALTH_FILE.delete }
+    end
+    ```
+
+## [0.3.4] 2026-02-27
+
+### Breaking Changes
+
+- `GetaroundUtils::Utils::ConfigUrl.from_env` ([#460](https://github.com/drivy/backend-configs/pull/460))
+  - Add `_USERNAME` variable support
+  - Make sub variables overriding base url segments
+  ```dotenv
+  TEST_URL="whatever://foo:my-pwd@localhost:666/test"
+  TEST_USERNAME="bar"
+  TEST_PASSWORD="new-pwd"
+  ```
+  ```ruby
+  # BEFORE (<= 0.3.3)
+  GetaroundUtils::Utils::ConfigUrl.from_env('TEST')
+  # => <URI::Generic whatever://foo:my-pwd@localhost:666/test>
+    
+  # AFTER (> 0.3.3)
+  GetaroundUtils::Utils::ConfigUrl.from_env('TEST')
+  # => <URI::Generic whatever://bar:new-pwd@localhost:666/test>
+  ```
+
 ## [0.3.3] 2026-02-27
 - `GetaroundUtils::I18nBackend::FlatKeys` should be a module
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getaround_utils (0.3.3)
+    getaround_utils (0.3.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -147,23 +147,25 @@ For more details, [read the spec](spec/getaround_utils/utils/deep_key_value_spec
 
 ### GetaroundUtils::Utils::ConfigUrl
 
-This helper allows to manage configuration urls with password extracted in a dedicated variable.
+This helper allows to manage configuration urls with username and password extracted in dedicated variables.
 
-It uses `*_URL` variable and tries to compute `*_PASSWORD` inside the parsed url.
+Uses `*_URL` variable and tries to compute `*_USERNAME` and `*_PASSWORD` variables inside the parsed url.
 
+```dotenv
+FOO_URL="redis://foo@localhost:666/10"
+FOO_PASSWORD="added-pwd"
+BAR_URL="whatever://bar:baz@localhost:666/42"
+BAR_USERNAME="user666"
+BAR_PASSWORD="new-pwd"
+ENV_TEST_NUMBER=1
+```
 ```ruby
-# FOO_URL="redis://foo@localhost:666/10"
-# FOO_PASSWORD="added-pwd"
-# BAR_URL="whatever://bar:used-pwd@localhost:666/42"
-# BAR_PASSWORD="not-used-pwd"
-# ENV_TEST_NUMBER=1
-
 GetaroundUtils::Utils::ConfigUrl
   .from_env('FOO')
   .tap { |uri| uri.path += ENV['ENV_TEST_NUMBER'] }
 # => <URI::Generic redis://foo:added-pwd@localhost:666/101>
 GetaroundUtils::Utils::ConfigUrl.from_env('BAR').to_s
-# => "whatever://bar:used-pwd@localhost:666/42"
+# => "whatever://user666:new-pwd@localhost:666/42"
 GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN')
 # => KeyError: key not found "UNKNOWN_URL"
 GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN', 'mysql://localhost/test')
@@ -197,3 +199,19 @@ end
 ```
 
 For more details, [read the spec](spec/getaround_utils/utils/handle_error_spec.rb)
+
+### GetaroundUtils::Utils::HealthCheckFile
+
+Helper to easily create health check file used for Kubernetes Probes (Sidekiq, Captur, etc...)
+
+*Example in `config/initializers/sidekiq.rb`*
+```ruby
+SIDEKIQ_HEALTH_FILE = GetaroundUtils::Utils::HealthCheckFile.new('sidekiq')
+
+Sidekiq.configure_server do |config|
+  config.on(:startup) { SIDEKIQ_HEALTH_FILE.create }
+  config.on(:shutdown) { SIDEKIQ_HEALTH_FILE.delete }
+end
+```
+
+For more details, [read the spec](spec/getaround_utils/utils/health_check_file_spec.rb)

data/lib/getaround_utils/utils/config_url.rb

@@ -9,15 +9,19 @@ module GetaroundUtils::Utils; end
 module GetaroundUtils::Utils::ConfigUrl
   def self.from_env(config_name, ...)
     env_url = ENV.fetch("#{config_name}_URL", ...)
+    env_usr = ENV.fetch("#{config_name}_USERNAME", nil)
     env_pwd = ENV.fetch("#{config_name}_PASSWORD", nil)
-    return if env_url.nil?
+    return if env_url.nil? || env_url.empty? # rubocop:disable Rails/Blank
 
     ::URI.parse(env_url).tap do |uri|
-      if env_pwd && !uri.userinfo
-        uri.userinfo = ":#{env_pwd}"
-      elsif env_pwd
-        uri.password ||= env_pwd
-      end
+      uri_usr, uri_pwd = uri.userinfo&.split(':', 2)
+      uri_pwd = uri_pwd.to_s if uri.userinfo&.include?(':')
+      usr = env_usr.nil? ? uri_usr : env_usr
+      pwd = env_pwd.nil? ? uri_pwd : env_pwd
+      userinfo = usr.to_s
+      userinfo += ":#{pwd}" unless pwd.nil?
+
+      uri.userinfo = userinfo unless userinfo.empty?
     end
   end
 end

data/lib/getaround_utils/utils/handle_error.rb

@@ -11,7 +11,7 @@ module GetaroundUtils::Utils::HandleError
 
   # @see https://docs.bugsnag.com/platforms/ruby/rails/reporting-handled-errors/#sending-custom-diagnostics
   def self.notify_of(error, **metadata, &)
-    if defined?(::Bugsnag)
+    if defined?(::Bugsnag) && ::Bugsnag.configuration.api_key
       ::Bugsnag.notify(error) do |event|
         metadata.each do |name, value|
           if value.is_a?(Hash)

data/lib/getaround_utils/utils/health_check_file.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+module GetaroundUtils; end
+
+module GetaroundUtils::Utils; end
+
+class GetaroundUtils::Utils::HealthCheckFile
+  FILE_NAME = 'health_check_file'
+
+  attr_reader :path
+
+  def initialize(name)
+    raise ArgumentError, "Expected name as String, got: #{name.inspect}" if !name.is_a?(String) || name.empty?
+
+    @base_path = root_path.join('tmp', name)
+    @path = @base_path.join(FILE_NAME)
+  end
+
+  def create
+    FileUtils.mkdir_p(@base_path)
+    FileUtils.touch(@path)
+  end
+
+  def delete
+    FileUtils.rm_f(@path)
+  end
+
+  def exists?
+    File.exist?(@path)
+  end
+
+  private
+
+  def root_path
+    defined?(::Rails) ? Rails.root : Pathname.new('/')
+  end
+end

data/lib/getaround_utils/utils.rb

@@ -3,3 +3,4 @@
 require 'getaround_utils/utils/config_url'
 require 'getaround_utils/utils/deep_key_value'
 require 'getaround_utils/utils/handle_error'
+require 'getaround_utils/utils/health_check_file'

data/lib/getaround_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GetaroundUtils
-  VERSION = '0.3.3'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Drivy
@@ -222,6 +222,7 @@ files:
 - lib/getaround_utils/utils/config_url.rb
 - lib/getaround_utils/utils/deep_key_value.rb
 - lib/getaround_utils/utils/handle_error.rb
+- lib/getaround_utils/utils/health_check_file.rb
 - lib/getaround_utils/version.rb
 homepage: https://github.com/drivy
 licenses: