restful-capabilities 0.0.2

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/get_handler_mixin.rb

@@ -0,0 +1,159 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Mixin for all Capabilities microservice's get route handlers.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/razor/connectivity/entity_connectors/exceptions'
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/capabilities_connector'
+
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'pantheios'
+
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# Get Handler Mixin
+
+# This ia a mixin module that provides the implementation for handling a get
+# capabilities request.
+#
+# @note Methods in this module should not be used directly, only as methods
+# on handler classes.
+module GetHandlerMixin
+
+    include ::RazorRisk::Cassini::Util::ConversionUtil
+
+    include ::RazorRisk::Razor::Connectivity::EntityConnectors::Exceptions
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    include ::Pantheios
+
+    HTTP_VERB        = :get
+    HTTP_ACCEPTS     = %w{
+        application/xml
+        application/json
+        text/xml
+    }
+    QUERY_PARAMETERS = %w{
+    }
+    ErrorHeaders     = {
+        'Content-Type' => 'text/plain',
+    }
+
+    # Handles a GET capabilities request.
+    #
+    # @param env [::Hash] The Rack request environment (@see
+    #   Rack::Request#env).
+    # @param params [::Hash] Validated query parameters (@see
+    #   ValidateQueryParametersMixin#validate_query_parameters)
+    # @param request [::Sinatra::Request] The request to be handled.
+    # @param response [::Sinatra::Response] The response object that will be
+    #   returned.
+    #
+    # @yield [ec] Gives the entity connector to be used to perform the Razor
+    #   Request.
+    # @yieldparam [CapabilitiesConnector] The entity connector.
+    # @yieldreturn [RazorRisk::Core::QualifiedResult] The qulified result of
+    #   the request.
+    def handle env, params, request, response, &block
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        request_options = settings.request_options
+
+        cr = get_required_credentials
+        rr = settings.razor_requester
+        ec = CapabilitiesConnector.new(
+            rr,
+            credentials: cr,
+            **request_options
+        )
+
+        # Send reqest
+        begin
+            qr = yield(ec)
+        rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+            log :failure, "exception (#{x.class}): #{x}"
+            raise
+        rescue UnexpectedServerResponseException => x
+            log :failure, "exception (#{x.class}): #{x}"
+            halt 500, ErrorHeaders, "Server Error"
+        end
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        r = qr.result
+
+        # check result
+        unless qr.succeeded?
+
+            if qr.failure_qualifier.reasons.lookup?('RZ0011')
+                r       = qr.failure_qualifier.reasons.lookup?('RZ0011')
+                reasons = qr.failure_qualifier.reasons.join("\n")
+                log :debug1, "failed to retrieve capabilities; #{reasons}"
+                halt 404, ErrorHeaders, "#{r.message}: #{r.details}"
+            elsif !qr.failure_qualifier.reasons.empty?
+                reasons = qr.failure_qualifier.reasons.join("\n")
+                log :warning, "Failed to retrieve capabilities; #{reasons}"
+                halt 500, ErrorHeaders, 'Server Error'
+            elsif r.nil?
+                log :debug1, 'failed to retrieve capabilities'
+                halt 404, ErrorHeaders, "Capabilities not found"
+            else
+                log :warning, "Failed to retrieve capabilities for an unknown reason #{r}"
+                halt 500, ErrorHeaders, 'Server Error'
+            end
+        end
+
+        # return result
+        status 200
+        if request.accept?('text/xml')
+            log :debug1, 'text/xml'
+            content_type 'text/xml'
+            r.to_s
+        elsif request.accept?('application/xml')
+            log :debug1, 'application/xml'
+            content_type 'application/xml'
+            r.to_s
+        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}'"
+            halt 500, ErrorHeaders, 'No supported Accept types'
+        end
+    end
+end # class GetHandlerMixin
+
+# ##########################################################################
+# modules
+
+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/capabilities/group_get.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET group.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# GroupGet
+
+class GroupGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    ROUTE_VARIABLES         =   %w{
+        id
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        id = params['id']
+
+        super do |ec|
+            ec.get_group id, indicate_result_by: :qualified_result
+        end
+    end
+end # class GroupGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/group_users_get.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET groups.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# GroupsGet
+
+class GroupUsersGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    ROUTE_VARIABLES         =   %w{
+        group_id
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        group_id = params['group_id']
+
+        super do |ec|
+            ec.get_group_users group_id, indicate_result_by: :qualified_result
+        end
+    end
+end # class GroupsGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/groups_get.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET groups.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# GroupsGet
+
+class GroupsGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        super do |ec|
+            ec.get_groups indicate_result_by: :qualified_result
+        end
+    end
+end # class GroupsGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/subject_get.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET group.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# SubjectGet
+
+class SubjectGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    ROUTE_VARIABLES         =   %w{
+        id
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        id = params['id']
+
+        super do |ec|
+            ec.get_subject id, indicate_result_by: :qualified_result
+        end
+    end
+end # class SubjectGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/subjects_get.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET users.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# SubjectsGet
+
+class SubjectsGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        super do |ec|
+            ec.get_subjects indicate_result_by: :qualified_result
+        end
+    end
+end # class SubjectsGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/user_get.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET group.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# UserGet
+
+class UserGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    ROUTE_VARIABLES         =   %w{
+        id
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        id = params['id']
+
+        super do |ec|
+            ec.get_user id, indicate_result_by: :qualified_result
+        end
+    end
+end # class UserGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/users_get.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET users.
+#
+#  Copyright (c) 2019 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/capabilities/get_handler_mixin'
+
+require 'pantheios'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Capabilities
+
+
+# ##########################################################################
+# UsersGet
+
+class UsersGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        super do |ec|
+            ec.get_users indicate_result_by: :qualified_result
+        end
+    end
+end # class UsersGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/group_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/groups_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/user_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/users_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/group_users_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/subjects_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/subject_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/data_subjects_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/capabilities/data_subject_get'
+
+# ############################## end of file ############################# #
+
+