singleton-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9948a8ed190dc317c552c9dd9ca2f2f1579aa7903765562b44fe8ec4684f7531
-  data.tar.gz: 037a56320794f476e2aa4de9b09a50f52d348ce652838a30604a613b6cbe2f4b
+  metadata.gz: ea69ecdb18c928648d4f13c86c49c28eb06ac6debbff0a6b81d00a3aa22a470a
+  data.tar.gz: 5591f0fd49b0dd594b292fed1d4afce9bba3ab60bb23a3aa697a0b0c93957eb3
 SHA512:
-  metadata.gz: 4d568de3d1de3df32358f2ae5232868beb28de9e59d41d7d470473ebf789a4d868e6d8a1ef10cff24d4e59375f907a46d622c3180e00b77d95af64ffc246f4ec
-  data.tar.gz: 6f4a695dacfc078c449070fec32992f133c39abeca3a9a1a093258014f0e3db24d92da36635fde18869817541c356c89ef0ecdf697e75c24c3aa273691bbf904
+  metadata.gz: 10c04aa1bdd5d23a8057fabe04d4f9e9736d8a109b27042bb8f8133cbe6bbdce3036f4bf9c2e31b9773f48285ffde8c5e5bd590f01c71c72d6c2c9f522228c1a
+  data.tar.gz: 83393a302754efa12fcb739756b57fec8b4f957f6903357bb091a5f6497740d43544fbffa4bc7ce717c9fedd4eeeb1b041945fc0b0638eb5725f7ce07b489fdf

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

@@ -0,0 +1,65 @@
+require 'erb'
+require 'yaml'
+
+module SgtnClient
+
+  autoload :CacheUtil,       "sgtn-client/util/cache-util"
+
+  class Source
+
+      def self.getSource(component, key)
+        locale = "en"
+        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
+        items = SgtnClient::CacheUtil.get_cache(cache_key)
+        if items.nil?
+          items = getBundle(component)
+          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
+        end
+        if items.nil?
+          return key
+        end
+        str = items[locale][key]
+        return str
+      end
+
+      def self.loadBundles(locale)
+        env = SgtnClient::Config.default_environment
+        source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
+        SgtnClient.logger.debug "Loading bundles from path: " + source_bundle
+        Dir.children(source_bundle).each do |component|
+          yamlfile = File.join(source_bundle, component + "/" + locale + ".yml")
+          bundle = read_yml(yamlfile)
+          cachekey = SgtnClient::CacheUtil.get_cachekey(component, locale)
+          SgtnClient::CacheUtil.write_cache(cachekey,bundle)
+        end
+
+      end
+
+      private
+
+      def self.getBundle(component)
+        env = SgtnClient::Config.default_environment
+        source_bundle = SgtnClient::Config.configurations[env]["source_bundle"]
+        bundlepath = source_bundle  + "/" + component + "/en.yml"
+        SgtnClient.logger.debug "Getting source from  bundle: " + bundlepath
+        begin
+          bundle = read_yaml(bundlepath)
+          puts bundle
+        rescue => exception
+          SgtnClient.logger.error exception.message
+        end
+        return bundle
+      end
+
+      def self.read_yml(file_name)
+        erb = ERB.new(File.read(file_name))
+        erb.filename = file_name
+        YAML.load(erb.result)
+      end
+
+  end
+
+end

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

@@ -5,25 +5,31 @@ module SgtnClient
   module Core
     autoload :Request,     "sgtn-client/core/request"
     autoload :Cache,       "sgtn-client/core/cache"
+    autoload :CacheUtil,   "sgtn-client/util/cache-util"
   end
   
   class Translation
 
-      include Logging
-
       def self.getString(component, key, locale)
-        cache_key = get_cachekey(component, locale)
-        SgtnClient::Core::Cache.initialize()
-        items = get_cache(cache_key)
+        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
+        items = SgtnClient::CacheUtil.get_cache(cache_key)
         if items.nil?
           items = getTranslations(component, locale)
-          write_cache(cache_key, items)
+          SgtnClient::CacheUtil.write_cache(cache_key, items)
+        else
+          SgtnClient.logger.debug "Getting translations from cache with key: " + cache_key
         end
         if items.nil?
           return key
         end
         str = items["messages"][key]
-        return str
+
+        if str.nil?
+          return SgtnClient::Source.getSource(component, key)
+        else
+          return str
+        end
+
       end
 
       private
@@ -42,9 +48,9 @@ module SgtnClient
         env = SgtnClient::Config.default_environment
         product_name = SgtnClient::Config.configurations[env]["product_name"]
         version = SgtnClient::Config.configurations[env]["version"]
