restful-portfolios 0.13.17

data/lib/razor_risk/cassini/applications/route_verb_adaptors/portfolios/hierarchy_get.rb

@@ -0,0 +1,207 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Portfolios microservice's hierarchy GET verb
+#
+#  Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/collection_get_helper'
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/portfolios'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/entity_connectors/exceptions'
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/portfolios_connector'
+
+require 'razor_risk/core/diagnostics/exceptions/rrcs_base_exception'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+require 'xqsr3/conversion/integer_parser'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Portfolios
+
+# ##########################################################################
+# classes
+
+class HierarchyGet < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::CollectionGetHelper
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::Portfolios
+    include ::RazorRisk::Cassini::Util::ConversionUtil
+
+    include ::RazorRisk::Razor::Connectivity::EntityConnectors::Exceptions
+    include ::RazorRisk::Razor::Connectivity::Razor3
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    include ::RazorRisk::Core::Diagnostics::Exceptions
+
+    include ::Pantheios
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    HTTP_VERB           = :get
+
+    HTTP_ACCEPTS        = %w{ application/xml application/json text/xml }
+
+    QUERY_PARAMETERS    = %w{
+
+        filter-name
+
+        page-base
+        page-extent
+
+        key-search
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+        # params
+
+        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
+        ) do |x, arg|
+            halt 422, {'Content-Type' => 'text/plain'}, "invalid page specifier: 'page-base'=#{arg}"
+        end
+        page_extent = ::Xqsr3::Conversion::IntegerParser.to_integer(
+            params['page-extent'] || 1000
+        ) do |x, arg|
+            halt 422, {'Content-Type' => 'text/plain'}, "invalid page specifier: 'page-extent'=#{arg}"
+        end
+        key_search = params['key-search']
+        key_search = nil if key_search.to_s.strip.empty?
+
+        if page_base < 0 || page_extent < 1
+
+            halt 416, {'Content-Type' => 'text/plain'}, "invalid page specifier: 'page-base'=#{page_base}; 'page-extent'=#{page_extent}"
+        end
+
+        if key_search
+            begin
+                key_search = MultiValueConjunctionParser.new.parse_conjunction_list key_search
+            rescue MultiValueConjunctionParser::SyntaxError => x
+                halt 422, {'Content-Type' => 'text/plain'}, x.message
+            end
+        end
+
+        rq_opts = {
+            :filter_name => filter_name,
+            :page_base => page_base,
+            :page_extent => page_extent,
+            :key_search => key_search,
+        }
+
+        # get credentials
+
+        cr = get_required_credentials
+
+        # get requester
+
+        rr = settings.razor_requester
+
+        # get connector
+
+        ec = PortfoliosConnector.new(rr, credentials: cr, **rq_opts)
+
+        # issue request
+
+        begin
+
+            qr = ec.get_hierarchy indicate_result_by: :qualified_result
+        rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+
+            log(:violation) { "(#{x.class}): #{x.message}" }
+            raise
+        rescue RazorRequester::InvalidCredentialsException => x
+
+            log(:failure) { "exception (#{x.class}): #{x}" }
+            halt 401, { 'Content-Type'  =>  'text/plain' }, 'Invalid credentials'
+        rescue DataNotFoundException => x
+
+            log(:failure) { "exception (#{x.class}): #{x}" }
+            halt 404, { 'Content-Type'  =>  'text/plain' }, x.message
+        rescue RRCSBaseException => x
+
+            log(:failure) { "exception (#{x.class}): #{x}" }
+            halt 500, { 'Content-Type'  =>  'text/plain' }, x.message
+        end
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            if :no_such_filter == qr.result
+
+                log :debug1, "failed to retrieve portfolios: no such filter '#{filter_name}'"
+                halt 422, { 'Content-Type'  =>  'text/plain' }, "no such filter '#{filter_name}'"
+            elsif r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                log :debug1, 'failed to retrieve portfolios'
+                halt 404, { 'Content-Type'  =>  'text/plain' }, "#{r.message}: #{r.details}"
+            else
+
+                log :warning, 'failed to retrieve portfolios'
+                halt 500, { 'Content-Type'  =>  'text/plain' }, 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'
+            convert_XML_to_JSON r, { scheme: :gdata }
+        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 Portfolios
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/portfolios/item_delete.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Portfolios microservice's item DELETE verb
+#
+#  Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/portfolios_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+require 'xqsr3/conversion/integer_parser'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Portfolios
+
+# ##########################################################################
+# classes
+
+class ItemDelete < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    include ::Pantheios
+
+    include ::Xqsr3::Conversion
+
+    HTTP_VERB               =   :delete
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+
+        id
+    }
+
+    QUERY_PARAMETERS        =   []
+
+    def handle env, params, request, response
+
+        # trace
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # parameters
+
+        id  =   IntegerParser.to_integer(params['id'], allow_nil: true) { halt *[ 404, {}, 'invalid identifier for DELETE verb - must be an integer' ] }
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   PortfoliosConnector.new(rr, credentials: cr)
+
+        # issue request
+
+        qr  =   ec.delete_portfolio id, indicate_result_by: :qualified_result
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            log :warning, "failed to delete portfolio with 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 Portfolios
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/portfolios/item_get.rb

