restful-riskpointdata-domains 0.6.13

data/lib/razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/collection_get.rb

@@ -0,0 +1,258 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/collection_get.rb
+#
+# Purpose:      Adaptor for RPD microservice's collection GET verb
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/collection_get_helper'
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/risk_point_data/domains'
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/risk_point_data/domains_connector'
+require 'razor_risk/razor/connectivity/search/parsers/multi_value_conjunction_parser'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'active_support/core_ext/hash'
+require 'json'
+require 'nokogiri'
+require 'pantheios'
+require 'xqsr3/conversion/integer_parser'
+require 'fastxml'
+require 'xmlhasher'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module RiskPointData
+module Domains
+
+# ##########################################################################
+# classes
+
+class CollectionGet < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::RiskPointData::Domains
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::CollectionGetHelper
+    include ::RazorRisk::Cassini::Util::ConversionUtil
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors::RiskPointData
+    include ::RazorRisk::Razor::Connectivity::Search::Parsers
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    include ::Pantheios
+
+    HTTP_VERB               =   :get
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+
+        domain
+    }
+
+    QUERY_PARAMETERS        =   %w{
+
+        field-search
+
+        filter-name
+
+        page-base
+        page-extent
+
+        sort-field
+        sort-direction
+        isModified
+        oper-type
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # params
+
+        domain      =   infer_domain(params)
+
+        validate_exclusive_search_parameters params, 'filter-name', 'field-search', message_scope: 'invalid search specifier'
+
+        field_srch  =   params['field-search'].to_s.strip
+        field_srch  =   nil if field_srch.empty?
+        filter_name =   params['filter-name'].to_s.strip
+        filter_name =   nil if filter_name.empty?
+        page_base   =   ::Xqsr3::Conversion::IntegerParser.to_integer(params['page-base'] || 0) { |x, arg| halt 422, {}, "invalid page specifier: 'page-base'=#{arg}" }
+        page_extent =   ::Xqsr3::Conversion::IntegerParser.to_integer(params['page-extent'] || 1000) { |x, arg| halt 422, {}, "invalid page specifier: 'page-extent'=#{arg}" }
+        sort_field  =   params['sort-field'].to_s.strip
+        sort_field  =   nil if sort_field.empty?
+        sort_direction  =   params['sort-direction'].to_s.strip
+        sort_direction  =   nil if sort_direction.empty?
+        isModified  =   params['isModified']
+        isModified ? isModified = true : isModified = false
+        operType  =   params['oper-type']
+        operType  =   operType === "OR"? "OR" : "AND"
+
+        if page_base < 0 || page_extent < 1
+
+            halt 416, {}, "invalid page specifier: 'page-base'=#{page_base}; 'page-extent'=#{page_extent}"
+        end
+
+        unless sort_direction.nil? or sort_direction =~ /^ascending|descending$/
+
+            halt 400, {'Content-Type' => 'text/plain'}, "invalid sort direction, must be 'ascending' or 'descending'; was #{sort_direction}"
+        end
+
+        if field_srch
+            begin
+                cp = MultiValueConjunctionParser.new
+                field_srch = cp.parse_conjunction_list field_srch
+            rescue MultiValueConjunctionParser::SyntaxError => x
+                halt 422, {'Content-Type' => 'text/plain'}, x.message
+            end
+        end
+
+        rq_opts     =   {
+
+            :field_search => field_srch,
+            :filter_name => filter_name,
+            :page_base => page_base,
+            :page_extent => page_extent,
+            :sort_field => sort_field,
+            :sort_direction => sort_direction,
+            :operType => operType,
+        }
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   DomainsConnector.new(rr, credentials: cr, **rq_opts)
+
+        # issue request
+
+        qr  =   ec.get_records domain, indicate_result_by: :qualified_result, result_form: :body
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            if false
+
+                ;
+            elsif :no_such_filter == qr.result
+
+                log :debug1, "failed to retrieve risk point data for domain '#{domain}': no such filter '#{filter_name}'"
+
+                halt 422, {}, "no such filter '#{filter_name}'"
+            elsif r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                log :debug1, "failed to retrieve risk point data for domain '#{domain}'"
+
+                halt 404, {}, "#{r.message}: #{r.details}"
+            else
+
+                log :warning, "failed to retrieve risk point data for domain '#{domain}'"
+
+                halt 500, {}, qr.failure_qualifier.reasons.join("\n")
+            end
+        end
+
+        r   =   qr.result.to_s
+
+        # return result
+
+        status 200
+
+        if false
+        elsif request.accept?('application/xml')
+
+            log :debug1, 'application/xml'
+            content_type 'application/xml'
+            r
+        elsif request.accept?('application/json')
+
+            log :debug1, 'application/json'
+
+            content_type 'application/json'
+
+            # TODO: this switch should be removed. This is a temporary fix
+            # for continuation of UI development only. This code is repeated
+            # in item_get.rb where it must also be removed.
+            unless ENV['RR_TOOL_WEBAPI_RISKPOINTDATA_DOMAINS_JSON_OUTPUT_FORMAT_SWITCH']
+
+                xml = ::Nokogiri::XML(r)
+
+                if isModified
+				    xml.xpath('//field').each do |e|
+                        if e['id']
+                            e.name = e['id']
+                            e['text'] = e.text
+                            e.content = ""
+                        end
+                    end
+                    resp_hash   =   XmlHasher.parse(xml.to_xml)
+                else
+                    xml.xpath('//field').each { |e| e.name = e['id'] }
+                    resp_hash   =   Hash.from_xml xml.to_xml
+                end
+                
+                resp_json   =   resp_hash
+
+                JSON.generate resp_json
+            else
+
+                convert_XML_to_JSON r, { scheme: :gdata }
+            end
+        elsif request.accept?('text/xml')
+
+            log :debug1, 'text/xml'
+
+            content_type 'text/xml'
+
+            r
+        else
+
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+
+            status 500
+        end
+    end
+end # class CollectionGet
+
+# ##########################################################################
+# module
+
+end # module Domains
+end # module RiskPointData
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/collection_riskpoint_get.rb

@@ -0,0 +1,193 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/item_get.rb
+#
+# Purpose:      Adaptor for RPD microservice's item GET verb
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/risk_point_data/domains'
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/risk_point_data/domains_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'active_support/core_ext/hash'
+require 'json'
+require 'nokogiri'
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module RiskPointData
+module Domains
+
+# ##########################################################################
+# classes
+
+class RiskPointGet < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::RiskPointData::Domains
+
+    include ::RazorRisk::Cassini::Util::ConversionUtil
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors::RiskPointData
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    include ::Pantheios
+
+    HTTP_VERB               =   :get
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+    }
+
+    QUERY_PARAMETERS        =   %w{
+
+        result-form
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # params
+
+        rf  =   case rf = (params['result-form'] || '').to_s
+                when '', 'default'
+                    :body
+                when 'summary'
+                    :rpd_summary
+                when 'rpd'
+                    :rpd
+                else
+                    log(:warning) { "unrecognised result-form '#{rf}'" }
+                    :body
+                end
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   DomainsConnector.new(rr, credentials: cr)
+
+        # issue request
+
+        qr  =   ec.get_riskpoint_domian indicate_result_by: :qualified_result, result_form: rf
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            if false
+
+                ;
+            elsif qr.result.nil?
+
+                log :debug1, "failed to retrieve risk point data with domain '#{dom}' and id '#{id}'"
+
+                halt *[ 404, {}, "risk-point-data domain with '#{dom}' and id '#{id}' does not exist" ]
+            elsif r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                log :debug1, "failed to retrieve risk point data with domain '#{dom}' and id '#{id}'"
+
+                halt *[ 404, {}, "#{r.message}: #{r.details}" ]
+            else
+
+                log :warning, "failed to retrieve risk point data with domain '#{dom}' and id '#{id}'"
+
+                halt *[ 500, {}, qr.failure_qualifier.reasons.join("\n") ]
+            end
+        end
+
+        r   =   qr.result.to_s
+
+        # return result
+
+        status 200
+
+        if false
+        elsif request.accept?('application/xml')
+
+            log :debug1, 'application/xml'
+
+            content_type 'application/xml'
+
+            r
+        elsif request.accept?('application/json')
+
+            log :debug1, 'application/json'
+
+            content_type 'application/json'
+
+            # TODO: this switch should be removed. This is a temporary fix
+            # for continuation of UI development only. This code is repeated
+            # in item_get.rb where it must also be removed.
+            unless ENV['RR_TOOL_WEBAPI_RISKPOINTDATA_DOMAINS_JSON_OUTPUT_FORMAT_SWITCH']
+
+                xml = ::Nokogiri::XML(r)
+                xml.xpath('//field').each { |e| e.name = e['id'] }
+                resp_hash   =   Hash.from_xml xml.to_xml
+
+                resp_json   =   resp_hash
+
+                JSON.generate resp_json
+            else
+
+                convert_XML_to_JSON r, { scheme: :gdata }
+            end
+        elsif request.accept?('text/xml')
+
+            log :debug1, 'text/xml'
+
+            content_type 'text/xml'
+
+            r
+        else
+
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+
+            status 500
+        end
+    end
+end # class RiskPointGet
+
+# ##########################################################################
+# module
+
+end # module Domains
+end # module RiskPointData
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/hierarchy_item_get.rb

@@ -0,0 +1,212 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for RPD microservice's item GET verb
+#
+#  Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/risk_point_data/domains'
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/risk_point_data/domains_connector'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module RiskPointData
+module Domains
+
+# ##########################################################################
+# classes
+
+class HierarchyItemGet < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Core::Diagnostics::Exceptions
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::RiskPointData::Domains
+    include ::RazorRisk::Cassini::Util::ConversionUtil
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors::RiskPointData
+
+    include ::Pantheios
+
+    HTTP_VERB               =   :get
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+
+        domain
+        id
+    }
+
+    QUERY_PARAMETERS        =   %w{
+
+        result-form
+        complete-tree
+        group-by
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # params
+
+        dom             =   infer_domain(params)
+        id              =   infer_id(params)
+
+        complete_tree   =   params['complete-tree'].to_s.strip
+        complete_tree   =   nil if complete_tree.empty?
+        halt 422, {}, "'complete-tree' may only be 't[rue]' or 'f[alse]'" unless complete_tree.nil? or complete_tree =~ /^t(rue)?$|^f(alse)?$/i
+        complete_tree   =   complete_tree =~ /^t(rue)?$/i ? true : false
+        group_by        =   params['group-by'].to_s.strip
+        group_by        =   nil if group_by.empty?
+
+        rf  =   case rf = (params['result-form'] || '').to_s
+                when 'body', ''
+                    :body
+                when 'tree'
+                    :tree
+                else
+                    log(:failure) { "unrecognised result-form '#{rf}'" }
+                    halt 422, {}, "unrecognised result-form '#{rf}'"
+                end
+
+        rq_opts = {
+            complete_tree: complete_tree,
+            group_by: group_by,
+        }
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   DomainsConnector.new(rr, credentials: cr, **rq_opts)
+
+        # issue request
+
+        begin
+
+            qr  =   ec.get_hierarchy dom, id, indicate_result_by: :qualified_result, result_form: rf
+
+        rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+
+            log(:violation) { "(#{x.class}): #{x.message}" }
+
+            raise
+        rescue RazorRequester::InvalidCredentialsException => x
+
+            log(:failure) { "exception (#{x.class}): #{x}" }
+
+            headers =   {
+
+                'Content-Type'  =>  'text/plain',
+            }
+
+            halt 401, headers, 'Invalid credentials'
+        rescue RRCSBaseException => x
+
+            log(:failure) { "exception (#{x.class}): #{x}" }
+
+            headers =   {
+
+                'Content-Type'  =>  'text/plain',
+            }
+
+            halt 500, headers, x.message
+        end
+
+        log(:debug1) { "qr(#{qr.class})='#{qr}'" }
+
+        unless qr.succeeded?
+
+            if false
+            elsif qr.result.nil?
+
+                log(:debug1) { "failed to retrieve risk point data tree with domain '#{dom}' and id '#{id}'" }
+
+                halt 404, {}, "risk-point-data domain '#{dom}' with id '#{id}' does not exist"
+            elsif r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                log(:debug1) { "failed to retrieve risk point data tree with domain '#{dom}' and id '#{id}'; #{r.message}: #{r.details}" }
+
+                halt 422, {}, "#{r.message}: #{r.details}"
+            else
+
+                log(:warning) { "failed to retrieve risk point data tree with domain '#{dom}' and id '#{id}'" }
+
+                halt 500, {}, qr.failure_qualifier.reasons.join("\n")
+            end
+        end
+
+        r   =   qr.result.to_s
+
+        # return result
+
+        status 200
+
+        if request.accept?('application/xml')
+
+            log(:debug1) { 'application/xml' }
+
+            content_type 'application/xml'
+
+            r
+        elsif request.accept?('text/xml')
+
+            log(:debug1) { 'text/xml' }
+
+            content_type 'text/xml'
+
+            r
+        elsif request.accept?('application/json')
+
+            log(:debug1) { 'application/json' }
+
+            content_type 'application/json'
+
+            convert_XML_to_JSON r, { scheme: :gdata }
+        else
+
+            log(:violation) { "unexpected failure to match given 'Accept' header '#{request.accept}'" }
+
+            status 500
+        end
+    end
+end # class HierarchyItemGet
+
+# ##########################################################################
+# module
+
+end # module Domains
+end # module RiskPointData
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+