restful-userprofiles 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f30bbf64754a1548562bef94a07f7ace2f54256
+  data.tar.gz: 4e16651bad36f01220f99b810cdb61ac69c8b40c
+SHA512:
+  metadata.gz: 88efbbe093e93e4222261b8357ee7fb847642403233b1d89db02ad4696bebb9b2076c892c11500c2e11d5f93169e8d23283f300a15529c335529d2a715310fa7
+  data.tar.gz: 0c9b5717fa704c7730b78c69ab46d2835f154a94c72fae370dc7c89e5bb5b271b701b0c19a54f0861194e256a392d7908ee2751c33b6655b4ebbab9b5da94e35

data/bin/razorrisk-microservice-userprofiles

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Main module/entry file for the UserProfiles Microservice
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/applications/microservices/restful/user_profiles'
+require 'razor_risk/cassini/main'
+
+# TODO: This needs to be added to cassini/main
+require 'razor_risk/cassini/common/version'
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications::Microservices::RESTful
+
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION = UserProfiles::VERSION
+
+
+# ##########################################################################
+# main section
+
+TheApp = UserProfiles::UserProfilesApp
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/restful/user_profiles/app.rb

@@ -0,0 +1,151 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/route_verb_dispatcher'
+require 'razor_risk/cassini/applications/route_verb_adaptors/user_profiles'
+require 'razor_risk/cassini/applications/secured_microservice'
+
+require 'razor_risk/cassini/mixin/razor_response_validator'
+
+require 'pantheios'
+
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+module UserProfiles
+
+
+# ##########################################################################
+# includes
+
+
+# ##########################################################################
+# application
+
+# Sinatra Application for the UserProfiles Microservice.
+class UserProfilesApp < SecuredMicroservice
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Applications::RouteVerbAdaptors::UserProfiles
+    include Cassini::Applications::RESTFramework::RouteVerbDispatch
+    include Cassini::Mixin::RazorResponseValidator
+
+    include ::Pantheios
+
+
+    # ##########################################################
+    # Constants
+
+    FULL_DESIGNATION  = 'UserProfiles'
+    SHORT_DESIGNATION = 'user_profiles'
+    SERVICE_TYPE      = :microservice
+    PROGRAM_FEATURES  = {
+        has_web_server:         true,
+        has_host_and_port:      true,
+        has_razor_connectivity: true,
+        authentication:         true,
+        copyright_year:         2019,
+    }
+    SUPPORTED_ROUTES  = [
+    ]
+    HTTP_ACCEPTS      = %w{
+        text/html
+        application/json
+        application/xml
+        text/xml
+        text/csv
+        text/plain
+        text/tab-separated-values
+        text/tsv
+    }
+
+
+    # ##########################################################
+    # methods
+
+    def self.on_init_service options
+
+        trace ParamNames[ :options ], options
+
+        raise ArgumentError.new(
+            'missing keyword: razor_requester'
+        ) unless options.has_key? :razor_requester
+
+        request_options = options[:request_options]
+
+        set :razor_requester, options[:razor_requester]
+        set :request_options, request_options
+    end
+
+
+    # ##########################################################
+    # routes
+
+    put '/:id/custom-details/:name/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch CustomDetailPut
+    end
+
+    get '/:id/custom-details/:name/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch CustomDetailGet
+    end
+
+    get '/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch ItemGet
+    end
+
+    get '/' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch CollectionGet
+    end
+
+
+    # ##########################################################
+    # catch-all hook
+
+    define_catch_all_handlers
+
+end # class App
+
+
+# ##########################################################################
+# modules
+
+end # module UserProfiles
+end # module RESTful
+end # module Microservices
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/restful/user_profiles/version.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Version for RazorRisk.Cassini.Microservices.RESTful.UserProfiles library
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+
+module UserProfiles
+
+    # Current version of the RazorRisk.Cassini.Microservices.RESTful.UserProfiles library
+    VERSION             =   '0.0.4'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i }
+    public
+    # Major version of the RazorRisk.Cassini.Microservices.RESTful.UserProfiles library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]
+    # Minor version of the RazorRisk.Cassini.Microservices.RESTful.UserProfiles library
+    VERSION_MINOR       =   VERSION_PARTS_[1]
+    # Patch version of the RazorRisk.Cassini.Microservices.RESTful.UserProfiles library
+    VERSION_PATCH       =   VERSION_PARTS_[2]
+    # Commit version of the RazorRisk.Cassini.Microservices.RESTful.UserProfiles library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0
+
+
+    # The description of the framework
+    DESCRIPTION         =   "Razor Risk's Cassini Web-framework's UserProfiles RESTful microservice"
+end # module UserProfiles
+
+end # module RESTful
+end # module Microservices
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/restful/user_profiles.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/microservices/restful/user_profiles/app'
+require 'razor_risk/cassini/applications/microservices/restful/user_profiles/version'
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/collection_get.rb

