singleton-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea69ecdb18c928648d4f13c86c49c28eb06ac6debbff0a6b81d00a3aa22a470a
-  data.tar.gz: 5591f0fd49b0dd594b292fed1d4afce9bba3ab60bb23a3aa697a0b0c93957eb3
+  metadata.gz: 41a2068f7bad6dd8f8ce5940386b82897eca3a1f0d4d1d275c80f411ae40fd14
+  data.tar.gz: fa7d5bd49e8fb9d04911cfe9b6869eb0ed8489be83ca58dbf74d62dfc08ac6db
 SHA512:
-  metadata.gz: 10c04aa1bdd5d23a8057fabe04d4f9e9736d8a109b27042bb8f8133cbe6bbdce3036f4bf9c2e31b9773f48285ffde8c5e5bd590f01c71c72d6c2c9f522228c1a
-  data.tar.gz: 83393a302754efa12fcb739756b57fec8b4f957f6903357bb091a5f6497740d43544fbffa4bc7ce717c9fedd4eeeb1b041945fc0b0638eb5725f7ce07b489fdf
+  metadata.gz: 1f2b1f1350f8bc4c83c9515db52e6a64242ba42bd92af1c1468a3660dad055ec8c064b8a27b5e6185ff20a1eec725ff3fbf76bbd7e2e639bf591fb45ec88e127
+  data.tar.gz: 7726b44fd11e02ad674527f949508796a96dd9b56e04ea860dfe68fddac3bed31c4a3bfa92d0da20b9cb3eca0ca0c03e76daafb538077e017f888cc1c8e5f146

data/README.md

@@ -4,5 +4,8 @@
 - Ruby version: 3.0.0 or above
 - Bundler version: 2.2.3 or above
 
+## Run Unit Test
+rake spec:unit
+
 
 

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

@@ -28,7 +28,7 @@ module SgtnClient
       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
+        SgtnClient.logger.debug "Loading [" + locale + "] bundles from path: " + source_bundle
         Dir.children(source_bundle).each do |component|
           yamlfile = File.join(source_bundle, component + "/" + locale + ".yml")
           bundle = read_yml(yamlfile)
@@ -46,7 +46,7 @@ module SgtnClient
         bundlepath = source_bundle  + "/" + component + "/en.yml"
         SgtnClient.logger.debug "Getting source from  bundle: " + bundlepath
         begin
-          bundle = read_yaml(bundlepath)
+          bundle = read_yml(bundlepath)
           puts bundle
         rescue => exception
           SgtnClient.logger.error exception.message

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

@@ -20,10 +20,10 @@ module SgtnClient
           SgtnClient.logger.debug "Getting translations from cache with key: " + cache_key
         end
         if items.nil?
-          return key
+          return SgtnClient::Source.getSource(component, key)
         end
-        str = items["messages"][key]
 
+        str = items["messages"][key]
         if str.nil?
           return SgtnClient::Source.getSource(component, key)
         else
@@ -49,7 +49,7 @@ module SgtnClient
         product_name = SgtnClient::Config.configurations[env]["product_name"]
         version = SgtnClient::Config.configurations[env]["version"]
         translation_bundle = SgtnClient::Config.configurations[env]["translation_bundle"]
-        bundlepath = translation_bundle + product_name + "/" + version + "/" + component + "/messages_" + locale + ".json"
+        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/lib/sgtn-client/core/cache.rb

@@ -4,38 +4,64 @@ module SgtnClient::Core
         class Cache
             Entry = Struct.new(:expiry, :value)
 
-            def self.initialize(opts={})
-                $data = Hash.new
+            def self.initialize(disabled=false, opts={})
                 $opts = opts
+                if disabled == false
+                    $data = Hash.new
+                    SgtnClient.logger.debug "Cache is enabled!"
+                else
+                    SgtnClient.logger.debug "Cache is disabled!"
+                end
             end
 
             def self.keys
