razorrisk-cassini-utilities-cassis 0.7.6

data/lib/razor_risk/cassini/utilities/cassis/configuration_generator.rb

@@ -0,0 +1,274 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassis/configuration_generator.rb
+#
+# Purpose:      ::RazorRisk::Cassini::Utilities::CassIS::ConfigurationGenerator
+#
+# Created:      11th July 2018
+# Updated:      7th November 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+require 'razor_risk/cassini/utilities/cassis/internal/require/pantheios'
+require 'razor_risk/cassini/utilities/cassis/internal/require/xqsr3/quality/parameter_checking'
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassIS
+
+class ConfigurationGenerator
+
+    include ::Pantheios
+
+    include ::Xqsr3::Quality::ParameterChecking
+
+    module Constants
+
+        TOP_LEVEL_KEYS  =   %w{ properties cassini control diagnostics razor }
+
+
+    end # module Constants
+
+    class Microservice
+
+        include ::Pantheios
+
+        include ::Xqsr3::Quality::ParameterChecking
+
+        class Route
+
+            include ::Pantheios
+
+            include ::Xqsr3::Quality::ParameterChecking
+
+            def initialize internal, security, verbs
+
+                internal    =   check_parameter internal, 'internal', type: ::String
+                security    =   check_parameter security, 'security', types: [ :boolean, ::Symbol ], values: [ false, true, :insecure, :secure, nil ], allow_nil: true
+                verbs       =   check_parameter verbs, 'verbs', types: [ ::String, ::Symbol, [ ::String, ::Symbol ]]
+
+                verbs       =   [ verbs ] unless ::Array == verbs
+
+                security    =
+                case security
+                when :secure, true
+
+                    true
+                when :insecure, false, nil
+
+                    false
+                else
+
+                    $stderr.puts "unexpected value for security - '#{security}' (of type #{security.class})"
+                end
+
+                @internal   =   internal
+                @security   =   security
+                @verbs      =   verbs
+            end
+
+            attr_reader :internal
+            attr_reader :security
+            attr_reader :verbs
+
+            def to_h
+
+                h   =   {
+
+                    'internal'  =>  internal,
+                    'security'  =>  security,
+                    'verbs'     =>  verbs.map { |verb| verb.to_s },
+                }
+            end
+        end
+
+        def initialize name, external_route, service_path, routes, **options
+
+            @name           =   check_parameter name, 'name', type: ::String
+            @external_route =   check_parameter external_route, 'external_route', type: ::String, allow_nil: true
+            @service_path   =   check_parameter service_path, 'service_path', type: ::String, allow_nil: true
+            @routes         =   check_parameter routes, 'routes', types: [ Route, [ Route ] ]
+
+            @external_route ||= options[:restful] ? "entities/#{@name}" : @name
+            @service_path   ||= "bin/razorrisk-microservice-#{name.gsub('_', '-')}"
+            @routes         =   [ @routes ] if Route === @routes
+        end
+
+
+        attr_reader :name
+        attr_reader :external_route
+        attr_reader :routes
+        attr_reader :service_path
+
+        def to_h
+
+            routes_u = routes.uniq { |r| "#{r.internal}:#{r.verbs}" }
+
+            h   =   {
+
+                'external_route'    =>  external_route,
+                'routes'            =>  routes_u.map { |route| route.to_h },
+                'service_path'      =>  service_path,
+            }
+        end
+    end
+
+    #
+    # === Signature
+    #
+    # * *Options:*
+    # @option +:stock+:: (::Hash) Specifications for *stock* microservices.
+    #  May be +nil+
+    def initialize **options
+
+        restful =   check_option(options, :restful, type: [ Microservice ], allow_nil: true)
+        stock   =   check_option(options, :stock, types: [ [ Microservice ] ], allow_nil: true)
+
+        @options    =   {}.merge(options)
+    end
+
+    def generate root_directory = nil, **options
+
+        check_option(options, :restful, type: [ Microservice ], allow_nil: true)
+        check_option(options, :stock, type: [ Microservice ], allow_nil: true)
+
+        options     =   @options.merge(options)
+
+        restful     =   options[:restful] || []
+        stock       =   options[:stock] || []
+
+        h           =   {}
+
+        Constants::TOP_LEVEL_KEYS.each { |k| h[k] = {} }
+
+
+
+        # properties
+
+        properties  =   h['properties']
+
+        properties['edit-history'] = [
+
+            "This file generated on #{Time.now.strftime('%Y/%m/%d %H:%M:%S.%L')}",
+        ]
+
+
+        # cassini
+
+        cassini     =   h['cassini']
+
+        cassini['auth_mode']    =   lookup_(options, :auth_mode) ||\
+                "*** ENTER THE AUTHORISATION MODE - ONE OF 'authorisation_only', 'basic' OR 'jwt' - WHICH THE INSTANCE WILL SUPPORT ***"
+
+        cassini['ces']          =   {
+
+            'service_path' => 'bin/razorrisk-microservice-clientedgeservice',
+        }
+
+        cassini['first_port']   =   lookup_(options, :first_port) ||\
+                '*** ENTER THE FIRST PORT, WHICH IS THE ONE BY WHICH YOU WILL CONNECT TO CASSINI ***'
+
+        cassini['host'] =   lookup_(options, :host) ||\
+                '*** ENTER THE HOST IDENTIFIER BY WHICH YOU WILL CONNECT TO CASSINI ***'
+
+        cassini['microservices'] = {
+
+            'stock'     =>  Hash[stock.map { |usvc| [ usvc.name, usvc.to_h ] }],
+            'restful'   =>  Hash[restful.map { |usvc| [ usvc.name, usvc.to_h ] }],
+        }
+
+        cassini['tls'] = {
+
+            'cert' => '*** ENTER THE (RELATIVE/ABSOLUTE) PATH OF THE CERTIFICATE FILE ***',
+            'key' => '*** ENTER THE (RELATIVE/ABSOLUTE) PATH OF THE CERTIFICATE PUBLIC KEY FILE ***',
+        }
+
+        cassini['us_multiplier'] = lookup_(options, :us_multiplier) ||\
+                '*** ENTER A MULTIPLIER FOR THE NUMBER OF EACH INTERNAL MICROSERVICE TO USE ***'
+
+        cassini['root_dir'] = root_directory ||\
+                "*** ENTER THE ROOT DIRECTORY WHEN CONFIGURING THE INSTALLATION ***"
+
+        cassini['web_server'] = lookup_(options, :web_server) ||\
+                "*** ENTER THE WEB-SERVER TO USE - REMEMBER ONLY THE 'thin' WEB-SERVER SUPPORTS TLS/SSL ***"
+
+        cassini['web_ui_server'] = lookup_(options, :web_ui_server) ||\
+                "*** ENTER THE WEB-UI-SERVER TO USE - REMEMBER THAT THIS MAY INCLUDE WILDCARDS ***"
+
+        # control
+
+        control     =   h['control']
+
+        control['detach']   =   false
+
+        control['ss_wait']  =   4
+
+        control['cassid_wait']  =   10
+
+        # diagnostics
+
+        diagnostics =   h['diagnostics']
+
+        diagnostics['benchmark']    =   false
+        diagnostics['console']      =   {
+
+            'threshold' => 'informational',
+        }
+        diagnostics['main']         =   {
+
+            'threshold' => 'informational',
+        }
+
+        # razor
+
+        razor       =   h['razor']
+
+        razor['clarite_config'] = lookup_(options, :clarite_config) ||\
+                '*** ENTER THE (RELATIVE/ABSOLUTE) PATH OF THE CLARITE CONFIG FILE ***'
+
+        razor['environment'] = lookup_(options, :environment) ||\
+                '*** ENTER THE (RELATIVE/ABSOLUTE) PATH OF THE RAZOR ENVIRONMENT ***'
+
+        razor['executable'] = lookup_(options, :executable) ||\
+                '*** ENTER THE (RELATIVE/ABSOLUTE) PATH OF THE RAZOR CONNECTIVITY ADAPTOR EXECUTABLE ***'
+
+
+        h
+    end
+
+    private
+    def lookup_(h, *name_strings)
+
+        names   =   name_strings.map { |n| n.to_s }.uniq
+        names   =   names + names.map { |s| s.to_sym }
+
+        names.each do |name|
+
+            return h[name] if h.has_key?(name)
+        end
+
+        h.default
+    end
+    public
+
+end # class ConfigurationGenerator
+
+end # module CassIS
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassis/constants.rb
+#
+# Purpose:      Constants
+#
+# Created:      27th October 2018
+# Updated:      27th October 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+
+module CassIS
+
+    CASSIS_INFO_DESCRIPTION     =   'CassIS - the Cassini Installation System'
+    CASSINI_INFO_DESCRIPTION    =   'Cassini - the Razor Risk Web Services API'
+    CASSINI_INFO_COPYRIGHT_     =   'Copyright Razor Risk Technologies (c) '
+
+end # module CassIS
+
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+
+

