razorrisk-cassini-common 0.26.24

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 236c6282305896273a4ec80db78f5455c862c718
+  data.tar.gz: 64be38f9a5b4f4f5ab54d0c0cea21b1166cffe3f
+SHA512:
+  metadata.gz: cb2d95a8efe4270026d02f125f237dde0c2eef7865d1e94a0dc84927b3f1393b1e0bfe7803f7f56ba528b6f0a521a3997e618c0b622e5c2c99f22cab619e0cfc
+  data.tar.gz: b361155b9cf118c9de9af6694945384a55e40909eb2165cbff17e44366446a184aee2d44bf6f4163a30ee197953d0a3cd423641225e09b747776c68559052adf

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## [0.18.1] (2018-06-20)
+
+**Implemented enhancements:**
+
+none
+
+**Fixed defects:**
+
+none
+
+**Dependencies and packaging:**
+
+- separated into own project/repo/package [WEBAPI-138]
+
+**Merged pull requests:**
+
+none
+
+## END OF CHANGE LOG
+

data/LICENSE

@@ -0,0 +1,5 @@
+Cassini
+
+Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+All rights reserved.
+

data/README.md

@@ -0,0 +1,2 @@
+T.B.C.
+

data/Rakefile

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+
+# ##########################################################
+# bundler
+
+require 'rubygems'
+require 'bundler/setup'
+
+
+# ######################################################################## #
+# requires
+
+require 'razor_risk/razor/control/rake_helpers/diagnostic_tasks'
+require 'razor_risk/razor/control/rake_helpers/gem_tasks'
+require 'razor_risk/razor/control/rake_helpers/task_helpers'
+
+require 'rake'
+require 'rake/clean'
+
+
+# ##########################################################
+# includes
+
+include ::RazorRisk::Razor::Control
+include ::Pantheios
+
+
+# ##########################################################
+# Constants
+
+Spec = ::Gem::Specification.load(Dir['*.gemspec'].first)
+LogDir = 'log'
+LogThresholds = [ :informational, :informational ]
+
+
+# ##########################################################
+# clean/clobber
+
+Dir[
+    'log',
+    'doc',
+    'test/reports',
+].each { |f| CLEAN << f }
+Dir[
+    '.bundle',
+    'vendor',
+    'GEM_HOME',
+    '*.gem',
+    '*.zip',
+].each { |f| CLOBBER << f }
+
+
+# ##########################################################
+# Tasks
+
+desc 'Run tests'
+task :test => [ :'gem:unit_test' ]
+
+desc 'Build gem'
+task :build_gem, [ :path ] => :'gem:build'
+
+desc 'Builds the Razor EntityConnector Gem'
+task :build, [ :path ] => [
+    :build_gem,
+]
+
+desc 'Push the gem to the gem server.'
+task :deploy => :'gem:push'
+
+
+# ##########################################################
+# Hooks
+
+task :default do
+    puts 'Run \'bundler exec rake --tasks\' to see available tasks'
+end
+
+task :first do
+    ::Rake::Task[:'diagnostics:init'].execute(
+        name: Spec.name,
+        version: Spec.version.to_s,
+        directory: LogDir,
+        thresholds: LogThresholds,
+    )
+end
+
+RakeHelpers::TaskHelpers.add_hooks
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservice.rb

