singleton-client 0.7.2 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b866f4160d99e04ac3140bf8da0e7f15abf5db1fac6360d2e5d8f8a6c392eb8
-  data.tar.gz: 7e4977b0480ef04e774a2891fafee6d6b76fc1abbafd436e718f9846c138d545
+  metadata.gz: 662845b2e8dcbe69030049114857506ba0e2d5fd0ab98fdf886ddfd07ed1c7a8
+  data.tar.gz: bafa7b6a9f9d68e735ad1c830f37ea7f770381cafd7ff4ecda142d1673cec9c3
 SHA512:
-  metadata.gz: e34e259dbf04c59adb5ab96e3fde9d73a3918f9a7d284e5a33313185c1e6afbd25e43c850e3eedabbdb8602c6b32bbdb3cb76efee3536d1d7d615ddd43e94316
-  data.tar.gz: 73f14c209b98942d919c6037b31dd5f14ac44350609e8ab42d7afdc75098a42072794b40266145c44080c936c1a90aa86b7cea4d6e2b85053d30bf2db7d22324
+  metadata.gz: 3249cfcdce192e2e04670aefb03fd090c9b436171edeb80bec82d1d62816e8406d7aaaa92e3b85aec0d9e625babbab136d61e3e0d4ecf12d582c0fd99ad5a5c5
+  data.tar.gz: c694298fc391a1395ea62b4b3fe7595c5deae8fd1909d01af1b6097a03848583a81e5b0d52ef16339645bc74035f180feae9110cad56f0b67d082a95c72bb3e1

data/lib/sgtn-client/api/source.rb

@@ -1,3 +1,5 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
   
@@ -6,18 +8,18 @@ module SgtnClient
   class Source
 
       def self.getSource(component, key, locale)
+        SgtnClient.logger.debug "[Source][getSource]component=#{component}, key=#{key}, locale=#{locale}"
         cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        items = SgtnClient::CacheUtil.get_cache(cache_key)
+        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
         if items.nil?
-          items = getBundle(component, locale)
-          SgtnClient.logger.debug "Putting sources items into cache with key: " + cache_key
+          items = getBundle(component, locale)    
           SgtnClient::CacheUtil.write_cache(cache_key, items)
         else
-          SgtnClient.logger.debug "Getting sources from cache with key: " + cache_key
+          SgtnClient.logger.debug "[Source][getSource]getting sources from cache with key: " + cache_key
         end
-        s = items[locale][key]
+        s = (items.nil? || items[locale].nil?)? nil : items[locale][key]  
         if items.nil? || s.nil?
-          SgtnClient.logger.debug "Source not found, return key: " + key
+          SgtnClient.logger.debug "[Source][getSource]source not found, return key: " + key
           #return key
           return nil
         else
@@ -26,23 +28,23 @@ module SgtnClient
       end
 
       def self.getSources(component, locale)
+        SgtnClient.logger.debug "[Source][getSources]component=#{component}, locale=#{locale}"
         cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
-        items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil?
+        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
+        if items.nil? || expired
           items = getBundle(component, locale)
-          SgtnClient.logger.debug "Putting sources items into cache with key: " + cache_key
           SgtnClient::CacheUtil.write_cache(cache_key, items)
         else
-          SgtnClient.logger.debug "Getting sources from cache with key: " + cache_key
+          SgtnClient.logger.debug "[Source][getSources]getting sources from cache with key: " + cache_key
         end
         return items
       end
 
       def self.loadBundles(locale)
+        SgtnClient.logger.debug "[Source][loadBundles]locale=#{locale}"
         env = SgtnClient::Config.default_environment
         SgtnClient::Config.configurations.default = locale
         source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
-        SgtnClient.logger.debug "Loading [" + locale + "] source bundles from path: " + source_bundle
         Dir.foreach(source_bundle) do |component|
           next if component == '.' || component == '..'
           yamlfile = File.join(source_bundle, component + "/" + locale + ".yml")
@@ -54,10 +56,10 @@ module SgtnClient
 
       private
       def self.getBundle(component, locale)
+        SgtnClient.logger.debug "[Source][getBundle]component=#{component}, locale=#{locale}"
         env = SgtnClient::Config.default_environment
         source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
         bundlepath = source_bundle  + "/" + component + "/" + locale + ".yml"
