OpenC3/cosmos

View on GitHub
openc3-cosmos-cmd-tlm-api/config/routes.rb

Summary

Maintainability
A
0 mins
Test Coverage
# encoding: ascii-8bit

# Copyright 2022 Ball Aerospace & Technologies Corp.
# All Rights Reserved.
#
# This program is free software; you can modify and/or redistribute it
# under the terms of the GNU Affero General Public License
# as published by the Free Software Foundation; version 3 with
# attribution addendums as found in the LICENSE.txt
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.

# Modified by OpenC3, Inc.
# All changes Copyright 2024, OpenC3, Inc.
# All Rights Reserved
#
# This file may also be used under the terms of a commercial license
# if purchased from OpenC3, Inc.

# For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html

Rails.application.routes.draw do
  scope "openc3-api" do
    resources :routers, only: [:index, :create]
    get '/routers/:id', to: 'routers#show', id: /[^\/]+/
    match '/routers/:id', to: 'routers#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/routers/:id', to: 'routers#destroy', id: /[^\/]+/

    resources :interfaces, only: [:index, :create]
    get '/interfaces/:id', to: 'interfaces#show', id: /[^\/]+/
    match '/interfaces/:id', to: 'interfaces#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/interfaces/:id', to: 'interfaces#destroy', id: /[^\/]+/

    resources :targets, only: [:index, :create]
    get '/targets/:id', to: 'targets#show', id: /[^\/]+/
    get '/targets/:id/modified_files', to: 'targets#modified_files', id: /[^\/]+/
    get '/targets_modified', to: 'targets#all_modified'
    match '/targets/:id', to: 'targets#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/targets/:id', to: 'targets#destroy', id: /[^\/]+/
    post '/targets/:id/download', to: 'targets#download', id: /[^\/]+/
    post '/targets/:id/delete_modified', to: 'targets#delete_modified', id: /[^\/]+/

    resources :packages, only: [:index, :create]
    delete '/packages/:id', to: 'packages#destroy', id: /[^\/]+/
    post '/packages/:id/download', to: 'packages#download', id: /[^\/]+/

    resources :microservices, only: [:index, :create]
    get '/microservices/:id', to: 'microservices#show', id: /[^\/]+/
    match '/microservices/:id', to: 'microservices#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/microservices/:id', to: 'microservices#destroy', id: /[^\/]+/

    resources :process_status, only: [:index]
    get '/process_status/:id', to: 'process_status#show', id: /[^\/]+/

    get '/microservice_status/:id', to: 'microservice_status#show', id: /[^\/]+/

    post '/tools/position/:id', to: 'tools#position', id: /[^\/]+/
    resources :tools, only: [:index, :create]
    get '/tools/:id', to: 'tools#show', id: /[^\/]+/
    match '/tools/:id', to: 'tools#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/tools/:id', to: 'tools#destroy', id: /[^\/]+/

    resources :scopes, only: [:index, :create]
    get '/scopes/:id', to: 'scopes#show', id: /[^\/]+/
    match '/scopes/:id', to: 'scopes#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/scopes/:id', to: 'scopes#destroy', id: /[^\/]+/

    resources :widgets, only: [:index, :create]
    get '/widgets/:id', to: 'widgets#show', id: /[^\/]+/
    match '/widgets/:id', to: 'widgets#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/widgets/:id', to: 'widgets#destroy', id: /[^\/]+/

    resources :permissions, only: [:index]

    post '/plugins/install/:id', to: 'plugins#install', id: /[^\/]+/
    resources :plugins, only: [:index, :create]
    get '/plugins/:id', to: 'plugins#show', id: /[^\/]+/
    match '/plugins/:id', to: 'plugins#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/plugins/:id', to: 'plugins#destroy', id: /[^\/]+/

    resources :environment, only: [:index, :create]
    delete '/environment/:name', to: 'environment#destroy', name: /[^\/]+/

    resources :timeline, only: [:index, :create]
    get '/timeline/:name', to: 'timeline#show', name: /[^\/]+/
    post '/timeline/:name/color', to: 'timeline#color', name: /[^\/]+/
    delete '/timeline/:name', to: 'timeline#destroy', name: /[^\/]+/

    post '/timeline/activities/create', to: 'activity#multi_create'
    post '/timeline/activities/delete', to: 'activity#multi_destroy'

    get '/timeline/:name/count', to: 'activity#count', name: /[^\/]+/
    get '/timeline/:name/activities', to: 'activity#index', name: /[^\/]+/
    post '/timeline/:name/activities', to: 'activity#create', name: /[^\/]+/
    get '/timeline/:name/activity/:id', to: 'activity#show', name: /[^\/]+/, id: /[^\/]+/
    post '/timeline/:name/activity/:id', to: 'activity#event', name: /[^\/]+/, id: /[^\/]+/
    match '/timeline/:name/activity/:id', to: 'activity#update', name: /[^\/]+/, id: /[^\/]+/, via: [:patch, :put]
    # NOTE: uuid is new as of 5.19.0
    delete '/timeline/:name/activity/:id(/:uuid)', to: 'activity#destroy', name: /[^\/]+/, id: /[^\/]+/, uuid: /[^\/]+/

    get '/autonomic/group', to: 'trigger_group#index'
    post '/autonomic/group', to: 'trigger_group#create'
    get '/autonomic/group/:group', to: 'trigger_group#show', group: /[^\/]+/
    delete '/autonomic/group/:group', to: 'trigger_group#destroy', group: /[^\/]+/

    get '/autonomic/:group/trigger', to: 'trigger#index', group: /[^\/]+/
    post '/autonomic/:group/trigger', to: 'trigger#create', group: /[^\/]+/
    get '/autonomic/:group/trigger/:name', to: 'trigger#show', group: /[^\/]+/, name: /[^\/]+/
    post '/autonomic/:group/trigger/:name/enable', to: 'trigger#enable', group: /[^\/]+/, name: /[^\/]+/
    post '/autonomic/:group/trigger/:name/disable', to: 'trigger#disable', group: /[^\/]+/, name: /[^\/]+/
    match '/autonomic/:group/trigger/:name', to: 'trigger#update', group: /[^\/]+/, name: /[^\/]+/, via: [:patch, :put]
    delete '/autonomic/:group/trigger/:name', to: 'trigger#destroy', group: /[^\/]+/, name: /[^\/]+/

    get '/autonomic/reaction', to: 'reaction#index'
    post '/autonomic/reaction', to: 'reaction#create'
    get '/autonomic/reaction/:name', to: 'reaction#show', name: /[^\/]+/
    # match '/autonomic/reaction/:name, to: 'reaction#update', name: /[^\/]+/, via: [:patch, :put]
    post '/autonomic/reaction/:name/enable', to: 'reaction#enable', name: /[^\/]+/
    post '/autonomic/reaction/:name/disable', to: 'reaction#disable', name: /[^\/]+/
    post '/autonomic/reaction/:name/execute', to: 'reaction#execute', name: /[^\/]+/
    match '/autonomic/reaction/:name', to: 'reaction#update', name: /[^\/]+/, via: [:patch, :put]
    delete '/autonomic/reaction/:name', to: 'reaction#destroy', name: /[^\/]+/

    get '/metadata', to: 'metadata#index'
    post '/metadata', to: 'metadata#create'
    get '/metadata/latest', to: 'metadata#latest', name: /[^\/]+/
    # get '/metadata/_search', to: 'metadata#search'
    get '/metadata/:id', to: 'metadata#show', id: /[^\/]+/
    match '/metadata/:id', to: 'metadata#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/metadata/:id', to: 'metadata#destroy', id: /[^\/]+/

    get '/notes', to: 'notes#index'
    post '/notes', to: 'notes#create'
    # get '/note/_search', to: 'note#search'
    get '/notes/:id', to: 'notes#show', id: /[^\/]+/
    match '/notes/:id', to: 'notes#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/notes/:id', to: 'notes#destroy', id: /[^\/]+/

    get '/autocomplete/reserved-item-names', to: 'script_autocomplete#reserved_item_names'
    get '/autocomplete/keywords/:type', to: 'script_autocomplete#keywords', type: /[^\/]+/
    get '/autocomplete/data/:type', to: 'script_autocomplete#ace_autocomplete_data', type: /[^\/]+/

    # format: false to ensure the full path is used and not interpreted as a format (.xxx)
    scope format: false do
      get '/storage/buckets', to: 'storage#buckets'
      get '/storage/volumes', to: 'storage#volumes'
      get '/storage/files/:root/(*path)', to: 'storage#files'
      get '/storage/exists/:object_id', to: 'storage#exists', object_id: /.*/
      get '/storage/download_file/:object_id', to: 'storage#download_file', object_id: /.*/
      get '/storage/download/:object_id', to: 'storage#get_download_presigned_request', object_id: /.*/
      get '/storage/upload/:object_id', to: 'storage#get_upload_presigned_request', object_id: /.*/
      delete '/storage/delete/:object_id', to: 'storage#delete', object_id: /.*/
    end

    get  '/tables', to: 'tables#index'
    # format: false to ensure the file extension (.bin, .txt) remains and is passed to 'name'
    get  '/tables/*name', to: 'tables#body', format: false, defaults: { format: 'html' }
    post '/tables/*name/lock', to: 'tables#lock'
    post '/tables/*name/unlock', to: 'tables#unlock'
    post '/tables/binary', to: 'tables#binary'
    post '/tables/definition', to: 'tables#definition'
    post '/tables/report', to: 'tables#report'
    post '/tables/load', to: 'tables#load'
    post '/tables/generate', to: 'tables#generate'
    # Allow new_name to contain anything (including a dot '.')
    put '/tables/*name/save-as/*new_name', to: 'tables#save_as', new_name: /.*/
    # Must be last post /tables/*name so others will match first
    post '/tables/*name', to: 'tables#save'
    delete '/tables/*name', to: 'tables#destroy', format: false

    get "/screens", to: "screens#index"
    get "/screen/:target/:screen", to: "screens#show"
    post "/screen", to: "screens#create"
    delete '/screen/:target/:screen', to: 'screens#destroy'

    get "/secrets", to: "secrets#index"
    post "/secrets/:key", to: "secrets#create", key: /[^\/]+/
    delete '/secrets/:key', to: 'secrets#destroy', key: /[^\/]+/

    # This route handles all the JSON DRB requests
    # It gets routed to the api_controller.rb api method which
    # ultimately calls OpenC3::Cts.instance.json_drb.process_request
    # to do the remote procedure call
    post "/api" => "api#api"
    get "/ping" => "api#ping"

    get "/auth/token-exists" => "auth#token_exists"
    post "/auth/verify" => "auth#verify"
    post "/auth/set" => "auth#set"

    get "/internal/health" => "internal_health#health"
    get "/internal/metrics" => "internal_metrics#index"
    get "/internal/status" => "internal_status#status"

    get "/time" => "time#get_current"
    get "map.json" => "tools#importmap"
    get "auth.js" => "tools#auth"
    get "/traefik" => "microservices#traefik"

    post "/redis/exec" => "redis#execute_raw"

    # The remaining routes are Enterprise only
    get "/users/active" => "users#active"
    match "/users/logout/:user", to: "users#logout", id: /[^\/]+/, via: [:patch, :put]

    get "/info" => "info#info"

    resources :roles, only: [:index, :create]
    get '/roles/:id', to: 'roles#show', id: /[^\/]+/
    match '/roles/:id', to: 'roles#update', id: /[^\/]+/, via: [:patch, :put]
    delete '/roles/:id', to: 'roles#destroy', id: /[^\/]+/

    get '/cmdauth', to: 'cmd_authority#index'
    post '/cmdauth/take', to: 'cmd_authority#take'
    post '/cmdauth/release', to: 'cmd_authority#release'
    post '/cmdauth/take-all', to: 'cmd_authority#take_all'
    post '/cmdauth/release-all', to: 'cmd_authority#release_all'

    get '/criticalcmd/status/:id', to: 'critical_cmd#status'
    post '/criticalcmd/approve/:id', to: 'critical_cmd#approve'
    post '/criticalcmd/reject/:id', to: 'critical_cmd#reject'
    get '/criticalcmd/canapprove/:id', to: 'critical_cmd#canapprove'
  end
end