data/lib/razor_risk/cassini/utilities/cassis/internal/require/pantheios.rb

@@ -0,0 +1,16 @@
+
+begin
+
+    require 'pantheios'
+rescue LoadError
+
+    module Pantheios; end
+
+    class ParamNames; def self.[](*args); end; end
+
+    def trace(*args); end
+end
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassis/internal/require/xqsr3/quality/parameter_checking.rb

@@ -0,0 +1,16 @@
+
+begin
+
+    require 'xqsr3/quality/parameter_checking'
+rescue LoadError
+
+    module Xqsr3; module Quality; module ParameterChecking; end; end; end
+
+    def check_parameter(a0, *args); a0; end
+
+    def check_option(options, symbol, *args); options[symbol]; end
+end
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassis/program_utils.rb

@@ -0,0 +1,86 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassis/program_utils.rb
+#
+# Purpose:      Program utility functions
+#
+# Created:      26th June 2018
+# Updated:      27th October 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+require 'razor_risk/cassini/utilities/cassis/internal/require/pantheios'
+require 'razor_risk/cassini/utilities/cassis/internal/require/xqsr3/quality/parameter_checking'
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+module CassIS
+
+module ProgramUtils
+
+    def basename
+
+        bn  = File.basename $0
+
+        /\.rb$/ =~ bn ? "#$`(.rb)" : bn
+    end
+
+    def fo_help name, usage
+
+        "\t#{name}\n\t\t#{usage}"
+    end
+
+    def make_windows_path dir, homedrive
+
+        return dir if dir =~ /^[A-Z]:/i
+
+        dir =   "/#{dir}" unless [ '/', '\\' ].include? dir[0]
+
+        "#{homedrive}#{dir}"
+    end
+
+    def quote_if s
+
+        return s if s !~ /\s/
+
+        %Q<"#{s}">
+    end
+
+    def ruby
+
+        return 'ruby.exe' if windows?
+
+        'ruby'
+    end
+
+    def windows?
+
+        w   =   false
+
+        w   ||= ENV['OS'] == 'Windows_NT'
+        w   ||= RUBY_PLATFORM =~ /mingw/
+        w   ||= RUBY_PLATFORM =~ /mswin/
+
+        w
+    end
+end # module ProgramUtils
+
+end # module CassIS
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/cassis/version.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/cassis/version.rb
+#
+# Purpose:      Version for RazorRisk CassIS utility support library
+#
+# Created:      11th July 2018
+# Updated:     25th January 2019
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+
+module CassIS
+
+    # Current version of the RazorRisk.Cassini.Common library
+    VERSION             =   '0.7.6'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk.Cassini.Common library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk.Cassini.Common library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk.Cassini.Common library
+    VERSION_PATCH       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk.Cassini.Common library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   'Cassini Web Service framework for Razor Risk Razor system'
+
+    # [DEPRECATED] Instead use +DESCRIPTION+
+    FRAMEWORK_DESCRIPTION = DESCRIPTION
+
+end # module CassIS
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+