restful-snapshots 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1d369a3e3bbc7054b2685a4eb770328fd34d1c6
+  data.tar.gz: 48d459c9a751e23489b04a870e7444f8a5bee735
+SHA512:
+  metadata.gz: 95bb4d1afe8e74aa0890e5d88c4ea346aa60fe6293348721735cdab0fa19243c4bbfeafa0a4b326cf6a6d2050f756fed06380778e4dba31c4c5bc55582fd0a69
+  data.tar.gz: 6fbf754141dcd05f91fc2602c2365f5587870c21b71280ab95c7a2b3d2ba8cee63d782288f3e31a200df982c858da3c0451e888370e93662f550acb2dd3c52eb

data/bin/razorrisk-microservice-snapshots

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Main module/entry file for the Snapshots Microservice
+#
+#  Copyright (c) 2020 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/applications/microservices/restful/snapshots'
+require 'razor_risk/cassini/main'
+
+# TODO: This needs to be added to cassini/main
+require 'razor_risk/cassini/common/version'
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications::Microservices::RESTful
+
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION = Snapshots::VERSION
+
+
+# ##########################################################################
+# main section
+
+TheApp = Snapshots::SnapshotsApp
+
+
+# ############################## end of file ############################# #
+
+

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

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Copyright (c) 2020 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/snapshots'
+require 'razor_risk/cassini/applications/secured_microservice'
+
+require 'razor_risk/cassini/mixin/razor_response_validator'
+
+require 'pantheios'
+
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module RESTful
+module Snapshots
+
+
+# ##########################################################################
+# application
+
+# Sinatra Application for the Snapshot Microservice.
+class SnapshotsApp < SecuredMicroservice
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Applications::RouteVerbAdaptors::Snapshots
+    include Cassini::Applications::RESTFramework::RouteVerbDispatch
+    include Cassini::Mixin::RazorResponseValidator
+
+    include ::Pantheios
+
+
+    # ##########################################################
+    # Constants
+
+    FULL_DESIGNATION  = 'Snapshots'
+    SHORT_DESIGNATION = 'snapshots'
+    SERVICE_TYPE      = :microservice
+    PROGRAM_FEATURES  = {
+        has_web_server:         true,
+        has_host_and_port:      true,
+        has_razor_connectivity: true,
+        authentication:         true,
+        copyright_year:         2020,
+    }
+    SUPPORTED_ROUTES  = [
+        [ '/progress', :get, 'Get the details of all in progress snapshots' ],
+        [ '/progress/:id', :get, 'Get the details of a specific snapshot if it is in progress' ],
+    ]
+    HTTP_ACCEPTS      = %w{
+        text/html
+        application/json
+        application/xml
+        text/xml
+        text/csv
+        text/plain
+        text/tab-separated-values
+        text/tsv
+    }
+
+
+    # ##########################################################
+    # methods
+
+    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]
+
+        set :razor_requester, options[:razor_requester]
+        set :request_options, request_options
+    end
+
+
+    # ##########################################################
+    # routes
+
+    get '/progress/:id/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Progress::ItemGet
+    end
+
+    get '/progress/?' do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch Progress::CollectionGet
+    end
+
+    # ##########################################################
+    # catch-all hook
+
+    define_catch_all_handlers
+
+end # class App
+
+
+# ##########################################################################
+# modules
+
+end # module Snapshots
+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/snapshots/version.rb

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

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

data/lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress/collection_get.rb

@@ -0,0 +1,125 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Snapshots microservice's collection GET verb
+#
+#  Copyright (c) 2020 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+require 'razor_risk/cassini/mixin/razor_response_validator'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/snapshots_connector'
+require 'razor_risk/core/diagnostics/logger'
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Snapshots
+module Progress
+
+
+# ##########################################################################
+# classes
+
+class CollectionGet < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Mixin::RazorResponseValidator
+    include Cassini::Util::ConversionUtil
+
+    include Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    public
+    HTTP_VERB        = :get
+    HTTP_ACCEPTS     = [
+        'application/xml',
+        'application/json',
+        'text/xml',
+    ]
+    QUERY_PARAMETERS = []
+    ROUTE_VARIABLES  = []
+
+
+    # ##########################################################
+    # methods
+
+    def initialize *args, **options
+
+        @connector_class = options[:connector_class] || SnapshotsConnector
+        super
+    end
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        ec = @connector_class.new settings.razor_requester, credentials: get_required_credentials
+        qr = ec.get_progress indicate_result_by: :qualified_result
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        # Check the request succeeded
+        validate_qualified_razor_response qr
+        if qr.result.nil?
+                error HTTP_STATUS_NAMES::NOT_FOUND, 'No snapshots in progress'
+        elsif qr.failed?
+            log :warning, 'Failed to retrieve snapshot progress information for an unkown reason'
+            error HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR, 'Oops! Something went wrong'
+        end
+
+        unless qr.result.xpath('snapshotProgress').any?
+            error HTTP_STATUS_NAMES::NOT_FOUND, 'No snapshots in progress'
+        end
+
+        status HTTP_STATUS_NAMES::OK
+
+        if request.accept?('application/xml')
+            log :debug1, 'application/xml'
+            content_type 'application/xml'
+            qr.result.to_s
+        elsif request.accept?('text/xml')
+            log :debug1, 'text/xml'
+            content_type 'text/xml'
+            qr.result.to_s
+        elsif request.accept?('application/json')
+            log :debug1, 'application/json'
+            content_type 'application/json'
+            convert_XML_to_JSON qr.result, { scheme: :gdata }
+        else
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+            error HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR, 'Oops! Something went wrong'
+        end
+    end
+end # class CollectionGet
+
+
+# ##########################################################################
+# module
+
+end # module Progress
+end # module Snapshots
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress/item_get.rb