+                if $data == nil
+                    return nil
+                end 
                 $data.keys
             end
 
             def self.get(key)
+                if $data == nil
+                    return nil
+                end 
                 $data[key][:value] if has(key)
             end
 
             def self.has(key)
+                if $data == nil
+                    return nil
+                end 
                 $data.has_key? key
             end
 
             def self.put(key, value, ttl=nil)
+                if $data == nil
+                    return nil
+                end 
                 ttl ||= @opts[:ttl]
                 # hours from new
                 $data[key] = Entry.new(DateTime.new + Rational(ttl, 24), value)
             end
 
             def self.delete(key)
+                if $data == nil
+                    return nil
+                end 
                 $data.delete key
             end
 
             def self.clear
+                if $data == nil
+                    return nil
+                end 
                 $data = Hash.new
             end
 
             def self.invalidate
+                if $data == nil
+                    return nil
+                end 
                 now = DateTime.new
                 $data.delete_if {|k, v| v[:expiry] < now}
             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
+    :translation_bundle, :source_bundle, :cache_expiry_period, :disable_cache
 
 
     # Create Config object

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

@@ -7,6 +7,7 @@ module SgtnClient
       autoload :Config,             "sgtn-client/core/config"
       autoload :Logging,            "sgtn-client/core/logging"
       autoload :Exceptions,         "sgtn-client/core/exceptions"
+      autoload :ValidateUtil,         "sgtn-client/util/validate-util"
 
       class << self
             def configure(options = {}, &block)
@@ -18,6 +19,7 @@ module SgtnClient
                   # load configuration file
                   begin
                     SgtnClient::Config.load(args[0], args[1])
+                    SgtnClient::ValidateUtil.validate_config()
                   rescue => exception
                     file = File.open('./error.log', 'a')
                     file.sync = true
@@ -45,7 +47,12 @@ module SgtnClient
                   end
 
                   # initialize cache
-                  SgtnClient::Core::Cache.initialize()
+                  disable_cache = SgtnClient::Config.configurations[env]["disable_cache"]
+                  if disable_cache != nil
+                        SgtnClient::Core::Cache.initialize(disable_cache)
+                  else
+                        SgtnClient::Core::Cache.initialize()
+                  end
             end
 
             def logger

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

@@ -8,15 +8,20 @@ module SgtnClient
   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)
+        env = SgtnClient::Config.default_environment
+        cache_expiry_period = SgtnClient::Config.configurations[env]["cache_expiry_period"]
         # expired after 24 hours
-        SgtnClient::Core::Cache.put(cache_key, items, 24)
+        if cache_expiry_period == nil
+            cache_expiry_period = 24
+        end
+        SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
       end
 
       def self.get_cachekey(component, locale)

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

@@ -0,0 +1,44 @@
+
+module SgtnClient
+
+  class ValidateUtil
+
+      def self.validate_config()
+        SgtnClient.logger.debug "-----------Start to validate configuration's setting itmes-----------"
+        env = SgtnClient::Config.default_environment
+        messages = "\n"
+
+        mode = SgtnClient::Config.configurations[env]["mode"]
+        if mode != 'sandbox' && mode != 'live'
+          messages =  messages + "Configuration[mode] has to be 'sandbox' or 'live'!\n"
+        end
+        
+        bundle_mode = SgtnClient::Config.configurations[env]["bundle_mode"]
+        if bundle_mode != 'offline' && mode != 'online'
+          messages = messages +  "Configuration[bundle_mode] has to be 'offline' or 'online'!\n"
+        end
+        
+        version = SgtnClient::Config.configurations[env]["version"]
+        if version.is_a? Integer
+          messages = messages +  "Configuration[version] has to be standard as '#.#.#, e.g '1.0.0'!\n"
+        end
+        
+        cache_expiry_period = SgtnClient::Config.configurations[env]["cache_expiry_period"]
+        if cache_expiry_period != nil && (cache_expiry_period.is_a? Integer) == false
+          messages = messages +  "Configuration[cache_expiry_period] has to be a number!\n"
+        end
+        
+        disable_cache = SgtnClient::Config.configurations[env]["disable_cache"]
+        if disable_cache != nil && disable_cache != false && disable_cache != true
+          messages = messages +  "Configuration[disable_cache] has to be a 'true' or 'false'!\n"
+        end
+        
+        if messages != "\n"
+          raise SgtnClient::Exceptions::MissingConfig.new(messages)
+        end
+        SgtnClient.logger.debug "-----------End  to  validate configuration's setting itmes-----------"
+      end
+
+  end
+
+end

