razorrisk-cassini-common 0.26.24

data/lib/razor_risk/cassini/mixin/razor_response_validator.rb

@@ -0,0 +1,176 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/core/diagnostics/exceptions/rrcs_base_exception'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+
+# ##########################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Mixin
+
+
+# ##########################################################
+# Mixin Module
+
+# Methods for handling qualified responses from Razor. Should be included by
+# a Sintra Microservice. When included into a microservice that inherits from
+# Sinatra::Base it will define a custom error hanlder so exceptions generated
+# during validation do not need to be caught.
+module RazorResponseValidator
+
+    # ##########################################################
+    # extends
+
+    extend self
+
+
+    # ##########################################################
+    # includes
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+
+    # ##########################################################
+    # exceptions
+
+    class RazorErrorException < ::RazorRisk::Core::Diagnostics::Exceptions::RRCSBaseException
+
+        include ::Pantheios
+        include ::Xqsr3::Quality::ParameterChecking
+        include ::RazorRisk::Core::Diagnostics::Logger
+
+        attr_reader :http_status
+        attr_reader :options
+
+        # Raised when a qualified response failed with a Razor Error
+        # specified.
+        #
+        # @param http_status [Integer] The recommended HTTP error status.
+        # @param message [String] The exception message.
+        # @param options [Hash] The options hash.
+        #
+        # @option options [Exception] :cause The causing exception.
+        def initialize http_status, message, **options
+
+            trace(
+                ParamNames[ :http_status, :message, :options ],
+                http_status, message, options
+            )
+
+            @http_status = check_parameter(
+                http_status, 'http_status',
+                type: Integer,
+            )
+
+            super message, **options
+
+            @options = options
+        end
+    end
+
+
+    # ##########################################################
+    # methods
+
+    # Adds a custom error handler to a Sintra Application so the exceptions
+    # raised by +validate_qualified_response+ will automatically get handled.
+    def included(base)
+
+        if base.respond_to? :error
+            base.error RazorErrorException do
+                x = env['sinatra.error']
+                halt(
+                    x.http_status,
+                    { 'Content-Type' => 'text/plain' },
+                    x.message
+                )
+            end
+        end
+    end
+
+    # Halts procressing the request with an appropriate status code if the
+    # response is a failure and provided a Razor Error code.
+    #
+    # @raise [RazorErrorException] if the response is a failure and provided
+    #   a Razor Error code.
+    def validate_qualified_razor_response qualified_result
+
+        return unless qualified_result.respond_to? :succeeded?
+
+        unless qualified_result.succeeded?
+
+            failure_qualifier = qualified_result.failure_qualifier
+            return unless failure_qualifier.respond_to? :reasons
+
+            reasons = failure_qualifier.reasons
+
+            if r = reasons.lookup?('RZ0007')
+                # Unauthorized
+                log :debug1, 'Invalid Razor session'
+                raise RazorErrorException.new 401, 'Invalid credentials'
+            elsif r = reasons.lookup?('RZ0009')
+                # Invalid session
+                log :debug1, 'Invalid Razor session'
+                raise RazorErrorException.new 401, 'Invalid credentials'
+            elsif r = reasons.lookup?('RZ0002')
+                # Generic error, should be checked before others as will
+                # acompany errors such as ODBC errors that should not be
+                # reported to the user.
+                reasons_str = reasons.map { |r| "#{r.message}: #{r.details}" }.to_s
+                log :warning, 'Request Failed:', reasons_str
+                raise RazorErrorException.new 500, "#{r.message}: #{r.details}"
+            elsif r = reasons.lookup?('RZ0011')
+                # Record does not exist
+                log :debug1, 'Record does not exist'
+                raise RazorErrorException.new 404, "#{r.message}: #{r.details}"
+            elsif r = reasons.lookup?('RZ0010')
+                # Duplicate record
+                log :debug1, 'Duplicate record'
+                raise RazorErrorException.new 400, "#{r.message}: #{r.details}"
+            elsif r = reasons.lookup?('RZ0008')
+                # ODBC Error. Should not be reported to the user.
+                reasons_str = reasons.map { |r| "#{r.message}: #{r.details}" }.to_s
+                log :warning, 'Request Failed:', reasons_str
+                raise RazorErrorException.new 500, 'Oops! Something went wrong!'
+            elsif !reasons.empty?
+                # Unhandled Razor error code.
+                reasons_str = reasons.map { |r| "#{r.message}: #{r.details}" }.to_s
+                log :warning, 'Request Failed:', reasons_str
+                raise RazorErrorException.new 500, 'Oops! Something went wrong!'
+            end
+        end
+
+        nil
+    end
+end # module RazorResponseHandler
+
+
+# ##########################################################
+# modules
+
+end # module Mixin
+end # module Cassini
+end # module RazorRisk
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/testing/suppress_pantheios_logging.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/testing/suppress_pantheios_logging.rb
+#
+# Purpose:      When required before 'pantheios', sets the log-service class
+#               to be the ::Pantheios::Services::NullLogService class
+#
+# Created:      9th January 2018
+# Updated:      4th March 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'pantheios/globals'
+require 'pantheios/services/null_log_service'
+
+# Sets the initial log-service class to the null log-service class
+::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/util/conversion_util.rb

