bbk-utils 1.0.1.68971 → 1.0.1.72916

data/lib/bbk/utils/env_helper.rb

@@ -1,93 +1,98 @@
 # frozen_string_literal: true
+
 require 'uri'
 
 module BBK
-  module EnvHelper
-    def self.prepare_database_envs(env)
-      uri = build_uri_with_defaults(env)
-      apply_env_from_uri(env, uri)
-      env
-    end
+  module Utils
+    module EnvHelper
 
-    def self.prepare_mq_envs(env)
-      apply_mq_env_from_uri(env, build_mq_uri_with_defaults(env))
-      env
-    end
+      def self.prepare_database_envs(env)
+        uri = build_uri_with_defaults(env)
+        apply_env_from_uri(env, uri)
+        env
+      end
 
-    def self.build_uri_with_defaults(env)
-      ::URI.parse(env['DATABASE_URL'] || '').tap do |uri|
-        uri.scheme    = env.fetch('DATABASE_ADAPTER', uri.scheme) || 'postgresql'
-        uri.user      = env.fetch('DATABASE_USER',    uri.user) || 'postgres'
-        uri.password  = env.fetch('DATABASE_PASS',    uri.password)
-        uri.hostname  = env.fetch('DATABASE_HOST',    uri.hostname) || 'db'
-        uri.port      = env.fetch('DATABASE_PORT',    uri.port) || 5432
+      def self.prepare_mq_envs(env)
+        apply_mq_env_from_uri(env, build_mq_uri_with_defaults(env))
+        env
+      end
 
-        name = env.fetch('DATABASE_NAME', uri.path) || ''
-        name = "/#{name}" unless name.start_with?('/')
-        uri.path = name
+      def self.build_uri_with_defaults(env)
+        ::URI.parse(env['DATABASE_URL'] || '').tap do |uri|
+          uri.scheme    = env.fetch('DATABASE_ADAPTER', uri.scheme) || 'postgresql'
+          uri.user      = env.fetch('DATABASE_USER',    uri.user) || 'postgres'
+          uri.password  = env.fetch('DATABASE_PASS',    uri.password)
+          uri.hostname  = env.fetch('DATABASE_HOST',    uri.hostname) || 'db'
+          uri.port      = env.fetch('DATABASE_PORT',    uri.port) || 5432
+
+          name = env.fetch('DATABASE_NAME', uri.path) || ''
+          name = "/#{name}" unless name.start_with?('/')
+          uri.path = name
+
+          if uri.query
+            params = URI.decode_www_form(uri.query).to_h
+            params['pool'] = env.fetch('DATABASE_POOL', params['pool'])
+            uri.query = URI.encode_www_form(params)
+          end
+        end
+      end
+
+      def self.apply_env_from_uri(env, uri)
+        env['DATABASE_URL'] = uri.to_s
+        env['DATABASE_ADAPTER'] = uri.scheme
+        env['DATABASE_USER'] = uri.user
+        env['DATABASE_PASS'] = uri.password
+        env['DATABASE_HOST'] = uri.hostname
+        env['DATABASE_PORT'] = uri.port.to_s
+        env['DATABASE_NAME'] = uri.path[1..-1]
 
         if uri.query
           params = URI.decode_www_form(uri.query).to_h
-          params['pool'] = env.fetch('DATABASE_POOL', params['pool'])
-          uri.query = URI.encode_www_form(params)
+          env['DATABASE_POOL'] = params['pool']
         end
-
-      end
-    end
-
-    def self.apply_env_from_uri(env, uri)
-      env['DATABASE_URL'] = uri.to_s
-      env['DATABASE_ADAPTER'] = uri.scheme
-      env['DATABASE_USER'] = uri.user
-      env['DATABASE_PASS'] = uri.password
-      env['DATABASE_HOST'] = uri.hostname
-      env['DATABASE_PORT'] = uri.port.to_s
-      env['DATABASE_NAME'] = uri.path[1..-1]
-
-      if uri.query
-        params = URI.decode_www_form(uri.query).to_h
-        env['DATABASE_POOL'] = params['pool']
       end
 
-    end
+      def self.build_mq_uri_with_defaults(env)
+        # Only first MQ_URL selected as template if any
+        url = [env.fetch('MQ_URL', '').split(/[;|]/)].flatten.select(&:present?).first || ''
 
