restful-portfolios 0.13.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afdeee7dc34ce903cb034e7db4c531411206f2211fe9c931cd7d85fdc46ef6a8
+  data.tar.gz: 39c6de3caae664a82a9b630c6c05449962ab436ac6a62461292539b46defb334
+SHA512:
+  metadata.gz: e398a4378657e62781dae9633fc4ba0f718f5b5af5ec5229ec26bcd30a5884558affa60eaff81a65e777c32e874f5f2d1b198262ac5137dec91e4f366e9b385e
+  data.tar.gz: f76d75976e8744eebce9321e7edb87222207e78256d97a55e09f576d27497ed3ab92fc3f75a5d87b7b4ef37da4585cb3ba89657876633dd661a48cd0fab44db8

data/bin/razorrisk-microservice-portfolios

@@ -0,0 +1,390 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Main module/entry file for the Portfolios Microservice
+#
+#  Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+
+# Microservices: Portfolios (portfolios)
+#
+# Supported:
+#
+#  - [GET] / {Unsecured}
+#  - [DELETE] /delete/:id {Secured}
+#  - [GET] /get {Secured}
+#  - [GET] /get/:id {Secured}
+#  - [PUT] /put/:id {Secured}
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/applications/microservices/restful/portfolios'
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/portfolios'
+
+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 ::Pantheios
+
+include ::RazorRisk::Core::Diagnostics::Logger
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION     =   ::RazorRisk::Cassini::Applications::Microservices::RESTful::Portfolios::VERSION
+
+SUPPORTED_ROUTES = [
+
+    [ '/delete/:id', :delete, 'deletes the specified portfolio', ],
+    [ '/get', :get, 'gets the collection of portfolios', ],
+    [ '/get/:id', :get, 'gets the specified portfolio', ],
+    [ '/put/:id', :put, 'puts the specified portfolio', ],
+]
+
+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 - Portfolio</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 PortfoliosApp < SecuredMicroservice
+
+    include RouteVerbDispatch
+
+    include ::Pantheios
+
+
+    FULL_DESIGNATION    =   'Portfolios'
+    SHORT_DESIGNATION   =   'portfolios'
+    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)
+
+    delete '/delete/:id/?' do
+
+        # trace
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Portfolios::ItemDelete
+    end
+
+    # === Query Parameters
+    #
+    # +page-base+:: [Numeric] (0) Specifies the (0-based) index index of the
+    #   first element to be presented.
+    # +page-extent+:: [Numeric] (1000) Specifies the number of records to
+    #   return in the retrieval window.
+    # +key-search+:: [String] Specifies a string inf the form of a series of
+    #   keys and values to search for.
+    # +filter-name+:: [String] The name of a filter to use.
+    get '/get/hierarchy/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Portfolios::HierarchyGet
+    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 portfolio-summary form; +portfolio+ gets the portfolio form
+    get '/get/:id/?' do
+
+        # trace
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Portfolios::ItemGet
+    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
+    # +key-search+:: Specifies a string inf the form of a series of keys and values to search for
+    get '/get/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Portfolios::CollectionGet
+    end
+
+    post '/post/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Portfolios::ItemPost
+    end
+
+    put '/put/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Portfolios::ItemPut
+    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 = PortfoliosApp
+
+# 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 =~ /: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/portfolios/version.rb

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

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

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

