opentelemetry-common 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3fa580b58803ab61d7f60c80576fee3012197cbd3819a23430f58f03210e397
-  data.tar.gz: 0fed67cb9dab224fa0705a4e45106d70716adf5b46f0a50cb34490eef93c4276
+  metadata.gz: 5770bd4c706c29a084505ab091a83da8752eb31f5cb1287bee064c522446b20d
+  data.tar.gz: 70fadc8a4a72c3b80154b53b227be12c3fbe5550aed9064ead579816ee08ec9e
 SHA512:
-  metadata.gz: 9fa9cd94d3b5d766fea3e7d7bf575fab6b1169767efcaded96d045daf9ad83d2ddac642cd882854138c98b3cce16ac437f79ab575ca9841b6bb458b88077b85c
-  data.tar.gz: f43abd95f657c1751a2f230504c43ceed199979026a48c9f3d0b4677b2da978a4392ae8fa2d96d06bbd98000556a21012db3599e6b8268306237b4df1ec39e91
+  metadata.gz: ef34f32f90cb1e2e48657777c8ceb91623238fc0e309fc2c47753ea0be4d372d66d9cde74faa755df2e2e16bc3a48f69359e4f397bca7837527b30978ecfd39a
+  data.tar.gz: eb1a5b1219c5379af28646795d26ffc8abee5fa19ba6af16de611d56e1dfae2fa958880b2c9c0b1fc662ae488a5bfc200494baabda06f036aaf1b988c9258fb5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 
 
+### v0.11.0 / 2020-12-11
+
+* ADDED: Move utf8 encoding to common utils 
+* FIXED: Copyright comments to not reference year 
+
 ### v0.10.0 / 2020-12-03
 
 * FIXED: Common gem should depend on api gem 

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/lib/opentelemetry-common.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/common.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/common/http.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/common/http/client_context.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/common/utilities.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -10,15 +10,41 @@ module OpenTelemetry
     module Utilities
       extend self
 
-      # @api private
-      #
-      # Returns nil if timeout is nil, 0 if timeout has expired, or the remaining (positive) time left in seconds.
+      STRING_PLACEHOLDER = ''.encode(::Encoding::UTF_8).freeze
+
+      # Returns nil if timeout is nil, 0 if timeout has expired,
+      # or the remaining (positive) time left in seconds.
       def maybe_timeout(timeout, start_time)
         return nil if timeout.nil?
 
         timeout -= (Time.now - start_time)
         timeout.positive? ? timeout : 0
       end
+
+      # Encodes a string in utf8
+      #
+      # @param [String] string The string to be utf8 encoded
+      # @param [optional boolean] binary This option is for displaying binary data
+      # @param [optional String] placeholder The fallback string to be used if encoding fails
+      #
+      # @return [String]
+      def utf8_encode(string, binary: false, placeholder: STRING_PLACEHOLDER)
+        string = string.to_s
+
+        if binary
+          # This option is useful for "gracefully" displaying binary data that
+          # often contains text such as marshalled objects
+          string.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+        elsif string.encoding == ::Encoding::UTF_8
+          string
+        else
+          string.encode(::Encoding::UTF_8)
+        end
+      rescue StandardError => e
+        OpenTelemetry.logger.debug("Error encoding string in UTF-8: #{e}")
+
+        placeholder
+      end
     end
   end
 end

data/lib/opentelemetry/common/version.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module Common
-    VERSION = '0.10.0'
+    VERSION = '0.11.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-common
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,10 +143,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.10.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.11.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/common
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.10.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-common/v0.11.0
 post_install_message: 
 rdoc_options: []
 require_paths: