razorrisk-razor-connectivity 0.14.10

data/lib/razor_risk/razor/connectivity/razor_3/response.rb

@@ -0,0 +1,224 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/razor/connectivity/razor_3/response.rb
+#
+# Purpose:      Definition of the
+#               ::RazorRisk::Razor::Connectivity::Razor3::RazorRequester
+#               class
+#
+# Created:      26th July 2017
+# Updated:      27th July 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ######################################################################## #
+# requires
+
+require 'nokogiri'
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+require 'date'
+
+require 'razor_risk/core/diagnostics/logger'
+
+# ######################################################################## #
+# modules
+
+module RazorRisk
+module Razor
+module Connectivity
+module Razor3
+
+# ######################################################################## #
+# classes
+
+class Response
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+    private
+
+    class Reason
+
+        def initialize code, message, details, **options
+
+            @code       =   code
+            @message    =   message
+            @details    =   details
+            @options    =   {}.merge! options
+        end
+
+        attr_reader :code
+        attr_reader :message
+        attr_reader :details
+        attr_reader :options
+
+        def to_s
+
+            "#{code}: #{message}: #{details}"
+        end
+    end
+
+    def obtain_ node, path, **options
+
+        trace ParamNames[ :node, :path, :options ], node, path, options
+
+        sub_node = node.at_xpath(path)
+
+        if sub_node && !options[:no_text]
+
+            r = sub_node.text
+        else
+
+            r = sub_node
+        end
+
+        r = nil if options[:nil] && r.to_s.strip.empty?
+
+        r
+    end
+
+    def obtain_reasons_ errors
+
+        x_errors    =   errors ? errors.xpath('error') : nil
+
+        reasons = (x_errors || []).map do |x_error|
+
+            Reason.new(obtain_(x_error, 'code'), obtain_(x_error, 'message'), obtain_(x_error, 'details'))
+        end
+
+        reasons.define_singleton_method(:lookup?) do |code|
+
+            code    =   code.code if Reason === code
+
+            self.each do |reason|
+
+                return reason if reason.code == code
+            end
+
+            nil
+        end
+
+        reasons
+    end
+
+    def to_time_ s
+
+        return nil if s.nil? || (::String === s && s.empty?)
+
+        DateTime.strptime(s, '%Y-%m-%d %H:%M:%S.%L')
+    end
+    public
+
+    # Initialises an instance from an XML node (of type
+    # +Nokogiri::XML::Node+)
+    #
+    # @param node (::Nokogiri::XML::Node)
+    #
+    def initialize node
+
+        trace ParamNames[ :node ], node
+
+        check_parameter node, 'node', types: [ ::Nokogiri::XML::Node ]
+
+        razor_outbound          =   node.xpath('/razorOutbound')
+
+        if razor_outbound.nil? || razor_outbound.empty?
+
+            log :failure, "node(#{node.class})='#{node.to_xml}'"
+
+            raise ArgumentError, "node does not contain a recognised Razor 3 response"
+        end
+
+        @s                      =   node.to_s
+
+        @body                   =   obtain_ razor_outbound, 'body', no_text: true
+
+        if @body
+
+            # convert to standalone document
+            @body               =   ::Nokogiri.XML(@body.to_s).root
+        end
+
+        @errors                 =   obtain_ razor_outbound, 'errors', no_text: true
+
+        @caller                 =   obtain_ razor_outbound, 'caller'
+
+        @request_received_time  =   to_time_ obtain_ razor_outbound, 'requestReceivedTime', nil: true
+
+        @response_sent_time     =   to_time_ obtain_ razor_outbound, 'responseSentTime', nil: true
+
+        @response_received_time =   to_time_ obtain_ razor_outbound, 'responseReceivedTime', nil: true
+
+        @result_code            =   obtain_ razor_outbound, 'returnCode'
+
+        @reasons                =   obtain_reasons_ @errors
+
+        e_c                     =   @errors ? @errors.xpath('error/code') : nil
+        @razor_code             =   e_c ? e_c.text.chomp.strip : ''
+    end
+
+    # A copy of the response document's <body/> node
+    attr_reader :body
+    attr_reader :errors
+    attr_reader :caller
+    attr_reader :request_received_time
+    attr_reader :response_sent_time
+    attr_reader :response_received_time
+    attr_reader :result_code
+    attr_reader :razor_code
+
+    # An array of 0 or more reasons as to why the response represents a
+    # failed operation
+    def reasons
+
+        @reasons
+    end
+
+    # +false+ if the response represents success (which means that the
+    # +result_code+ is +'ack'+); +true+ otherwise
+    def failed?
+
+        !succeeded?
+    end
+
+    # +true+ if the response represents success (which means that the
+    # +result_code+ is +'ack'+); +false+ otherwise
+    def succeeded?
+
+        result_code == 'ack'
+    end
+
+    # Full string form of the +node+ from which the instance was initialised
+    def to_s
+
+        @s
+    end
+
+    # Human-readable debug-like string form
+    def inspect
+
+        "#<#{self.class}:#{object_id.to_s(16).rjust(14, '0').upcase} : caller=#{caller}; result_code=#{result_code}>"
+    end
+end
+
+# ######################################################################## #
+# modules
+
+end # module Razor3
+end # module Connectivity
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/razor/connectivity/razor_3.rb