@@ -0,0 +1,137 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for UserProfiles microservice's collection GET verb
+#
+#  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/mixin/razor_response_validator'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/user_profiles_connector'
+require 'razor_risk/core/diagnostics/logger'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module UserProfiles
+
+
+# ##########################################################################
+# classes
+
+class CollectionGet < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Mixin::RazorResponseValidator
+    include Cassini::Util::ConversionUtil
+
+    include Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    public
+    HTTP_VERB        = :get
+    HTTP_ACCEPTS     = [
+        'application/xml',
+        'application/json',
+        'text/xml',
+    ]
+    QUERY_PARAMETERS = []
+    ROUTE_VARIABLES  = []
+
+
+    # ##########################################################
+    # methods
+
+    def initialize *args, **options
+
+        @connector_class = options[:connector_class] || UserProfilesConnector
+        super
+    end
+
+    def handle env, params, request, response
+
+        trace(
+            ParamNames[ :env, :params, :request, :response ],
+            env, params, request, response
+        )
+
+        ec = @connector_class.new(
+            settings.razor_requester,
+            credentials: get_required_credentials,
+        )
+
+        qr = ec.get_user_profiles indicate_result_by: :qualified_result
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        validate_qualified_razor_response qr
+
+        unless qr.succeeded?
+            if qr.result.nil?
+                error(
+                    HTTP_STATUS_NAMES::NOT_FOUND,
+                    'User Profiles could not be found'
+                )
+            else
+                log :warning, 'Failed to retrieve User Profiles for an unkown reason'
+                error(
+                    HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                    'Oops! Something went wrong'
+                )
+            end
+        end
+
+        status HTTP_STATUS_NAMES::OK
+
+        if request.accept?('application/xml')
+            log :debug1, 'application/xml'
+            content_type 'application/xml'
+            qr.result.to_s
+        elsif request.accept?('text/xml')
+            log :debug1, 'text/xml'
+            content_type 'text/xml'
+            qr.result.to_s
+        elsif request.accept?('application/json')
+            log :debug1, 'application/json'
+            content_type 'application/json'
+            convert_XML_to_JSON qr.result, { scheme: :gdata }
+        else
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+            error(
+                HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                'Oops! Something went wrong'
+            )
+        end
+    end
+end # class CollectionGet
+
+
+# ##########################################################################
+# module
+
+end # module UserProfiles
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/custom_detail_get.rb

@@ -0,0 +1,183 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for UserProfiles microservice's item GET verb
+#
+#  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/mixin/razor_response_validator'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/user_profiles_connector'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'base64'
+require 'json'
+
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module UserProfiles
+
+
+# ##########################################################################
+# classes
+
+class CustomDetailGet < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Mixin::RazorResponseValidator
+    include Cassini::Util::ConversionUtil
+
+    include Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    public
+    HTTP_VERB        = :get
+    HTTP_ACCEPTS     = [
+        'text/plain',
+    ]
+    QUERY_PARAMETERS = []
+    ROUTE_VARIABLES  = [
+        'id',
+        'name',
+    ]
+
+
+    # ##########################################################
+    # methods
+
+    def initialize *args, **options
+
+        @connector_class = options[:connector_class] || UserProfilesConnector
+        super
+    end
+
+    def handle env, params, request, response
+
+        trace(
+            ParamNames[ :env, :params, :request, :response ],
+            env, params, request, response
+        )
+
+        user_id = check_option(
+            params,
+            'id',
+            strip_str_whitespace: true,
+            reject_empty: true,
+            nothrow: true,
+        ) || error(
+            HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+            'Invalid User ID'
+        )
+
+        detail_name = check_option(
+            params,
+            'name',
+            strip_str_whitespace: true,
+            reject_empty: true,
+            nothrow: true,
+        ) || error(
+            HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+            'Invalid Detail Name'
+        )
+
+        # FIXME: Validate that all characters in the User ID and Detail Name are
+        # alphanumerics, spaces, or underscores.
+        #
+        # This check is temporary and does not grantee SQL safety. This
+        # must be addressed as a larger issue around sanitization of user
+        # inputs to Razor.
+        settings.razor_requester.stopgap_sql_string_validator_fix_me user_id do
+            error(
+                HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+                 'User ID contained invalid characters, may only be alphanumerics, spaces, or underscores.'
+            )
+        end
+        settings.razor_requester.stopgap_sql_string_validator_fix_me detail_name do
+            error(
+                HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+                'Detail Name contained invalid characters, may only be alphanumerics, spaces, or underscores.'
+            )
+        end
+
+        ec = @connector_class.new(
+            settings.razor_requester,
+            credentials: get_required_credentials,
+        )
+
+        # Send update
+        qr = ec.get_custom_detail(
+            user_id,
+            detail_name,
+            indicate_result_by: :qualified_result,
+        )
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        validate_qualified_razor_response qr
+
+        if !qr.succeeded? and qr.result.nil?
+            error(
+                HTTP_STATUS_NAMES::NOT_FOUND,
+                "Detail #{detail_name} for profile #{user_id} could not be found"
+            )
+        end
+
+        detail = decode_ qr.result.text
+
+        status HTTP_STATUS_NAMES::OK
+
+        if request.accept?('text/plain')
+            log :debug1, 'text/plain'
+            content_type 'text/plain'
+            detail
+        else
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+            error(
+                HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                'Oops! Something went wrong'
+            )
+        end
+    end
+
+    private
+    # Checks if the string is base 64 encoded and returns the decoded string.
+    def decode_ value
+        decoded   = Base64.decode64(value)
+        reencoded = Base64.encode64(decoded)
+
+        reencoded.chomp == value.chomp ? decoded : value
+    end
+end # class CustomDetailPut
+
+
+# ##########################################################################
+# module
+
+end # module UserProfiles
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/custom_detail_put.rb