-        offline_bundle = SgtnClient::Config.configurations[env]["offline_bundle"]
-        bundlepath = offline_bundle + "/l10n/bundles/" + product_name + "/" + version + "/" + component + "/messages_" + locale + ".json"
-        SgtnClient.logger.info "Getting translations from offline bundle: " + bundlepath
+        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
         begin
           file = File.read(bundlepath)
           data_hash = JSON.parse(file)
@@ -58,7 +64,7 @@ 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.info "Getting translations from server: " + vip_server
+        SgtnClient.logger.debug "Getting translations from server: " + vip_server
         version = SgtnClient::Config.configurations[env]["version"]
         url = vip_server + "/i18n/api/v2/translation/products/" + product_name + "/versions/" + version + "/locales/" + locale + "/components/" + component+ "?checkTranslationStatus=false&machineTranslation=false&pseudo=false"
         begin
@@ -72,21 +78,6 @@ module SgtnClient
         return obj
       end
 
-      def self.get_cache(cache_key)
-        items = SgtnClient::Core::Cache.get(cache_key)
-        return items
-      end
-
-      def self.write_cache(cache_key, items)
-        SgtnClient::Core::Cache.put(cache_key, items, 144000)
-      end
-
-      def self.get_cachekey(component, locale)
-        env = SgtnClient::Config.default_environment
-        product_name = SgtnClient::Config.configurations[env]["product_name"]
-        version = SgtnClient::Config.configurations[env]["version"]
-        return product_name + "_" + version + "_" + component + "_" + locale
-      end
   end
 
 end

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

@@ -23,7 +23,8 @@ module SgtnClient::Core
 
             def self.put(key, value, ttl=nil)
                 ttl ||= @opts[:ttl]
-                $data[key] = Entry.new(DateTime.new + Rational(ttl, 1440), value)
+                # hours from new
+                $data[key] = Entry.new(DateTime.new + Rational(ttl, 24), value)
             end
 
             def self.delete(key)

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

@@ -39,7 +39,8 @@ module SgtnClient
     :mode, :endpoint, :merchant_endpoint, :platform_endpoint, :ipn_endpoint,
     :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, :offline_bundle
+    :verbose_logging, :product_name, :version, :vip_server, :bundle_mode,
+    :translation_bundle, :source_bundle
 
 
     # Create Config object

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

@@ -38,7 +38,7 @@ module SgtnClient
       def logger=(logger)
         @logger = logger
         if Config.config.mode.eql? 'live' and @logger.level == Logger::DEBUG
-          @logger.warn "DEBUG log level not allowed in sandbox mode for security of confidential information. Changing log level to INFO..."
+          @logger.warn "DEBUG log level not allowed in live mode for security of confidential information. Changing log level to INFO..."
           @logger.level = Logger::INFO
         end
       end

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

@@ -1,6 +1,9 @@
 module SgtnClient
-
+      module Core
+            autoload :Cache,       "sgtn-client/core/cache"
+      end
       autoload :Translation,        "sgtn-client/api/translation"
+      autoload :Source,             "sgtn-client/api/source"
       autoload :Config,             "sgtn-client/core/config"
       autoload :Logging,            "sgtn-client/core/logging"
       autoload :Exceptions,         "sgtn-client/core/exceptions"
@@ -12,6 +15,7 @@ module SgtnClient
 
             include Logging
             def load(*args)
+                  # load configuration file
                   begin
                     SgtnClient::Config.load(args[0], args[1])
                   rescue => exception
@@ -21,6 +25,7 @@ module SgtnClient
                     log.error exception.message
                   end
 
+                  # create log file
                   file = './sgtnclient_d.log'
                   if args[2] != nil
                         file = args[2]
@@ -28,6 +33,19 @@ module SgtnClient
                   file = File.open(file, 'a')
                   file.sync = true
                   SgtnClient.logger = Logger.new(file)
+
+                  # Set log level for sandbox mode
+                  env = SgtnClient::Config.default_environment
+                  mode = SgtnClient::Config.configurations[env]["mode"]
+                  SgtnClient.logger.info "Current mode is: " + mode
+                  if mode == 'sandbox'
+                        SgtnClient.logger.level = Logger::DEBUG
+                  else 
+                        SgtnClient.logger.level = Logger::INFO
+                  end
+
+                  # initialize cache
+                  SgtnClient::Core::Cache.initialize()
             end
 
             def logger

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

@@ -0,0 +1,30 @@
+require 'erb'
+require 'yaml'
+
+module SgtnClient
+
+  module Core
+    autoload :Cache,       "sgtn-client/core/cache"
+  end
+  
+  class CacheUtil
+    
+      def self.get_cache(cache_key)
+        items = SgtnClient::Core::Cache.get(cache_key)
+        return items
+      end
+
+      def self.write_cache(cache_key, items)
+        # expired after 24 hours
+        SgtnClient::Core::Cache.put(cache_key, items, 24)
+      end
+
+      def self.get_cachekey(component, locale)
+        env = SgtnClient::Config.default_environment
+        product_name = SgtnClient::Config.configurations[env]["product_name"]
+        version = SgtnClient::Config.configurations[env]["version"]
+        return product_name + "_" + version + "_" + component + "_" + locale
+      end
+  end
+
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 
-    VERSION_INFO = [0, 0, 3].freeze
+    VERSION_INFO = [0, 0, 4].freeze
     VERSION = VERSION_INFO.map(&:to_s).join('.').freeze