-        SgtnClient.logger.debug "Getting source from  bundle: " + bundlepath
         begin
           bundle = SgtnClient::FileUtil.read_yml(bundlepath)
         rescue => exception
@@ -68,4 +70,4 @@ module SgtnClient
 
   end
 
-end
+end

data/lib/sgtn-client/api/t.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 module SgtnClient
     class T < Translation
 
@@ -19,4 +22,4 @@ module SgtnClient
             return getStrings(component, locale)
         end
     end
-end
+end

data/lib/sgtn-client/api/translation.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'multi_json'
 
 module SgtnClient
@@ -12,17 +15,26 @@ module SgtnClient
   class Translation
 
       def self.getString(component, key, locale)
+        SgtnClient.logger.debug "[Translation.getString]component: #{component}, key: #{key}, locale: #{locale}"
         str = getTranslation(component, key, locale)
         if str.nil?
           str = SgtnClient::Source.getSource(component, key, SgtnClient::Config.configurations.default)
+          if str.nil?
+            SgtnClient.logger.debug "[Translation][getString] Missing source string with key: #{key}, component: #{component}, locale: #{locale}"
+          end
         end
         str
       end
 
       def self.getString_p(component, key, plural_args, locale)
+        SgtnClient.logger.debug "[Translation][getString_p]component=#{component}, key=#{key}, locale=#{locale}"
         str = getTranslation(component, key, locale)
         if str.nil?
           str = SgtnClient::Source.getSource(component, key, SgtnClient::Config.configurations.default)
+          if str.nil?
+            SgtnClient.logger.debug "[Translation][getString_p] Missing source string with key: #{key}, component: #{component}, locale: #{locale}"
+            return nil
+          end
           str.to_plural_s(:en, plural_args)
         else
           str.to_plural_s(locale, plural_args)
@@ -30,7 +42,11 @@ module SgtnClient
       end
 
       def self.getString_f(component, key, args, locale, *optionals)
+         SgtnClient.logger.debug "[Translation][getString_f]component=#{component}, key=#{key}, locale=#{locale}"
          s = getString(component, key, locale, *optionals)
+         if s.nil?
+          return nil
+         end
          if args.is_a?(Hash)
           args.each do |source, arg|
             s.gsub! "{#{source}}", arg
@@ -42,24 +58,21 @@ module SgtnClient
       end
 
       def self.getStrings(component, locale)
-        flocale = SgtnClient::LocaleUtil.fallback(locale)
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, flocale)
-        items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil?
-          items = getTranslations(component, flocale)
-          SgtnClient::CacheUtil.write_cache(cache_key, items)
-        else
-          SgtnClient.logger.debug "Getting translations from cache with key: " + cache_key
-        end
-
+        SgtnClient.logger.debug "[Translation][getStrings]component=#{component}, locale=#{locale}"
+        locale = SgtnClient::LocaleUtil.get_best_locale(locale)
+        items = get_cs(component, locale)
         default = SgtnClient::Config.configurations.default
         if items.nil? || items["messages"] == nil
           items = {}
           s = SgtnClient::Source.getSources(component, default)
-          default_component, value = s.first
-          items["component"] = component
-          items["messages"] = value
-          items["locale"] = 'source'
+          if s.nil?
+            SgtnClient.logger.error "[Translation][getStrings] Missing component: #{component}, locale: #{locale}"
+          else
+            default_component, value = s.first
+            items["component"] = component
+            items["messages"] = value
+            items["locale"] = 'source'
+          end
         end
         return items
        end
@@ -68,11 +81,28 @@ module SgtnClient
       private
 
       def self.getTranslation(component, key, locale)
-        flocale = SgtnClient::LocaleUtil.fallback(locale)
-        cache_key = SgtnClient::CacheUtil.get_cachekey(component, flocale)
-        items = SgtnClient::CacheUtil.get_cache(cache_key)
-        if items.nil?
-          items = getTranslations(component, flocale)
+        locale = SgtnClient::LocaleUtil.get_best_locale(locale)
+        items = get_cs(component, locale)
+        if items.nil? || items["messages"] == nil
+          nil
+        else
+          items["messages"][key]
+        end
+      end
+
+      def self.get_cs(component, locale)
+        # source locale always return source bundle
+        if locale == LocaleUtil.get_source_locale
+          sources = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
+          messages = sources&.first&.last
+          return {'locale' => locale, 'component' => component, 'messages' => messages} if messages
+        end
+
+        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
+        SgtnClient.logger.debug "[Translation][get_cs]cache_key=#{cache_key}"
+        expired, items = SgtnClient::CacheUtil.get_cache(cache_key)
+        if items.nil? || expired
+          items = load(component, locale)
           if items.nil?
             items = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
             SgtnClient::Core::Cache.put(cache_key, items, 60)