@@ -0,0 +1,210 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for UserProfiles microservice's custom details put verb
+#
+#  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/mixin/razor_response_validator'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/user_profiles_connector'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'base64'
+
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module UserProfiles
+
+
+# ##########################################################################
+# classes
+
+class CustomDetailPut < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Mixin::RazorResponseValidator
+    include Cassini::Util::ConversionUtil
+
+    include Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    public
+    HTTP_VERB        = :put
+    HTTP_ACCEPTS     = [
+        'application/xml',
+        'application/json',
+        'text/xml',
+    ]
+    QUERY_PARAMETERS = []
+    ROUTE_VARIABLES  = [
+        'id',
+        'name',
+    ]
+
+
+    # ##########################################################
+    # methods
+
+    def initialize *args, **options
+
+        @connector_class = options[:connector_class] || UserProfilesConnector
+        super
+    end
+
+    def handle env, params, request, response
+
+        trace(
+            ParamNames[ :env, :params, :request, :response ],
+            env, params, request, response
+        )
+
+        user_id = check_option(
+            params,
+            'id',
+            strip_str_whitespace: true,
+            reject_empty: true,
+            nothrow: true,
+        ) || error(
+            HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+            'Invalid User ID'
+        )
+
+        detail_name = check_option(
+            params,
+            'name',
+            strip_str_whitespace: true,
+            reject_empty: true,
+            nothrow: true,
+        ) || error(
+            HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+            'Invalid Detail Name'
+        )
+
+        # FIXME: Validate that all characters in the User ID and Detail Name are
+        # alphanumerics, spaces, or underscores.
+        #
+        # This check is temporary and does not grantee SQL safety. This
+        # must be addressed as a larger issue around sanitization of user
+        # inputs to Razor.
+        settings.razor_requester.stopgap_sql_string_validator_fix_me user_id do
+            error(
+                HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+                 'User ID contained invalid characters, may only be alphanumerics, spaces, or underscores.'
+            )
+        end
+        settings.razor_requester.stopgap_sql_string_validator_fix_me detail_name do
+            error(
+                HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+                'Detail Name contained invalid characters, may only be alphanumerics, spaces, or underscores.'
+            )
+        end
+
+        # Get the body content
+        request.body.rewind
+        body_text    = request.body.read
+        detail_value = Base64.encode64(body_text)
+
+        ec = @connector_class.new(
+            settings.razor_requester,
+            credentials: get_required_credentials,
+        )
+
+        # Get existing profile
+        qr = ec.get_user_profile(
+            user_id,
+            indicate_result_by: :qualified_result,
+        )
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        validate_qualified_razor_response qr
+
+        unless qr.succeeded?
+            if qr.result.nil?
+                error(
+                    HTTP_STATUS_NAMES::NOT_FOUND,
+                    'User Profile could not be found'
+                )
+            else
+                log :warning, "Failed to retrieve User Profile for '#{user_id}' for an unkown reason."
+                error(
+                    HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                    'Oops! Something went wrong'
+                )
+            end
+        end
+
+        # Updated profile XML with detail
+        profile = qr.result
+        details = profile.at_xpath('customDetails')
+        unless details
+            ::Nokogiri::XML::Builder.with(profile) { |xml| xml.customDetails }
+            details = profile.at_xpath('customDetails')
+        end
+
+        detail = details.at_xpath("customDetail[@name='#{detail_name}']")
+        unless detail
+            ::Nokogiri::XML::Builder.with(details) do |xml|
+                xml.customDetail name: detail_name
+            end
+            detail = details.at_xpath("customDetail[@name='#{detail_name}']")
+        end
+        detail.content = detail_value
+
+        # Send update
+        qr = ec.update_user_profile(
+            user_id,
+            profile,
+            indicate_result_by: :qualified_result,
+        )
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        validate_qualified_razor_response qr
+
+        unless qr.succeeded?
+            log :warning, "Failed to update User Profile for '#{user_id}' for an unknown reason"
+            error(
+                HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                'Oops! Something went wrong!'
+            )
+        end
+
+        status 202
+
+        nil
+    end
+end # class CustomDetailPut
+
+
+# ##########################################################################
+# module
+
+end # module UserProfiles
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,159 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for UserProfiles microservice's item GET verb
+#
+#  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/mixin/razor_response_validator'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/user_profiles_connector'
+require 'razor_risk/core/diagnostics/logger'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module UserProfiles
+
+
+# ##########################################################################
+# classes
+
+class ItemGet < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Mixin::RazorResponseValidator
+    include Cassini::Util::ConversionUtil
+
+    include Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    public
+    HTTP_VERB        = :get
+    HTTP_ACCEPTS     = [
+        'application/xml',
+        'application/json',
+        'text/xml',
+    ]
+    QUERY_PARAMETERS = []
+    ROUTE_VARIABLES  = [ 'id' ]
+
+
+    # ##########################################################
+    # methods
+
+    def initialize *args, **options
+
+        @connector_class = options[:connector_class] || UserProfilesConnector
+        super
+    end
+
+    def handle env, params, request, response
+
+        trace(
+            ParamNames[ :env, :params, :request, :response ],
+            env, params, request, response
+        )
+
+        user_id = check_option(
+            params,
+            'id',
+            strip_str_whitespace: true,
+            reject_empty: true,
+            nothrow: true,
+        ) || error(HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY, "Invalid User ID")
+
+        # FIXME: Validate that all characters in the User ID are alphanumerics,
+        # spaces, or underscores.
+        #
+        # This check is temporary and does not grantee SQL safety. This
+        # must be addressed as a larger issue around sanitization of user
+        # inputs to Razor.
+        settings.razor_requester.stopgap_sql_string_validator_fix_me user_id do
+            error(
+                HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY,
+                'User ID contained invalid characters, may only be alphanumerics, spaces, or underscores.'
+            )
+        end
+
+        ec = @connector_class.new(
+            settings.razor_requester,
+            credentials: get_required_credentials,
+        )
+
+        qr = ec.get_user_profile(
+            user_id,
+            indicate_result_by: :qualified_result,
+        )
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        validate_qualified_razor_response qr
+
+        unless qr.succeeded?
+            if qr.result.nil?
+                error HTTP_STATUS_NAMES::NOT_FOUND, 'User Profile could not be found'
+            else
+                reasons = qr.failure_qualifier.reasons.join("\n")
+                log :warning, "Failed to retrieve User Profile for '#{user_id}'; #{reasons}"
+                error(
+                    HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                    'Oops! Something went wrong'
+                )
+            end
+        end
+
+        status HTTP_STATUS_NAMES::OK
+
+        if request.accept?('application/xml')
+            log :debug1, 'application/xml'
+            content_type 'application/xml'
+            qr.result.to_s
+        elsif request.accept?('text/xml')
+            log :debug1, 'text/xml'
+            content_type 'text/xml'
+            qr.result.to_s
+        elsif request.accept?('application/json')
+            log :debug1, 'application/json'
+            content_type 'application/json'
+            convert_XML_to_JSON qr.result, { scheme: :gdata }
+        else
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+            error(
+                HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR,
+                'Oops! Something went wrong'
+            )
+        end
+    end
+end # class ItemGet
+
+
+# ##########################################################################
+# module
+
+end # module UserProfiles
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/user_profiles/collection_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/user_profiles/item_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/user_profiles/custom_detail_put'
+require 'razor_risk/cassini/applications/route_verb_adaptors/user_profiles/custom_detail_get'
+
+
+# ############################## end of file ############################# #
+
+

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: restful-userprofiles
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Razor Risk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: razorrisk-cassini-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.24
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.24
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-razor-connectivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-razor-connectivity-entityconnectors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.14
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pantheios-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+- !ruby/object:Gem::Dependency
+  name: xqsr3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Razor Risk's Cassini Web-framework's UserProfiles RESTful microservice
+email: operations@razor-risk.com
+executables:
+- razorrisk-microservice-userprofiles
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/razorrisk-microservice-userprofiles
+- lib/razor_risk/cassini/applications/microservices/restful/user_profiles.rb
+- lib/razor_risk/cassini/applications/microservices/restful/user_profiles/app.rb
+- lib/razor_risk/cassini/applications/microservices/restful/user_profiles/version.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/collection_get.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/custom_detail_get.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/custom_detail_put.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/user_profiles/item_get.rb
+homepage: https://razor-risk.com/
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Razor Risk Cassini User Profiles RESTful microservice
+test_files: []