@@ -0,0 +1,134 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Adaptor for Snapshots microservice's collection GET verb
+#
+#  Copyright (c) 2020 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+require 'razor_risk/cassini/mixin/razor_response_validator'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/snapshots_connector'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'xqsr3/conversion/integer_parser'
+
+
+# ##########################################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Snapshots
+module Progress
+
+
+# ##########################################################################
+# classes
+
+class ItemGet < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include Cassini::Mixin::RazorResponseValidator
+    include Cassini::Util::ConversionUtil
+
+    include Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # Constants
+
+    public
+    HTTP_VERB        = :get
+    HTTP_ACCEPTS     = [
+        'application/xml',
+        'application/json',
+        'text/xml',
+    ]
+    QUERY_PARAMETERS = []
+    ROUTE_VARIABLES  = [ 'id' ]
+
+
+    # ##########################################################
+    # methods
+
+    def initialize *args, **options
+
+        @connector_class = options[:connector_class] || SnapshotsConnector
+        super
+    end
+
+    def handle env, params, request, response
+
+        trace ParamNames[ :env, :params, :request, :response ], env, params, request, response
+
+        id = ::Xqsr3::Conversion::IntegerParser.to_integer(params['id'], nil: true)
+        error HTTP_STATUS_NAMES::UNPROCESSABLE_ENTITY, 'ID must be an integer' unless id
+
+        ec = @connector_class.new settings.razor_requester, credentials: get_required_credentials
+
+        qr = ec.get_progress indicate_result_by: :qualified_result
+        log :debug1, "qr(#{qr.class})='#{qr}'"
+
+        # Check the request succeeded
+        validate_qualified_razor_response qr
+        if qr.result.nil?
+            error HTTP_STATUS_NAMES::NOT_FOUND, "Snapshot #{id} is not in progress"
+        elsif qr.failed?
+            log :warning, "Failed to retrieve snapshot progress information for #{id} for an unkown reason"
+            error HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR, 'Oops! Something went wrong'
+        end
+
+        # Get the specified snapshot
+        unless snapshot = qr.result.at_xpath("snapshotProgress[@sysId='#{id}']")
+            error HTTP_STATUS_NAMES::NOT_FOUND, "Snapshot #{id} is not in progress"
+        end
+
+        # Set response
+        status HTTP_STATUS_NAMES::OK
+
+        if request.accept?('application/xml')
+            log :debug1, 'application/xml'
+            content_type 'application/xml'
+            snapshot.to_s
+        elsif request.accept?('text/xml')
+            log :debug1, 'text/xml'
+            content_type 'text/xml'
+            snapshot.to_s
+        elsif request.accept?('application/json')
+            log :debug1, 'application/json'
+            content_type 'application/json'
+            convert_XML_to_JSON snapshot, { scheme: :gdata }
+        else
+            log :violation, "unexpected failure to match given 'Accept' header '#{request.accept}'"
+            error HTTP_STATUS_NAMES::INTERNAL_SERVER_ERROR, 'Oops! Something went wrong'
+        end
+    end
+end # class ItemGet
+
+
+# ##########################################################################
+# module
+
+end # module Progress
+end # module Snapshots
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2020 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress/collection_get'
+require 'razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress/item_get'
+
+
+# ############################## end of file ############################# #
+
+

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

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

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: restful-snapshots
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+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-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.24
+    - - "<"
+      - !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.24
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-razor-connectivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !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.23
+    - - "<"
+      - !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.23
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: 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 Snapshots RESTful microservice
+email: operations@razor-risk.com
+executables:
+- razorrisk-microservice-snapshots
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/razorrisk-microservice-snapshots
+- lib/razor_risk/cassini/applications/microservices/restful/snapshots.rb
+- lib/razor_risk/cassini/applications/microservices/restful/snapshots/app.rb
+- lib/razor_risk/cassini/applications/microservices/restful/snapshots/version.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress/collection_get.rb
+- lib/razor_risk/cassini/applications/route_verb_adaptors/snapshots/progress/item_get.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 Snapshot RESTful microservice
+test_files: []