singleton-client 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b866f4160d99e04ac3140bf8da0e7f15abf5db1fac6360d2e5d8f8a6c392eb8
-  data.tar.gz: 7e4977b0480ef04e774a2891fafee6d6b76fc1abbafd436e718f9846c138d545
+  metadata.gz: 3fa11214d62c5669477f86cf9cdd5535112c9fa48ec46504e192048e008173cc
+  data.tar.gz: 29675027bf9d235c59728680dd791a11665209c4e99445032410c38166db6463
 SHA512:
-  metadata.gz: e34e259dbf04c59adb5ab96e3fde9d73a3918f9a7d284e5a33313185c1e6afbd25e43c850e3eedabbdb8602c6b32bbdb3cb76efee3536d1d7d615ddd43e94316
-  data.tar.gz: 73f14c209b98942d919c6037b31dd5f14ac44350609e8ab42d7afdc75098a42072794b40266145c44080c936c1a90aa86b7cea4d6e2b85053d30bf2db7d22324
+  metadata.gz: f62c62c7e7d0e49124e8cdbd648154099e8d3b6bf5a8ac295b25817acefaf71a89dd09d6a8e1ef4f766f9e42d2ffb398af5e92f832933e650fef556aab767d53
+  data.tar.gz: 0d97b5eb531a64e9be1543edf3bebcc78ebc094fa06db9f711a1bb1e365ec42c4cfc0a96ffa5130f220a1c39f38ab57f10fb3120fea266ad698607557069143a

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

@@ -7,7 +7,7 @@ module SgtnClient
 
       def self.getSource(component, key, 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
@@ -15,7 +15,7 @@ module SgtnClient
         else
           SgtnClient.logger.debug "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
           #return key
@@ -27,8 +27,8 @@ module SgtnClient
 
       def self.getSources(component, 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)

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

@@ -15,6 +15,9 @@ module SgtnClient
         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!"
+          end
         end
         str
       end
@@ -23,6 +26,10 @@ module SgtnClient
         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!"
+            return nil
+          end
           str.to_plural_s(:en, plural_args)
         else
           str.to_plural_s(locale, plural_args)
@@ -31,6 +38,9 @@ module SgtnClient
 
       def self.getString_f(component, key, args, locale, *optionals)
          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 +52,19 @@ 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
-
+        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 "Can't find the component '" + component + "' in source path!"
+          else
+            default_component, value = s.first
+            items["component"] = component
+            items["messages"] = value
+            items["locale"] = 'source'
+          end
         end
         return items
        end
@@ -68,11 +73,20 @@ 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)
+        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)
@@ -82,24 +96,21 @@ module SgtnClient
         else
           SgtnClient.logger.debug "Getting 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"]
         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
@@ -109,7 +120,7 @@ module SgtnClient
         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"]

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

@@ -5,86 +5,95 @@ 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
+                    @@data = Hash.new
                     SgtnClient.logger.debug "Cache is enabled!"
                 else
+                    @@data = nil
                     SgtnClient.logger.debug "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
+                @@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)
+                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 "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)
+                    @@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
+                    @@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
+                    @@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......"
                     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 "Checking 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}"
+                            @@data.delete(key)
+                            SgtnClient.logger.debug "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/util/cache-util.rb

@@ -10,8 +10,8 @@ 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)
+        return expired, items
       end
 
       def self.clear_cache()
@@ -19,6 +19,10 @@ module SgtnClient
       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
         cache_expiry_period = SgtnClient::Config.configurations[env]["cache_expiry_period"]
         # expired after 24 hours
@@ -32,7 +36,12 @@ 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
+        return product_name + "_" + version + "_" + component + "_" + lc
       end
   end
 

metadata

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