-    def self.build_mq_uri_with_defaults(env)
-      # Only first MQ_URL selected as template if any
-      url = [env.fetch('MQ_URL', '').split(/[;\|]/)].flatten.select(&:present?).first || ''
+        # all hosts if form of list fills url template
+        hosts = [env.fetch('MQ_HOST',
+                           URI.parse(url).hostname || 'mq').split(/[;|]/)].flatten.select(&:present?).uniq
 
-      # all hosts if form of list fills url template
-      hosts = [env.fetch('MQ_HOST', URI.parse(url).hostname || 'mq').split(/[;\|]/)].flatten.select(&:present?).uniq
+        hosts.map do |host|
+          URI.parse(url).tap do |uri|
+            uri.scheme   = uri.scheme || 'amqps'
+            uri.hostname = host
+            uri.port     = env.fetch('MQ_PORT', uri.port) || 5671
+            uri.user     = env.fetch('MQ_USER', uri.user)
+            uri.password = env.fetch('MQ_PASS', uri.password)
 
-      hosts.map do |host|
-        URI.parse(url).tap do |uri|
-          uri.scheme   = uri.scheme || 'amqps'
-          uri.hostname = host
-          uri.port     = env.fetch('MQ_PORT', uri.port) || 5671
-          uri.user     = env.fetch('MQ_USER', uri.user)
-          uri.password = env.fetch('MQ_PASS', uri.password)
+            vhost = [env.fetch('MQ_VHOST', uri.path), '/'].find(&:present?)
+            vhost = "/#{vhost}" unless vhost.start_with?('/')
 
-          vhost = [env.fetch('MQ_VHOST', uri.path), '/'].find(&:present?)
-          vhost = "/#{vhost}" unless vhost.start_with?('/')
+            uri.path = vhost
+          end
+        end
+      end
 
-          uri.path = vhost
+      def self.apply_mq_env_from_uri(env, uris)
+        uri = uris.first
+
+        env['MQ_URL']   = uris.map(&:to_s).join(';')
+        env['MQ_HOST']  = uris.map(&:hostname).join(';')
+        env['MQ_PORT']  = uri.port.to_s
+        env['MQ_PASS']  = uri.password
+        env['MQ_USER']  = uri.user
+        vhost = if uri.path == '/'
+          uri.path
+        else
+          uri.path.gsub(%r{\A/}, '')
         end
+        env['MQ_VHOST'] = vhost
       end
-    end
 
-    def self.apply_mq_env_from_uri(env, uris)
-      uri = uris.first
-
-      env['MQ_URL']   = uris.map(&:to_s).join(';')
-      env['MQ_HOST']  = uris.map(&:hostname).join(';')
-      env['MQ_PORT']  = uri.port.to_s
-      env['MQ_PASS']  = uri.password
-      env['MQ_USER']  = uri.user
-      vhost = if uri.path == '/'
-                uri.path
-              else
-                uri.path.gsub(%r{\A/}, '')
-              end
-      env['MQ_VHOST'] = vhost
     end
   end
 end
+

data/lib/bbk/utils/log_formatter.rb

@@ -1,15 +1,22 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module BBK
-  class LogFormatter < ::Logger::Formatter
-    FORMAT = "%5s [%sUTC #%d] (%s)[%s]: %s\n".freeze
-    def call(severity, time, progname, msg)
-      line = msg2str(msg).gsub("\n", '\\n')
-      format(FORMAT, severity, format_datetime(time.utc), Process.pid, progname, thread_id, line)
-    end
+  module Utils
+    class LogFormatter < ::Logger::Formatter
+
+      FORMAT = "%5s [%sUTC #%d] (%s)[%s]: %s\n"
+      def call(severity, time, progname, msg)
+        line = msg2str(msg).gsub("\n", '\\n')
+        format(FORMAT, severity, format_datetime(time.utc), Process.pid, progname, thread_id, line)
+      end
+
+      def thread_id
+        [Thread.current.object_id.to_s, Thread.current.name].compact.join('@')
+      end
 
-    def thread_id
-      [Thread.current.object_id.to_s, Thread.current.name].compact.join('@')
     end
   end
 end
+

data/lib/bbk/utils/logger.rb

@@ -5,44 +5,47 @@ require 'active_support/tagged_logging'
 require 'bbk/utils/log_formatter'
 
 module BBK
-  class Logger < ::Logger
-    DEFAULT_NAME = 'bbk'
-    DEFAULT_LEVEL = Logger::Severity::DEBUG
+  module Utils
+    class Logger < ::Logger
 
