opentelemetry-helpers-sql-obfuscation 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66253cab5a508b91ad8dabe570f87e1c959e0dba5e198b37f77ec459ffd4df9a
-  data.tar.gz: 575897a6df6ab90e9933f2433a3a1139752d2d8d9d1a098ccdd4ecd4b01a8ceb
+  metadata.gz: 5a72f3fc9e038b07ab4b107949bc0dbe0fc427b335a8014872f77a23f3fc07aa
+  data.tar.gz: ce94524d998ed39f0e3e0d068a3af45e9be3cc2e2a80f79d3b47d3504c21993f
 SHA512:
-  metadata.gz: 2e8f30b749b2ed676b64a276ce4d6fba0270f7dbd2c7a4030c3846b260e921b2051257f6bcd16aa9d83bdea6cee500c955b3349f1ae786e228a96d1916e89f87
-  data.tar.gz: 73f1ea1f4b31ad4d8c2ab3d2e5134e0439954c7cebfdcb4d351ac75b4b9b8e7a86afa69389efcfea73067ca918dd76775906924140b74da6d1f4697e28471f40
+  metadata.gz: d82a71d7d753b7e5d6efacb6fa4b17e9c9d80acf1309abab0be9078e64dce7b86b748cbe7534079e5956e34a772bec917493fde8f36571c236723b8702636ff4
+  data.tar.gz: cedbf5db344c4dc5aaca0d8e0151a1b3d38e544d50e8e61375ebbe39af58ebc870e8ee135dbb03e424a25dad0651efa9249951d6ca8282d9829852a6b0e0584f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release History: opentelemetry-helpers-sql-obfuscation
 
+### v0.5.0 / 2025-10-22
+
+* BREAKING CHANGE: Min Ruby Version 3.2
+
+* ADDED: Min Ruby Version 3.2
+
+### v0.4.0 / 2025-10-08
+
+## Deprecation Notice
+
+* **DEPRECATED:** This gem, `opentelemetry-helpers-sql-obfuscation`, has been replaced by `opentelemetry-helpers-sql-processor`. This is the final release and serves as a transitional package.
+* **ACTION REQUIRED:** No action is needed unless you use this gem directly. If you use this gem directly, update your `Gemfile` to use `gem 'opentelemetry-helpers-sql-processor'` instead.
+* **SUPPORT ENDING:** `opentelemetry-helpers-sql-obfuscation` will no longer receive updates.
+
 ### v0.3.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1

data/README.md

@@ -1,6 +1,14 @@
-# OpenTelemetry Instrumentation Helpers: SQL Obfuscation
+# Deprecation Notice
 
-This Ruby gem contains logic to obfuscate SQL. It's intended for use by by gem authors instrumenting SQL adapter libraries, such as mysql2, pg, and trilogy.
+**This gem (`opentelemetry-helpers-sql-obfuscation`) is deprecated and no longer maintained.**
+
+It has been replaced by **`opentelemetry-helpers-sql-processor`**.
+
+All future development, bug fixes, and feature releases will occur in the new gem.
+
+## OpenTelemetry Instrumentation Helpers: SQL Obfuscation
+
+This Ruby gem contains logic to obfuscate SQL. It's intended for use by gem authors instrumenting SQL adapter libraries, such as mysql2, pg, and trilogy.
 
 The logic is largely drawn from the [New Relic Ruby agent's SQL Obfuscation Helpers module][new-relic-obfuscation-helpers].
 
@@ -18,7 +26,7 @@ Add the gem to your instrumentation's Gemfile:
 ```ruby
 # Gemfile
 
-group :test, :development do
+group :test do
   gem 'opentelemetry-helpers-sql-obfuscation', path: '../../helpers/sql-obfuscation'
 end
 ```

data/lib/opentelemetry/helpers/sql_obfuscation/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Helpers
     module SqlObfuscation
-      VERSION = '0.3.0'
+      VERSION = '0.5.0'
     end
   end
 end

data/lib/opentelemetry/helpers/sql_obfuscation.rb

@@ -96,8 +96,8 @@ module OpenTelemetry
       # @param sql [String] The SQL to obfuscate.
       # @param obfuscation_limit [optional Integer] the length at which the SQL string will not be obfuscated
       # @param adapter [optional Symbol] the type of database adapter calling the method. `:default`, `:mysql` and `:postgres` are supported.
-      # @return [String] The SQL query string where the values are replaced with "?". When the sql statement exceeds the obufscation limit
-      #  the first matched pair from the SQL statement will be returned, with an appended truncation message. If trunaction is unsuccessful,
+      # @return [String] The SQL query string where the values are replaced with "?". When the sql statement exceeds the obfuscation limit
+      #  the first matched pair from the SQL statement will be returned, with an appended truncation message. If truncation is unsuccessful,
       #  a string describing the error will be returned.
       #
       # @api public

data/lib/opentelemetry-helpers-sql-obfuscation.rb

@@ -5,3 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require_relative 'opentelemetry/helpers'
+
+OpenTelemetry.logger.warn <<~WARNING
+  [DEPRECATION] The 'opentelemetry-helpers-sql-obfuscation' gem has been renamed to 'opentelemetry-helpers-sql-processor'. No action is needed unless you use this gem directly.
+WARNING

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-helpers-sql-obfuscation
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
@@ -24,119 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: opentelemetry-test-helpers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.69.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.69.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
-description: SQL Obfuscation Instrumentation Helpers for the OpenTelemetry framework
+description: This gem is deprecated and no longer maintained. It has been replaced
+  by opentelemetry-helpers-sql-processor.
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
 executables: []
@@ -155,10 +44,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.3.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.5.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/helpers/sql-obfuscation
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.3.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-helpers-sql-obfuscation/0.5.0
 post_install_message: ''
 rdoc_options: []
 require_paths:
@@ -167,15 +56,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
-summary: SQL Obfuscation Instrumentation Helpers for the OpenTelemetry framework
+summary: This gem is deprecated and no longer maintained. It has been replaced by
+  opentelemetry-helpers-sql-processor.
 test_files: []