@@ -0,0 +1,318 @@
+
+#############################################################################
+# File:     lib/razor_risk/cassini/applications/microservice.rb
+#
+# Purpose:  Define the Microservice base class
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 2017, Razor Risk Technologies Pty Ltd
+# All rights reserved
+#
+# ##########################################################################
+
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+require 'razor_risk/cassini/constants'
+
+require 'razor_risk/sinatra/helpers/validate_accept_helper'
+require 'razor_risk/sinatra/helpers/validate_content_type_helper'
+require 'razor_risk/sinatra/helpers/validate_query_parameters_helper'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'sinatra/base'
+
+require 'socket'
+
+module RazorRisk
+module Cassini
+module Applications
+
+# Common base-class for all microservices
+#
+# === Notable features:
+# - provide class attribute +full_description+, which assumes the deriving
+#   class has defined the constants +FULL_DESIGNATION+ +SERVICE_TYPE+ and
+#   +SHORT_DESIGNATION+, that obtains a human-readable "full Cassini'
+#   service description
+# - provides class method +init_base_service+ that is used to initialise the
+#   microservice class. It must be called within a class initialiser of a
+#   derived class
+# - provides class method +run!+ that ensures class initialisation (by a
+#   derived microservice class) has been performed
+# - provides global 'before' handler that:
+#   * trace
+#   * log of request details
+#   * before handle that:
+#     + sets 'Content-Type' to 'text/plain'
+#
+#
+class Microservice < ::Sinatra::Base
+
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    helpers ::RazorRisk::Sinatra::Helpers::ValidateAcceptHelper
+    helpers ::RazorRisk::Sinatra::Helpers::ValidateContentTypeHelper
+    helpers ::RazorRisk::Sinatra::Helpers::ValidateQueryParametersHelper
+
+    private
+    def self.to_nil *a; end
+    def to_nil *a; end
+
+    def self.init_base_service_ \
+        host,
+        port,
+        options
+
+        trace
+
+        # Will raise Errno::EADDRINUSE if port is in use
+        TCPServer.new(host, port).close
+
+        # Default to 'production' rather than 'development' (default from
+        # Sinatra. 'APP_ENV' is a Sinatra environment variable that needs to
+        # be checked first (note this isn't introduced to Sinatra until 2.0).
+        if ENV['APP_ENV']
+            set :environment, ENV['APP_ENV']
+        elsif $DEBUG or Constants::RZ_EXPOSE_MICROSERVICE_EXCEPTIONS
+            set :environment, 'development'
+        else
+            set :environment, 'production'
+        end
+
+        # Call error handlers even in testing.
+        configure :test do
+            set :show_exceptions, :after_handler
+        end
+
+        # Call error handlers even in development.
+        configure :development do
+            set :show_exceptions, :after_handler
+        end
+
+        configure :production do
+
+            # Don't print the stack trace to the console.
+            disable :dump_errors
+
+            # Error handler for all uncaught exceptions when in production.
+            error Exception do
+                x = env['sinatra.error']
+                log :violation, "unexpected exception (#{x.class}): '#{x}'"
+                error 500, "Oops! Something went wrong!"
+            end
+        end
+
+        set :bind, host unless host.nil?
+        set :port, port
+        set :server, options[:web_server] if options[:web_server]
+
+        if options[:tls_certificate_file]
+
+            cts = {
+
+                certificate_file: options[:tls_certificate_file],
+                public_key_file: options[:tls_public_key_file],
+            }
+
+            set :cassini_tls_settings, cts
+        end
+
+        set :microservice_base_is_initialised, Time.now
+
+        if self.respond_to? :on_init_service
+
+            self.on_init_service options
+        end
+
+        self
+    end
+
+    public
+
+    # Provides a full description of an including type, which must have the
+    # constants +FULL_DESIGNATION+, +SERVICE_TYPE+, and +SHORT_DESIGNATION+.
+    def self.full_description
+
+        "#{self::FULL_DESIGNATION} #{self::SERVICE_TYPE.to_s.capitalize} (#{self::SHORT_DESIGNATION})"
+    end
+
+    # Defines catch-all handlers for all available verbs
+    #
+    # Unless given a block, it will create catch-all handlers with a basic
+    # message and obtaining a 404. If a block given, it will be invoked with
+    # two parameters - the method name symbol and an options hash within
+    # which are the options +:env+, +:params+, +:request+, and +:response+ -
+    # and should return an array consisting of the HTTP status code and the
+    # body message.
+    #
+    # NOTE: Must be the last component defining the application!
+    def self.define_catch_all_handlers
+
+        methods =   %i(delete get head link options patch post put unlink)
+
+        if block_given?
+
+            methods.each do |method|
+
+                send method, // do
+
+                    yield method, env: env, params: params, request: request, response: response
+                end
+            end
+        else
+
+            methods.each do |method|
+
+                send method, // do
+
+                    [ 404, "'#{env['PATH_INFO']}' [#{method.to_s.upcase}] not found" ]
+                end
+            end
+        end
+    end
+
+    # This must be invoked prior to activation of the application
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +host+:: [String] The host to which the application binds. May be:
+    #     +nil+, in which case no binding is performed and the Sinatra
+    #     defaults are observed; +'0.0.0.0', in which case the server will
+    #     listen on all available interfaces; a specific IP addres, in which
+    #     case the server will listen only on that address. It is recommend
+    #     that a specific address is used. Required
+    #   - +port+:: [Integer] The port on which to activate. Required
+    def self.init_base_service \
+        host: to_nil(host_not_given_ = true),
+        port: to_nil(port_not_given_ = true),
+        **options
+
+        trace ParamNames[ :host, :port, :options ], host, port, options
+
+        raise ArgumentError, 'missing keyword: host' if host_not_given_
+
+        raise ArgumentError, 'missing keyword: port' if port_not_given_
+        check_parameter port, 'port', type: Integer
+
+        init_base_service_ host, port, options
+    end
+
+    # Refinement of +::Sinatra::Base.run!+ that ensures that the
+    # microservice class has been initialised
+    def self.run!(options = {}, &block)
+
+        trace
+
+        # TODO: Change this to use proper exception
+        unless settings.respond_to?(:microservice_is_initialised) &&
+                settings.respond_to?(:microservice_base_is_initialised)
+
+            raise ArgumentError, "#{self} microservice application class is not initialised. Must first call #{self}.init_service()"
+        end
+
+        # Configures settings in backend service (e.g. thin, webrick)
+        begin
+
+            super do |server|
+
+                # Set the timeout for the backend service. This prevents thin
+                # from closing connections
+                server.timeout = nil if server.respond_to? :timeout
+
+                # This configures ssl in the backend service, which must be
+                # thin.
+                if settings.respond_to? :cassini_tls_settings
+
+                    cts = settings.cassini_tls_settings
+                    ssl_opts = {
+
+                        cert_chain_file: cts[:tls_certificate_file],
+                        private_key_file: cts[:tls_private_key_file],
+                        verify_peer: false,
+                    }
+                    server.ssl = true
+                    server.ssl_options = ssl_opts
+                end
+            end
+        rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+
+            log :violation, "unexpected exception (#{x.class}): '#{x.message}': #{x.backtrace}"
+            raise
+        rescue => x
+
+            log :alert, "exception (#{x.class}): '#{x.message}': #{x.backtrace}"
+            raise
+        end
+    end
+
+    before do
+
+        trace
+
+        # benchmarking (if enabled)
+
+        @before_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_ = Time.now if severity_logged? :benchmark
+
+        # log the request information
+
+        log :informational, 'handling ', request.path_info, ' [', request.request_method, ']'
+
+        if severity_logged? :debug2
+
+            prefix = ?\t
+
+            e = env.map { |k, v| "#{prefix}'#{k}' : '#{v}'" }.sort.join("\n")
+
+            log :debug2, "ENV for #{request.path_info} [#{request.request_method}] :\n#{e}"
+        end
+
+        if severity_logged? :debug3
+
+            request.body.rewind
+
+            b = request.body.read.strip
+
+            request.body.rewind
+
+            log :debug3, "body for #{request.path_info} [#{request.request_method}] :", b.empty? ? 'no body' : ?\n + b
+        end
+
+        # general (shared) logical actions
+
+        # by default, all handlers return 'text/plain'
+        content_type 'text/plain'
+    end
+
+    after do
+
+        trace
+
+        log :informational, 'handled ', request.path_info, ' [', request.request_method, ']'
+
+        # benchmarking (if enabled)
+
+        if @before_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_ && severity_logged?(:benchmark)
+
+            after_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_ =   Time.now
+
+            delta_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_ =   after_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_ - @before_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_
+            delta_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_ *=  1000
+
+            log :benchmark, "execution of HTTP(S) request - '#{request.path_info}' - (in #{self.class}): dt=#{delta_time_01dd7eef998dwfh_23hfsdfh_777_ashdf732bf_}ms"
+        end
+    end
+
+end # class Microservice
+
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/rest_framework/route_verb_dispatcher.rb

