singleton-client 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa11214d62c5669477f86cf9cdd5535112c9fa48ec46504e192048e008173cc
-  data.tar.gz: 29675027bf9d235c59728680dd791a11665209c4e99445032410c38166db6463
+  metadata.gz: 43d840f37ce5f60b23e16623db0b4393f014eaeaafa0ddf91520225a93bd9c57
+  data.tar.gz: d3c1e045e6c75f7e09cd2790de733a217516afede51dbfede1224cbabcbd3b53
 SHA512:
-  metadata.gz: f62c62c7e7d0e49124e8cdbd648154099e8d3b6bf5a8ac295b25817acefaf71a89dd09d6a8e1ef4f766f9e42d2ffb398af5e92f832933e650fef556aab767d53
-  data.tar.gz: 0d97b5eb531a64e9be1543edf3bebcc78ebc094fa06db9f711a1bb1e365ec42c4cfc0a96ffa5130f220a1c39f38ab57f10fb3120fea266ad698607557069143a
+  metadata.gz: 56593be0f8686d669216a849592b9100bb47f52087bf10938d1fae79fb123b9b4ee68baa10e8e627c2ef263e79f2f056aac777e2e5ebc3d8d7f5fbd15b758ce5
+  data.tar.gz: 5eca696945202e002be5c489ee37153d63c6498e4cc8639f5ea3ad11666ac63e4fffee59572e29fbeb0ff4c7489ff29b06a77cb57e2f9f077cde0663ca5e115b

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

@@ -6,18 +6,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)
         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.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 +26,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)
         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 +54,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

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

@@ -12,22 +12,24 @@ 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.error "Can't find the key '" + key + "' in source path!"
+            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.error "Can't find the key '" + key + "' in source path!"
+            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)
@@ -37,6 +39,7 @@ 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
@@ -52,13 +55,14 @@ module SgtnClient
       end
 
       def self.getStrings(component, locale)
+        SgtnClient.logger.debug "[Translation][getStrings]component=#{component}, 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)
           if s.nil?
-            SgtnClient.logger.error "Can't find the component '" + component + "' in source path!"
+            SgtnClient.logger.error "[Translation][getStrings] Missing component: #{component}, locale: #{locale}"
           else
             default_component, value = s.first
             items["component"] = component
@@ -84,6 +88,7 @@ module SgtnClient
       def self.get_cs(component, locale)
         flocale = SgtnClient::LocaleUtil.fallback(locale)
         cache_key = SgtnClient::CacheUtil.get_cachekey(component, flocale)
+        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, flocale)
@@ -94,7 +99,7 @@ module SgtnClient
             SgtnClient::CacheUtil.write_cache(cache_key, items)
           end
         else
-          SgtnClient.logger.debug "Getting translations from cache with key: " + cache_key
+          SgtnClient.logger.debug "[Translation]get translations from cache with key: " + cache_key
         end
 
         return items
@@ -103,6 +108,7 @@ module SgtnClient
       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 load_o(component, locale)
         else
@@ -116,7 +122,6 @@ module SgtnClient
         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
 
@@ -124,10 +129,8 @@ module SgtnClient
         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

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

@@ -7,13 +7,12 @@ module SgtnClient::Core
             def self.initialize(disabled=false, opts={})
                 @@opts = opts
                 @mutex = Mutex.new
-                SgtnClient.logger.debug "Initialize cache......"
                 if disabled == false
                     @@data = Hash.new
-                    SgtnClient.logger.debug "Cache is enabled!"
+                    SgtnClient.logger.debug "[Cache][initialize]cache is enabled!"
                 else
                     @@data = nil
-                    SgtnClient.logger.debug "Cache is disabled!"
+                    SgtnClient.logger.debug "[Cache][initialize]cache is disabled!"
                 end
             end
 
@@ -21,7 +20,7 @@ module SgtnClient::Core
                 if @@data == nil
                     return nil
                 end
