restful-externalfacilities 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 712e64b4db1d45bb15f239e308c5e5874c26d5c561e3c2f0062927c75b187d4d
+  data.tar.gz: fe0378c2bfa05e2273a79d000d65a17aa1af0ea87281d7143ecbf223694c2ee4
+SHA512:
+  metadata.gz: 26afb94efa10f29750bde7d5c0c20305839d004c806eeac68ab409cbdb2e6abca5b2e715aec8723352392f8aa073f41438f2b63b8eb3fc1a288367e867caf0f7
+  data.tar.gz: 19709dd1afaa2183171edac42a5a12f140adb87c0547d5d447cdf1cdd9a8a24cbef58ab0c58dad30eb11592e55f87a7d347996a1115776520a0a43b7510afa84

data/Rakefile

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+
+# ##########################################################
+# bundler
+
+require 'rubygems'
+require 'bundler/setup'
+
+
+# ######################################################################## #
+# requires
+
+require 'razor_risk/razor/control/rake_helpers/diagnostic_tasks'
+require 'razor_risk/razor/control/rake_helpers/gem_tasks'
+require 'razor_risk/razor/control/rake_helpers/task_helpers'
+
+require 'rake'
+require 'rake/clean'
+
+
+# ##########################################################
+# includes
+
+include ::RazorRisk::Razor::Control
+include ::Pantheios
+
+
+# ##########################################################
+# Constants
+
+Spec = ::Gem::Specification.load(Dir['*.gemspec'].first)
+LogDir = 'log'
+LogThresholds = [ :informational, :informational ]
+
+
+# ##########################################################
+# clean/clobber
+
+Dir[
+    'log',
+    'doc',
+    'test/reports',
+].each { |f| CLEAN << f }
+Dir[
+    '.bundle',
+    'vendor',
+    'GEM_HOME',
+    '*.gem',
+    '*.zip',
+].each { |f| CLOBBER << f }
+
+
+# ##########################################################
+# Tasks
+
+desc 'Run tests'
+task :test => [ :'gem:unit_test' ]
+
+desc 'Build zip'
+task :build_zip, [ :path ] do |task, args|
+
+    trace ParamNames[ :task, :args ], task, args
+
+    `build_zip.cmd #{args[:path]}`
+end
+
+desc 'Build gem'
+task :build_gem, [ :path ] => :'gem:build'
+
+desc 'Builds the Razor EntityConnector Gem'
+task :build, [ :path ] => [
+    :build_gem,
+    :build_zip,
+]
+
+desc 'Push the gem to the gem server.'
+task :deploy => :'gem:push'
+
+
+# ##########################################################
+# Hooks
+
+task :default do
+    puts 'Run \'bundler exec rake --tasks\' to see available tasks'
+end
+
+task :first do
+    ::Rake::Task[:'diagnostics:init'].execute(
+        name: Spec.name,
+        version: Spec.version.to_s,
+        directory: LogDir,
+        thresholds: LogThresholds,
+    )
+end
+
+RakeHelpers::TaskHelpers.add_hooks
+
+
+# ############################## end of file ############################# #
+
+