@@ -0,0 +1,169 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Portfolios microservice's item GET verb
+#
+#  Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/portfolios_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Portfolios
+
+# ##########################################################################
+# classes
+
+class ItemGet < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    include ::Pantheios
+
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    HTTP_VERB               =   :get
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    ROUTE_VARIABLES         =   %w{
+
+        id
+    }
+
+    QUERY_PARAMETERS        =   %w{
+
+        result-form
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # params
+
+        id  =   Integer(params['id']) { halt *[ 404, {}, 'invalid identifier for GET verb - must be an integer' ] }
+        rf  =   case rf = (params['result-form'] || '').to_s
+                when '', 'default'
+                    :body
+                when 'summary'
+                    :portfolio_summary
+                when 'portfolio'
+                    :portfolio
+                else
+                    log(:warning) { "unrecognised result-form '#{rf}'" }
+                    :body
+                end
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   PortfoliosConnector.new(rr, credentials: cr)
+
+        # issue request
+
+        qr  =   ec.get_portfolio 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 portfolio'
+
+                halt *[ 404, {}, "portfolio with id '#{id}' does not exist" ]
+            elsif r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                log :debug1, 'failed to retrieve portfolio'
+
+                halt *[ 404, {}, "#{r.message}: #{r.details}" ]
+            else
+
+                log :warning, 'failed to retrieve portfolio'
+
+                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'
+
+            resp_hash   =   Hash.from_xml r
+
+            resp_json   =   resp_hash
+
+            JSON.generate resp_json
+        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 Portfolios
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/portfolios/item_post.rb

@@ -0,0 +1,130 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adapter for Portfolios microservice's item POST verb
+#
+#  Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/portfolios'
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/portfolios_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Portfolios
+
+# ##########################################################################
+# classes
+
+class ItemPost < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::Portfolios
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    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 }
+
+    QUERY_PARAMETERS        =   []
+
+    def handle env, params, request, response
+
+        # trace
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # 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
+        # 'portfolios'
+
+        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
+
+        rq_body = validate_request_body rq_body, require_id: false
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   PortfoliosConnector.new(rr, credentials: cr)
+
+        # issue request
+
+        qr  =   ec.insert_portfolio rq_body, indicate_result_by: :qualified_result
+
+        unless qr.succeeded?
+
+            log :warning, "failed to post portfolio: #{qr.failure_qualifier.reasons.join(':')}"
+
+            if r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                halt 404, {}, "#{r.message}: #{r.details}"
+            else
+
+                halt 422, {}, "failed to post portfolio"
+            end
+        end
+
+        status 201
+        portfolio_id = qr.result and return %Q{<portfolio id="#{portfolio_id}" />}
+
+        halt 500, {}, "returned response from Razor is not well formed"
+    end
+end # class ItemPost
+
+# ##########################################################################
+# module
+
+end # module Portfolios
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+