razorrisk-razor-connectivity 0.14.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 163162c6e84916a28c9fba50315691d9ae9aeda5
+  data.tar.gz: 30d5c2ca917025b0ef4e1defed1ff80ece04a5d0
+SHA512:
+  metadata.gz: f80616833e83f7f50eb49873302fddc67a24aace01ea4bd1450110afb966668bed9f59c292094e1d495e941e5ca3426defaedf61b2b4367cfc5e198f50cb7a2d
+  data.tar.gz: c76e6ab451b5955e7562f51041bbed9a7c7f249d93be8adf9ce49691f618c95eecf80edd595e055c6dfb8143c25cd866d56b44d6ec05f4c31549fc7ce5f6e9bc

data/Rakefile

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$LOAD_PATH.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 # rubocop:todo Style/MixinUsage
+include ::Pantheios # rubocop:todo Style/MixinUsage
+
+# ##########################################################
+# Constants
+
+Spec          = ::Gem::Specification.load(Dir['*.gemspec'].first)
+LogDir        = 'log' # rubocop:todo Naming/ConstantName
+# rubocop:todo Naming/ConstantName
+LogThresholds = %i[informational informational].freeze
+# rubocop:enable Naming/ConstantName
+
+# ##########################################################
+# clean/clobber
+
+Dir[
+    'log',
+    'doc',
+].each { |f| CLEAN << f }
+Dir[
+    '.bundle',
+    'vendor',
+    'GEM_HOME',
+    '*.gem',
+].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/razor/connectivity/clarite_2/config_maker.rb