@@ -0,0 +1,176 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/util/conversion_util.rb
+#
+# Purpose:      RRAWT::Util module
+#
+# Created:      21st May 2018
+# Updated:      7th November 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+require 'xqsr3/quality/parameter_checking'
+
+require 'nokogiri'
+require 'active_support/core_ext/hash'
+
+require 'json'
+
+require 'razor_risk/core/diagnostics/logger'
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Util
+
+module ConversionUtil
+
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    module ConversionUtil_Constants
+
+        XML_to_JSON_Schemes = [
+            :default,
+            :gdata,
+        ]
+    end
+
+    def self.included receiver
+
+        receiver.extend self
+    end
+
+    # Converts XML to a Hash
+    #
+    # === Signature
+    #
+    # * *Options:*
+    #  @option +:scheme+:: The scheme to use for the conversion. May be
+    #   +:default+, +:gdata+ or +nil+, if +nil+ the +:default+ scheme is used.
+    #
+    # === Return
+    #  A hash representing the supplied XML.
+    #
+    def convert_XML_to_Hash xml, **options
+
+        check_parameter xml, 'xml', types: [ ::Nokogiri::XML::Node, ::String ]
+        scheme  =   check_option options, :scheme, type: ::Symbol, allow_nil: true, values: ConversionUtil_Constants::XML_to_JSON_Schemes
+        scheme  ||= :default
+
+        case scheme
+        when :gdata
+
+            xml_to_gdata_hash_ xml
+        when :default
+
+            xml_to_hash_ xml
+        else
+
+            log :violation, "invalid scheme '#{scheme}'"
+        end
+    end
+
+    # Converts XML to a JSON
+    #
+    # === Signature
+    #
+    # * *Options:*
+    #  @option +:scheme+:: The scheme to use for the conversion. May be
+    #   +:default+, +:gdata+ or +nil+, if +nil+ the +:default+ scheme is used.
+    #
+    # === Return
+    #  The supplied XML in JSON format.
+    #
+    def convert_XML_to_JSON xml, **options
+
+        check_parameter xml, 'xml', types: [ ::Hash, ::Nokogiri::XML::Node, ::String ]
+
+        case xml
+        when ::Hash
+
+            h   =   xml
+        else
+
+            h   =   convert_XML_to_Hash xml, options
+        end
+
+        JSON.generate(h)
+    end
+
+    private
+    def xml_to_hash_ xml
+
+        case xml
+        when ::Nokogiri::XML::Node
+
+            h   =   Hash.from_xml xml.to_s
+        when ::String
+
+            h   =   Hash.from_xml xml
+        else
+
+            log :violation, "unexpected case: xml parameter is of type '#{xml.class}'}"
+        end
+    end
+
+    def xml_to_gdata_hash_ xml
+
+        case xml
+        when ::Nokogiri::XML::Node
+
+            xml_dom =   xml.class == ::Nokogiri::XML::Document ? xml.root : xml
+        when ::String
+
+            xml_dom =   ::Nokogiri.XML(xml).root
+        else
+
+            log :violation, "unexpected case: xml parameter is of type '#{xml.class}'}"
+        end
+
+        [ xml_element_to_gdata_hash_(xml_dom) ].to_h
+    end
+
+    def xml_element_to_gdata_hash_ element
+
+        body = [
+            unless 0 != element.element_children.count
+
+                [ [ '$t', element.text ] ] unless (element.text.empty?)
+            else
+
+                element.element_children.map { |c| xml_element_to_gdata_hash_ c }
+            end,
+            element.attributes
+                .reject { |k| k == 'ns' }
+                .map { |_,v| [ v.name, v.value ] }
+        ].flatten(1).compact
+
+        unless body.empty?
+            body = body.group_by(&:first)
+            body.transform_values! { |v| v.map(&:last) }
+            body.transform_values! { |v| v.length == 1 ? v.first : v }
+        end
+
+        [ element.name, body ]
+    end
+
+end # module ProgramExecutionUtil
+
+end # module Util
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+
+