getaround_utils 0.2.37 → 0.2.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef85783014358aa9de1a8e177a58dbf5f8df596583f8caeb73d5490638a91f8f
-  data.tar.gz: f10368811d122f9a54a451e29abcdf527c3d6d86e1c634ded313860dc910c667
+  metadata.gz: 916e4ff4d5a7e304388761fa589ed6d5cf6607415323db868832e098176898da
+  data.tar.gz: 909e21f9dc77e1da802084938478197acf05f4020922873cfe4867d2bcc727e4
 SHA512:
-  metadata.gz: 5ce5ae96d95d0d57a9dd3ba2203e3593d38c7dd37147641af60da821307ad0fb6f3e52c0982f72f593d8f574c36d9ec34705a3444c78432874b6c233065793ff
-  data.tar.gz: b59465dbc69f32174b784d6e3c29e643b52a5376c642bfb291c0a304677007d802fb36c256925a238f5f29092a3fc397ce4923acfdada529029d20464c21b474
+  metadata.gz: 9172dc32867f096bebd47bcad9cefaf38a02085917d91af8254d942496ab159a1b9f12aa60692f8e0c84dd370e9f2633a85f3314589d8ef60abc751137a7da9e
+  data.tar.gz: a0c67681e628904bf1b36b4f1fe726bd8a33951b595e301d5da55de4a187d02714721d2952775688f4cf94082fa2118b2ac49302b0f63985debfb04fa3a54f53

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## [0.2.38] 2025-11-19
+
+### Added
+
+- `GetaroundUtils::Utils::HandleError` ([#433](https://github.com/drivy/backend-configs/pull/433))
+    ```ruby
+    module MyApp::Errors
+      def self.handle(error, **)
+        GetaroundUtils::Utils::HandleError.notify_of(error, **) do |report|
+          report.grouping_hash = 'hello-world' # Bugsnag example
+        end
+      end
+    end
+    ```
+- `GetaroundUtils::Utils::ConfigUrl` ([#432](https://github.com/drivy/backend-configs/pull/432))
+    ```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"
+    GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN')
+    # => KeyError: key not found "UNKNOWN_URL"
+    GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN', 'mysql://localhost/test')
+    # => <URI::Generic mysql://localhost/test>
+    GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN') { GetaroundUtils::Utils::ConfigUrl.from_env('BAZ') }
+    # => KeyError: key not found "BAZ_URL"
+    ```

data/Gemfile.lock

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

data/README.md

@@ -49,6 +49,44 @@ require 'getaround_utils/railties/ougai'
 
 For more details, [read the spec](spec/getaround_utils/railties/ougai_spec.rb)
 
+## Engines
+
+### GetaroundUtils::Engine::Health
+
+- Exposes the currently deployed release version:
+  - `GetaroundUtils::Engine::Health.release_version`
+- Exposes the currently deployed commit SHA1:
+  - `GetaroundUtils::Engine::Health.commit_sha1`
+- Provides a `Rack` application to expose "health" endpoints (used by Shipit)
+  - `GET /release_version`
+  - `GET /commit_sha1`
+  - `GET /migration_status`
+
+The engine can be mounted in a Rails application:
+```ruby
+# config/routes.rb
+require 'getaround_utils/engines/health'
+
+Rails.application.routes.draw do
+  mount GetaroundUtils::Engines::Health.engine, at: '/health'
+  # ...
+end
+```
+
+Or in a simple `Rack` application:
+```ruby
+# config.ru
+require 'getaround_utils/engines/health'
+
+run Rack::Builder.new {
+  map '/health' do
+    run GetaroundUtils::Engines::Health.engine
+  end
+  # ...
+}
+```
+*This will generates `/health/release_version`, `/health/commit_sha1` and `/health/migration_status` endpoints*
+
 ## Mixins
 
 ### GetaroundUtils::Mixins::Loggable
@@ -100,11 +138,62 @@ For more details, [read the spec](spec/getaround_utils/mixins/loggable_spec.rb#L
 
 ## Misc
 
-### GetaroundUtils::LogFormatters::DeepKeyValue
+### GetaroundUtils::Utils::DeepKeyValue
 
 This log formatter will serialize an object of any depth into a key-value string.
 It supports basic scalars (ie: `Hash`,`Array`,`Numeric`,`String`) and will call "#inspect" for any other type.
 
-For more details, [read the spec](spec/getaround_utils/log_formatters/deep_key_value_spec.rb)
+For more details, [read the spec](spec/getaround_utils/utils/deep_key_value_spec.rb)
+
+### GetaroundUtils::Utils::ConfigUrl
+
+This helper allows to manage configuration urls with password extracted in a dedicated variable.
 
+It uses `*_URL` variable and tries to compute `*_PASSWORD` inside the parsed url.
+
+```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"
+GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN')
+# => KeyError: key not found "UNKNOWN_URL"
+GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN', 'mysql://localhost/test')
+# => <URI::Generic mysql://localhost/test>
+GetaroundUtils::Utils::ConfigUrl.from_env('UNKNOWN') { GetaroundUtils::Utils::ConfigUrl.from_env('BAZ') }
+# => KeyError: key not found "BAZ_URL"
+```
+
+For more details, [read the spec](spec/getaround_utils/utils/config_url_spec.rb)
+
+### GetaroundUtils::Utils::HandleError
+
+Allows to easily notify our error provider by providing context metadata as keyword arguments.
+
+*If there is no error provider defined, a `debug` message will be logged using `GetaroundUtils::Mixins::Loggable`*
+
+```ruby
+module MyApp::Errors
+  def self.handle(error, **)
+    GetaroundUtils::Utils::HandleError.notify_of(error, **) do |event|
+      event.grouping_hash = 'hello-world' # Bugsnag example
+    end
+  end
+end
+
+begin
+  raise 'woopsie'
+rescue StandardError => e
+  MyApp::Errors.handle(e, foo: 'bar', baz: 42)
+end
+```
 
+For more details, [read the spec](spec/getaround_utils/utils/handle_error_spec.rb)

data/getaround_utils.gemspec

@@ -17,6 +17,10 @@ Gem::Specification.new do |gem|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
   end
 
+  gem.metadata = {
+    "changelog_uri" => "https://github.com/drivy/backend-configs/blob/main/getaround_utils/CHANGELOG.md",
+  }
+
   # Development dependencies
   gem.add_development_dependency 'getaround-rubocop', '= 0.2.11'
   gem.add_development_dependency 'irb', '~> 1.15'

data/lib/getaround_utils/utils/config_url.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module GetaroundUtils; end
+
+module GetaroundUtils::Utils; end
+
+module GetaroundUtils::Utils::ConfigUrl
+  def self.from_env(config_name, ...)
+    env_url = ENV.fetch("#{config_name}_URL", ...)
+    env_pwd = ENV.fetch("#{config_name}_PASSWORD", nil)
+    return if env_url.nil?
+
+    ::URI.parse(env_url).tap do |uri|
+      if env_pwd && !uri.userinfo
+        uri.userinfo = ":#{env_pwd}"
+      elsif env_pwd
+        uri.password ||= env_pwd
+      end
+    end
+  end
+end

data/lib/getaround_utils/utils/handle_error.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'getaround_utils/mixins/loggable'
+
+module GetaroundUtils; end
+
+module GetaroundUtils::Utils; end
+
+module GetaroundUtils::Utils::HandleError
+  extend GetaroundUtils::Mixins::Loggable
+
+  # @see https://docs.bugsnag.com/platforms/ruby/rails/reporting-handled-errors/#sending-custom-diagnostics
+  def self.notify_of(error, **metadata, &)
+    if defined?(::Bugsnag)
+      ::Bugsnag.notify(error) do |event|
+        metadata.each do |name, value|
+          if value.is_a?(Hash)
+            event.add_metadata(name, value)
+          else
+            event.add_metadata('custom', name, value)
+          end
+        end
+        yield event if block_given?
+      end
+    else
+      loggable_log(
+        :debug,
+        'handled_error',
+        error_class: error.class.name,
+        error_message: error.to_s,
+        **metadata
+      )
+    end
+  end
+end

data/lib/getaround_utils/utils.rb

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+require 'getaround_utils/utils/config_url'
 require 'getaround_utils/utils/deep_key_value'
+require 'getaround_utils/utils/handle_error'

data/lib/getaround_utils/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.37
+  version: 0.2.38
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-26 00:00:00.000000000 Z
+date: 2025-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: getaround-rubocop
@@ -202,6 +202,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -218,12 +219,15 @@ files:
 - lib/getaround_utils/railties/lograge.rb
 - lib/getaround_utils/railties/ougai.rb
 - lib/getaround_utils/utils.rb
+- 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/version.rb
 homepage: https://github.com/drivy
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/drivy/backend-configs/blob/main/getaround_utils/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -239,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Backend shared utility classes