singleton-client-test 0.7.0.26 → 0.7.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a0d174f65d5ce5b87ead4f4c61bc57070bc051ab51bc65343c7ca50a0fd0b68
-  data.tar.gz: eaf356bee612ecf0f512083e029964de5307acd3dc05555c710ce386384346ea
+  metadata.gz: 8bbeb4b91e49f392f67d86832ba947550035c57e5d95ed8a9ba3f7018bea1933
+  data.tar.gz: 2f42e96d26b18919eca9dde3673b9b9ae20af3f627bf06fd21ebac63ce496e55
 SHA512:
-  metadata.gz: 512573410bae6caa91cf0b893f27e95a0864a0374e75bd601a55a2f471ca75ed69c6f537aeb24ca7b9202a6bc59c231a838c3d5a167fdc56f130c8ab844a32e5
-  data.tar.gz: 6a2f2f82f806b564ede5218c7cda2123e528515f5089bb4ea3658451598174d140006e9d075ed68e4b1ae3c04b78b4dc3892a00bc26e447387edb282a8f35c9b
+  metadata.gz: 19ea390e3e040215ea4dd38d38ae4e36452c217a2e82e22bf638ac08798dda63797be2b346fd3bde89a9c6e5ff5aa415c02a21b0094518a3b698ebb3864ff383
+  data.tar.gz: dfc215e21a95bf65a7b25799e13f80fc026fdc13e5b0566ab478a4977c5f73041c6754fc88ba8bef48ee2c0e26ee3721c887032614bd350ba125397f489fe35f

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)
-        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?? 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)
-        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 +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,17 +12,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 +39,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 +55,20 @@ 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}"
+        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 +77,21 @@ module SgtnClient
       private
 
       def self.getTranslation(component, key, 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)
         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.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)
           if items.nil?
             items = SgtnClient::Source.getSources(component, SgtnClient::Config.configurations.default)
             SgtnClient::Core::Cache.put(cache_key, items, 60)
@@ -80,43 +99,38 @@ 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
-        if items.nil? || items["messages"] == nil
-          nil
-        else
-          items["messages"][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

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

@@ -7,12 +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
-                    SgtnClient.logger.debug "Cache is disabled!"
+                    @@data = nil
+                    SgtnClient.logger.debug "[Cache][initialize]cache is disabled!"
                 end
             end
 
@@ -20,35 +20,34 @@ 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
 
             def self.get(key)
                 if @@data == nil
-                    return 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
                     return nil
                 end
-                SgtnClient.logger.debug "Has cache for 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]
                     # 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,23 +67,32 @@ 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
 
-            def self.invalidate
+            def self.invalidate(key)
                 @mutex.synchronize do
                     if @@data == nil
-                        return 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

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

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

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

@@ -10,21 +10,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,7 +38,13 @@ 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
+        default_l = SgtnClient::Config.configurations[env]["default_language"]
+        if default_l == nil
+          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-test
 version: !ruby/object:Gem::Version
-  version: 0.7.0.26
+  version: 0.7.0.30
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client