-    def self.new(*args, **kwargs)
-      instance = super
-      ActiveSupport::TaggedLogging.new(instance)
-    end
+      DEFAULT_NAME = 'bbk'
+      DEFAULT_LEVEL = Logger::Severity::DEBUG
 
-    def initialize(progname, level, io: STDOUT)
-      io.sync = true
-      super(io)
-      self.progname = progname
-
-      if level.is_a?(Integer)
-        self.level = level
-      else
-        level = level.to_s.upcase
-        level = level.present? ? level : 'INFO'
-        self.level = Logger.const_get(level)
+      def self.new(*args, **kwargs)
+        instance = super
+        ActiveSupport::TaggedLogging.new(instance)
       end
 
-      self.formatter = LogFormatter.new
-      info "Using LOG_LEVEL=#{level}"
-    end
+      def initialize(progname, level, io: STDOUT)
+        io.sync = true
+        super(io)
+        self.progname = progname
+
+        if level.is_a?(Integer)
+          self.level = level
+        else
+          level = level.to_s.upcase
+          level = level.present? ? level : 'INFO'
+          self.level = Logger.const_get(level)
+        end
+
+        self.formatter = LogFormatter.new
+        info "Using LOG_LEVEL=#{level}"
+      end
 
-    def silence(*_args)
-      yield self
-    end
+      def silence(*_args)
+        yield self
+      end
 
-    def self.default
-      if @default
-        @default
-      else
-        @default = new(DEFAULT_NAME, DEFAULT_LEVEL)
-        @default.level = DEFAULT_LEVEL
+      def self.default
+        unless @default
+          @default = new(DEFAULT_NAME, DEFAULT_LEVEL)
+          @default.level = DEFAULT_LEVEL
+        end
         @default
       end
+
     end
   end
 end
+

data/lib/bbk/utils/proxy_logger.rb

@@ -3,37 +3,42 @@
 require 'bbk/utils/logger'
 
 module BBK
-  class ProxyLogger
-    attr_reader :tags, :logger
+  module Utils
+    class ProxyLogger
 
-    def initialize(logger, tags:)
-      @logger = logger
-      @tagged = @logger.respond_to?(:tagged)
-      @tags = [tags].flatten
-    end
+      attr_reader :tags, :logger
 
-    def add_tags(*tags)
-      @tags += tags.flatten
-      @tags = @tags.uniq
-    end
+      def initialize(logger, tags:)
+        @logger = logger
+        @tagged = @logger.respond_to?(:tagged)
+        @tags = [tags].flatten
+      end
 
-    def method_missing(method, *args, &block)
-      super unless logger.respond_to?(method)
+      def add_tags(*tags)
+        @tags += tags.flatten
+        @tags = @tags.uniq
+      end
+
+      def method_missing(method, *args, &block)
+        super unless logger.respond_to?(method)
 
-      if @tagged
-        current_tags = tags - logger.formatter.current_tags
-        logger.tagged(current_tags) { logger.send(method, *args, &block) }
-      else
-        logger.send(method, *args, &block)
+        if @tagged
+          current_tags = tags - logger.formatter.current_tags
+          logger.tagged(current_tags) { logger.send(method, *args, &block) }
+        else
+          logger.send(method, *args, &block)
+        end
       end
-    end
 
-    def respond_to?(*args)
-      logger.send(:respond_to?, *args) || super
-    end
+      def respond_to?(name, include_private=false)
+        logger.send(:respond_to?, name, include_private) || super
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        logger.send(:respond_to_missing?, method_name, include_private) || super
+      end
 
-    def respond_to_missing?(method_name, include_private = false)
-      logger.send(:respond_to_missing?, method_name, include_private) || super
     end
   end
 end
+

data/lib/bbk/utils/version.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module BBK
   module Utils
-    VERSION = '1.0.1'.freeze
+
+    VERSION = '1.0.1'
+
   end
 end
+

data/lib/bbk/utils/xml.rb

@@ -1,30 +1,41 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 require 'russian'
 
 module BBK
-  module Xml
-    MTOM_ID_FIRST_LETTERS = %w[a b c d e f].freeze
+  module Utils
+    module Xml
 
-    ##
-    # Generate identifier to future substitution in XML body. Ex.: real attachment identifier when uploading to FTP
-    def self.build_substitution_id(id)
-      "@{#{id}}"
-    end
+      MTOM_ID_FIRST_LETTERS = %w[a b c d e f].freeze
 