@@ -80,43 +110,38 @@ module SgtnClient
             SgtnClient::CacheUtil.write_cache(cache_key, items)
           end
         else
-          SgtnClient.logger.debug "Getting translations from cache with key: " + cache_key
-        end
-        if items.nil? || items["messages"] == nil
-          nil
-        else
-          items["messages"][key]
+          SgtnClient.logger.debug "[Translation]get translations from cache with key: " + cache_key
         end
-      end
-      
-      def self.getTranslations(component, locale)
+
+        return items
+       end
+
+      def self.load(component, locale)
         env = SgtnClient::Config.default_environment
         mode = SgtnClient::Config.configurations[env]["bundle_mode"]
+        SgtnClient.logger.debug "[Translation][load]mode=#{mode}"
         if mode == 'offline'
-          return get_offbundle(component, locale)
+          return load_o(component, locale)
         else
-          return get_server(component, locale)
+          return load_s(component, locale)
         end
       end
 
-      def self.get_offbundle(component, locale)
+      def self.load_o(component, locale)
         env = SgtnClient::Config.default_environment
         product_name = SgtnClient::Config.configurations[env]["product_name"]
         version = SgtnClient::Config.configurations[env]["version"].to_s
         translation_bundle = SgtnClient::Config.configurations[env]["translation_bundle"]
         bundlepath = translation_bundle + "/" + product_name + "/" + version + "/" + component + "/messages_" + locale + ".json"
-        SgtnClient.logger.debug "Getting translations from offline bundle: " + bundlepath
         SgtnClient::FileUtil.read_json(bundlepath)
       end
 
-      def self.get_server(component, locale)
+      def self.load_s(component, locale)
         env = SgtnClient::Config.default_environment
         product_name = SgtnClient::Config.configurations[env]["product_name"]
         vip_server = SgtnClient::Config.configurations[env]["vip_server"]
-        SgtnClient.logger.debug "Getting translations from server: " + vip_server
         version = SgtnClient::Config.configurations[env]["version"].to_s
         url = vip_server + "/i18n/api/v2/translation/products/" + product_name + "/versions/" + version + "/locales/" + locale + "/components/" + component+ "?checkTranslationStatus=false&machineTranslation=false&pseudo=false"
-        SgtnClient.logger.debug url
         begin
           obj = SgtnClient::Core::Request.get(url)
         rescue => exception
@@ -130,4 +155,4 @@ module SgtnClient
 
   end
 
-end
+end

data/lib/sgtn-client/cldr/core_ext.rb

@@ -1,4 +1,7 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'sgtn-client/cldr/localized_datetime'
 require 'sgtn-client/cldr/localized_date'
 require 'sgtn-client/cldr/localized_time'
-require 'sgtn-client/cldr/localized_str'
+require 'sgtn-client/cldr/localized_str'

data/lib/sgtn-client/cldr/localized_date.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'date'
 require 'time'
 
@@ -24,4 +27,4 @@ Date.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
         def l_short_s(locale = TwitterCldr.locale)
          self.to_datetime().localize(locale).to_date().to_short_s
         end
-      LOCALIZE
+      LOCALIZE

data/lib/sgtn-client/cldr/localized_datetime.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'date'
 require 'time'
 
@@ -60,4 +63,4 @@ DateTime.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
               tz.display_name_for(self, display_name)
            end
         end
-      LOCALIZE
+      LOCALIZE

data/lib/sgtn-client/cldr/localized_str.rb

@@ -1,3 +1,5 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
 String.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
           def to_plural_s(locale, arg)
@@ -8,4 +10,4 @@ String.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
               num_str
             end
           end
-        LOCALIZE
+        LOCALIZE