data/bin/razorrisk-microservice-externalfacilities

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Main module/entry file for the External Facilities 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/externalfacilities'
+require 'razor_risk/cassini/main'
+
+# Requires for compatibility check
+require 'razor_risk/cassini/util/version_util'
+require 'razor_risk/cassini/common/version'
+require 'razor_risk/razor/connectivity/version'
+require 'xqsr3/version'
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications::Microservices::RESTful
+include ::RazorRisk::Cassini::Util::VersionUtil
+
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION = ExternalFacilities::VERSION
+
+
+# ##########################################################################
+# compatibility checks
+
+check_version_compatibility ::RazorRisk::Cassini::Common, [ 0, 21 ], 'RazorRisk.Cassini.Common'
+check_version_compatibility ::RazorRisk::Razor::Connectivity, [ 0, 11, 2 ], 'RazorRisk.Razor.Connectivity'
+check_version_compatibility ::LibCLImate, '0.10'
+check_version_compatibility ::Pantheios, '0.20'
+check_version_compatibility ::Xqsr3::VERSION, '0.30'
+
+
+# ##########################################################################
+# main section
+
+TheApp = ExternalFacilities::CapabilitiesApp
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,244 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Sinatra App for ExternalFacilities microservice.
+#
+#  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/externalfacilities'
+require 'razor_risk/cassini/applications/secured_microservice'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+require 'csv'
+require 'json'
+
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+module ExternalFacilities
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications
+
+
+# ##########################################################################
+# application
+
+# Sinatra Application for the ExternalFacilities Microservice.
+class ExternalFacilitiesApp < SecuredMicroservice
+
+    include RouteVerbAdaptors::ExternalFacilities
+    include RESTFramework::RouteVerbDispatch
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    FULL_DESIGNATION  = 'ExternalFacilities'
+    SHORT_DESIGNATION = 'externalfacilities'
+    SERVICE_TYPE      = :microservice
+    PROGRAM_FEATURES  = {
+        has_web_server:         true,
+        has_host_and_port:      true,
+        has_razor_connectivity: true,
+        authentication:         :with_credentials_algorithm,
+        copyright_year:         2019,
+    }
+    SUPPORTED_ROUTES = [
+        [ '/externalfacilities/?', :get, 'Get the external facilities.' ],
+    ]
+    HTTP_ACCEPTS     = %w{
+        text/html
+        application/json
+        application/xml
+        text/xml
+        text/csv
+        text/plain
+        text/tab-separated-values
+        text/tsv
+    }
+
+
+    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] || {
+            validate: true
+        }
+
+        set :razor_requester, options[:razor_requester]
+        set :request_options, request_options
+    end
+
+    private
+    def sec
+        return '' if credentials.empty?
+        " (for #{credentials.join(':')})"
+    end
+    public
+
+
+    # ##########################################################
+    # routes
+
+    get '/externalfacilities/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch ExternalFacilitiesSet
+    end
+
+    get '/' do
+
+        HTTP_ACCEPTS.each do |accept_type|
+
+            if request.accept? accept_type
+
+                content_type accept_type
+
+                case accept_type
+                when 'application/json'
+                    r = make_JSON_routes SUPPORTED_ROUTES
+                when 'application/xml', 'text/xml'
+                    r = make_XML_routes SUPPORTED_ROUTES
+                when 'text/csv'
+                    r = make_CSV_routes SUPPORTED_ROUTES
+                when 'text/html'
+                    r = make_HTML_routes SUPPORTED_ROUTES
+                when 'text/plain'
+                    r = make_Plain_routes SUPPORTED_ROUTES
+                when 'text/tsv', 'text/tab-separated-values'
+                    r = make_TSV_routes SUPPORTED_ROUTES
+                else
+                    log :violation, "unrecognised accept type '#{accept_type}'"
+                    halt(
+                        500,
+                        {},
+                        'internal server failure'
+                    )
+                end
+
+                return r
+            end
+        end
+
+        halt(
+            406,
+            {},
+            "supports only the Accept types #{HTTP_ACCEPTS.map do |t|
+                %Q<'#{t}'>
+            end.join(', ')}"
+        )
+    end
+
+    define_catch_all_handlers
+
+
+    # ##########################################################
+    # routes helpers
+
+    def make_CSV_routes routes
+        CSV.generate do |csv|
+            routes.each do |ar|
+                csv << ar
+            end
+        end
+    end
+
+    def make_HTML_routes routes, **options
+        routes = routes.map do |ar|
+        <<END_OF_tr
+   <tr>
+    <td>#{ar[0]}</td>
+    <td>#{ar[1]}</td>
+    <td>#{ar[2]}</td>
+   </tr>
+END_OF_tr
+    end
+
+    <<END_OF_html
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.we.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+  <title>Razor Risk Web Service API - Internal Microservice - External Facilities</title>
+  <meta name="revisit-after" content="24 hours" />
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ </head>
+ <body>
+  <h1>Routes</h1>
+  <table>
+   <tr>
+    <th>Route</th>
+    <th>Verb</th>
+    <th>Description</th>
+   </tr>
+#{routes.map { |r| r.chomp("\n") }.join("\n")}
+  </table>
+ </body>
+</html>
+END_OF_html
+    end
+
+    def make_JSON_routes routes, **options
+        r = {
+            'routes' => []
+        }
+        r['routes'] = SUPPORTED_ROUTES.map { |ar| { route: ar[0], verb: ar[1].to_s.upcase, description: ar[2] } }
+        r.to_json
+    end
+
+    def make_Plain_routes routes
+        make_TSV_routes routes
+    end
+
+    def make_TSV_routes routes
+        routes.map { |ar| "#{ar[0]}\t#{ar[1]}\t#{ar[2]}\n" }
+    end
+
+    def make_XML_routes routes
+    <<END_OF_xml
+<?xml version="1.0">
+<routes>#{routes.map { |ar| %Q{  <route route="#{ar[0]}" verb="#{ar[1].to_s.upcase}" description="#{ar[2]}"/>}}.join(%Q{\n})}
+</routes>
+END_OF_xml
+    end
+
+end # class App
+
+
+# ##########################################################################
+# modules
+
+end # module ExternalFacilities
+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/externalfacilities/version.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Version for RazorRisk.Cassini.Microservices.RESTful.ExternalFacilities library
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+
+module ExternalFacilities
+
+    # Current version of the
+    # RazorRisk.Cassini.Microservices.RESTful.ExternalFacilities library
+    VERSION             =   '0.0.1'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i }
+    public
+    VERSION_MAJOR       =   VERSION_PARTS_[0]
+    VERSION_MINOR       =   VERSION_PARTS_[1]
+    VERSION_PATCH       =   VERSION_PARTS_[2]
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0
+
+    # The description of the framework
+    DESCRIPTION         =   "Razor Risk's Cassini Web-framework's ExternalFacilities RESTful microservice"
+end # module ExternalFacilities
+
+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/externalfacilities.rb

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

