diff options
Diffstat (limited to 'lib/api/users.rb')
| -rw-r--r-- | lib/api/users.rb | 392 |
1 files changed, 196 insertions, 196 deletions
diff --git a/lib/api/users.rb b/lib/api/users.rb index 7d88880d412..4c0da1ca72f 100644 --- a/lib/api/users.rb +++ b/lib/api/users.rb @@ -6,9 +6,9 @@ module API include APIGuard include Helpers::CustomAttributes - allow_access_with_scope :read_user, if: -> (request) { request.get? } + allow_access_with_scope :read_user, if: ->(request) { request.get? } - resource :users, requirements: { uid: /[0-9]*/, id: /[0-9]*/ } do + resource :users, requirements: {uid: /[0-9]*/, id: /[0-9]*/} do include CustomAttributesEndpoints before do @@ -19,7 +19,7 @@ module API # rubocop: disable CodeReuse/ActiveRecord def find_user_by_id(params) id = params[:user_id] || params[:id] - User.find_by(id: id) || not_found!('User') + User.find_by(id: id) || not_found!("User") end # rubocop: enable CodeReuse/ActiveRecord @@ -34,47 +34,47 @@ module API # rubocop: enable CodeReuse/ActiveRecord params :optional_attributes do - optional :skype, type: String, desc: 'The Skype username' - optional :linkedin, type: String, desc: 'The LinkedIn username' - optional :twitter, type: String, desc: 'The Twitter username' - optional :website_url, type: String, desc: 'The website of the user' - optional :organization, type: String, desc: 'The organization of the user' - optional :projects_limit, type: Integer, desc: 'The number of projects a user can create' - optional :extern_uid, type: String, desc: 'The external authentication provider UID' - optional :provider, type: String, desc: 'The external provider' - optional :bio, type: String, desc: 'The biography of the user' - optional :location, type: String, desc: 'The location of the user' - optional :public_email, type: String, desc: 'The public email of the user' - optional :admin, type: Boolean, desc: 'Flag indicating the user is an administrator' - optional :can_create_group, type: Boolean, desc: 'Flag indicating the user can create groups' - optional :external, type: Boolean, desc: 'Flag indicating the user is an external user' - optional :avatar, type: File, desc: 'Avatar image for user' - optional :private_profile, type: Boolean, desc: 'Flag indicating the user has a private profile' + optional :skype, type: String, desc: "The Skype username" + optional :linkedin, type: String, desc: "The LinkedIn username" + optional :twitter, type: String, desc: "The Twitter username" + optional :website_url, type: String, desc: "The website of the user" + optional :organization, type: String, desc: "The organization of the user" + optional :projects_limit, type: Integer, desc: "The number of projects a user can create" + optional :extern_uid, type: String, desc: "The external authentication provider UID" + optional :provider, type: String, desc: "The external provider" + optional :bio, type: String, desc: "The biography of the user" + optional :location, type: String, desc: "The location of the user" + optional :public_email, type: String, desc: "The public email of the user" + optional :admin, type: Boolean, desc: "Flag indicating the user is an administrator" + optional :can_create_group, type: Boolean, desc: "Flag indicating the user can create groups" + optional :external, type: Boolean, desc: "Flag indicating the user is an external user" + optional :avatar, type: File, desc: "Avatar image for user" + optional :private_profile, type: Boolean, desc: "Flag indicating the user has a private profile" all_or_none_of :extern_uid, :provider end params :sort_params do optional :order_by, type: String, values: %w[id name username created_at updated_at], - default: 'id', desc: 'Return users ordered by a field' - optional :sort, type: String, values: %w[asc desc], default: 'desc', - desc: 'Return users sorted in ascending and descending order' + default: "id", desc: "Return users ordered by a field" + optional :sort, type: String, values: %w[asc desc], default: "desc", + desc: "Return users sorted in ascending and descending order" end end - desc 'Get the list of users' do + desc "Get the list of users" do success Entities::UserBasic end params do # CE - optional :username, type: String, desc: 'Get a single user with a specific username' - optional :extern_uid, type: String, desc: 'Get a single user with a specific external authentication provider UID' - optional :provider, type: String, desc: 'The external provider' - optional :search, type: String, desc: 'Search for a username' - optional :active, type: Boolean, default: false, desc: 'Filters only active users' - optional :external, type: Boolean, default: false, desc: 'Filters only external users' - optional :blocked, type: Boolean, default: false, desc: 'Filters only blocked users' - optional :created_after, type: DateTime, desc: 'Return users created after the specified time' - optional :created_before, type: DateTime, desc: 'Return users created before the specified time' + optional :username, type: String, desc: "Get a single user with a specific username" + optional :extern_uid, type: String, desc: "Get a single user with a specific external authentication provider UID" + optional :provider, type: String, desc: "The external provider" + optional :search, type: String, desc: "Search for a username" + optional :active, type: Boolean, default: false, desc: "Filters only active users" + optional :external, type: Boolean, default: false, desc: "Filters only external users" + optional :blocked, type: Boolean, default: false, desc: "Filters only blocked users" + optional :created_after, type: DateTime, desc: "Return users created after the specified time" + optional :created_before, type: DateTime, desc: "Return users created before the specified time" all_or_none_of :extern_uid, :provider use :sort_params @@ -105,26 +105,26 @@ module API entity = current_user&.admin? ? Entities::UserWithAdmin : Entities::UserBasic users = users.preload(:identities, :u2f_registrations) if entity == Entities::UserWithAdmin - users, options = with_custom_attributes(users, { with: entity, current_user: current_user }) + users, options = with_custom_attributes(users, {with: entity, current_user: current_user}) present paginate(users), options end # rubocop: enable CodeReuse/ActiveRecord - desc 'Get a single user' do + desc "Get a single user" do success Entities::User end params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" use :with_custom_attributes end # rubocop: disable CodeReuse/ActiveRecord get ":id" do user = User.find_by(id: params[:id]) - not_found!('User') unless user && can?(current_user, :read_user, user) + not_found!("User") unless user && can?(current_user, :read_user, user) - opts = { with: current_user&.admin? ? Entities::UserWithAdmin : Entities::User, current_user: current_user } + opts = {with: current_user&.admin? ? Entities::UserWithAdmin : Entities::User, current_user: current_user} user, opts = with_custom_attributes(user, opts) present user, opts @@ -133,26 +133,26 @@ module API desc "Get the status of a user" params do - requires :user_id, type: String, desc: 'The ID or username of the user' + requires :user_id, type: String, desc: "The ID or username of the user" end get ":user_id/status", requirements: API::USER_REQUIREMENTS do user = find_user(params[:user_id]) - not_found!('User') unless user && can?(current_user, :read_user, user) + not_found!("User") unless user && can?(current_user, :read_user, user) present user.status || {}, with: Entities::UserStatus end - desc 'Create a user. Available only for admins.' do + desc "Create a user. Available only for admins." do success Entities::UserPublic end params do - requires :email, type: String, desc: 'The email of the user' - optional :password, type: String, desc: 'The password of the new user' - optional :reset_password, type: Boolean, desc: 'Flag indicating the user will be sent a password reset token' - optional :skip_confirmation, type: Boolean, desc: 'Flag indicating the account is confirmed' + requires :email, type: String, desc: "The email of the user" + optional :password, type: String, desc: "The password of the new user" + optional :reset_password, type: Boolean, desc: "Flag indicating the user will be sent a password reset token" + optional :skip_confirmation, type: Boolean, desc: "Flag indicating the account is confirmed" at_least_one_of :password, :reset_password - requires :name, type: String, desc: 'The name of the user' - requires :username, type: String, desc: 'The username of the user' + requires :name, type: String, desc: "The name of the user" + requires :username, type: String, desc: "The username of the user" use :optional_attributes end post do @@ -164,11 +164,11 @@ module API if user.persisted? present user, with: Entities::UserPublic, current_user: current_user else - conflict!('Email has already been taken') if User + conflict!("Email has already been taken") if User .by_any_email(user.email.downcase) .any? - conflict!('Username has already been taken') if User + conflict!("Username has already been taken") if User .by_username(user.username) .any? @@ -176,16 +176,16 @@ module API end end - desc 'Update a user. Available only for admins.' do + desc "Update a user. Available only for admins." do success Entities::UserPublic end params do - requires :id, type: Integer, desc: 'The ID of the user' - optional :email, type: String, desc: 'The email of the user' - optional :password, type: String, desc: 'The password of the new user' - optional :skip_reconfirmation, type: Boolean, desc: 'Flag indicating the account skips the confirmation by email' - optional :name, type: String, desc: 'The name of the user' - optional :username, type: String, desc: 'The username of the user' + requires :id, type: Integer, desc: "The ID of the user" + optional :email, type: String, desc: "The email of the user" + optional :password, type: String, desc: "The password of the new user" + optional :skip_reconfirmation, type: Boolean, desc: "Flag indicating the account skips the confirmation by email" + optional :name, type: String, desc: "The name of the user" + optional :username, type: String, desc: "The username of the user" use :optional_attributes end # rubocop: disable CodeReuse/ActiveRecord @@ -193,15 +193,15 @@ module API authenticated_as_admin! user = User.find_by(id: params.delete(:id)) - not_found!('User') unless user + not_found!("User") unless user - conflict!('Email has already been taken') if params[:email] && - User.by_any_email(params[:email].downcase) - .where.not(id: user.id).count > 0 + conflict!("Email has already been taken") if params[:email] && + User.by_any_email(params[:email].downcase) + .where.not(id: user.id).count > 0 - conflict!('Username has already been taken') if params[:username] && - User.by_username(params[:username]) - .where.not(id: user.id).count > 0 + conflict!("Username has already been taken") if params[:username] && + User.by_username(params[:username]) + .where.not(id: user.id).count > 0 user_params = declared_params(include_missing: false) identity_attrs = user_params.slice(:provider, :extern_uid) @@ -229,20 +229,20 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Add an SSH key to a specified user. Available only for admins.' do + desc "Add an SSH key to a specified user. Available only for admins." do success Entities::SSHKey end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :key, type: String, desc: 'The new SSH key' - requires :title, type: String, desc: 'The title of the new SSH key' + requires :id, type: Integer, desc: "The ID of the user" + requires :key, type: String, desc: "The new SSH key" + requires :title, type: String, desc: "The title of the new SSH key" end # rubocop: disable CodeReuse/ActiveRecord post ":id/keys" do authenticated_as_admin! user = User.find_by(id: params.delete(:id)) - not_found!('User') unless user + not_found!("User") unless user key = user.keys.new(declared_params(include_missing: false)) @@ -254,57 +254,57 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Get the SSH keys of a specified user.' do + desc "Get the SSH keys of a specified user." do success Entities::SSHKey end params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" use :pagination end # rubocop: disable CodeReuse/ActiveRecord - get ':id/keys' do + get ":id/keys" do user = User.find_by(id: params[:id]) - not_found!('User') unless user && can?(current_user, :read_user, user) + not_found!("User") unless user && can?(current_user, :read_user, user) present paginate(user.keys), with: Entities::SSHKey end # rubocop: enable CodeReuse/ActiveRecord - desc 'Delete an existing SSH key from a specified user. Available only for admins.' do + desc "Delete an existing SSH key from a specified user. Available only for admins." do success Entities::SSHKey end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :key_id, type: Integer, desc: 'The ID of the SSH key' + requires :id, type: Integer, desc: "The ID of the user" + requires :key_id, type: Integer, desc: "The ID of the SSH key" end # rubocop: disable CodeReuse/ActiveRecord - delete ':id/keys/:key_id' do + delete ":id/keys/:key_id" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user key = user.keys.find_by(id: params[:key_id]) - not_found!('Key') unless key + not_found!("Key") unless key destroy_conditionally!(key) end # rubocop: enable CodeReuse/ActiveRecord - desc 'Add a GPG key to a specified user. Available only for admins.' do - detail 'This feature was added in GitLab 10.0' + desc "Add a GPG key to a specified user. Available only for admins." do + detail "This feature was added in GitLab 10.0" success Entities::GPGKey end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :key, type: String, desc: 'The new GPG key' + requires :id, type: Integer, desc: "The ID of the user" + requires :key, type: String, desc: "The new GPG key" end # rubocop: disable CodeReuse/ActiveRecord - post ':id/gpg_keys' do + post ":id/gpg_keys" do authenticated_as_admin! user = User.find_by(id: params.delete(:id)) - not_found!('User') unless user + not_found!("User") unless user key = user.gpg_keys.new(declared_params(include_missing: false)) @@ -316,83 +316,83 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Get the GPG keys of a specified user. Available only for admins.' do - detail 'This feature was added in GitLab 10.0' + desc "Get the GPG keys of a specified user. Available only for admins." do + detail "This feature was added in GitLab 10.0" success Entities::GPGKey end params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" use :pagination end # rubocop: disable CodeReuse/ActiveRecord - get ':id/gpg_keys' do + get ":id/gpg_keys" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user present paginate(user.gpg_keys), with: Entities::GPGKey end # rubocop: enable CodeReuse/ActiveRecord - desc 'Delete an existing GPG key from a specified user. Available only for admins.' do - detail 'This feature was added in GitLab 10.0' + desc "Delete an existing GPG key from a specified user. Available only for admins." do + detail "This feature was added in GitLab 10.0" end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :key_id, type: Integer, desc: 'The ID of the GPG key' + requires :id, type: Integer, desc: "The ID of the user" + requires :key_id, type: Integer, desc: "The ID of the GPG key" end # rubocop: disable CodeReuse/ActiveRecord - delete ':id/gpg_keys/:key_id' do + delete ":id/gpg_keys/:key_id" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user key = user.gpg_keys.find_by(id: params[:key_id]) - not_found!('GPG Key') unless key + not_found!("GPG Key") unless key status 204 key.destroy end # rubocop: enable CodeReuse/ActiveRecord - desc 'Revokes an existing GPG key from a specified user. Available only for admins.' do - detail 'This feature was added in GitLab 10.0' + desc "Revokes an existing GPG key from a specified user. Available only for admins." do + detail "This feature was added in GitLab 10.0" end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :key_id, type: Integer, desc: 'The ID of the GPG key' + requires :id, type: Integer, desc: "The ID of the user" + requires :key_id, type: Integer, desc: "The ID of the GPG key" end # rubocop: disable CodeReuse/ActiveRecord - post ':id/gpg_keys/:key_id/revoke' do + post ":id/gpg_keys/:key_id/revoke" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user key = user.gpg_keys.find_by(id: params[:key_id]) - not_found!('GPG Key') unless key + not_found!("GPG Key") unless key key.revoke status :accepted end # rubocop: enable CodeReuse/ActiveRecord - desc 'Add an email address to a specified user. Available only for admins.' do + desc "Add an email address to a specified user. Available only for admins." do success Entities::Email end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :email, type: String, desc: 'The email of the user' - optional :skip_confirmation, type: Boolean, desc: 'Skip confirmation of email and assume it is verified' + requires :id, type: Integer, desc: "The ID of the user" + requires :email, type: String, desc: "The email of the user" + optional :skip_confirmation, type: Boolean, desc: "Skip confirmation of email and assume it is verified" end # rubocop: disable CodeReuse/ActiveRecord post ":id/emails" do authenticated_as_admin! user = User.find_by(id: params.delete(:id)) - not_found!('User') unless user + not_found!("User") unless user email = Emails::CreateService.new(current_user, declared_params(include_missing: false).merge(user: user)).execute @@ -404,38 +404,38 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Get the emails addresses of a specified user. Available only for admins.' do + desc "Get the emails addresses of a specified user. Available only for admins." do success Entities::Email end params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" use :pagination end # rubocop: disable CodeReuse/ActiveRecord - get ':id/emails' do + get ":id/emails" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user present paginate(user.emails), with: Entities::Email end # rubocop: enable CodeReuse/ActiveRecord - desc 'Delete an email address of a specified user. Available only for admins.' do + desc "Delete an email address of a specified user. Available only for admins." do success Entities::Email end params do - requires :id, type: Integer, desc: 'The ID of the user' - requires :email_id, type: Integer, desc: 'The ID of the email' + requires :id, type: Integer, desc: "The ID of the user" + requires :email_id, type: Integer, desc: "The ID of the email" end # rubocop: disable CodeReuse/ActiveRecord - delete ':id/emails/:email_id' do + delete ":id/emails/:email_id" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user email = user.emails.find_by(id: params[:email_id]) - not_found!('Email') unless email + not_found!("Email") unless email destroy_conditionally!(email) do |email| Emails::DestroyService.new(current_user, user: user).execute(email) @@ -443,21 +443,21 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Delete a user. Available only for admins.' do + desc "Delete a user. Available only for admins." do success Entities::Email end params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" optional :hard_delete, type: Boolean, desc: "Whether to remove a user's contributions" end # rubocop: disable CodeReuse/ActiveRecord delete ":id" do - Gitlab::QueryLimiting.whitelist('https://gitlab.com/gitlab-org/gitlab-ce/issues/42279') + Gitlab::QueryLimiting.whitelist("https://gitlab.com/gitlab-org/gitlab-ce/issues/42279") authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user destroy_conditionally!(user) do user.delete_async(deleted_by: current_user, params: params) @@ -465,36 +465,36 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Block a user. Available only for admins.' + desc "Block a user. Available only for admins." params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" end # rubocop: disable CodeReuse/ActiveRecord - post ':id/block' do + post ":id/block" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user if !user.ldap_blocked? user.block else - forbidden!('LDAP blocked users cannot be modified by the API') + forbidden!("LDAP blocked users cannot be modified by the API") end end # rubocop: enable CodeReuse/ActiveRecord - desc 'Unblock a user. Available only for admins.' + desc "Unblock a user. Available only for admins." params do - requires :id, type: Integer, desc: 'The ID of the user' + requires :id, type: Integer, desc: "The ID of the user" end # rubocop: disable CodeReuse/ActiveRecord - post ':id/unblock' do + post ":id/unblock" do authenticated_as_admin! user = User.find_by(id: params[:id]) - not_found!('User') unless user + not_found!("User") unless user if user.ldap_blocked? - forbidden!('LDAP blocked users cannot be unblocked by the API') + forbidden!("LDAP blocked users cannot be unblocked by the API") else user.activate end @@ -502,41 +502,41 @@ module API # rubocop: enable CodeReuse/ActiveRecord params do - requires :user_id, type: Integer, desc: 'The ID of the user' + requires :user_id, type: Integer, desc: "The ID of the user" end - segment ':user_id' do + segment ":user_id" do resource :impersonation_tokens do helpers do def finder(options = {}) user = find_user_by_id(params) - PersonalAccessTokensFinder.new({ user: user, impersonation: true }.merge(options)) + PersonalAccessTokensFinder.new({user: user, impersonation: true}.merge(options)) end def find_impersonation_token - finder.find_by_id(declared_params[:impersonation_token_id]) || not_found!('Impersonation Token') + finder.find_by_id(declared_params[:impersonation_token_id]) || not_found!("Impersonation Token") end end before { authenticated_as_admin! } - desc 'Retrieve impersonation tokens. Available only for admins.' do - detail 'This feature was introduced in GitLab 9.0' + desc "Retrieve impersonation tokens. Available only for admins." do + detail "This feature was introduced in GitLab 9.0" success Entities::ImpersonationToken end params do use :pagination - optional :state, type: String, default: 'all', values: %w[all active inactive], desc: 'Filters (all|active|inactive) impersonation_tokens' + optional :state, type: String, default: "all", values: %w[all active inactive], desc: "Filters (all|active|inactive) impersonation_tokens" end get { present paginate(finder(declared_params(include_missing: false)).execute), with: Entities::ImpersonationToken } - desc 'Create a impersonation token. Available only for admins.' do - detail 'This feature was introduced in GitLab 9.0' + desc "Create a impersonation token. Available only for admins." do + detail "This feature was introduced in GitLab 9.0" success Entities::ImpersonationTokenWithToken end params do - requires :name, type: String, desc: 'The name of the impersonation token' - optional :expires_at, type: Date, desc: 'The expiration date in the format YEAR-MONTH-DAY of the impersonation token' - optional :scopes, type: Array, desc: 'The array of scopes of the impersonation token' + requires :name, type: String, desc: "The name of the impersonation token" + optional :expires_at, type: Date, desc: "The expiration date in the format YEAR-MONTH-DAY of the impersonation token" + optional :scopes, type: Array, desc: "The array of scopes of the impersonation token" end post do impersonation_token = finder.build(declared_params(include_missing: false)) @@ -548,24 +548,24 @@ module API end end - desc 'Retrieve impersonation token. Available only for admins.' do - detail 'This feature was introduced in GitLab 9.0' + desc "Retrieve impersonation token. Available only for admins." do + detail "This feature was introduced in GitLab 9.0" success Entities::ImpersonationToken end params do - requires :impersonation_token_id, type: Integer, desc: 'The ID of the impersonation token' + requires :impersonation_token_id, type: Integer, desc: "The ID of the impersonation token" end - get ':impersonation_token_id' do + get ":impersonation_token_id" do present find_impersonation_token, with: Entities::ImpersonationToken end - desc 'Revoke a impersonation token. Available only for admins.' do - detail 'This feature was introduced in GitLab 9.0' + desc "Revoke a impersonation token. Available only for admins." do + detail "This feature was introduced in GitLab 9.0" end params do - requires :impersonation_token_id, type: Integer, desc: 'The ID of the impersonation token' + requires :impersonation_token_id, type: Integer, desc: "The ID of the impersonation token" end - delete ':impersonation_token_id' do + delete ":impersonation_token_id" do token = find_impersonation_token destroy_conditionally!(token) do @@ -583,8 +583,8 @@ module API # Enabling /user endpoint for the v3 version to allow oauth # authentication through this endpoint. - version %w(v3 v4), using: :path do - desc 'Get the currently authenticated user' do + version %w[v3 v4], using: :path do + desc "Get the currently authenticated user" do success Entities::UserPublic end get do @@ -609,27 +609,27 @@ module API present paginate(current_user.keys), with: Entities::SSHKey end - desc 'Get a single key owned by currently authenticated user' do + desc "Get a single key owned by currently authenticated user" do success Entities::SSHKey end params do - requires :key_id, type: Integer, desc: 'The ID of the SSH key' + requires :key_id, type: Integer, desc: "The ID of the SSH key" end # rubocop: disable CodeReuse/ActiveRecord get "keys/:key_id" do key = current_user.keys.find_by(id: params[:key_id]) - not_found!('Key') unless key + not_found!("Key") unless key present key, with: Entities::SSHKey end # rubocop: enable CodeReuse/ActiveRecord - desc 'Add a new SSH key to the currently authenticated user' do + desc "Add a new SSH key to the currently authenticated user" do success Entities::SSHKey end params do - requires :key, type: String, desc: 'The new SSH key' - requires :title, type: String, desc: 'The title of the new SSH key' + requires :key, type: String, desc: "The new SSH key" + requires :title, type: String, desc: "The title of the new SSH key" end post "keys" do key = current_user.keys.new(declared_params) @@ -641,56 +641,56 @@ module API end end - desc 'Delete an SSH key from the currently authenticated user' do + desc "Delete an SSH key from the currently authenticated user" do success Entities::SSHKey end params do - requires :key_id, type: Integer, desc: 'The ID of the SSH key' + requires :key_id, type: Integer, desc: "The ID of the SSH key" end # rubocop: disable CodeReuse/ActiveRecord delete "keys/:key_id" do key = current_user.keys.find_by(id: params[:key_id]) - not_found!('Key') unless key + not_found!("Key") unless key destroy_conditionally!(key) end # rubocop: enable CodeReuse/ActiveRecord desc "Get the currently authenticated user's GPG keys" do - detail 'This feature was added in GitLab 10.0' + detail "This feature was added in GitLab 10.0" success Entities::GPGKey end params do use :pagination end - get 'gpg_keys' do + get "gpg_keys" do present paginate(current_user.gpg_keys), with: Entities::GPGKey end - desc 'Get a single GPG key owned by currently authenticated user' do - detail 'This feature was added in GitLab 10.0' + desc "Get a single GPG key owned by currently authenticated user" do + detail "This feature was added in GitLab 10.0" success Entities::GPGKey end params do - requires :key_id, type: Integer, desc: 'The ID of the GPG key' + requires :key_id, type: Integer, desc: "The ID of the GPG key" end # rubocop: disable CodeReuse/ActiveRecord - get 'gpg_keys/:key_id' do + get "gpg_keys/:key_id" do key = current_user.gpg_keys.find_by(id: params[:key_id]) - not_found!('GPG Key') unless key + not_found!("GPG Key") unless key present key, with: Entities::GPGKey end # rubocop: enable CodeReuse/ActiveRecord - desc 'Add a new GPG key to the currently authenticated user' do - detail 'This feature was added in GitLab 10.0' + desc "Add a new GPG key to the currently authenticated user" do + detail "This feature was added in GitLab 10.0" success Entities::GPGKey end params do - requires :key, type: String, desc: 'The new GPG key' + requires :key, type: String, desc: "The new GPG key" end - post 'gpg_keys' do + post "gpg_keys" do key = current_user.gpg_keys.new(declared_params) if key.save @@ -700,32 +700,32 @@ module API end end - desc 'Revoke a GPG key owned by currently authenticated user' do - detail 'This feature was added in GitLab 10.0' + desc "Revoke a GPG key owned by currently authenticated user" do + detail "This feature was added in GitLab 10.0" end params do - requires :key_id, type: Integer, desc: 'The ID of the GPG key' + requires :key_id, type: Integer, desc: "The ID of the GPG key" end # rubocop: disable CodeReuse/ActiveRecord - post 'gpg_keys/:key_id/revoke' do + post "gpg_keys/:key_id/revoke" do key = current_user.gpg_keys.find_by(id: params[:key_id]) - not_found!('GPG Key') unless key + not_found!("GPG Key") unless key key.revoke status :accepted end # rubocop: enable CodeReuse/ActiveRecord - desc 'Delete a GPG key from the currently authenticated user' do - detail 'This feature was added in GitLab 10.0' + desc "Delete a GPG key from the currently authenticated user" do + detail "This feature was added in GitLab 10.0" end params do - requires :key_id, type: Integer, desc: 'The ID of the SSH key' + requires :key_id, type: Integer, desc: "The ID of the SSH key" end # rubocop: disable CodeReuse/ActiveRecord - delete 'gpg_keys/:key_id' do + delete "gpg_keys/:key_id" do key = current_user.gpg_keys.find_by(id: params[:key_id]) - not_found!('GPG Key') unless key + not_found!("GPG Key") unless key status 204 key.destroy @@ -742,26 +742,26 @@ module API present paginate(current_user.emails), with: Entities::Email end - desc 'Get a single email address owned by the currently authenticated user' do + desc "Get a single email address owned by the currently authenticated user" do success Entities::Email end params do - requires :email_id, type: Integer, desc: 'The ID of the email' + requires :email_id, type: Integer, desc: "The ID of the email" end # rubocop: disable CodeReuse/ActiveRecord get "emails/:email_id" do email = current_user.emails.find_by(id: params[:email_id]) - not_found!('Email') unless email + not_found!("Email") unless email present email, with: Entities::Email end # rubocop: enable CodeReuse/ActiveRecord - desc 'Add new email address to the currently authenticated user' do + desc "Add new email address to the currently authenticated user" do success Entities::Email end params do - requires :email, type: String, desc: 'The new email' + requires :email, type: String, desc: "The new email" end post "emails" do email = Emails::CreateService.new(current_user, declared_params.merge(user: current_user)).execute @@ -773,14 +773,14 @@ module API end end - desc 'Delete an email address from the currently authenticated user' + desc "Delete an email address from the currently authenticated user" params do - requires :email_id, type: Integer, desc: 'The ID of the email' + requires :email_id, type: Integer, desc: "The ID of the email" end # rubocop: disable CodeReuse/ActiveRecord delete "emails/:email_id" do email = current_user.emails.find_by(id: params[:email_id]) - not_found!('Email') unless email + not_found!("Email") unless email destroy_conditionally!(email) do |email| Emails::DestroyService.new(current_user, user: current_user).execute(email) @@ -788,9 +788,9 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Get a list of user activities' + desc "Get a list of user activities" params do - optional :from, type: DateTime, default: 6.months.ago, desc: 'Date string in the format YEAR-MONTH-DAY' + optional :from, type: DateTime, default: 6.months.ago, desc: "Date string in the format YEAR-MONTH-DAY" use :pagination end # rubocop: disable CodeReuse/ActiveRecord @@ -805,7 +805,7 @@ module API end # rubocop: enable CodeReuse/ActiveRecord - desc 'Set the status of the current user' do + desc "Set the status of the current user" do success Entities::UserStatus end params do @@ -822,10 +822,10 @@ module API end end - desc 'get the status of the current user' do + desc "get the status of the current user" do success Entities::UserStatus end - get 'status' do + get "status" do present current_user.status || {}, with: Entities::UserStatus end end |