data/lib/sgtn-client/cldr/localized_time.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'date'
 require 'time'
 
@@ -24,4 +27,4 @@ Time.class_eval <<-LOCALIZE, __FILE__, __LINE__ + 1
         def l_short_s(locale = TwitterCldr.locale)
            self.localize(locale).to_short_s
         end
-      LOCALIZE
+      LOCALIZE

data/lib/sgtn-client/core/cache.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'date'
 
 module SgtnClient::Core
@@ -5,88 +8,96 @@ module SgtnClient::Core
             Entry = Struct.new(:expiry, :value)
 
             def self.initialize(disabled=false, opts={})
-                $opts = opts
+                @@opts = opts
                 @mutex = Mutex.new
-                SgtnClient.logger.debug "Initialize cache......"
                 if disabled == false
-                    $data = Hash.new
-                    SgtnClient.logger.debug "Cache is enabled!"
+                    @@data = Hash.new
+                    SgtnClient.logger.debug "[Cache][initialize]cache is enabled!"
                 else
-                    SgtnClient.logger.debug "Cache is disabled!"
+                    @@data = nil
+                    SgtnClient.logger.debug "[Cache][initialize]cache is disabled!"
                 end
             end
 
             def self.keys
-                if $data == nil
+                if @@data == nil
                     return nil
                 end
-                SgtnClient.logger.debug "Get cache keys"
-                $data.keys
+                SgtnClient.logger.debug "[Cache][keys]get cache keys"
+                @@data.keys
             end
 
             def self.get(key)
-                if $data == nil
-                    return nil
+                if @@data == nil
+                    return nil, nil
                 end
-                SgtnClient.logger.debug "Get cache for key: " + key
-                invalidate
-                $data[key][:value] if has(key)
+                SgtnClient.logger.debug "[Cache][get]get cache for key: " + key
+                invalidate(key)
             end
 
             def self.has(key)
-                if $data == nil
+                if @@data == nil
                     return nil
                 end
-                SgtnClient.logger.debug "Has cache for key: " + key
-                $data.has_key? key
+                SgtnClient.logger.debug "[Cache][has]check if the cache has key: #{(@@data.has_key? key)}"
+                @@data.has_key? key
             end
 
             def self.put(key, value, ttl=nil)
                 @mutex.synchronize do
-                    if $data == nil
+                    if @@data == nil || value == nil
                         return nil
                     end
-                    ttl ||= @opts[:ttl]
+                    ttl ||= @@opts[:ttl]
                     # hours from new
-                    SgtnClient.logger.debug "Put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
-                    $data[key] = Entry.new(Time.now + ttl*60, value)
+                    SgtnClient.logger.debug "[Cache][put]put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
+                    @@data[key] = Entry.new(Time.now + ttl*60, value)
                 end
             end
 
             def self.delete(key)
                 @mutex.synchronize do
-                    if $data == nil
+                    if @@data == nil
                         return nil
                     end
-                    SgtnClient.logger.debug "Delete cache for key: " + key
-                    $data.delete key
+                    SgtnClient.logger.debug "[Cache][delete]delete cache for key: " + key
+                    @@data.delete key
                 end
             end
 
             def self.clear
                 @mutex.synchronize do
-                    if $data == nil
+                    if @@data == nil
                         return nil
                     end
-                    SgtnClient.logger.debug "Clear cache!"
-                    $data = Hash.new
+                    SgtnClient.logger.debug "[Cache][clear]clear cache!"
+                    @@data = Hash.new
                 end
             end
 
-            def self.invalidate
+            def self.invalidate(key)
                 @mutex.synchronize do
-                    if $data == nil
-                        return nil
+                    if @@data == nil
+                        return nil, nil
                     end
-                    SgtnClient.logger.debug "Invalidating expired cache......"
+                    SgtnClient.logger.debug "[Cache][invalidate]invalidate expired cache......"
                     now = Time.now
