2014-08-12 08:16:25 -04:00
module API
class Labels < Grape :: API
2017-01-16 23:45:07 -05:00
include PaginationParams
2017-02-20 13:18:12 -05:00
2014-08-12 08:16:25 -04:00
before { authenticate! }
2016-10-24 08:05:33 -04:00
params do
requires :id , type : String , desc : 'The ID of a project'
end
2017-08-31 07:44:49 -04:00
resource :projects , requirements : API :: PROJECT_ENDPOINT_REQUIREMENTS do
2016-10-24 08:05:33 -04:00
desc 'Get all labels of the project' do
success Entities :: Label
end
2017-01-16 23:45:07 -05:00
params do
use :pagination
end
2014-08-12 08:16:25 -04:00
get ':id/labels' do
2017-12-06 14:07:47 -05:00
present paginate ( available_labels_for ( user_project ) ) , with : Entities :: Label , current_user : current_user , project : user_project
2014-08-12 08:16:25 -04:00
end
2016-10-24 08:05:33 -04:00
desc 'Create a new label' do
success Entities :: Label
end
params do
requires :name , type : String , desc : 'The name of the label to be created'
2017-03-29 07:45:15 -04:00
requires :color , type : String , desc : " The color of the label given in 6-digit hex notation with leading ' # ' sign (e.g. # FFAABB) or one of the allowed CSS color names "
2016-10-24 08:05:33 -04:00
optional :description , type : String , desc : 'The description of label to be created'
2016-09-29 10:33:38 -04:00
optional :priority , type : Integer , desc : 'The priority of the label' , allow_blank : true
2016-10-24 08:05:33 -04:00
end
2014-08-12 08:16:25 -04:00
post ':id/labels' do
2014-08-15 04:59:19 -04:00
authorize! :admin_label , user_project
2014-08-12 08:16:25 -04:00
2017-12-06 14:07:47 -05:00
label = available_labels_for ( user_project ) . find_by ( title : params [ :name ] )
2014-08-18 14:09:09 -04:00
conflict! ( 'Label already exists' ) if label
2014-08-12 08:16:25 -04:00
2016-09-29 10:33:38 -04:00
priority = params . delete ( :priority )
2017-03-29 07:45:15 -04:00
label = :: Labels :: CreateService . new ( declared_params ( include_missing : false ) ) . execute ( project : user_project )
2014-08-12 08:16:25 -04:00
if label . valid?
2016-09-29 10:33:38 -04:00
label . prioritize! ( user_project , priority ) if priority
present label , with : Entities :: Label , current_user : current_user , project : user_project
2014-08-12 08:16:25 -04:00
else
2014-08-18 14:09:09 -04:00
render_validation_error! ( label )
2014-08-12 08:16:25 -04:00
end
end
2016-10-24 08:05:33 -04:00
desc 'Delete an existing label' do
success Entities :: Label
end
params do
requires :name , type : String , desc : 'The name of the label to be deleted'
end
2014-08-12 08:16:25 -04:00
delete ':id/labels' do
2014-08-15 04:59:19 -04:00
authorize! :admin_label , user_project
2014-08-12 08:16:25 -04:00
2016-10-20 06:15:29 -04:00
label = user_project . labels . find_by ( title : params [ :name ] )
2014-08-18 14:09:09 -04:00
not_found! ( 'Label' ) unless label
2014-08-12 08:16:25 -04:00
2017-03-02 07:14:13 -05:00
destroy_conditionally! ( label )
2014-08-12 08:16:25 -04:00
end
2014-08-13 06:23:51 -04:00
2016-10-24 08:05:33 -04:00
desc 'Update an existing label. At least one optional parameter is required.' do
success Entities :: Label
end
params do
requires :name , type : String , desc : 'The name of the label to be updated'
optional :new_name , type : String , desc : 'The new name of the label'
2017-03-29 07:45:15 -04:00
optional :color , type : String , desc : " The new color of the label given in 6-digit hex notation with leading ' # ' sign (e.g. # FFAABB) or one of the allowed CSS color names "
2016-10-24 08:05:33 -04:00
optional :description , type : String , desc : 'The new description of label'
2016-09-29 10:33:38 -04:00
optional :priority , type : Integer , desc : 'The priority of the label' , allow_blank : true
at_least_one_of :new_name , :color , :description , :priority
2016-10-24 08:05:33 -04:00
end
2014-08-13 06:23:51 -04:00
put ':id/labels' do
2014-08-15 04:59:19 -04:00
authorize! :admin_label , user_project
2014-08-13 06:23:51 -04:00
2016-10-20 06:15:29 -04:00
label = user_project . labels . find_by ( title : params [ :name ] )
2014-08-18 14:09:09 -04:00
not_found! ( 'Label not found' ) unless label
2014-08-13 06:23:51 -04:00
2016-09-29 10:33:38 -04:00
update_priority = params . key? ( :priority )
priority = params . delete ( :priority )
2016-11-14 08:44:27 -05:00
label_params = declared_params ( include_missing : false )
2014-08-13 06:23:51 -04:00
# Rename new name to the actual label attribute name
2016-11-14 08:44:27 -05:00
label_params [ :name ] = label_params . delete ( :new_name ) if label_params . key? ( :new_name )
2014-08-13 06:23:51 -04:00
2017-03-29 07:45:15 -04:00
label = :: Labels :: UpdateService . new ( label_params ) . execute ( label )
render_validation_error! ( label ) unless label . valid?
2016-09-29 10:33:38 -04:00
if update_priority
if priority . nil?
label . unprioritize! ( user_project )
else
label . prioritize! ( user_project , priority )
end
2014-08-13 06:23:51 -04:00
end
2016-09-29 10:33:38 -04:00
present label , with : Entities :: Label , current_user : current_user , project : user_project
2014-08-13 06:23:51 -04:00
end
2014-08-12 08:16:25 -04:00
end
end
end