-                SgtnClient.logger.debug "Get cache keys"
+                SgtnClient.logger.debug "[Cache][keys]get cache keys"
                 @@data.keys
             end
 
@@ -29,7 +28,7 @@ module SgtnClient::Core
                 if @@data == nil
                     return nil, nil
                 end
-                SgtnClient.logger.debug "Get cache for key: " + key
+                SgtnClient.logger.debug "[Cache][get]get cache for key: " + key
                 invalidate(key)
             end
 
@@ -37,7 +36,7 @@ module SgtnClient::Core
                 if @@data == nil
                     return nil
                 end
-                SgtnClient.logger.debug "Check if the cache has 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
 
@@ -48,7 +47,7 @@ module SgtnClient::Core
                     end
                     ttl ||= @@opts[:ttl]
                     # hours from new
-                    SgtnClient.logger.debug "Put cache for key '" + key + "' with expired time at'" + (Time.now + ttl*60).to_s
+                    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
@@ -58,7 +57,7 @@ module SgtnClient::Core
                     if @@data == nil
                         return nil
                     end
-                    SgtnClient.logger.debug "Delete cache for key: " + key
+                    SgtnClient.logger.debug "[Cache][delete]delete cache for key: " + key
                     @@data.delete key
                 end
             end
@@ -68,7 +67,7 @@ module SgtnClient::Core
                     if @@data == nil
                         return nil
                     end
-                    SgtnClient.logger.debug "Clear cache!"
+                    SgtnClient.logger.debug "[Cache][clear]clear cache!"
                     @@data = Hash.new
                 end
             end
@@ -78,16 +77,16 @@ module SgtnClient::Core
                     if @@data == nil
                         return nil, nil
                     end
-                    SgtnClient.logger.debug "Invalidating expired cache......"
+                    SgtnClient.logger.debug "[Cache][invalidate]invalidate expired cache......"
                     now = Time.now
                     if has(key)
                         v = @@data[key]
                         expired = false
-                        SgtnClient.logger.debug "Checking cache: key=#{key}, expiredtime=#{v[:expiry]}, now=#{now}, expired=#{(v[:expiry] < now)}"
+                        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 "Before deleting the cache: data=#{@@data}"
+                            SgtnClient.logger.debug "[Cache][invalidate]before deleting the cache: data=#{@@data}"
                             @@data.delete(key)
-                            SgtnClient.logger.debug "After deleting the cache: data=#{@@data}"
+                            SgtnClient.logger.debug "[Cache][invalidate]after deleting the cache: data=#{@@data}"
                             expired = true
                         end
                         return expired, v[:value]

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

@@ -4,7 +4,7 @@ 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

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

@@ -38,6 +38,7 @@ 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
@@ -48,7 +49,7 @@ module SgtnClient
                   # 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 +58,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

@@ -11,16 +11,17 @@ module SgtnClient
 
       def self.get_cache(cache_key)
         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?
-          SgtnClient.logger.debug "write cache with key #{cache_key}, itmes #{items}"
           return nil
         end
         env = SgtnClient::Config.default_environment
@@ -29,6 +30,7 @@ module SgtnClient
         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
 
@@ -41,6 +43,7 @@ module SgtnClient
           default_l = 'en'
         end
         lc = locale == default_l ? SgtnClient::Config.configurations.default: locale
+        SgtnClient.logger.debug "[CacheUtil]get cache key: #{lc}"
         return product_name + "_" + version + "_" + component + "_" + lc
       end
   end

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

@@ -8,6 +8,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 +22,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

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

@@ -4,8 +4,8 @@ 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,7 +36,6 @@ module SgtnClient
         if messages != "\n"
           raise SgtnClient::Exceptions::MissingConfig.new(messages)
         end
-        SgtnClient.logger.debug "-----------End  to  validate configuration's setting itmes-----------"
       end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-client
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client