data/lib/razor_risk/cassini/applications/route_verb_adaptors/externalfacilities/externalfacilities_get.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for ExternalFacilities microservice's GET external facilities.
+#
+#  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 ExternalFacilities
+
+
+# ##########################################################################
+# ExternalFacilitiesSet
+
+class ExternalFacilitiesGet < 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 ExternalFacilitiesGet
+
+
+# ##########################################################################
+# module
+
+end # module ExternalFacilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

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

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

data/test/unit/microservice/tc_app.rb

@@ -0,0 +1,381 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+#############################################################################
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 3), 'lib')
+
+ENV['APP_ENV'] = 'test'
+ENV['RZ_EXPOSE_MICROSERVICE_EXCEPTIONS'] = 'true'
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/testing/suppress_pantheios_logging' unless $DEBUG
+
+require 'razor_risk/cassini/applications/microservices/restful/externalfacilities/app'
+require 'razor_risk/razor/connectivity/test_doubles/razor_requester/raises_on_send'
+require 'razor_risk/razor/connectivity/test_doubles/razor_requester/returns_given_response'
+require 'razor_risk/razor/connectivity/razor_3/response'
+
+require 'rack/test'
+require 'test/unit'
+
+# ##########################################################
+# Tests
+
+class TestExternalFacilitiesApp < Test::Unit::TestCase
+
+    include ::Rack::Test::Methods
+
+    include ::RazorRisk::Cassini::Applications::Microservices::RESTful
+    include ::RazorRisk::Razor::Connectivity::TestDoubles::RazorRequester
+    include ::RazorRisk::Razor::Connectivity::Razor3
+    include ::RazorRisk::Razor::Connectivity::EntityConnectors::Exceptions
+
+    RazorEnv = 'env'
+
+    def app
+       ExternalFacilities::ExternalFacilitiesApp
+    end
+
+    def set_razor_response body, **options
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.razorOutbound(
+                environment: RazorEnv,
+                request:     'select',
+                server:      'DataServer',
+            ) do
+                xml.requestReceivedTime  '2020-09-09 14:20:33.844'
+                xml.responseSentTime     '2019-09-09 14:20:33.911'
+                xml.responseReceivedTime '2019-09-09 14:20:33.917'
+                xml.returnCode           (options[:failed] ? 'nack' : 'ack')
+                xml.parent << ::Nokogiri.XML(body).root
+            end
+        end.doc
+
+        rsp = Response.new(doc)
+        rr  = ReturnsGivenResponse.new('conf', RazorEnv, given_response: rsp)
+
+        app.on_init_service(
+            razor_requester: rr,
+            request_options: options[:request_options],
+        )
+    end
+
+    def configure_app **opts
+        opts = {
+            host: 'localhost',
+            port: 5679,
+            authentication_scheme: 'none',
+            executable: 'abc',
+            razor_requester: nil,
+        }.merge(opts)
+
+        app.init_service(**opts)
+    end
+
+    def setup
+        configure_app
+    end
+end
+
+class TestCommon < TestExternalFacilitiesApp
+
+    # TODO: HEAD does the full razor request as if it is a GET, but returns
+    # empty. This is not ok and it must be changed not do the razor request.
+
+    # TODO: Currently cannot mock raising UnexpectedServerResponseException
+    # as due to restrictuions in RaisesOnSend exception must be a class.
+
+    Routes = {
+        'externalfacilities' => [ '/externalfacilities' ],
+    }
+end
+
+class TestInvalidVerbs < TestCommon
+
+    InvalidVerbs = [ :post, :put, :delete, :options ]
+
+    InvalidVerbs.each do |verb|
+        Routes.each do |name, args|
+            define_method "test_#{verb}_#{name}" do
+                self.send(verb, *args)
+                assert_false last_response.ok?
+                assert_equal 404, last_response.status
+                assert_equal(
+                    "'#{args.first}' [#{verb.to_s.upcase}] not found",
+                    last_response.body
+                )
+            end
+        end
+    end
+end
+
+class TestHeaders < TestCommon
+
+    Routes.each do |name, args|
+        define_method "test_#{name}_invalid_accept_type" do
+            set_razor_response('<body/>')
+
+            header 'Accept', 'image/png'
+            get(*args)
+
+            assert_false last_response.ok?, last_response.body
+            assert_equal 406, last_response.status
+            assert_match(/invalid accept type/, last_response.body)
+        end
+
+        define_method "test_#{name}_invalid_accept_types" do
+            set_razor_response('<body/>')
+
+            header 'Accept', [ 'image/png', 'application/pdf' ]
+            get(*args)
+
+            assert_false last_response.ok?, last_response.body
+            assert_equal 406, last_response.status
+            assert_match(/invalid accept type/, last_response.body)
+        end
+
+        define_method "test_#{name}_valid_accept_type" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'application/xml'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+        end
+
+        define_method "test_#{name}_valid_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', [ 'application/json', 'application/xml' ]
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+        end
+
+        define_method "test_#{name}_mixed_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', [ 'application/pdf', 'application/xml' ]
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+        end
+
+        define_method "test_#{name}_application_xml_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'application/xml'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/xml/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal '<body/>', last_response.body
+        end
+
+        define_method "test_#{name}_text_xml_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'text/xml'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /text\/xml/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal '<body/>', last_response.body
+        end
+
+        define_method "test_#{name}_application_json_accept_types" do
+
+            set_razor_response(
+                '<body/>',
+                request_options: { validate: false }
+            )
+
+            header 'Accept', 'application/json'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/json/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal '{"body":[]}', last_response.body
+        end
+    end
+end
+
+class TestJSONConversion < TestCommon
+
+    Routes.each do |name, args|
+
+        define_method "test_#{name}_json_uses_gdata_scheme" do
+
+            doc = ::Nokogiri::XML::Builder.new do |xml|
+                xml.body do
+                    xml.group 'value', id: 'group 1'
+                    xml.group id: 'group 2'
+                end
+            end.doc.root.to_xml
+            set_razor_response(doc, request_options: { validate: false })
+
+            exp_doc = {
+                'body' => {
+                    'group' => [
+                        { '$t' => 'value', 'id' => 'group 1' },
+                        { 'id' => 'group 2' }
+                    ]
+                }
+            }.to_json
+
+            header 'Accept', 'application/json'
+            get(*args)
+
+            assert last_response.ok?, last_response.body
+            assert_equal 200, last_response.status
+            assert_match(
+                /application\/json/,
+                last_response.headers['Content-Type']
+            )
+            assert_equal(
+                exp_doc,
+                last_response.body
+            )
+        end
+    end
+end
+
+class TestErrorHandling < TestCommon
+
+    Routes.each do |name, args|
+
+        define_method "test_#{name}_RZ0011_error" do
+            doc = ::Nokogiri::XML::Builder.new do |xml|
+                xml.errors do
+                    xml.error do
+                        xml.code 'RZ0011'
+                        xml.message 'This failed'
+                        xml.details 'This failed'
+                    end
+                end
+            end.doc.root.to_xml
+            set_razor_response doc, failed: true
+
+            get(*args)
+
+            assert_false last_response.ok?
+            assert_equal 404, last_response.status
+            assert_equal('This failed: This failed', last_response.body)
+        end
+
+        define_method "test_#{name}_razor_error" do
+            doc = ::Nokogiri::XML::Builder.new do |xml|
+                xml.body
+            end.doc.root.to_xml
+            set_razor_response doc, failed: true
+
+            get(*args)
+
+            assert_false last_response.ok?
+            assert_equal 500, last_response.status
+            assert_equal('Server Error', last_response.body)
+        end
+
+        define_method "test_#{name}_unknown_error" do
+
+            doc = '<body/>'
+            set_razor_response doc, failed: true
+
+            get(*args)
+
+            assert_false last_response.ok?
+            assert_equal 500, last_response.status
+            assert_equal('Server Error', last_response.body)
+        end
+    end
+end
+
+class TestExternalFacilities < TestExternalFacilitiesApp
+
+    def test_validates_xml
+
+        doc = '<body/>'
+        set_razor_response(doc)
+
+        get '/externalfacilities'
+
+        assert_false last_response.ok?, last_response.body
+        assert_equal 404, last_response.status
+        assert_equal('External Facilities not found', last_response.body)
+    end
+
+    def test_get
+
+        doc = ::Nokogiri::XML::Builder.new do |xml|
+            xml.body do
+                xml.group id: 'group 1'
+                xml.group id: 'group 2'
+            end
+        end.doc.root.to_xml
+        set_razor_response(doc)
+
+        get '/externalfacilities'
+        assert last_response.ok?
+        assert_equal 200, last_response.status
+        assert_equal doc, last_response.body
+    end
+end
+
+# ############################## end of file ############################# #
+
+

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: restful-externalfacilities
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Razor Risk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-22 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.16
+    - - "<"
+      - !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.16
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-core-diagnostics-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-razor-connectivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+    - - "<"
+      - !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.7
+    - - "<"
+      - !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.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: clasp-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !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
+- !ruby/object:Gem::Dependency
+  name: libclimate-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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'
+description: Razor Risk's Cassini Web-framework's ExternalFacilities RESTful microservice
+email: operations@razor-risk.com
+executables:
+- razorrisk-microservice-externalfacilities
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- bin/razorrisk-microservice-externalfacilities
+- lib/razor_risk/cassini/applications/microservices/restful/externalfacilities.rb
+- lib/razor_risk/cassini/applications/microservices/restful/externalfacilities/app.rb
+- lib/razor_risk/cassini/applications/microservices/restful/externalfacilities/version.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/externalfacilities.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/externalfacilities/externalfacilities_get.rb
+- test/unit/microservice/tc_app.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: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Razor Risk Cassini External Facilities RESTful microservice
+test_files: []