-                    $data.each {
-                        |k, v|
-                            SgtnClient.logger.debug "Checking cache: key=#{k}, expiredtime=#{v[:expiry]}, now=#{now}, expired=#{(v[:expiry] < now)}"
-                        }
-                    $data.delete_if {|k, v| v[:expiry] < now}
+                    if has(key)
+                        v = @@data[key]
+                        expired = false
+                        SgtnClient.logger.debug "[Cache][invalidate]check cache: key=#{key}, expiredtime=#{v[:expiry]}, now=#{now}, expired=#{(v[:expiry] < now)}"
+                        if v[:expiry] < now
+                            SgtnClient.logger.debug "[Cache][invalidate]before deleting the cache: data=#{@@data}"
+                            @@data.delete(key)
+                            SgtnClient.logger.debug "[Cache][invalidate]after deleting the cache: data=#{@@data}"
+                            expired = true
+                        end
+                        return expired, v[:value]
+                    else
+                        return nil, nil
+                    end
                 end
             end
         end
 
-end
+end

data/lib/sgtn-client/core/config.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'erb'
 require 'yaml'
 
@@ -40,7 +43,7 @@ module SgtnClient
     :rest_endpoint, :rest_token_endpoint, :client_id, :client_secret,
     :openid_endpoint, :openid_redirect_uri, :openid_client_id, :openid_client_secret,
     :verbose_logging, :product_name, :version, :vip_server, :bundle_mode,
-    :translation_bundle, :source_bundle, :cache_expiry_period, :disable_cache
+    :translation_bundle, :source_bundle, :cache_expiry_period, :disable_cache, :default_language
 
 
     # Create Config object
@@ -163,4 +166,4 @@ module SgtnClient
     end
   end
 
-end
+end

data/lib/sgtn-client/core/exceptions.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'multi_json'
 require 'pp'
 

data/lib/sgtn-client/core/logging.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'logger'
 
 module SgtnClient
@@ -47,4 +50,3 @@ module SgtnClient
   end
 
 end
-

data/lib/sgtn-client/core/request.rb

@@ -1,10 +1,13 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'rest-client'
 require 'multi_json'
 
 module SgtnClient::Core
     class Request
         def self.get(url)
-          #res = RestClient.get(url)
+          SgtnClient.logger.debug "[Request][get]url=#{url}"
           res = RestClient::Resource.new(
             url,
             :verify_ssl       =>  false
@@ -18,4 +21,4 @@ module SgtnClient::Core
           return obj
         end
     end
-end
+end

data/lib/sgtn-client/formatters/plurals/plural_formatter.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'json'
 
 module SgtnClient
@@ -35,4 +38,4 @@ module SgtnClient
               end
         end
     end
-end
+end

data/lib/sgtn-client/sgtn-client.rb

@@ -1,4 +1,9 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 module SgtnClient
+      LOGFILE_SHIFT_AGE = 4
+
       module Core
             autoload :Cache,        "sgtn-client/core/cache"
       end
@@ -38,17 +43,18 @@ module SgtnClient
 
                   # create log file
                   file = './sgtnclient_d.log'
+                  SgtnClient.logger.debug "[Client][load]create log file=#{file}"
                   if args[2] != nil
                         file = args[2]
                   end
                   file = File.open(file, 'a')
                   file.sync = true
-                  SgtnClient.logger = Logger.new(file)
+                  SgtnClient.logger = Logger.new(file, LOGFILE_SHIFT_AGE)
 
                   # Set log level for sandbox mode
                   env = SgtnClient::Config.default_environment
                   mode = SgtnClient::Config.configurations[env]["mode"]
-                  SgtnClient.logger.info "Current mode is: " + mode
+                  SgtnClient.logger.debug "[Client][load]set log level, mode=#{mode}"
                   if mode == 'sandbox'
                         SgtnClient.logger.level = Logger::DEBUG
                   else 
@@ -57,6 +63,7 @@ module SgtnClient
 
                   # initialize cache
                   disable_cache = SgtnClient::Config.configurations[env]["disable_cache"]
+                  SgtnClient.logger.debug "[Client][load]cache initialize, disable_cache=#{disable_cache}"
                   if disable_cache != nil
                         SgtnClient::Core::Cache.initialize(disable_cache)
                   else

data/lib/sgtn-client/util/cache-util.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'erb'
 require 'yaml'
 
@@ -10,21 +13,27 @@ module SgtnClient
   class CacheUtil
 
       def self.get_cache(cache_key)
-        items = SgtnClient::Core::Cache.get(cache_key)
-        return items
+        expired, items = SgtnClient::Core::Cache.get(cache_key)
+        SgtnClient.logger.debug "[CacheUtil]get cache with key #{cache_key}, expired #{expired}"
+        return expired, items
       end
 
       def self.clear_cache()
         SgtnClient::Core::Cache.clear()
+        SgtnClient.logger.debug "[CacheUtil]clear cache"
       end
 
       def self.write_cache(cache_key, items)
+        if items.nil?
+          return nil
+        end
         env = SgtnClient::Config.default_environment
         cache_expiry_period = SgtnClient::Config.configurations[env]["cache_expiry_period"]
         # expired after 24 hours
         if cache_expiry_period == nil
             cache_expiry_period = 24*60
         end
+        SgtnClient.logger.debug "[CacheUtil]write cache with key #{cache_key}, cache_expiry_period #{cache_expiry_period}, itmes #{items}"
         SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
       end
 
@@ -32,8 +41,8 @@ module SgtnClient
         env = SgtnClient::Config.default_environment
         product_name = SgtnClient::Config.configurations[env]["product_name"]
         version = SgtnClient::Config.configurations[env]["version"].to_s
-        return product_name + "_" + version + "_" + component + "_" + locale
+        product_name + "_" + version + "_" + component + "_" + locale
       end
   end
 
-end
+end

data/lib/sgtn-client/util/file-util.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require 'erb'
 require 'yaml'
 
@@ -8,6 +11,7 @@ module SgtnClient
       @mutex = Mutex.new
 
       def self.read_json(bundlepath)
+        SgtnClient.logger.debug "[FileUtil]read json file from: " + bundlepath
         @mutex.synchronize do
           data_hash = nil
           begin
@@ -21,6 +25,7 @@ module SgtnClient
       end
 
       def self.read_yml(file_name)
+        SgtnClient.logger.debug "[FileUtil]read yml file from: " + file_name
         @mutex.synchronize do
           erb = ERB.new(File.read(file_name))
           erb.filename = file_name
@@ -29,4 +34,4 @@ module SgtnClient
       end
   end
 
-end
+end

data/lib/sgtn-client/util/locale-util.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 module SgtnClient
 
     DEFAULT_LOCALES = ['en', 'de', 'es', 'fr', 'ko', 'ja', 'zh-Hans', 'zh-Hant']
@@ -10,6 +13,13 @@ module SgtnClient
                   }
 
     class LocaleUtil