data/lib/version.rb

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

data/spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_en.json

@@ -1,6 +1,7 @@
 {
   "component" : "JAVA",
   "messages" : {
+    "hello": "@hello@",
     "com.vmware.loginsight.web.settings.stats.StatsTable.host" : "Host",
     "com.vmware.loginsight.web.settings.stats.StatsTableType.eventsIngestionRatePerSecond" : "Events Ingestion Rate (Per Second)",
     "com.vmware.loginsight.web.settings.stats.StatsTableType.eventsIngestionRatePerSecond.help" : "The actual ingestion rate (syslog + API) of each node after message rebalancing.<br />Log Insight nodes will rebalance messages to attempt uniform ingestion per node for balanced retention and performance.<br /><br />Note that the ingestion rate of each node must be below the ingestion rate configuration maximum for a node.<br /><br />For the actual rate of events being sent directly to each node prior to message rebalancing, see the Syslog Events Incoming Rate (Per Second) and API Events Incoming Rate (Per Second) tables below.",

data/spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh_CN.json

@@ -0,0 +1,11 @@
+{
+  "component" : "JAVA",
+  "messages" : {
+    "com.vmware.loginsight.web.settings.stats.StatsTable.host" : "主机",
+    "com.vmware.loginsight.web.settings.stats.StatsTableType.eventsIngestionRatePerSecond" : "事件载入速率 (每秒)",
+    "com.vmware.loginsight.web.settings.stats.StatsTableType.eventsIngestionRatePerSecond.help" : "消息再平衡之后每个节点的实际载入速率 (syslog + API)。<br />Log Insight 节点将再平衡消息以尝试每节点的统一载入，从而实现平衡保留和性能。<br /><br />请注意，每个节点的载入速率必须低于配置的最大节点载入速率。<br /><br />有关消息再平衡之前直接发送到每个节点的事件的实际速率，请参见下述“Syslog 事件入站速率 (每秒)”和“API 事件入站速率 (每秒)”表。",
+    "com.vmware.loginsight.web.settings.stats.StatsTableType.syslogEventsIncomingRatePerSecond" : "Syslog 事件入站速率 (每秒)",
+    "com.vmware.loginsight.web.utilities.EmailUtil.upgrade.body48" : "{0} 现在正在运行版本 {1}。下面是 {1} 版本中新增的一些出色功能。我们感谢您一如既往地支持，同时非常重视您通过 Twitter 针对我们的 {3} 和 {4} 提供的反馈。<br /><br /><b>vRealize Log Insight 服务器功能</b><br />• TODO 增加服务器功能。<br /><br /><b>vRealize Log Insight 代理功能</b><br />• TODO 增加代理功能。<br /><br />有关 {0} 的新功能的详细信息，请查看 {0} v{1} {2}。<br /><br />祝您使用愉快!<br />{0} 团队<br /><br />"
+  },
+  "locale" : "zh-Hans"
+}

data/spec/config/sgtnclient-invalidate.yml

@@ -0,0 +1,48 @@
+test: &default
+
+  # Credentials for REST APIs
+  client_id: tee
+  client_secret: 89987
+
+  # Mode can be 'live' or 'sandbox'
+  mode: sandbox1
+
+  # Credentials for Classic APIs
+  app_id: APP-80W284485P519543T
+  username: linr
+  password: fdasf
+  signature: sfds-RWy
+  # # With Certificate
+  # cert_path: "config/cert_key.pem"
+  sandbox_email_address: linr@vmware.com
+
+  # #Product Name
+  product_name: logInsight
+
+  # # bundle version
+  version: 481
+
+  # # HTTP Proxy
+  vip_server: https://g11n-vip-dev-1.eng.vmware.com:8090
+
+  # # mode of bundle: online/offline
+  bundle_mode: offline1www
+
+  # # translation bundle Path
+  translation_bundle: ./spec/config/locales/l10n/bundles
+
+  # # source bundle Path
+  source_bundle: ./spec/config/locales/default
+
+  # # memory cache's expration(hours), default value is 24
+  cache_expiry_period: 36t
+
+  # # disable cache, it's optional setting
+  disable_cache: true1
+  
+development:
+  <<: *default
+
+production:
+  <<: *default
+  mode: live

data/spec/config/sgtnclient.yml

@@ -28,12 +28,18 @@ test: &default
   # # mode of bundle: online/offline
   bundle_mode: offline
 
-  # # Offline Bundle Path
+  # # translation bundle Path
   translation_bundle: ./spec/config/locales/l10n/bundles
 
-  # # Offline Bundle Path
+  # # source bundle Path
   source_bundle: ./spec/config/locales/default
 
+  # # memory cache's expration(hours), default value is 24
+  cache_expiry_period: 36
+
+  # # disable cache, it's optional setting
+  ##disable_cache: true
+  
 development:
   <<: *default
 

data/spec/unit/inconfig_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require_relative '../../lib/sgtn-client/sgtn-client.rb'
+
+describe SgtnClient do
+
+  describe "loadinconfig" do
+
+    before :each do
+      #SgtnClient.load("./spec/config/sgtnclient-invalide.yml", "test", './sgtnclient_config.log')
+    end
+
+    it "validate_configuration" do
+      SgtnClient.load("./spec/config/sgtnclient-invalidate.yml", "test", './sgtnclient_config.log')
+    end
+
+  end 
+end

data/spec/unit/offclient_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singleton-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - VMware G11n Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -225,6 +225,7 @@ files:
 - lib/sgtn-client/core/request.rb
 - lib/sgtn-client/sgtn-client.rb
 - lib/sgtn-client/util/cache-util.rb
+- lib/sgtn-client/util/validate-util.rb
 - lib/singleton-ruby.rb
 - lib/version.rb
 - spec/config/locales/default/JAVA/en.yml
@@ -233,14 +234,17 @@ files:
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_latest.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh-Hans.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh-Hant.json
+- spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh_CN.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/creation.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/version.json
 - spec/config/sample_data.yml
+- spec/config/sgtnclient-invalidate.yml
 - spec/config/sgtnclient.yml
 - spec/log/http.log
 - spec/spec_helper.rb
 - spec/support/sample_data.rb
 - spec/unit/config_spec.rb
+- spec/unit/inconfig_spec.rb
 - spec/unit/logging_spec.rb
 - spec/unit/offclient_spec.rb
 - spec/unit/restclient_spec.rb
@@ -275,14 +279,17 @@ test_files:
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_latest.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh-Hans.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh-Hant.json
+- spec/config/locales/l10n/bundles/logInsight/4.8.1/JAVA/messages_zh_CN.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/creation.json
 - spec/config/locales/l10n/bundles/logInsight/4.8.1/version.json
 - spec/config/sample_data.yml
+- spec/config/sgtnclient-invalidate.yml
 - spec/config/sgtnclient.yml
 - spec/log/http.log
 - spec/spec_helper.rb
 - spec/support/sample_data.rb
 - spec/unit/config_spec.rb
+- spec/unit/inconfig_spec.rb
 - spec/unit/logging_spec.rb
 - spec/unit/offclient_spec.rb
 - spec/unit/restclient_spec.rb