cosmos-cmd-tlm-api/app/controllers/notes_controller.rb
# 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.
#
# This program may also be used under the terms of a commercial or
# enterprise edition license of COSMOS if purchased from the
# copyright holder
require 'cosmos/models/note_model'
require 'time'
class NotesController < ApplicationController
def initialize
@model_class = Cosmos::NoteModel
end
# Returns an array/list of notes in json. With optional start_time and end_time parameters
#
# scope [String] the scope of the note, `DEFAULT`
# start [String] (optional) The start time of the search window
# stop [String] (optional) The stop time of the search window
# limit [String] (optional) Maximum number of entries to return
# @return [String] the array of entries converted into json format.
def index
return unless authorization('scripts')
action do
hash = params.to_unsafe_h.slice(:start, :stop, :limit)
if (hash['start'] && hash['stop'])
hash['start'] = Time.parse(hash['start']).to_i
hash['stop'] = Time.parse(hash['stop']).to_i
json = @model_class.range(**hash.symbolize_keys, scope: params[:scope])
else
json = @model_class.all(scope: params[:scope])
end
render json: json, status: 200
end
end
# Record note and returns an object/hash of in json.
#
# scope [String] the scope of the note, `TEST`
# json [String] The json of the activity (see below)
# @return [String] the activity converted into json format
# Request Headers
# ```json
# {
# "Authorization": "token/password",
# "Content-Type": "application/json"
# }
# ```
# Request Post Body
# ```json
# {
# "start": "2031-04-16T01:02:00+00:00",
# "stop": "2031-04-16T02:02:00+00:00",
# "color": "#FF0000",
# "description": "",
# }
# ```
def create
return unless authorization('scripts')
action do
hash = params.to_unsafe_h.slice(:start, :stop, :color, :description).to_h
if hash['start'].nil? || hash['stop'].nil?
raise ArgumentError.new 'post body must contain a time value'
end
hash['start'] = Time.parse(hash['start']).to_i
hash['stop'] = Time.parse(hash['stop']).to_i
model = @model_class.from_json(hash.symbolize_keys, scope: params[:scope])
model.create
Cosmos::Logger.info(
"Note created: #{model}",
scope: params[:scope],
user: user_info(request.headers['HTTP_AUTHORIZATION']),
)
render json: model.as_json, status: 201
end
end
# Returns an object/hash of a single activity in json.
#
# scope [String] the scope of the note, `DEFAULT`
# id [String] the id of the entry, `1620248449`
# @return [String] the activity as a object/hash converted into json format
# Request Headers
# ```json
# {
# "Authorization": "token/password",
# "Content-Type": "application/json"
# }
# ```
def show
return unless authorization('scripts')
action do
model_hash = @model_class.get(start: params[:id], scope: params[:scope])
if model_hash
render json: model_hash, status: 200
else
render json: { status: 'error', message: 'not found' }, status: 404
end
end
end
# Update and returns an object/hash of a single activity in json.
#
# id [String] the score or id of the activity, `1620248449`
# scope [String] the scope of the timeline, `TEST`
# json [String] The json of the event (see #activity_model)
# @return [String] the activity as a object/hash converted into json format
# Request Headers
# ```json
# {
# "Authorization": "token/password",
# "Content-Type": "application/json"
# }
# ```
# Request Post Body
# ```json
# {
# "start": "2031-04-16T01:02:00+00:00",
# "stop": "2031-04-16T01:04:00+00:00",
# "color": "#FF0000",
# "description": "",
# }
# ```
def update
return unless authorization('scripts')
action do
hash = @model_class.get(start: params[:id], scope: params[:scope])
if hash.nil?
render json: { status: 'error', message: 'not found' }, status: 404
return
end
model = @model_class.from_json(hash.symbolize_keys, scope: params[:scope])
hash = params.to_unsafe_h.slice(:start, :stop, :color, :description).to_h
hash['start'] = Time.parse(hash['start']).to_i
hash['stop'] = Time.parse(hash['stop']).to_i
model.update(
start: hash['start'],
stop: hash['stop'],
color: hash['color'],
description: hash['description'],
)
Cosmos::Logger.info(
"Note updated: #{model}",
scope: params[:scope],
user: user_info(request.headers['HTTP_AUTHORIZATION']),
)
render json: model.as_json, status: 200
end
end
# Removes a note by score/id.
#
# scope [String] the scope of the timeline, `TEST`
# id [String] the score or id of the activity, `1620248449`
# @return [String] object/hash converted into json format but with a 204 no-content status code
# Request Headers
# ```json
# {
# "Authorization": "token/password",
# "Content-Type": "application/json"
# }
# ```
def destroy
return unless authorization('scripts')
action do
count = @model_class.destroy(start: params[:id], scope: params[:scope])
if count == 0
render json: { status: 'error', message: 'not found' }, status: 404
return
end
Cosmos::Logger.info(
"Note destroyed: #{params[:id]}",
scope: params[:scope],
user: user_info(request.headers['HTTP_AUTHORIZATION']),
)
render json: { 'status' => count }, status: 204
end
end
# Returns an array/list of notes in json. With optional start_time and end_time parameters
#
# scope [String] the scope of the note, `DEFAULT`
# start [String] (optional) The start time of the search window
# stop [String] (optional) The stop time of the search window
# description [String] (required) The string to contain in the note description
# @return [String] the array of entries converted into json format.
# def search
# return unless authorization()
# action do
# start, stop = parse_time_input(x_start: params[:start], x_stop: params[:stop])
# description = params[:description]
# raise SortedInputError "Must include description value" if description.nil?
# model_array = @model_class.range(scope: params[:scope], start: start, stop: stop)
# model_array.find { |model| model.description.include? description }
# render :json => model_array, :status => 200
# end
# end
private
# Yield and rescue all the possible exceptions
def action
begin
yield
rescue ArgumentError, TypeError => e
render json: {
status: 'error',
message: "Invalid input: #{e.message}",
type: e.class,
},
status: 400
rescue Cosmos::SortedError => e
render json: {
status: 'error',
message: e.message,
type: e.class,
},
status: 400
rescue StandardError => e
render json: {
status: 'error',
message: e.message,
type: e.class,
backtrace: e.backtrace,
},
status: 400
end
end
end