data/spec/config/locales/default/JAVA/en.yml

@@ -0,0 +1,2 @@
+en:
+  hello: "Hello world"

data/spec/config/sgtnclient.yml

@@ -29,7 +29,10 @@ test: &default
   bundle_mode: offline
 
   # # Offline Bundle Path
-  offline_bundle: ./spec/config/locales
+  translation_bundle: ./spec/config/locales/l10n/bundles
+
+  # # Offline Bundle Path
+  source_bundle: ./spec/config/locales/default
 
 development:
   <<: *default

data/spec/unit/logging_spec.rb

@@ -25,8 +25,7 @@ describe SgtnClient::Logging do
 
   it "write message to logger" do
     test_message = "Example log message!!!"
-    SgtnClient.logger.info(test_message)
-    SgtnClient.logger.info "Example log message!!!!"
+    SgtnClient.logger.debug(test_message)
    # @logger_file.rewind
    # expect(@logger_file.read).to match test_message
   end

data/spec/unit/offclient_spec.rb

@@ -5,11 +5,20 @@ describe SgtnClient do
 
     before :each do
       env = SgtnClient::Config.default_environment
-      SgtnClient::Config.configurations[env]["bundle_mode"] = 'offline'
+      SgtnClient::Config.configurations[env]["bundle_mode"] = 'online'
+      SgtnClient::Source.loadBundles("en")
     end
 
     it "GET" do
       expect(SgtnClient::Translation.getString("JAVA", "com.vmware.loginsight.web.settings.stats.StatsTable.host", "zh-Hans")).to eq '主机'
+      # get from cache in 2nd time
+      expect(SgtnClient::Translation.getString("JAVA", "com.vmware.loginsight.web.settings.stats.StatsTable.host", "zh-Hans")).to eq '主机'
+    end
+
+    it "NonExistingKey" do
+      expect(SgtnClient::Translation.getString("JAVA", "hello", "zh-Hans")).to eq 'Hello world'
+      # get from cache in 2nd time
+      expect(SgtnClient::Translation.getString("JAVA", "hello", "zh-Hans")).to eq 'Hello world'
     end
   end
 

data/spec/unit/restclient_spec.rb

@@ -1,15 +1,24 @@
 require 'spec_helper'
 
 describe SgtnClient do
-  describe "OnelineAPI" do
+  describe "OnlineAPI" do
 
     before :each do
       env = SgtnClient::Config.default_environment
       SgtnClient::Config.configurations[env]["bundle_mode"] = 'online'
+      SgtnClient::Source.loadBundles("en")
     end
 
     it "GET" do
       expect(SgtnClient::Translation.getString("JAVA", "com.vmware.loginsight.web.settings.stats.StatsTable.host", "zh-Hans")).to eq '主机'
+      # get from cache in 2nd time
+      expect(SgtnClient::Translation.getString("JAVA", "com.vmware.loginsight.web.settings.stats.StatsTable.host", "zh-Hans")).to eq '主机'
+    end
+
+    it "NonExistingKey" do
+      expect(SgtnClient::Translation.getString("JAVA", "hello", "zh-Hans")).to eq 'Hello world'
+      # get from cache in 2nd time
+      expect(SgtnClient::Translation.getString("JAVA", "hello", "zh-Hans")).to eq 'Hello world'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -216,6 +216,7 @@ files:
 - lib/generators/sgtnclient/install_generator.rb
 - lib/generators/sgtnclient/templates/sgtnclient.rb
 - lib/generators/sgtnclient/templates/sgtnclient.yml
+- lib/sgtn-client/api/source.rb
 - lib/sgtn-client/api/translation.rb
 - lib/sgtn-client/core/cache.rb
 - lib/sgtn-client/core/config.rb
@@ -223,8 +224,10 @@ files:
 - lib/sgtn-client/core/logging.rb
 - lib/sgtn-client/core/request.rb
 - lib/sgtn-client/sgtn-client.rb
+- lib/sgtn-client/util/cache-util.rb
 - lib/singleton-ruby.rb
 - lib/version.rb
+- spec/config/locales/default/JAVA/en.yml
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_de.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_en.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_latest.json
@@ -266,6 +269,7 @@ signing_key:
 specification_version: 4
 summary: Singleton client for Ruby.
 test_files:
+- spec/config/locales/default/JAVA/en.yml
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_de.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_en.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_latest.json