@@ -0,0 +1,5 @@
+
+require 'razor_risk/razor/connectivity/razor_3/header_maker'
+require 'razor_risk/razor/connectivity/razor_3/razor_requester'
+require 'razor_risk/razor/connectivity/razor_3/response'
+

data/lib/razor_risk/razor/connectivity/version.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+# ##########################################################################
+#
+# Version for RazorRisk.Ruby.Razor.Connectivity library
+#
+# Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+module RazorRisk
+module Razor
+module Connectivity
+
+    # Current version of the RazorRisk::Razor::Connectivity library
+    VERSION        = '0.14.10'
+
+    private
+    VERSION_PARTS_ = VERSION.split(/[.]/).collect { |n| n.to_i }
+    public
+    # Major version of the RazorRisk::Razor::Connectivity library
+    VERSION_MAJOR  = VERSION_PARTS_[0]
+    # Minor version of the RazorRisk::Razor::Connectivity library
+    VERSION_MINOR  = VERSION_PARTS_[1]
+    # Patch version of the RazorRisk::Razor::Connectivity library
+    VERSION_PATCH  = VERSION_PARTS_[2]
+    # Commit version of the RazorRisk::Razor::Connectivity library
+    VERSION_COMMIT = VERSION_PARTS_[3] || 0
+
+
+    # The description of the framework
+    DESCRIPTION    = "Razor Risk's Razor Connectivity library"
+
+end # module Connectivity
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/test/bin/razor_request_exe_empty_response.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/bin/razor_request_exe_empty_response.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      21st July 2017
+# Updated:      12th March 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+
+require 'pantheios'
+require 'razor_risk/core/diagnostics/logger'
+
+include ::Pantheios
+include ::RazorRisk::Core::Diagnostics::Logger
+
+log :informational, 'command-line: \'', ARGV.join(' '), ?' if severity_logged? :informational
+
+# ############################## end of file ############################# #
+
+

data/test/unit/connectivity/clarite_2/tc_config_maker.rb