+        def self.get_best_locale(locale)
+            fallback(process_locale(locale))
+        end
+        def self.process_locale(locale=nil)
+            locale ||= SgtnClient::Config.configurations.default
+            locale.to_s
+        end
         def self.fallback(locale)
             found = SgtnClient::DEFAULT_LOCALES.select {|e| e == locale}
             if !found.empty?
@@ -27,5 +37,10 @@ module SgtnClient
             end 
             return locale
         end
+        def self.get_source_locale
+            env = SgtnClient::Config.default_environment
+            source_locale = SgtnClient::Config.configurations[env]["default_language"]
+            source_locale || 'en'
+        end
     end
-end
+end

data/lib/sgtn-client/util/validate-util.rb

@@ -1,11 +1,13 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
 module SgtnClient
 
   class ValidateUtil
 
       def self.validate_config()
-        SgtnClient.logger.debug "-----------Start to validate configuration's setting itmes-----------"
         env = SgtnClient::Config.default_environment
+        SgtnClient.logger.debug "[ValidateUtil][validate_config] env = #{env}"
         messages = "\n"
 
         mode = SgtnClient::Config.configurations[env]["mode"]
@@ -36,9 +38,8 @@ module SgtnClient
         if messages != "\n"
           raise SgtnClient::Exceptions::MissingConfig.new(messages)
         end
-        SgtnClient.logger.debug "-----------End  to  validate configuration's setting itmes-----------"
       end
 
   end
 
-end
+end

data/lib/singleton-ruby.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
+
 require "sgtn-client/sgtn-client"
 require 'sgtn-client/cldr/core_ext'
 require 'twitter_cldr'

data/lib/version.rb

@@ -1,3 +1,5 @@
+# Copyright 2022 VMware, Inc.
+# SPDX-License-Identifier: EPL-2.0
 
     VERSION_INFO = [0, 2, 1].freeze
     VERSION = VERSION_INFO.map(&:to_s).join('.').freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.5
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client