@@ -0,0 +1,162 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/razor/connectivity/clarite_2/config_maker.rb
+#
+# Purpose:      ::RazorRisk::Razor::Connectivity::Clarite2::ConfigMaker
+#               module
+#
+# Created:      22nd December 2017
+# Updated:      27th July 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ######################################################################## #
+# requires
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+# ######################################################################## #
+# modules
+
+module RazorRisk
+module Razor
+module Connectivity
+module ClarITe2
+
+# ######################################################################## #
+# classes
+
+class ConfigMaker
+
+    private
+    def self.obtain_server_or_throw_ node, path
+
+        trace ParamNames[ :node, :path ], node, path
+
+        case node
+        when ::String
+            server      =   node
+        when ::Hash
+            server      =   node[:server]
+        end
+
+        if server
+
+            return [ $1, $2 ] if server =~ /^(.+):([^:]+)$/
+        end
+
+        host            =   node[:host]
+        port            =   node[:port]
+
+        if host && port
+
+            return [ host, port ]
+        end
+
+        raise ArgumentError, "'#{path}' option did not contain 'server' or 'host'+'port' options"
+    end
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+
+    public
+
+    # Makes a ClarITe configuration file
+    #
+    # @param io (IO) An instance of a class that has a +write+ method that
+    #  takes a single string argument, and, unless the option +:no_flush+
+    #  is specified, also has the +flush+ method. May be +nil+, in which
+    #  case no writing (or flushing) is done
+    # @param options (Hash) Options hash, wherein the keys are symbols, not
+    #  strings. A regular (string-keyed) hash, such as may be obtained from
+    #  YAML, may be converted using Xqsr3's deep_transform (e.g.
+    #  +h.deep_transform { |k| ::String === k ? k.to_sym : k }+) to be
+    #  compatible with this function
+    #
+    # @option +:razor_server+ (Hash) Specifies the Razor server dictionary,
+    #  from which the values of the +:environment+ and +:space+ keys are
+    #  obtained: the +:environment+ key is mandatory; the +:space+ key is
+    #  optional, and the value will be taken from the +:environment+ value
+    #  if not specified
+    # @option +:xml_client+ (Hash) Specifies the XML client dictionary, from
+    #  which the values of the +:root_space+ and +:sns+ keys are obtained.
+    #  Both keys are mandatory, and must be either of the two forms of: (i)
+    #  a string that has the format "<host>:<port>" or a Hash with the keys
+    #  +:host+ and +:port+
+    # @option +:no_flush+ (boolean) Determines whether the +io+ will be sent
+    #  the +flush+ method after writing
+    #
+    # @return The ClarITe configuration file contents
+    def self.make io = nil, **options
+
+        trace ParamNames[ :io, :options ], io, options
+
+        check_parameter io, 'io', responds_to: [ :write ] + (options[:no_flush] ? [] : [ :flush ]), allow_nil: true
+
+        razor_server    =   check_option options, :razor_server, type: ::Hash
+
+        xml_client      =   check_option options, :xml_client, type: ::Hash
+
+        environment     =   razor_server[:environment] or raise ArgumentError, "'razor_server/environment' option invalid or missing"
+        space           =   razor_server[:space] || environment
+
+        root_space      =   xml_client[:root_space] or raise ArgumentError, "'xml_client/root_space' option invalid or missing"
+
+        sns             =   xml_client[:sns] or raise ArgumentError, "'xml_client/sns' option invalid or missing"
+
+        cc_xc_rs_server =   self.obtain_server_or_throw_ root_space, 'xml_client/root_space'
+
+        cc_xc_sp_server =   self.obtain_server_or_throw_ sns, 'xml_client/sns'
+
+        cc = <<END_OF_xml
+<clarite_config>
+    <xml_client>
+        <root_space host="#{cc_xc_rs_server[0]}" port="#{cc_xc_rs_server[1]}"/>
+        <sns>
+            <server host="#{cc_xc_sp_server[0]}" port="#{cc_xc_sp_server[1]}"/>
+        </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="#{space}" environment="#{environment}"/>
+</clarite_config>
+END_OF_xml
+
+        if io
+
+            io.write cc
+            io.flush unless options[:no_flush]
+        end
+
+        cc
+    end
+end # class ConfigMaker
+
+# ######################################################################## #
+# modules
+
+end # module ClarITe2
+end # module Connectivity
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/razor/connectivity/exceptions.rb
+#
+# Purpose:      Exceptions
+#
+# Created:      28th July 2018
+# Updated:      28th July 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/core/diagnostics/exceptions/rrcs_base_exception'
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+=begin
+=end
+
+module RazorRisk
+module Razor
+module Connectivity
+
+# Module for exceptions for entity-connectors:
+#
+# Exceptions:
+#
+# (::RazorRisk::Core::Diagnostics::Exceptions::RRCSBaseException)
+#   |
+#   +- ConnectivityException (abstract)
+#       |
+#       ...
+module Exceptions
+
+
+# Root exception class for RazorRisk::Razor::Connectivity classes / modules
+#
+# NOTE: this class is abstract
+class ConnectivityException < ::RazorRisk::Core::Diagnostics::Exceptions::RRCSBaseException
+
+    include ::Pantheios
+
+    module ConnectivityException_Constants
+
+        ABSTRACT_CLASSES = %w{
+
+            ConnectivityException
+        }
+
+    end # module ConnectivityException_Constants
+
+    def self.new *args
+
+        if ConnectivityException_Constants::ABSTRACT_CLASSES.include?(self.name.split('::')[-1])
+
+            raise NoMethodError, "private method `new' called for #{self}:Class"
+        end
+
+        super
+    end
+
+    # Initialises an instance, based on the given message and options
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #  @param +message+:: (::String) the exception message
+    #  @param +options+:: (::Hash) options
+    #
+    # * *Options:*
+    #  @option +:cause+:: (::Exception) the cause
+    def initialize message, **options
+
+        trace ParamNames[ :message, :options ], message, options
+
+        super message, **options
+
+        @options = {}.merge! options
+    end
+
+    attr_reader :options
+end # class ConnectivityException
+
+end # module Exceptions
+end # module Connectivity
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,126 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         lib/razor_risk/razor/connectivity/razor_3/body_maker.rb
+#
+# Purpose:      ::RazorRisk::Razor::Connectivity::Razor3::BodyMaker class
+#
+# Created:      7th August 2018
+# Updated:      7th August 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ######################################################################## #
+# requires
+
+require 'nokogiri'
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+=begin
+=end
+
+module RazorRisk
+module Razor
+module Connectivity
+module Razor3
+
+class BodyMaker
+
+    include ::Pantheios
+
+    include ::Xqsr3::Quality::ParameterChecking
+
+    XML = ::Nokogiri::XML
+
+    def initialize
+
+    end
+
+    def make_condition **options
+
+
+        id                  =   options[:id]
+        name                =   options[:name]
+        key_path_elements   =   check_option(options, :key_path_elements, type: ::Hash, allow_nil: true) || []
+        oper                =   options[:oper]
+        values              =   options[:values] || []
+
+
+        xml =   ::Nokogiri.XML '<condition/>'
+
+        el  =   xml.children.first
+
+        el['id'] = id if id
+
+
+        nm  =   el.add_child("<name>#{name}</name>").first if name
+
+
+        kp  =   el.add_child('<keyPath/>').first
+
+        key_path_elements.each do |k, v|
+
+            kp.add_child(%Q{<keyElement nodeOffset="#{k}">#{v}</keyElement>})
+        end
+
+
+        op  =   el.add_child("<oper>#{oper}</oper>").first if oper
+
+
+        vls =   el.add_child('<values/>').first
+
+        values.each do |k, v|
+
+            vls.add_child(%Q{<value id="#{k}">#{v}</value>})
+        end
+
+
+        el
+    end
+
+    def make_query **options
+
+        params              =   options[:params] || {}
+
+        conditions          =   options[:conditions] || []
+
+
+        xml =   ::Nokogiri.XML '<query/>'
+
+        el  =   xml.children.first
+
+
+        params.each do |k, v|
+
+            el.add_child(%Q{<#{k}>#{v}</#{k}>})
+        end
+
+
+        cs  =   el.add_child('<conditions/>').first
+
+        conditions.each do |condition|
+
+            cs.add_child(condition)
+        end
+
+
+        el
+    end
+
+end # class BodyMaker
+
+end # module Razor3
+end # module Connectivity
+end # module Razor
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+