restful-riskpointdata-domains 0.6.13

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

@@ -0,0 +1,199 @@
+# 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 ItemAuditGet < 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{
+
+        domain
+        id
+    }
+
+    QUERY_PARAMETERS        =   %w{
+
+        result-form
+    }
+
+    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)
+        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_audit_record dom, id, 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 ItemGet
+
+# ##########################################################################
+# 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/item_delete.rb

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/item_delete.rb
+#
+# Purpose:      Adaptor for RPD microservice's item DELETE 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/razor/connectivity/razor_3/entity_connectors/risk_point_data/domains_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module RiskPointData
+module Domains
+
+# ##########################################################################
+# classes
+
+class ItemDelete < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::RiskPointData::Domains
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors::RiskPointData
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    include ::Pantheios
+
+    HTTP_VERB               =   :delete
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+
+        domain
+        id
+    }
+
+    QUERY_PARAMETERS        =   []
+
+    def handle env, params, request, response
+
+        # trace
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # parameters
+
+        dom =   infer_domain(params)
+
+        id  =   infer_id(params)
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   DomainsConnector.new(rr, credentials: cr)
+
+        # issue request
+
+        qr  =   ec.delete_record dom, id, indicate_result_by: :qualified_result
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            log :warning, "failed to delete risk point data with domain '#{dom}' and id '#{id}'"
+
+            if r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                halt *[ 404, {}, "#{r.message}: #{r.details}" ]
+            else
+
+                halt *[ 500, {}, qr.failure_qualifier.reasons.join("\n") ]
+            end
+        end
+    end
+end # class ItemDelete
+
+# ##########################################################################
+# 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/item_get.rb

@@ -0,0 +1,198 @@
+# 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 ItemGet < 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{
+
+        domain
+        id
+    }
+
+    QUERY_PARAMETERS        =   %w{
+
+        result-form
+    }
+
+    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)
+        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_record dom, id, 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 ItemGet
+
+# ##########################################################################
+# 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/item_post.rb

@@ -0,0 +1,153 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains/item_post.rb
+#
+# Purpose:      Adaptor for RPD microservice's item POST verb
+#
+# Author:       Julian Green, 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/razor/connectivity/razor_3/entity_connectors/risk_point_data/domains_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module RiskPointData
+module Domains
+
+# ##########################################################################
+# classes
+
+class ItemPost < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::RiskPointData::Domains
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors::RiskPointData
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    include ::Pantheios
+
+    HTTP_VERB               =   :post
+
+    HTTP_CONTENT_TYPES      =   %w{ application/xml text/xml }
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+
+        domain
+    }
+
+    QUERY_PARAMETERS        =   []
+
+    def handle env, params, request, response
+
+        # trace
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # parameters
+
+        dom =   infer_domain(params)
+
+        # read request body (XML)
+        #
+        # NOTE: For this handler, the input is required to be XML, and it
+        # is required that the document has a single top-level node
+        # 'updateRiskPointDomainRecords'
+
+        request.body.rewind
+
+        body_text   =   request.body.read
+        rq_body     =   nil
+
+        case request.content_type
+        when 'application/xml', 'text/xml'
+
+            rq_body =   ::Nokogiri.XML body_text
+        else
+
+            log :violation, "unexpected content-type '#{request.content_type}'"
+        end
+
+        case rq_body.children.count
+        when 0
+
+            halt 400, {}, 'not a valid body'
+        when 1
+        else
+
+            halt 400, {}, 'too many children'
+        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.insert_record dom, rq_body, indicate_result_by: :qualified_result
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            log :warning, "failed to update risk point data with domain '#{dom}'"
+
+            if r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                halt 404, {}, "#{r.message}: #{r.details}"
+            else
+
+                halt 422, {}, "failed to update risk point data with domain '#{dom}'"
+            end
+        end
+
+        status 201
+    end
+end # class ItemPost
+
+# ##########################################################################
+# module
+
+end # module Domains
+end # module RiskPointData
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+
+