@@ -0,0 +1,120 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/rest_framework/route_verb_dispatcher.rb
+#
+# Purpose:      Adaptor for Portfolios microservice's collection GET verb
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/razor/connectivity/razor_3/razor_requester'
+
+require 'razor_risk/cassini/constants'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+module RazorRisk
+module Cassini
+module Applications
+module RESTFramework
+
+# ##########################################################################
+# modules
+
+module RouteVerbDispatch
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    def dispatch supplier, *args, **options
+
+        trace ParamNames[ :supplier, :args, :options ], supplier, args, options
+
+        if ::Class === supplier
+
+            supplier_class  =   supplier
+            supplier        =   supplier_class.new(self, self.class, *args, **options)
+        else
+
+            supplier_class  =   supplier.class
+        end
+
+        if $PARAMETER_CHECKING
+
+            check_parameter supplier, 'supplier', responds_to: :handle
+        end
+
+        verb    =   (options[:verb] || request.request_method).to_s.downcase.to_sym
+
+        # validate 'Accept'
+
+        validate_accept(request, supplier_class::HTTP_ACCEPTS) if supplier_class.const_defined?(:HTTP_ACCEPTS)
+
+        # validate 'Content-Type'
+
+        validate_content_type(request, supplier_class::HTTP_CONTENT_TYPES) if supplier_class.const_defined?(:HTTP_CONTENT_TYPES)
+
+        # validate query parameters
+
+        validated_params = validate_query_parameters(params, supplier_class.const_defined?(:QUERY_PARAMETERS) ?  supplier_class::QUERY_PARAMETERS : nil, supplier_class.const_defined?(:ROUTE_VARIABLES) ?  supplier_class::ROUTE_VARIABLES : nil)
+
+        # handle base-64 for all params
+
+        validated_params = validated_params.merge(validated_params) do |k, o, n|
+
+            case n
+            when ::String
+
+                s   =   n.strip
+
+                if /^===(.+)===$/ =~ s
+
+                    e   =   $1
+
+                    begin
+
+                        Base64.strict_decode64(e).chomp
+                    rescue ::ArgumentError => x
+
+                        halt(*[ 422, {}, "value for query parameter '#{k}' is malformed Base-64: a valid Base-64 string must be prefixed and suffixed by '==='" ])
+                    end
+                else
+
+                    n
+                end
+            else
+
+                n
+            end
+        end
+
+        # execute handler
+        resp = supplier.handle(env, validated_params, request, response)
+
+        # TODO: post-process result, in terms of converting to 'Accept' type
+        # and calling halt / status appropriately
+
+        resp
+    end
+
+end # module RouteVerbDispatch
+
+
+end # module RESTFramework
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/rest_framework/verb_handler.rb