@@ -0,0 +1,399 @@
+#! /usr/bin/env ruby
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+
+# ##########################################################
+# load path
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 4), 'lib')
+
+
+# ##########################################################
+# diagnostics
+
+unless $DEBUG
+
+    require 'pantheios/globals'
+    require 'pantheios/services/null_log_service'
+
+    ::Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ ::Pantheios::Services::NullLogService ]
+end
+
+
+# ##########################################################
+# code coverage
+
+require 'simplecov'
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/razor/connectivity/clarite_2/config_maker'
+
+require 'xqsr3/xml/utilities/compare'
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+
+# ##########################################################
+# tests
+
+class Test_ConfigMaker_types_exist < Test::Unit::TestCase
+
+    def test_has_RazorRisk_module
+
+        assert Object.const_defined? :RazorRisk
+    end
+
+    def test_has_RazorRisk_Razor_module
+
+        assert RazorRisk.const_defined? :Razor
+    end
+
+    def test_has_RazorRisk_Razor_Connectivity_module
+
+        assert RazorRisk::Razor.const_defined? :Connectivity
+    end
+
+    def test_has_RazorRisk_Razor_Connectivity_ClarITe2_module
+
+        assert RazorRisk::Razor::Connectivity.const_defined? :ClarITe2
+    end
+
+    def test_has_ConfigMaker_class
+
+        assert RazorRisk::Razor::Connectivity::ClarITe2.const_defined? :ConfigMaker
+    end
+
+    def test_ConfigMaker_is_a_class
+
+        assert_kind_of ::Class, ::RazorRisk::Razor::Connectivity::ClarITe2::ConfigMaker
+    end
+end
+
+
+class Test_ConfigMaker_class_methods < Test::Unit::TestCase
+
+    include ::RazorRisk::Razor::Connectivity::ClarITe2
+
+    include ::Xqsr3::XML::Utilities::Compare
+
+    def test_missing
+
+        assert_raise_with_message(::ArgumentError, /option.*may not be nil/) { ConfigMaker.make nil, **Hash[] }
+
+        assert_raise_with_message(::ArgumentError, /option ':xml_client' may not be nil/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /option ':razor_server' may not be nil/) do
+
+            h = {
+
+                xml_client: {
+
+                    root_space: {
+
+                        server: 'http://rssvr:4444',
+                    },
+                    sns: {
+
+                        host: 'http://snssvr',
+                        port: 5555,
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /'razor_server\/environment' option invalid or missing/) do
+
+            h = {
+
+                razor_server: {
+
+                    space: 'env',
+                },
+                xml_client: {
+
+                    root_space: {
+
+                        server: 'http://rssvr:4444',
+                    },
+                    sns: {
+
+                        host: 'http://snssvr',
+                        port: 5555,
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /'xml_client\/root_space' option invalid or missing/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+                xml_client: {
+
+                    sns: {
+
+                        host: 'http://snssvr',
+                        port: 5555,
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /'xml_client\/sns' option invalid or missing/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+                xml_client: {
+
+                    root_space: {
+
+                        server: 'http://rssvr:4444',
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /xml_client\/root_space/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+                xml_client: {
+
+                    root_space: {
+
+                    },
+                    sns: {
+
+                        host: 'http://snssvr',
+                        port: 5555,
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /xml_client\/sns/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+                xml_client: {
+
+                    root_space: {
+
+                        server: 'http://rssvr:4444',
+                    },
+                    sns: {
+
+                        host: 'http://snssvr',
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /xml_client\/sns/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+                xml_client: {
+
+                    root_space: {
+
+                        server: 'http://rssvr:4444',
+                    },
+                    sns: {
+
+                        port: 5555,
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+
+        assert_raise_with_message(::ArgumentError, /xml_client\/sns/) do
+
+            h = {
+
+                razor_server: {
+
+                    environment: 'env',
+                    space: 'env',
+                },
+                xml_client: {
+
+                    root_space: {
+
+                        server: 'http://rssvr:4444',
+                    },
+                    sns: {
+
+                    },
+                },
+            }
+
+            ConfigMaker.make nil, **h
+        end
+    end
+
+    def test_make_1
+
+        expected = <<END_OF_input
+<clarite_config>
+    <xml_client>
+        <root_space host="http://rssvr" port="4444"/>
+        <sns>
+            <server host="http://snssvr" port="5555"/>
+        </sns>
+        <ssl>
+            <enabled>false</enabled>
+            <isDefault>false</isDefault>
+            <authenticateServer>false</authenticateServer>
+            <CAFile>ssl/serverCAcert.pem</CAFile>
+        </ssl>
+        <options>
+            <timers>
+                <clientPooledSockets>-1</clientPooledSockets>
+            </timers>
+        </options>
+    </xml_client>
+    <razor_server space="env" environment="env"/>
+</clarite_config>
+END_OF_input
+
+        o = {
+            razor_server: {
+
+                environment: 'env',
+            },
+            xml_client: {
+
+                root_space: 'http://rssvr:4444',
+                sns: {
+
+                    host: 'http://snssvr',
+                    port: 5555,
+                },
+            },
+        }
+
+        actual = ConfigMaker.make nil, **o
+
+        r = xml_compare expected, actual, normalise_whitespace: true
+
+        assert r.same?, "#{r.details}"
+    end
+
+    def test_make_2
+
+        expected = <<END_OF_input
+<clarite_config>
+    <xml_client>
+        <root_space host="http://rssvr" port="4444"/>
+        <sns>
+            <server host="http://snssvr" port="5555"/>
+        </sns>
+        <ssl>
+            <enabled>false</enabled>
+            <isDefault>false</isDefault>
+            <authenticateServer>false</authenticateServer>
+            <CAFile>ssl/serverCAcert.pem</CAFile>
+        </ssl>
+        <options>
+            <timers>
+                <clientPooledSockets>-1</clientPooledSockets>
+            </timers>
+        </options>
+    </xml_client>
+    <razor_server space="env" environment="env"/>
+</clarite_config>
+END_OF_input
+
+        o = {
+            razor_server: {
+
+                environment: 'env',
+                space: 'env',
+            },
+            xml_client: {
+
+                root_space: {
+
+                    server: 'http://rssvr:4444',
+                },
+                sns: {
+
+                    host: 'http://snssvr',
+                    port: 5555,
+                },
+            },
+        }
+
+        actual = ConfigMaker.make nil, **o
+
+        r = xml_compare expected, actual, normalise_whitespace: true
+
+        assert r.same?, "#{r.details}"
+    end
+end
+
+# ############################## end of file ############################# #
+
+