restful-capabilities 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0048aed0a1361bc29257358338c880a851895a2f'
+  data.tar.gz: 7f048793a7117749901399150f84922718e7ec49
+SHA512:
+  metadata.gz: 5893140789b1e154da19fdce0ab2057dc506515e66aa9c8f9a56b4b5a78ded55109d2ebed2cb38cf25dfac6113599270ccebbf2967454251e0c72237c9d15c0c
+  data.tar.gz: b540fddbd0a2c317bd250b3b8b7b27403a75278ec697270c08169a405a0aa2ac82e974dac47b272bf5a8f593f314c3da1800941a8a86a83182ca319c9c5a87c3

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-capabilities

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Main module/entry file for the Capabilities 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/capabilities'
+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 = Capabilities::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 = Capabilities::CapabilitiesApp
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,306 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Sinatra App for Capabilities 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/capabilities'
+require 'razor_risk/cassini/applications/secured_microservice'
+
+require 'pantheios'
+
+require 'csv'
+require 'json'
+
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+module Capabilities
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications
+
+
+# ##########################################################################
+# application
+
+# Sinatra Application for the Capabilities Microservice.
+class CapabilitiesApp < SecuredMicroservice
+
+    include RouteVerbAdaptors::Capabilities
+    include RESTFramework::RouteVerbDispatch
+
+    include ::Pantheios
+
+    FULL_DESIGNATION  = 'Capabilities'
+    SHORT_DESIGNATION = 'capabilities'
+    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 = [
+        [ '/groups/?', :get, 'Get the capabilities of all groups.' ],
+        [ '/groups/:id/?', :get, 'Get the capabilities of a specified group.' ],
+        [ '/users/?', :get, 'Get the user specific capabilities of all users.' ],
+        [ '/users/:group_id/?', :get, 'Get the user specific capabilities of all users in a specific group.' ],
+        [ '/users/-/:id/?', :get, 'Get the user specific capabilities of a specific user.' ],
+        [ '/subjects/?', :get, 'Get all the capability subjects and their actions.' ],
+        [ '/subjects/:id/?', :get, 'Get the actions for a specific capability subject.' ],
+        [ '/data-subjects/?', :get, 'Get all the capability data subjects and their actions.', ],
+        [ '/data-subjects/:id/?', :get, 'Get all the capability data subjects and their actions.', ],
+    ]
+    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 '/groups/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch GroupGet
+    end
+
+    get '/groups/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch GroupsGet
+    end
+
+    get '/users/-/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch UserGet
+    end
+
+    get '/users/:group_id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch GroupUsersGet
+    end
+
+    get '/users/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch UsersGet
+    end
+
+    get '/subjects/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch SubjectGet
+    end
+
+    get '/subjects/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch SubjectsGet
+    end
+
+    get '/data-subjects/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch DataSubjectGet
+    end
+
+    get '/data-subjects/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch DataSubjectsGet
+    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 - Capabilities</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 Capabilities
+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/capabilities/version.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Version for RazorRisk.Cassini.Microservices.RESTful.Capabilities library
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+
+module Capabilities
+
+    # Current version of the
+    # RazorRisk.Cassini.Microservices.RESTful.Capabilites library
+    VERSION             =   '0.0.2'
+
+    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 Capabilities RESTful microservice"
+end # module Capabilities
+
+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/capabilities.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/capabilities/app'
+require 'razor_risk/cassini/applications/microservices/restful/capabilities/version'
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/data_subject_get.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET group.
+#
+#  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 Capabilities
+
+
+# ##########################################################################
+# DataSubjectGet
+
+class DataSubjectGet < RESTFramework::VerbHandler
+
+    include GetHandlerMixin
+
+    ROUTE_VARIABLES         =   %w{
+        id
+    }
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        id = params['id']
+
+        super do |ec|
+            ec.get_data_subject id, indicate_result_by: :qualified_result
+        end
+    end
+end # class DataSubjectGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/capabilities/data_subjects_get.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Capabilities microservice's GET users.
+#
+#  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 Capabilities
+
+
+# ##########################################################################
+# DataSubjectsGet
+
+class DataSubjectsGet < 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_data_subjects indicate_result_by: :qualified_result
+        end
+    end
+end # class DataSubjectsGet
+
+
+# ##########################################################################
+# module
+
+end # module Capabilities
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+