-    ##
-    # Generate uuid compatible with SOAP AttachmentContent identifier
-    def self.generate_mtom_attachment_id
-      id = SecureRandom.uuid
-      id[0] = MTOM_ID_FIRST_LETTERS.sample
-      id
-    end
+      ##
+      # Generate identifier to future substitution in XML body. Ex.: real attachment identifier when uploading to FTP
+      def self.build_substitution_id(id)
+        "@{#{id}}"
+      end
+
+      ##
+      # Generate uuid compatible with SOAP AttachmentContent identifier
+      def self.generate_mtom_attachment_id
+        id = SecureRandom.uuid
+        id[0] = MTOM_ID_FIRST_LETTERS.sample
+        id
+      end
+
+      ##
+      # Normalize XML href to be predictible and constant in various cases
+      def self.normalize_slug(name, href)
+        href_uri = URI.parse(href)
+        href_slug = [href_uri.scheme, href_uri.host, *href_uri.path.split('/'), href_uri.query].select do |item|
+          item.present?
+        end.join('-').gsub(
+          /[.&]/, '-'
+        )
+        Russian.translit "#{name}_#{href_slug}"
+      end
 
-    ##
-    # Normalize XML href to be predictible and constant in various cases
-    def self.normalize_slug(name, href)
-      href_uri = URI.parse(href)
-      href_slug = [href_uri.scheme, href_uri.host, *href_uri.path.split('/'), href_uri.query].select(&:present?).join('-').gsub(/[\.&]/, '-')
-      Russian.translit "#{name}_#{href_slug}"
     end
   end
 end
+

data/lib/bbk/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext'
 require 'bbk/utils/config'
@@ -10,11 +12,15 @@ require 'bbk/utils/env_helper'
 
 module BBK
   module Utils
+
     class << self
+
       attr_accessor :logger
 
     end
 
-    self.logger = ::BBK::Logger.default
+    self.logger = ::BBK::Utils::Logger.default
+
   end
 end
+

data/sig/bbk/config.rbs

@@ -0,0 +1,55 @@
+module BBK
+  module Utils
+    class Config
+
+      class BooleanCaster
+        FALSE_VALUES: Array[bool | Integer | String | Symbol]
+        def self.cast: (untyped value) -> (bool|nil)
+      end
+
+      interface _CallableCaster
+        def call: (String) -> untyped
+      end
+
+      interface _ClassCaster
+        def new: (String) -> untyped
+      end
+
+      type typeCaster = _CallableCaster | _ClassCaster
+      type configItem = {env: String, file: String?, required: bool, desc: String?, bool: bool, value: untyped, default: untyped, type: typeCaster?}
+      type envSource = _ENV | ENVClass
+
+      attr_accessor store: untyped
+      attr_accessor name: String?
+
+      def self.instance: () -> instance
+      
+      def initialize: (?String name) -> void
+      def map: (envSource env, String file, ?required: bool, ?desc: String, ?bool: bool, ?key: String) -> void
+      def require: (envSource env, ?desc: String?, ?bool: bool, ?type: typeCaster, ?key: String?) -> void
+      def optional: (envSource env, ?default: untyped, ?desc: String, ?bool: bool, ?type: typeCaster, ?key: String) -> void
+
+      def run!: (?envSource source) -> void
+      def []: (String key) -> untyped
+      def []=: (String key, untyped value) -> void
+      def content: (String key) -> untyped
+      def fetch: (String key, ?untyped default) -> untyped
+      # def to_s: () -> String
+      def as_json: (*untyped) -> Hash[String, untyped]
+      def to_json: (*untyped) -> String
+      def to_yaml: (*untyped) -> String
+
+      private
+
+      def normalize_key: (string key) -> String
+      def process: (envSource source, configItem item) -> void
+
+      def required!: (configItem item) -> void
+      def print_file_item: (configItem item, String padding) -> String
+      def print_item: (configItem item, String padding) -> String
+      def wrap_required: (configItem item) -> String
+
+
+    end
+  end
+end

data/sig/bbk/crypt.rbs

@@ -0,0 +1,9 @@
+module BBK
+  module Utils
+    module Crypt
+      def self.full_check: (String key_path, String cert_path, *String cacert_chain) -> Array[String]?
+      def self.valid_key: (String key_path, String cert_path) -> bool
+      def self.valid_cert_sign?: (String cert_path, *String ca_certs_paths) -> bool
+    end
+  end
+end

