singleton-client 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bff1730aecabe391982a491a349af0a51af8f7c894d79a3704866959460dec5
+  data.tar.gz: ef351201885c96d9ada076af3f780291fc645ac100541bcdb87a7dd2f5bdf9c6
+SHA512:
+  metadata.gz: e10e2f79a2654cd0055dbfa555149c536aa2d7557b9ce1af12206abe2106e851cbb9b428e0e8f8fa6a6833a69f5566ec4a80df6d739d1c46d5b750a9e64d9653
+  data.tar.gz: f7cfc58191dae18ae6b1235980d2009e9d308982ac80c977ffd769884817d4b9745cfb5415996681b9085e366abd93c1b44119983663ecbdf2be4a8d59ff5c86

data/README.md

@@ -0,0 +1,54 @@
+# Singeleton client for Ruby
+
+## Prerequisites
+- Ruby version: 3.0.0 or above
+- Bundler version: 2.2.3 or above
+
+## Run Unit Test
+rake spec:unit
+
+## Usage
+
+Basic Usage:
+
+```ruby
+require 'singleton-ruby'
+
+include SgtnClient
+
+SgtnClient.load(file, mode)
+
+SgtnClient::Source.loadBundles(locale)
+
+@Result = SgtnClient::Translation.getString(component, key, locale)
+
+```
+## API Usage
+
+### Get a string's translation
+SgtnClient::Translation.getString(component, key, locale)
+
+### Get a string's translation and format it with placeholders
+SgtnClient::Translation.getString_f(component, key, args, locale)
+
+### Get a component's translations
+SgtnClient::Translation.getStrings(component, locale)
+
+
+## API Usage(with request_store)
+
+Before call below APIs(without locale and component arguments), it requires to set the locale and component in the initial codes.
+
+### Get a string's translation
+SgtnClient::T.s(key)
+
+### Get a string's translation and format it with placeholders
+SgtnClient::T.s_f(key, args)
+
+### Get a component's translations
+SgtnClient::T.c()
+
+
+
+
+

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