@@ -0,0 +1,117 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/rest_framework/verb_handler.rb
+#
+# Purpose:      Root (abstract) verb-handler class
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/authorisation/security_model_helpers'
+
+require 'razor_risk/extensions/rack/utils/http_status_names'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+module RazorRisk
+module Cassini
+module Applications
+module RESTFramework
+
+# ##########################################################################
+# classes
+
+class VerbHandler
+
+
+    # ##########################################################
+    # includes
+
+    include ::RazorRisk::Cassini::Authorisation::SecurityModelHelpers
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+
+    # ##########################################################
+    # constants
+
+    HTTP_STATUS_NAMES = ::Rack::Utils::HTTP_STATUS_NAMES
+
+
+    # ##########################################################
+    # methods
+
+    def initialize app, settings = nil, **options
+
+        check_parameter app, 'app'
+
+        settings    ||= app.class
+
+        @app        =   app
+        @settings   =   settings
+        @options    =   options
+    end
+
+    attr_reader :app
+    attr_reader :settings
+
+    def content_type *args
+
+        @app.content_type(*args)
+    end
+
+    def halt *args
+
+        @app.halt(*args)
+    end
+
+    def error *args
+
+        @app.error(*args)
+    end
+
+    def status *args
+
+        @app.status(*args)
+    end
+
+    # Obtains a credentials-hash, which will be empty if no authentication
+    # is being used, or will contain +:username+ and, optionally,
+    # +:password+ and/or +:domain+, depending on the authentication scheme
+    # being used
+    def get_required_credentials
+
+        if settings.respond_to?(:authentication_scheme)
+
+            razor_requester_credentials_options(
+                settings.authentication_scheme,
+                app.credentials,
+                auth_test_mode: settings.auth_test_mode
+            )
+        else
+
+            Hash.new
+        end
+    end
+end # class VerbHandler
+
+
+end # module RESTFramework
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+