@@ -0,0 +1,253 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Portfolios microservice's collection GET verb
+#
+#  Copyright (c) 2018 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/collection_get_helper'
+require 'razor_risk/cassini/applications/route_verb_adaptors/utilities/portfolios'
+
+require 'razor_risk/razor/connectivity/entity_connectors/exceptions'
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/portfolios_connector'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+require 'xqsr3/conversion/integer_parser'
+require 'xmlhasher'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Portfolios
+
+# ##########################################################################
+# classes
+
+class CollectionGet < RESTFramework::VerbHandler
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::CollectionGetHelper
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utilities::Portfolios
+
+    include ::RazorRisk::Razor::Connectivity::EntityConnectors::Exceptions
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    HTTP_VERB               =   :get
+
+    HTTP_ACCEPTS            =   %w{ application/xml application/json text/xml }
+
+    QUERY_PARAMETERS        =   %w{
+
+        filter-name
+
+        page-base
+        page-extent
+
+        quick-search
+
+        key-search
+
+        linked-to-trade
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        # params
+
+        filter_name     =   params['filter-name'].to_s.strip
+        filter_name     =   nil if filter_name.empty?
+        page_base       =   ::Xqsr3::Conversion::IntegerParser.to_integer(params['page-base'] || 0) { |x, arg|
+            halt 422, {}, "invalid page specifier: 'page-base'=#{arg}"
+        }
+        page_extent     =   ::Xqsr3::Conversion::IntegerParser.to_integer(params['page-extent'] || 1000) { |x, arg|
+            halt 422, {}, "invalid page specifier: 'page-extent'=#{arg}"
+        }
+        quick_search    =   params['quick-search']
+        quick_search    =   nil if String === quick_search && quick_search.strip.empty?
+        key_search      =   params['key-search']
+        key_search      =   nil if String === key_search && key_search.strip.empty?
+        linked_to_trade =   params['linked-to-trade'].to_s.strip
+        linked_to_trade =   nil if linked_to_trade.empty?
+
+        rf  =   case rf = (params['result-form'] || '').to_s
+                when '', 'default'
+                    :body
+                when 'children'
+                    :array
+                else
+                    log(:warning) { "unrecognised result-form '#{rf}'" }
+                    :body
+                end
+
+        if page_base < 0 || page_extent < 1
+
+            halt 416, {}, "invalid page specifier: 'page-base'=#{page_base}; 'page-extent'=#{page_extent}"
+        end
+
+        if filter_name and quick_search
+
+            halt 422, {}, "invalid search specifier: cannot specify 'filter-name' and 'quick-search' together"
+        end
+
+        if key_search
+            begin
+                key_search = MultiValueConjunctionParser.new.parse_conjunction_list key_search
+            rescue MultiValueConjunctionParser::SyntaxError => x
+                halt 422, {'Content-Type' => 'text/plain'}, x.message
+            end
+        end
+
+        rq_opts     =   {
+
+            :filter_name => filter_name,
+            :page_base => page_base,
+            :page_extent => page_extent,
+            :quick_search => quick_search,
+            :key_search => key_search,
+            :linked_to_trade => linked_to_trade,
+        }
+
+        # get credentials
+
+        cr  =   get_required_credentials
+
+        # get requester
+
+        rr  =   settings.razor_requester
+
+        # get connector
+
+        ec  =   PortfoliosConnector.new(rr, credentials: cr, **rq_opts)
+
+        # issue request
+
+        begin
+
+            qr  =   ec.get_portfolios indicate_result_by: :qualified_result, result_form: rf
+        rescue EntityConnectorInternalStepException => x
+
+            log :failure, "exception (#{x.class}): #{x}"
+
+            headers =   {
+
+                'Content-Type'  =>  'text/plain',
+            }
+
+            code    =   500
+            msg     =   x.message
+
+            halt(code, headers, msg)
+        end
+
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        unless qr.succeeded?
+
+            if false
+
+                ;
+            elsif :no_such_filter == qr.result
+
+                log :debug1, "failed to retrieve portfolios: no such filter '#{filter_name}'"
+
+                halt 422, {}, "no such filter '#{filter_name}'"
+            elsif r = qr.failure_qualifier.reasons.lookup?('RZ0011')
+
+                log :debug1, 'failed to retrieve portfolios'
+
+                halt 404, {}, "#{r.message}: #{r.details}"
+            else
+
+                log :warning, 'failed to retrieve portfolios'
+
+                halt 500, {}, qr.failure_qualifier.reasons.join("\n")
+            end
+        end
+
+        r   =   case rf
+                when :array
+
+                    xml_doc     =   ::Nokogiri.XML('<body/>')
+                    root_node   =   xml_doc.children.first
+
+                    qr.result.each do |pf_element|
+
+                        root_node.add_child pf_element.to_s
+                    end
+
+                    xml_doc.to_s
+                else
+
+                    qr.result.to_s
+                end
+
+        # return result
+
+        status 200
+
+        if false
+        elsif request.accept?('application/xml')
+
+            log :debug1, 'application/xml'
+
+            content_type 'application/xml'
+
+            r
+        elsif request.accept?('application/json')
+
+            log :debug1, 'application/json'
+
+            content_type 'application/json'
+
+            resp_hash   =   XmlHasher.parse(r)
+
+            #resp_hash   =   Hash.from_xml r
+            resp_json   =   resp_hash
+
+            JSON.generate resp_json
+        elsif request.accept?('text/xml')
+
+            log :debug1, 'text/xml'
+
+            content_type 'text/xml'
+
+            r
+        else
+
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+
+            status 500
+        end
+    end
+end # class CollectionGet
+
+# ##########################################################################
+# module
+
+end # module Portfolios
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+