razorrisk-cassini-utilities-cassid 0.8.11

data/lib/razor_risk/cassini/utilities/cassid/configuration.rb

@@ -0,0 +1,367 @@
+# encoding: UTF-8
+
+
+# ##########################################################################
+#
+# Definition of RazorRisk::Cassini::Utilities::CassiD::Configuration class
+#
+# Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'pantheios'
+require 'xqsr3/extensions/kernel/integer'
+require 'xqsr3/quality/parameter_checking'
+
+
+# ##########################################################
+# Configuration
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassiD
+
+# Class that represents a parsed Cassini configuration
+class Configuration
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    class Element
+
+        include ::Pantheios
+        include ::Xqsr3::Quality::ParameterChecking
+
+        private
+
+        def initialize_from_hash h, attributes, **options
+
+            trace ParamNames[ :h, :attributes, :options ], h, attributes, options
+
+            check_parameter h, 'h', type: ::Hash
+            check_parameter attributes, 'attributes', type: ::Hash
+
+            attributes.each do |name, spec|
+
+                v   =   nil
+                v   =   h[name] if v.nil?
+                v   =   h[name.to_s] if v.nil?
+
+                unless v.nil?
+
+                    convert =   spec[:convert]
+
+                    if false
+                    elsif convert.nil?
+                    elsif ::Integer == convert
+
+                        v = Integer(v, nil: true)
+                    elsif ::Proc === convert
+
+                        v = convert.call(v)
+                    elsif ::Symbol == convert
+
+                        v = v.to_sym
+                    end
+
+                    types   =   spec[:types]
+                    types   ||= [ spec[:type] ].reject { |t| t.nil? }
+
+                    raise ::ArgumentError, "the value - #{v} - for attribute '#{name}' is of type #{v.class} but is required to be #{types}" unless types.empty? || types.any? { |type| v.kind_of?(type) }
+
+                    values  =   [ spec[:values] || [ v ] ].flatten
+
+                    raise ::ArgumentError, "the value - #{v} - is not one of the required values #{values}" unless values.include?(v)
+
+                    define_singleton_method(name) { v }
+                else
+
+                    if spec[:optional]
+
+                        define_singleton_method(name) { spec[:default] }
+                    else
+
+                        raise ::ArgumentError, "missing required attribute '#{name}'"
+                    end
+                end
+            end
+
+            @attribute_names = attributes.keys
+        end
+
+        public
+
+        def inspect
+
+            attrs = @attribute_names
+
+            "#<#{self.class}:0x00#{object_id} attributes : #{attrs}>"
+        end
+    end
+
+    class CassiniSecretServerElement < Element
+
+        Attributes = {
+
+            host:   {
+
+                optional:   true,
+            },
+            port:   {
+
+                optional:   true,
+                type:   ::Integer,
+            },
+            secrets_path: {
+
+                optional:   true,
+            },
+            service_path: {
+
+                optional:   true,
+            },
+        }
+
+        def initialize h, **options
+
+            trace ParamNames[ :h, :options ], h, options
+
+            initialize_from_hash h, Attributes, **options
+        end
+    end
+
+    class CassiniElement < Element
+
+        Attributes = {
+
+            auth_mode:  {
+
+                types:      [ ::String, ::Symbol ],
+                convert:    Proc.new do |v|
+
+                    case v.strip.downcase
+                    when 'b', 'basic'
+
+                        :'basic'
+                    when 'a', /^auth(?:|ori[sz]ation)[-_]only$/
+
+                        :'authorisation_only'
+                    when 'j', 'jwt'
+
+                        :'jwt'
+                    else
+
+                        v
+                    end
+                end,
+                values:     [ 'authorisation_only', 'basic', 'jwt' ].map { |s| s.to_sym },
+            },
+            ces:    {
+
+                type:   ::Hash,
+            },
+            first_port: {
+
+                type:   ::Integer,
+            },
+            host:   {
+
+                optional:   true,
+                type:       ::String,
+            },
+            microservices:  {
+
+                type:   ::Hash,
+            },
+            external_services:  {
+
+                type:     ::Hash,
+                optional: true,
+            },
+            root_dir:   {
+
+                optional:   true,
+                type:   ::String,
+            },
+            secret_server:  {
+
+                optional:   true,
+                type:   ::Hash,
+            },
+            tls:    {
+
+                optional:   true,
+                types:  [ ::Hash, ::String ],
+            },
+            us_multiplier:  {
+
+                optional:   true,
+                type:   ::Integer,
+                default:    1,
+            },
+            web_server: {
+
+                optional:   true,
+                type:   ::String,
+            },
+            web_ui_server:  {
+
+                optional:   true,
+                type:   ::String,
+            },
+            auth_test_mode: {
+                optional: true,
+                types:    [ ::FalseClass, ::TrueClass ],
+            }
+        }
+
+        def initialize h, **options
+
+            trace ParamNames[ :h, :options ], h, options
+
+            initialize_from_hash h, Attributes, **options
+
+            if secret_server
+
+                ss = CassiniSecretServerElement.new(secret_server, **options)
+
+                define_singleton_method(:secret_server) { ss }
+            end
+        end
+    end
+
+    class ControlElement < Element
+
+        Attributes = {
+
+            detach: {
+
+                types:      [ ::FalseClass, ::TrueClass ],
+            },
+            cassid_wait:    {
+
+                optional:   true,
+                type:   ::Integer,
+            },
+            ss_wait:    {
+
+                optional:   true,
+                type:   ::Integer,
+            },
+        }
+
+        def initialize h, **options
+
+            trace ParamNames[ :h, :options ], h, options
+
+            check_parameter h, 'h', type: ::Hash
+
+            initialize_from_hash h, Attributes, **options
+        end
+    end
+
+    class DiagnosticsElement < Element
+
+        Attributes = {
+
+            benchmark:  {
+
+                types:      [ ::FalseClass, ::TrueClass ],
+            },
+            console: {
+
+                type:   ::Hash,
+            },
+            main: {
+
+                type:   ::Hash,
+            },
+            directory: {
+                type:       ::String,
+                optional:   true,
+            },
+        }
+
+        def initialize h, **options
+
+            trace ParamNames[ :h, :options ], h, options
+
+            check_parameter h, 'h', type: ::Hash
+
+            initialize_from_hash h, Attributes, **options
+        end
+    end
+
+    class RazorElement < Element
+
+        Attributes = {
+
+            clarite_config: {
+
+                type:       ::String,
+            },
+            executable: {
+
+                type:       ::String,
+            },
+            environment: {
+
+                type:       ::String,
+                optional:   true,
+            },
+            alias: {
+
+                type:      ::String,
+                optional:   true,
+            },
+            space: {
+
+                type:      ::String,
+                optional:   true,
+            },
+        }
+
+        def initialize h, **options
+
+            trace ParamNames[ :h, :options ], h, options
+
+            check_parameter h, 'h', type: ::Hash
+
+            initialize_from_hash h, Attributes, **options
+        end
+    end
+
+    def initialize h, **options
+
+            trace ParamNames[ :h, :options ], h, options
+
+        check_parameter h, 'h', type: ::Hash
+
+        @cassini        =   CassiniElement.new h['cassini'], **options
+        @control        =   ControlElement.new h['control'], **options
+        @diagnostics    =   DiagnosticsElement.new h['diagnostics'], **options
+        @razor          =   RazorElement.new h['razor'], **options
+    end
+
+    # Object representing the configurations's 'cassini' node
+    attr_reader :cassini
+    # Object representing the configurations's 'control' node
+    attr_reader :control
+    # Object representing the configurations's 'diagnostics' node
+    attr_reader :diagnostics
+    # Object representing the configurations's 'razor' node
+    attr_reader :razor
+
+end # class Configuration
+end # module CassiD
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassid/constants.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassid/constants.rb
+#
+# Purpose:      CassiD constants
+#
+# Created:      23rd February 2018
+# Updated:      5th November 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassiD
+
+    CONFIG_TOP_LEVEL_KEYS   =   %w{ properties cassini control diagnostics razor }
+
+    CONFIG_cassini_KEYS_REQ =   %w{ ces first_port host auth_mode microservices us_multiplier }
+    CONFIG_cassini_KEYS_OPT =   %w{ root_dir secret_server tls web_server web_ui_server external_services auth_test_mode }
+
+    CONFIG_control_KEYS_REQ =   %w{ }
+    CONFIG_control_KEYS_OPT =   %w{ detach cassid_wait ss_wait }
+
+    CONFIG_diag_KEYS_REQ    =   %w{ }
+    CONFIG_diag_KEYS_OPT    =   %w{ benchmark console main directory }
+
+    CONFIG_razor_KEYS_REQ   =   %w{ clarite_config }
+    CONFIG_razor_KEYS_OPT   =   %w{ executable environment alias space }
+
+end # module CassiD
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+