services-clientedgeservice 0.14.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 649ace591b448aee555bb12648b5764c609102b5
+  data.tar.gz: ce8cf4daaadc7daa1287532f2966ab99d8ae3463
+SHA512:
+  metadata.gz: a3b010ebad4136f33fce36c6d6ea372a198d0760d9d02c377795909a6a6d018973a9e4b8313be387d675ae9ba9edcb6c5d5721f8698deb9fb2d7e95e0a577953
+  data.tar.gz: 60718774f4f779b3a7d695437e24b701bbfb144f6a0666712212f1d18258f2ea8f7073aff3ead01288d51b52fcd73141d0fe708d47af78fd23ee957d9924fc79

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## [0.12.1] (2018-06-20)
+
+**Implemented enhancements:**
+
+none
+
+**Fixed defects:**
+
+none
+
+**Dependencies and packaging:**
+
+- separated into own project/repo/package [WEBAPI-138]
+
+**Merged pull requests:**
+
+none
+
+## END OF CHANGE LOG
+

data/LICENSE

@@ -0,0 +1,5 @@
+Cassini
+
+Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+All rights reserved.
+

data/README.md

@@ -0,0 +1,2 @@
+T.B.C.
+

data/bin/razorrisk-microservice-clientedgeservice

@@ -0,0 +1,396 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         tools/servers/ces/ws.rb
+#
+# Purpose:      Main module/entry file for the Client Edge Service
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+
+# Service: Client Edge Service (CES)
+#
+# Supported:
+#
+#  - [*] /* {Secured, Unsecured}
+#
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/applications/services/client_edge_service/version'
+
+require 'razor_risk/cassini/ces'
+require 'razor_risk/cassini/ces/version'
+
+require 'razor_risk/cassini/applications/securable_microservice'
+require 'razor_risk/cassini/cli'
+require 'razor_risk/cassini/common/version'
+require 'razor_risk/cassini/constants'
+require 'razor_risk/cassini/diagnostics/util_functions'
+require 'razor_risk/cassini/extensions/libclimate'
+require 'razor_risk/cassini/util/secrets_util'
+require 'razor_risk/cassini/util/version_util'
+
+require 'razor_risk/sinatra/helpers/check_auth_helper'
+
+require 'razor_risk/core/diagnostics/extensions/libclimate'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'libclimate'
+require 'pantheios'
+require 'xqsr3/extensions/enumerable/detect_map'
+require 'xqsr3/extensions/kernel/integer'
+require 'xqsr3/extensions/string'
+
+require 'sinatra/base'
+
+require 'uri'
+
+require 'yaml'
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::CES::RouteMapping
+
+include ::RazorRisk::Cassini
+
+include ::RazorRisk::Cassini::Applications
+include ::RazorRisk::Cassini::Constants
+include ::RazorRisk::Cassini::MicroserviceDispatcher
+include ::RazorRisk::Cassini::Util::SecretsUtil
+include ::RazorRisk::Cassini::Util::VersionUtil
+
+include ::RazorRisk::Cassini::Diagnostics
+include ::RazorRisk::Core::Diagnostics::Logger
+
+include ::Pantheios
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION     =   ::RazorRisk::Cassini::Applications::Services::ClientEdgeService::VERSION
+
+# ##########################################################################
+# compatibility checks
+
+check_version_compatibility ::RazorRisk::Cassini::CES, [ 0, 6 ], 'RazorRisk.Cassini.CES'
+check_version_compatibility ::RazorRisk::Cassini::Common, [ 0, 21 ], 'RazorRisk.Cassini.Common'
+check_version_compatibility ::LibCLImate, '0.10'
+check_version_compatibility ::Pantheios, '0.20'
+check_version_compatibility ::Sinatra, '1.4.8'
+
+# ##########################################################################
+# functions
+
+# ##########################################################################
+# static set-up
+
+# ##########################################################################
+# application
+
+class ClientEdgeServiceApp < SecurableMicroservice
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    FULL_DESIGNATION    =   'Client Edge'
+    SHORT_DESIGNATION   =   'CES'
+    SERVICE_TYPE        =   :service
+
+    def self.on_init_service options
+
+        trace ParamNames[ :options ], options
+
+        raise ArgumentError, 'missing keyword: mapped_routes' unless options.has_key? :mapped_routes
+
+        set :mapped_routes, options[:mapped_routes]
+        set :web_ui_server, options[:web_ui_server]
+    end
+
+
+    def log_response verb, request, handler, svr_resp
+
+        log :debug0, "#{verb} '#{request.path_info}' => '#{handler.uri}': code=#{svr_resp.code}; body-length=#{svr_resp.body ? svr_resp.body.size : '(no body)'}" if severity_logged? :debug0
+    end
+
+    delete '/*' do
+
+        trace
+        dispatch_ 'DELETE'
+    end
+
+
+    get '/*' do
+
+        trace
+        dispatch_ 'GET'
+    end
+
+
+    post '/*' do
+
+        trace
+        dispatch_ 'POST'
+    end
+
+
+    put '/*' do
+
+        trace
+        dispatch_ 'PUT'
+    end
+
+    before do
+
+        response.headers['Access-Control-Allow-Origin'] = settings.web_ui_server if settings.web_ui_server
+    end
+
+    options '*' do
+
+        if settings.web_ui_server
+
+            response.headers["Allow"] = "GET, DELETE, PUT, POST, OPTIONS"
+            response.headers["Access-Control-Allow-Methods"] = "GET, DELETE, PUT, POST, OPTIONS"
+            response.headers["Access-Control-Allow-Headers"] = "Authorization, Content-Type, Accept, X-Auth-Token"
+            response.headers["Access-Control-Allow-Origin"] = settings.web_ui_server
+        end
+
+        status 200
+    end
+
+    private
+    def dispatch_ verb
+
+        num_servers_tried = 0
+
+        if handlers = settings.mapped_routes.detect_map { |mr| mr.match request }
+
+            handlers = handlers.shuffle
+
+            handlers.each do |handler|
+
+                jwt_sec     =   secret(settings.jwt_encoding_algorithm)
+
+                check_auth(env, settings.authentication_scheme, jwt_secret: jwt_sec) if handler.security
+
+                log :info, 'attempting routing to ', handler.uri
+
+                begin
+
+                    num_servers_tried += 1
+
+                    args = [ verb, handler.uri, env, 'Accept', 'Authorization' ]
+
+                    if verb =~ /^POST|PUT$/
+                        args << 'Content-Length'
+                        args << 'Content-Type'
+                    end
+
+                    svr_resp = dispatch(*args) do |rq|
+
+                        rq.body = request.body.read if verb =~ /^POST|PUT$/
+                    end
+
+                    log_response verb, request, handler, svr_resp
+
+                    status  = Integer(svr_resp.code)
+                    headers = svr_resp.to_hash.reject do |k,v|
+                        HOP_BY_HOP_HEADERS.include? k.downcase
+                    end
+                    body    = svr_resp.body
+
+                    return [ status, headers, body ]
+                rescue Errno::ECONNREFUSED
+
+                    log :warning, 'failed to connect to \'', handler.uri, '\''
+                rescue EOFError => x
+
+                    log :warning, "Routed request timed-out"
+                    halt 504, { 'Content-Type' => 'text/plain' }, "Routed request unexpectedly closed"
+                rescue Net::ReadTimeout => x
+
+                    log :warning, "Routed request timed-out"
+                    halt 504, { 'Content-Type' => 'text/plain' }, "Routed request timed-out"
+                rescue ::Exception => x
+
+                    log :debug0, "exception (#{x.class}): #{x}"
+
+                    log :critical, "exception (of type #{x.class}) received when attempting to connect to '#{handler.uri}': #{x.message}"
+
+                    raise
+                end
+            end
+
+            log :critical, "failed to connect to handler for '#{request.path_info}' (#{verb})"
+        end
+
+
+        halt *[ 500, {}, "could not serve '#{request.path_info}'" ] if 0 != num_servers_tried
+
+        status 404
+    end
+end
+
+TheApp = ClientEdgeServiceApp
+
+# ##########################################################################
+# command-line parsing
+
+options =   {}
+
+climate = LibCLImate::Climate.new do |cl|
+
+    cl.option_tls_cert_and_key options
+
+    cl.add_flag('--accept-string-routes', alias: '-S', help: 'if specified, allows the YAML routes-configuration top-level keys to be strings, which will be made absolute and made trailing-slash permissive. Also required if specifying a JSON file') { options[:accept_string_routes] = true }
+
+    cl.add_option('--web-ui-server', alias: '-u', help: 'if specified, whitelists the provided url for CORS (Cross Origin Resource Sharing)') do |o,a|
+
+        cl.abort 'Web UI Server value was missing; use --help for usage' if o.value.nil?
+
+        options[:web_ui_server] = o.value
+    end
+
+    cl.option_web_server options
+
+    cl.option_host options
+    cl.option_port options
+
+    cl.option_authentication_scheme options, SUPPORTED_AUTHENTICATION_SCHEMES
+    cl.option_jwt_encoding_algorithm options
+    cl.option_credentials_encoding_algorithm options
+    cl.option_secret_server_source options
+
+    cl.option_log_threshold options, limit: -2
+
+    cl.info_lines = [
+
+        ::RazorRisk::Cassini::Common::DESCRIPTION,
+        ::RazorRisk::Cassini::CLI.Copyright(2017),
+        :version,
+        TheApp.full_description,
+    ]
+
+    cl.usage_values = '<routes-config-spec>'
+end
+
+log :debug0, 'parsing command line ...'
+
+r = climate.run ARGV
+
+::Pantheios::Core.program_name = options[:program_name] if options[:program_name]
+
+program_name    =   ::Pantheios::Core.program_name
+log_directory   =   options[:log_directory] || './logs'
+log_threshold   =   options[:log_threshold] || :notice
+
+setup_diagnostic_logging program_name, log_directory, log_threshold
+
+# amass the arguments that are required
+
+options[:host] ||= nil
+
+options[:authentication_scheme] ||= :jwt
+
+routes_config_spec = r.values[0] or climate.abort 'no routes-config-path specified'
+
+secret_server_source = options[:secret_server_source] or climate.abort 'no secret server url specified; use --help for usage' if :jwt == options[:authentication_scheme]
+
+case options[:authentication_scheme]
+when :jwt
+
+    options[:jwt_encoding_algorithm] or climate.abort "must specify JWT encoding algorithm; use --help for usage"
+
+    algorithms = (r.values.size < 2) ? [ options[:jwt_encoding_algorithm], ] : r.values[1..-1]
+else
+
+    algorithms = []
+end
+
+if options[:tls_certificate_file]
+
+    climate.abort "TLS/SSL may only be used when using the Thin web server" if (options[:web_server] || 'thin').to_s.downcase.strip != 'thin'
+
+    climate.abort "no public-key file specified with the TLS/SSL certificate file" unless options[:tls_public_key_file]
+end
+
+if options[:web_ui_server]
+
+    climate.abort 'Web UI Server must be a valid URI; use --help for usage' unless options[:web_ui_server] =~ URI.regexp
+end
+
+# ##########################################################################
+# main
+
+log :informational, 'initialising ', TheApp::SHORT_DESIGNATION, ' from routes config \'', routes_config_spec, '\' and secret server \'', secret_server_source, '\''
+
+handled_routes = load_routes routes_config_spec, **options
+
+log :debug2, "handled routes:\n#{handled_routes}" if severity_logged? :debug2
+
+mapped_routes = map_routes handled_routes
+
+options[:secrets] = if :jwt == options[:authentication_scheme]
+    log :informational, 'loading secrets ...'
+    load_secrets(secret_server_source, *algorithms)
+else
+    {}
+end
+
+log :informational, 'initialising application ...'
+log :debug0, 'options: ', options
+
+begin
+
+    TheApp.init_service **options, mapped_routes: mapped_routes, web_ui_server: options[:web_ui_server]
+rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+
+    log :violation, "unexpected exception (#{x.class}): '#{x.message}': #{x.backtrace}"
+
+    raise
+rescue ::Errno::EADDRINUSE => x
+
+    log :debug, x.message
+    msg = "Cannot start #{self.process_name}, '#{options[:host]}:#{options[:port]}' in use"
+    log :critical, msg
+    climate.abort msg
+rescue => x
+
+    log :alert, "exception(#{x.class}): #{x.message}"
+
+    climate.abort x.message
+end
+
+log :notice, "starting #{TheApp::SHORT_DESIGNATION} server with authentication scheme '#{options[:authentication_scheme]}'"
+
+begin
+
+    TheApp.run!
+rescue ::ArgumentError, ::NameError, ::NoMethodError, ::TypeError => x
+
+    log :violation, "unexpected exception (#{x.class}): '#{x.message}': #{x.backtrace}"
+
+    raise
+rescue => x
+
+    log :alert, "exception(#{x.class}): #{x.message}"
+
+    climate.abort x.message
+end
+
+# ############################## end of file ############################# #
+
+
+

data/lib/razor_risk/cassini/applications/services/client_edge_service/version.rb

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

data/lib/razor_risk/cassini/applications/services/client_edge_service.rb

@@ -0,0 +1,2 @@
+
+require 'razor_risk/cassini/applications/services/client_edge_service/version'

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: services-clientedgeservice
+version: !ruby/object:Gem::Version
+  version: 0.14.10
+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-ces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-cassini-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.22
+    - - "<"
+      - !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.22
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.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: 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: 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.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+- !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 Client Edge Service
+email: operations@razor-risk.com
+executables:
+- razorrisk-microservice-clientedgeservice
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/razorrisk-microservice-clientedgeservice
+- lib/razor_risk/cassini/applications/services/client_edge_service.rb
+- lib/razor_risk/cassini/applications/services/client_edge_service/version.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 Client Edge Service
+test_files: []