data/sig/bbk/env_helper.rbs

@@ -0,0 +1,13 @@
+module BBK
+  module Utils
+    module EnvHelper
+
+      def self.prepare_database_envs: (Hash[String, untyped]|::_ENV env ) -> (Hash[String,untyped]|::_ENV)
+      def self.prepare_mq_envs: (Hash[String, untyped]|::_ENV env) -> (Hash[String, untyped]|::_ENV)
+      def self.build_uri_with_defaults: (Hash[String, untyped]|::_ENV env) -> URI::Generic
+      def self.apply_env_from_uri: (Hash[String, untyped]|::_ENV env, URI::Generic uri) -> void
+      def self.build_mq_uri_with_defaults: (Hash[String, untyped]|::_ENV env) -> Array[URI::Generic]
+      def self.apply_mq_env_from_uri: (Hash[String, untyped]|::_ENV env, Array[URI::Generic] uris) -> void
+    end
+  end
+end

data/sig/bbk/log_formatter.rbs

@@ -0,0 +1,10 @@
+module BBK
+  module Utils
+    class LogFormatter
+      FORMAT: String
+      def call: (String severity, Time time, String progname, untyped msg) -> String
+
+      def thread_id: () -> String
+    end
+  end
+end

data/sig/bbk/logger.rbs

@@ -0,0 +1,15 @@
+module BBK
+  module Utils
+    class Logger < ::Logger
+
+      def self.new: (*untyped) -> _Logger
+
+      def initialize: (String progname, String|Symbol|Integer|nil level, ?io: ::Logger::logdev) -> void
+
+      def silence: (*untyped) { (self) -> untyped } -> untyped
+
+      def self.default: () -> instance
+
+    end
+  end
+end

data/sig/bbk/proxy_logger.rbs

@@ -0,0 +1,16 @@
+module BBK
+  module Utils
+    class ProxyLogger
+
+      include _ProxyObject
+
+      attr_reader tags: Array[String]
+      attr_reader logger: BBK::Utils::Logger|::_Logger
+
+      def initialize: (BBK::Utils::Logger|::_Logger logger, tags: Array[String?]|String?) -> void
+
+      def add_tags: (*String tags) -> void
+
+    end 
+  end
+end

data/sig/bbk/proxy_object.rbs

@@ -0,0 +1,7 @@
+module BBK
+  module Utils
+    interface _ProxyObject
+      def method_missing: (Symbol, *untyped) ?{(*untyped, **untyped) -> untyped} -> untyped
+    end
+  end
+end

data/sig/bbk/utils.rbs

@@ -0,0 +1,5 @@
+module BBK
+  module App
+    VERSION: String
+  end
+end

data/sig/bbk/xml.rbs

@@ -0,0 +1,10 @@
+module BBK
+  module Utils
+    module Xml
+      MTOM_ID_FIRST_LETTERS: Array[String]
+      def self.build_substituion_id: (string id) -> String
+      def self.generate_mtom_attachment_id: -> String
+      def self.normalize_slug: (String name, String href) -> String
+    end
+  end
+end

data/sig/env.rbs

@@ -0,0 +1,4 @@
+interface _ENV
+  def []: (String) -> String
+  def []=: (String) -> String
+end

data/sig/logger.rbs

@@ -0,0 +1,37 @@
+interface _Logger
+
+  def add: (untyped severity, ?untyped message, ?untyped progname) -> untyped
+
+  def close: () -> untyped
+
+  def debug: (?untyped progname) { (*untyped) -> untyped } -> untyped
+
+  def debug!: () -> untyped
+
+  def error: (?untyped progname) { (*untyped) -> untyped } -> untyped
+
+  def error!: () -> untyped
+
+  def fatal: (?untyped progname) { (*untyped) -> untyped } -> untyped
+
+  def fatal!: () -> untyped
+
+  def info: (?untyped progname) { (*untyped) -> untyped } -> untyped
+
+  def info!: () -> untyped
+
+  def info?: () -> untyped
+
+  def level: () -> untyped
+
+  def level=: (untyped severity) -> untyped
+
+  def progname: () -> untyped
+
+  def progname=: (untyped) -> untyped
+
+  def warn: (?untyped progname) { (*untyped) -> untyped } -> untyped
+
+  def warn!: () -> untyped
+
+end