restful-riskpointdata-domains 0.6.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d70bc8e2a192aea547f2f2c895a3c25ccebe814
+  data.tar.gz: '09027935e119fa72b666057d7832389077bf94a0'
+SHA512:
+  metadata.gz: cd82124bcb0f51ae5943edec291d05c09c887417c24a022640fc47a2ae1b94ca8e9d0e4bc8d2bc5c1c1384b487c06d422f328ae44d2df32c2173277905e722a3
+  data.tar.gz: 954fcc67180a73e71fc7346dfe72933d70ac66640ede88f9ffd0c329cb92de0c08e9b9de7a79f5fb4fb230e9c17ad5eed4456b86be4b1638fe883697987c4564

data/bin/razorrisk-microservice-riskpointdata-domains

@@ -0,0 +1,412 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         tools/servers/restful/rpd/ws.rb
+#
+# Purpose:      Main module/entry file for the RiskPointData.Domain Microservice
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+
+# Microservices: RiskPointData.Domain (rpd)
+#
+# Supported:
+#
+#  - [GET] /:domain {Unsecured}
+#  - [DELETE] /delete/:domain/:id {Secured}
+#  - [GET] /get/:domain {Secured}
+#  - [GET] /get/:domain/:id {Secured}
+#  - [PUT] /put/:domain/:id {Secured}
+#  - [GET] /get/:domain/:id/tree {Secured}
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/applications/microservices/restful/risk_point_data/domains'
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/risk_point_data/domains'
+
+require 'razor_risk/cassini/main'
+
+require 'razor_risk/cassini/applications/rest_framework/route_verb_dispatcher'
+require 'razor_risk/cassini/applications/secured_microservice'
+require 'razor_risk/cassini/authorisation'
+require 'razor_risk/cassini/common/version'
+require 'razor_risk/cassini/util/version_util'
+
+require 'razor_risk/razor/connectivity/razor_3/header_maker'
+require 'razor_risk/razor/connectivity/razor_3/razor_requester'
+require 'razor_risk/razor/connectivity/version'
+
+require 'razor_risk/core/diagnostics/extensions/libclimate'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'active_support/core_ext/hash'
+require 'pantheios'
+require 'xqsr3/version'
+
+require 'csv'
+require 'json'
+require 'nokogiri'
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications
+include ::RazorRisk::Cassini::Applications::RESTFramework
+include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors
+include ::RazorRisk::Cassini::Authorisation::SecurityModelHelpers
+include ::RazorRisk::Cassini::Constants
+include ::RazorRisk::Cassini::Util::SecretsUtil
+include ::RazorRisk::Cassini::Util::VersionUtil
+
+include ::RazorRisk::Razor::Connectivity::Razor3
+
+include ::RazorRisk::Cassini::Diagnostics
+include ::RazorRisk::Core::Diagnostics::Logger
+
+include ::Pantheios
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION     =   ::RazorRisk::Cassini::Applications::Microservices::RESTful::RiskPointData::Domains::VERSION
+
+SUPPORTED_ROUTES = [
+
+    [ '/delete/:domain/:id', :delete, 'deletes the specified rpd', ],
+    [ '/get/:domain', :get, 'gets the collection of rpd', ],
+    [ '/get/:domain/:id', :get, 'gets the specified rpd', ],
+    [ '/put/:domain/:id', :put, 'puts the specified rpd', ],
+    [ '/get/:domain/:id/tree', :get, 'gets the realationship hierarchy for the specified rpd', ],
+    [ '/get/audit/:domain/:id', :get, 'gets the specified audit data', ],
+    [ '/get/riskpointdata/?', :get, 'gets the risk point data', ],
+]
+
+HTTP_ACCEPTS = %w{ text/html application/json application/xml text/xml text/csv text/plain text/tab-separated-values text/tsv }
+
+# ##########################################################################
+# 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'
+
+# ##########################################################################
+# functions
+
+def make_CSV_routes routes
+
+    CSV.generate do |csv|
+
+        routes.each do |ar|
+
+            csv << ar
+        end
+    end
+end
+
+def make_HTML_routes routes, **options
+
+    # TODO: use erb
+
+    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 - RiskPointData.Domains/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
+
+# ##########################################################################
+# static set-up
+
+# ##########################################################################
+# lambdas
+
+Lambdas_XML_to_JSON = lambda do |xml|
+
+    ConversionUtil.convert_XML_to_JSON xml
+end
+
+# ##########################################################################
+# application
+
+class RiskPointData_DomainApp < SecuredMicroservice
+
+    include RouteVerbDispatch
+
+    include ::Pantheios
+
+
+    FULL_DESIGNATION    =   'RiskPointData.Domain'
+    SHORT_DESIGNATION   =   'rpd'
+    SERVICE_TYPE        =   :microservice
+
+    PROGRAM_FEATURES    =   {
+
+        has_web_server: true,
+
+        has_host_and_port:  true,
+
+        has_razor_connectivity: true,
+
+        authentication: :with_credentials_algorithm,
+
+        copyright_year: 2017,
+    }
+
+
+    def self.on_init_service options
+
+        trace ParamNames[ :options ], options
+
+        raise ArgumentError, 'missing keyword: razor_requester' unless options.has_key? :razor_requester
+
+        set :razor_requester, options[:razor_requester]
+    end
+
+
+
+    private
+    def sec
+
+        return '' if credentials.empty?
+        " (for #{credentials.join(':')})"
+    end
+    public
+
+
+    # functional routes (DELETE, GET, PUT, POST)
+
+    # params:
+    # +result-form+:: Specifies the form of the result: +default+ gets the
+    #  full Razor body, and is the default if none specified;
+    get '/get/hierarchy/:domain/:id/?' do
+
+        # trace
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::HierarchyItemGet
+    end
+
+    delete '/delete/:domain/:id/?' do
+
+        # trace
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::ItemDelete
+    end
+
+    # params:
+    # +result-form+:: Specifies the form of the result: +default+ gets the
+    #  full Razor body, and is the default if none specified; +summary+ gets
+    #  the rpd-summary form; +rpd+ gets the rpd form
+    get '/get/:domain/:id/?' do
+
+        # trace
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::ItemGet
+    end
+
+    get '/get/audit/:domain/:id/?' do
+
+        # trace
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::ItemAuditGet
+    end
+
+    get '/get/riskpointdata/?' do
+
+        # trace
+        trace ParamNames[ :request, :params ], request, params
+        dispatch RiskPointData::Domains::RiskPointGet
+    end
+
+    # params:
+    # +page-base+:: Specifies the (0-based) index index of the first element
+    #  to be presented. Defaults to 0 if not specified
+    # +page-extent+:: Specifies the number of records to return in the
+    #  retrieval window. Defaults to 1000 if not specified
+    # +quick-search+:: Specifies a quick-search string
+    # +sort_field+:: Specifies the field to sort results by
+    # +sort_direction+:: Specifies the direction to sort the results by. May
+    #  be +ascending+ or +descending+ and is case insensitive.
+    get '/get/:domain/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::CollectionGet
+    end
+
+    put '/put/:domain/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::ItemPut
+    end
+
+    post '/post/:domain/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch RiskPointData::Domains::ItemPost
+    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 { |t| %Q<'#{t}'> }.join(', ')}" ]
+    end
+
+    define_catch_all_handlers
+end
+
+TheApp = RiskPointData_DomainApp
+
+# now define the OPTIONS support
+
+supported_routes = Hash.new { |h, k| h[k] = [] }
+
+SUPPORTED_ROUTES.each do |ar|
+
+    supported_routes[ar[0]].push ar[1]
+end
+
+supported_routes.each do |k, v|
+
+    if k =~ /:domain\/:id(?:\/\?)?$/
+
+        route = "#$`*"
+    else
+
+        route = k
+    end
+
+    TheApp.options route do
+
+        verbs = v.map { |t| t.upcase }.join(',')
+
+        halt *[200, { 'Allow' => verbs }, [ verbs ] ]
+    end
+end
+
+TheApp.options '/' do
+
+    halt *[200, { 'Allow' => 'GET' }, '' ]
+end
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/restful/risk_point_data/domains/version.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/applications/microservices/restful/rsik_point_data/domains/version.rb
+#
+# Purpose:      Version for RazorRisk.Cassini.Microservices.RESTful.RiskPointData.Domains library
+#
+# Created:      7th January 2019
+# Updated:     15th January 2019
+#
+# Copyright (c) 2019, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+module RiskPointData
+
+module Domains
+
+    # Current version of the RazorRisk.Cassini.Microservices.RESTful.RiskPointData.Domains library
+    VERSION             =   '0.6.13'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk.Cassini.Microservices.RESTful.RiskPointData.Domains library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk.Cassini.Microservices.RESTful.RiskPointData.Domains library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk.Cassini.Microservices.RESTful.RiskPointData.Domains library
+    VERSION_PATCH       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk.Cassini.Microservices.RESTful.RiskPointData.Domains library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   "Razor Risk's Cassini Web-framework's RiskPointData.Domains RESTful microservice"
+
+    # [DEPRECATED] Instead use +DESCRIPTION+
+    FRAMEWORK_DESCRIPTION = DESCRIPTION
+end # module Domains
+
+end # module RiskPointData
+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/risk_point_data/domains.rb

@@ -0,0 +1,2 @@
+
+require 'razor_risk/cassini/applications/microservices/restful/risk_point_data/domains/version'