@@ -0,0 +1,74 @@
+require 'erb'
+require 'yaml'
+
+module SgtnClient
+  
+  autoload :CacheUtil,       "sgtn-client/util/cache-util"
+
+  class Source
+
+      def self.getSource(component, key, locale)
+        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
+        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
+          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.getSources(component, locale)
+        cache_key = SgtnClient::CacheUtil.get_cachekey(component, locale)
+        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
+          SgtnClient::CacheUtil.write_cache(cache_key, items)
+        else
+          SgtnClient.logger.debug "Getting sources from cache with key: " + cache_key
+        end
+        return items
+      end
+
+      def self.loadBundles(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.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, 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 = read_yml(bundlepath)
+        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/t.rb

@@ -0,0 +1,22 @@
+module SgtnClient
+    class T < Translation
+
+        def self.s(key)
+            locale = RequestStore.store[:locale]
+            component = RequestStore.store[:component]
+            return getString(component, key, locale)
+        end
+
+        def self.s_f(key, args)
+            locale = RequestStore.store[:locale]
+            component = RequestStore.store[:component]
+            return getString_f(component, key, args, locale)
+        end
+
+        def self.c()
+            locale = RequestStore.store[:locale]
+            component = RequestStore.store[:component]
+            return getStrings(component, locale)
+        end
+    end
+end

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

@@ -0,0 +1,122 @@
+require 'multi_json'
+
+module SgtnClient
+
+  module Core
+    autoload :Request,     "sgtn-client/core/request"
+    autoload :Cache,       "sgtn-client/core/cache"
+    autoload :CacheUtil,   "sgtn-client/util/cache-util"
+    autoload :LocaleUtil,   "sgtn-client/util/locale-util"
+  end
+  
+  class Translation
+
+      def self.getString(component, key, 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
+
+        default = SgtnClient::Config.configurations.default
+        if items.nil? || items["messages"] == nil
+          return SgtnClient::Source.getSource(component, key, default)
+        end
+        str = items["messages"][key]
+        if str.nil?
+          return SgtnClient::Source.getSource(component, key, default)
+        else
+          return str
+        end
+       end
+
+      def self.getString_f(component, key, args, locale)
+         s = getString(component, key, locale)
+         if args.is_a?(Hash)
+          args.each do |source, arg|
+            s.gsub! "{#{source}}", arg
+          end
+         elsif args.is_a?(Array)
+          s = sprintf s % args
+         end
+         return s
+      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
+
+        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"] = default_component
+          items["messages"] = value
+          items["locale"] = 'source'
+        end
+        return items
+       end
+
+
+      private
+
+      def self.getTranslations(component, locale)
+        env = SgtnClient::Config.default_environment
+        mode = SgtnClient::Config.configurations[env]["bundle_mode"]
+        if mode == 'offline'
+          return get_offbundle(component, locale)
+        else
+          return get_server(component, locale)
+        end
+      end
+
+      def self.get_offbundle(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
+        begin
+          file = File.read(bundlepath)
+          data_hash = MultiJson.load(file)
+        rescue => exception
+          SgtnClient.logger.error exception.message
+        end
+        return data_hash
+      end
+
+      def self.get_server(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
+          SgtnClient.logger.error exception.message
+        end
+        if obj != nil
+          obj = obj["data"]
+        end
+        return obj
+      end
+
+  end
+
+end

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

@@ -0,0 +1,83 @@
+require 'date'
+
+module SgtnClient::Core
+        class Cache
+            Entry = Struct.new(:expiry, :value)
+
+            def self.initialize(disabled=false, opts={})
+                $opts = opts
+                SgtnClient.logger.debug "Initialize cache......"
+                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
+                SgtnClient.logger.debug "Get cache keys"
+                $data.keys
+            end
+
+            def self.get(key)
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Get cache for key: " + key
+                invalidate
+                $data[key][:value] if has(key)
+            end
+
+            def self.has(key)
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Has cache for key: " + key
+                $data.has_key? key
+            end
+
+            def self.put(key, value, ttl=nil)
+                if $data == 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
+                $data[key] = Entry.new(Time.now + ttl*60, value)
+            end
+
+            def self.delete(key)
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Delete cache for key: " + key
+                $data.delete key
+            end
+
+            def self.clear
+                if $data == nil
+                    return nil
+                end
+                SgtnClient.logger.debug "Clear cache!"
+                $data = Hash.new
+            end
+
+            def self.invalidate
+                if $data == nil
+                    return 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}
+            end
+        end
+
+end

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

@@ -0,0 +1,166 @@
+require 'erb'
+require 'yaml'
+
+module SgtnClient
+  #include Exceptions
+  module Configuration
+
+    def config
+        @config ||= Config.config
+    end
+
+    def set_config(env, override_configurations = {})
+      @config =
+        case env
+        when Config
+          env
+        when Hash
+          begin
+            config.dup.merge!(env)
+          rescue Errno::ENOENT => error
+            Config.new(env)
+          end
+        else
+          Config.config(env, override_configurations)
+        end
+    end
+
+    alias_method :config=, :set_config
+
+  end
+  
+
+  class Config
+
+    attr_accessor :username, :password, :signature, :app_id, :cert_path,
+    :token, :token_secret, :subject,
+    :http_timeout, :http_proxy,
+    :device_ipaddress, :sandbox_email_address,
+    :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,
+    :translation_bundle, :source_bundle, :cache_expiry_period, :disable_cache
+
+
+    # Create Config object
+    # === Options(Hash)
+    # * <tt>username</tt>   -- Username
+    # * <tt>password</tt>   -- Password
+    # * <tt>signature</tt> (Optional if certificate present) -- Signature
+    # * <tt>app_id</tt>     -- Application ID
+    # * <tt>cert_path</tt> (Optional if signature present)  -- Certificate file path
+    def initialize(options)
+      merge!(options)
+    end
+
+    # Override configurations
+    def merge!(options)
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+      self
+    end
+    
+    class << self
+
+        @@config_cache = {}
+        def load(file_name, default_env = default_environment)
+          @@config_cache        = {}
+          @@configurations      = read_configurations(file_name)
+          @@default_environment = default_env
+          config
+        end
+
+
+        # Get default environment name
+        def default_environment
+          @@default_environment ||= ENV['SGTN_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development"
+        end
+
+
+        # Set default environment
+        def default_environment=(env)
+          @@default_environment = env.to_s
+        end
+
+        def configure(options = {}, &block)
+          begin
+            self.config.merge!(options)
+          rescue Errno::ENOENT
+            self.configurations = { default_environment => options }
+          end
+          block.call(self.config) if block
+          self.config
+        end
+        alias_method :set_config, :configure
+
+        # Create or Load Config object based on given environment and configurations.
+        # === Attributes
+        # * <tt>env</tt> (Optional) -- Environment name
+        # * <tt>override_configuration</tt> (Optional) -- Override the configuration given in file.
+        # === Example
+        #   Config.config
+        #   Config.config(:development)
+        #   Config.config(:development, { :app_id => "XYZ" })
+        def config(env = default_environment, override_configuration = {})
+          if env.is_a? Hash
+            override_configuration = env
+            env = default_environment
+          end
+          if override_configuration.nil? or override_configuration.empty?
+            default_config(env)
+          else
+            default_config(env).dup.merge!(override_configuration)
+          end
+        end
+  
+        def default_config(env = nil)
+          env = (env || default_environment).to_s
+          if configurations[env]
+            @@config_cache[env] ||= new(configurations[env])
+          else
+            raise SgtnClient::Exceptions::MissingConfig.new("Configuration[#{env}] NotFound")
+          end
+        end
+        
+        # Get raw configurations in Hash format.
+        def configurations
+          @@configurations ||= read_configurations
+        end
+  
+        # Set configuration
+        def configurations=(configs)
+          @@config_cache   = {}
+          @@configurations = configs && Hash[configs.map{|k,v| [k.to_s, v] }]
+        end
+
+        # Set logger
+        def logger=(logger)
+          Logging.logger = logger
+        end
+
+        # Get logger
+        def logger
+          if @@configurations[:mode] == 'live' and Logging.logger.level == Logger::DEBUG
+            Logging.logger.warn "DEBUG log level not allowed in live mode for security of confidential information. Changing log level to INFO..."
+            Logging.logger.level = Logger::INFO
+          end
+          Logging.logger
+        end
+
+        private
+        # Read configurations from the given file name
+        # === Arguments
+        # * <tt>file_name</tt> (Optional) -- Configuration file path
+        def read_configurations(file_name = "config/sgtnclient.yml")
+          erb = ERB.new(File.read(file_name))
+          erb.filename = file_name
+          YAML.load(erb.result)
+        end       
+          
+
+    end
+  end
+
+end

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

@@ -0,0 +1,112 @@
+require 'multi_json'
+require 'pp'
+
+module SgtnClient
+  module Exceptions
+    class ConnectionError < StandardError # :nodoc:
+      attr_reader :response
+
+      def initialize(response, message = nil)
+        @response = response
+        @message  = message
+      end
+
+      def to_s
+        begin
+          response_body = MultiJson.load(response.body)
+          debug_id = response["sgtn-debug-id"]
+          debug_id = response["correlation-id"] if debug_id.to_s == ''
+          debug_id = response_body["debug_id"] if debug_id.to_s == ''
+        rescue
+        end
+        message = "Failed."
+        message << "  Response code = #{response.code}." if response.respond_to?(:code)
+        message << "  Response message = #{response.message}." if response.respond_to?(:message)
+        message << "  Response debug ID = #{debug_id}." if debug_id
+        message
+      end
+    end
+
+    # Raised when a Timeout::Error occurs.
+    class TimeoutError < ConnectionError
+      def initialize(message)
+        @message = message
+      end
+      def to_s; @message ;end
+    end
+
+    # Raised when a OpenSSL::SSL::SSLError occurs.
+    class SSLError < ConnectionError
+      def initialize(message)
+        @message = message
+      end
+      def to_s; @message ;end
+    end
+
+    # 3xx Redirection
+    class Redirection < ConnectionError # :nodoc:
+      def to_s
+        response['Location'] ? "#{super} => #{response['Location']}" : super
+      end
+    end
+
+    class MissingParam < ArgumentError # :nodoc:
+    end
+
+    class MissingConfig < StandardError # :nodoc:
+    end
+
+    # 4xx Client Error
+    class ClientError < ConnectionError # :nodoc:
+    end
+
+    # 400 Bad Request
+    class BadRequest < ClientError # :nodoc:
+    end
+
+    # 401 Unauthorized
+    class UnauthorizedAccess < ClientError # :nodoc:
+    end
+
+    # 403 Forbidden
+    class ForbiddenAccess < ClientError # :nodoc:
+    end
+
+    # 404 Not Found
+    class ResourceNotFound < ClientError # :nodoc:
+    end
+
+    # 409 Conflict
+    class ResourceConflict < ClientError # :nodoc:
+    end
+
+    # 410 Gone
+    class ResourceGone < ClientError # :nodoc:
+    end
+
+    # 422 Unprocessable Entity
+    class ResourceInvalid < ClientError # :nodoc:
+    end
+
+    # 5xx Server Error
+    class ServerError < ConnectionError # :nodoc:
+    end
+
+    # 405 Method Not Allowed
+    class MethodNotAllowed < ClientError # :nodoc:
+      def allowed_methods
+        @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
+      end
+    end
+
+    # API error: returned as 200 + "error" key in response.
+    class UnsuccessfulApiCall < RuntimeError
+      attr_reader :api_error
+
+      def initialize(api_error)
+        super(api_error['message'])
+        @api_error = api_error
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'logger'
+
+module SgtnClient
+
+  # Include Logging module to provide logger functionality.
+  # == Configure logger
+  #   Logging.logger = Logger.new(STDERR)
+  #
+  # == Example
+  #   include Logger
+  #   logger.info "Debug message"
+  module Logging
+
+    # Get logger object
+    def logger
+      @logger ||= Logging.logger
+    end
+
+    def log_event(message, &block)
+      start_time = Time.now
+      block.call
+    ensure
+      logger.info sprintf("[%.3fs] %s", Time.now - start_time, message)
+    end
+
+    class << self
+
+      # Get or Create configured logger based on the default environment configuration
+      def logger
+        @logger ||= Logger.new(STDERR)
+      end
+
+      # Set logger directly and clear the loggers cache.
+      # === Attributes
+      # * <tt>logger</tt> -- Logger object
+      # === Example
+      #   Logging.logger = Logger.new(STDERR)
+      def logger=(logger)
+        @logger = logger
+        if Config.config.mode.eql? 'live' and @logger.level == Logger::DEBUG
+          @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
+
+    end
+  end
+
+end
+

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

@@ -0,0 +1,17 @@
+require 'rest-client'
+require 'multi_json'
+
+module SgtnClient::Core
+    class Request
+        def self.get(url)
+          res = RestClient.get(url)
+          begin
+            obj = MultiJson.load(res)
+          rescue MultiJson::ParseError => exception
+            exception.data
+            exception.cause
+          end
+          return obj
+        end
+    end
+end

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

@@ -0,0 +1,70 @@
+module SgtnClient
+      module Core
+            autoload :Cache,        "sgtn-client/core/cache"
+      end
+
+      autoload :Translation,        "sgtn-client/api/translation"
+      autoload :T,                  "sgtn-client/api/t"
+      autoload :Source,             "sgtn-client/api/source"
+      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"
+      autoload :LocaleUtil,         "sgtn-client/util/locale-util"
+
+      class << self
+            def configure(options = {}, &block)
+            SgtnClient::Config.configure(options, &block)
+            end
+
+            include Logging
+            def load(*args)
+                  # 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
+                    log = Logger.new(file)
+                    log.error exception.message
+                  end
+
+                  # create log file
+                  file = './sgtnclient_d.log'
+                  if args[2] != nil
+                        file = args[2]
+                  end
+                  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
+                  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
+                  SgtnClient::Config.logger
+            end
+
+            def logger=(log)
+                  SgtnClient::Config.logger = log
+            end           
+      end
+  
+end

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

@@ -0,0 +1,39 @@
+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.clear_cache()
+        SgtnClient::Core::Cache.clear()
+      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
+        if cache_expiry_period == nil
+            cache_expiry_period = 24*60
+        end
+        SgtnClient::Core::Cache.put(cache_key, items, cache_expiry_period)
+      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"].to_s
+        return product_name + "_" + version + "_" + component + "_" + locale
+      end
+  end
+
+end

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

@@ -0,0 +1,31 @@
+module SgtnClient
+
+    DEFAULT_LOCALES = ['en', 'de', 'es', 'fr', 'ko', 'ja', 'zh-Hans', 'zh-Hant']
+
+    MAP_LOCALES = {
+                    "zh-CN" =>"zh-Hans",
+                    "zh-TW" =>"zh-Hant",
+                    "zh-Hans-CN" =>"zh-Hans",
+                    "zh-Hant-TW" =>"zh-Hant",
+                  }
+
+    class LocaleUtil
+        def self.fallback(locale)
+            found = SgtnClient::DEFAULT_LOCALES.select {|e| e == locale}
+            if !found.empty?
+                return found[0]
+            end
+            if SgtnClient::MAP_LOCALES.key?(locale)
+                return SgtnClient::MAP_LOCALES[locale]
+            end
+            parts = locale.split("-")
+            if parts.size > 1
+                f = SgtnClient::DEFAULT_LOCALES.select {|e| e == parts[0]}
+                if !f.empty?
+                    return f[0]
+                end
+            end 
+            return locale
+        end
+    end
+end

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' && bundle_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/singleton-ruby.rb

@@ -0,0 +1,2 @@
+require "sgtn-client/sgtn-client"
+

data/lib/version.rb

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

metadata

@@ -0,0 +1,278 @@
+--- !ruby/object:Gem::Specification
+name: singleton-client
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- VMware G11n Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: http-accept
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Singleton Ruby client
+email: g11n-vip-project@vmware.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/sgtn-client/api/source.rb
+- lib/sgtn-client/api/t.rb
+- lib/sgtn-client/api/translation.rb
+- lib/sgtn-client/core/cache.rb
+- lib/sgtn-client/core/config.rb
+- lib/sgtn-client/core/exceptions.rb
+- 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/sgtn-client/util/locale-util.rb
+- lib/sgtn-client/util/validate-util.rb
+- lib/singleton-ruby.rb
+- lib/version.rb
+homepage: https://github.com/vmware/singleton
+licenses:
+- EPL 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Singleton Ruby client
+test_files: []