users.rb 12.8 KB
Newer Older
1
module API
N
Nihad Abbasov 已提交
2 3 4 5
  # Users API
  class Users < Grape::API
    before { authenticate! }

6
    resource :users, requirements: { uid: /[0-9]*/, id: /[0-9]*/ } do
N
Nihad Abbasov 已提交
7 8 9 10
      # Get a users list
      #
      # Example Request:
      #  GET /users
11 12
      #  GET /users?search=Admin
      #  GET /users?username=root
N
Nihad Abbasov 已提交
13
      get do
14 15 16 17 18 19 20 21
        if params[:username].present?
          @users = User.where(username: params[:username])
        else
          @users = User.all
          @users = @users.active if params[:active].present?
          @users = @users.search(params[:search]) if params[:search].present?
          @users = paginate @users
        end
22 23 24 25 26 27

        if current_user.is_admin?
          present @users, with: Entities::UserFull
        else
          present @users, with: Entities::UserBasic
        end
N
Nihad Abbasov 已提交
28 29 30 31 32 33 34 35 36 37
      end

      # Get a single user
      #
      # Parameters:
      #   id (required) - The ID of a user
      # Example Request:
      #   GET /users/:id
      get ":id" do
        @user = User.find(params[:id])
38 39 40 41

        if current_user.is_admin?
          present @user, with: Entities::UserFull
        else
42
          present @user, with: Entities::User
43
        end
N
Nihad Abbasov 已提交
44
      end
45

46 47 48 49 50
      # Create user. Available only for admin
      #
      # Parameters:
      #   email (required)                  - Email
      #   password (required)               - Password
J
jubianchi 已提交
51 52
      #   name (required)                   - Name
      #   username (required)               - Name
53
      #   skype                             - Skype ID
V
Valeriy Sizov 已提交
54
      #   linkedin                          - Linkedin
55
      #   twitter                           - Twitter account
J
Jerome Dalbert 已提交
56
      #   website_url                       - Website url
57
      #   projects_limit                    - Number of projects user can create
58 59 60
      #   extern_uid                        - External authentication provider UID
      #   provider                          - External provider
      #   bio                               - Bio
61 62
      #   admin                             - User is admin - true or false (default)
      #   can_create_group                  - User can create groups - true or false
M
Matthew Monaco 已提交
63
      #   confirm                           - Require user confirmation - true (default) or false
64
      #   external                          - Flags the user as external - true or false(default)
65 66 67 68
      # Example Request:
      #   POST /users
      post do
        authenticated_as_admin!
69
        required_attributes! [:email, :password, :name, :username]
Z
Zeger-Jan van de Weg 已提交
70
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :bio, :can_create_group, :admin, :confirm, :external]
71
        admin = attrs.delete(:admin)
72
        confirm = !(attrs.delete(:confirm) =~ (/(false|f|no|0)$/i))
73 74
        user = User.build_user(attrs)
        user.admin = admin unless admin.nil?
M
Matthew Monaco 已提交
75
        user.skip_confirmation! unless confirm
76
        identity_attrs = attributes_for_keys [:provider, :extern_uid]
Z
Zeger-Jan van de Weg 已提交
77

78 79 80 81
        if identity_attrs.any?
          user.identities.build(identity_attrs)
        end

82
        if user.save
83
          present user, with: Entities::UserFull
84
        else
J
jubianchi 已提交
85 86 87 88 89 90 91 92 93
          conflict!('Email has already been taken') if User.
              where(email: user.email).
              count > 0

          conflict!('Username has already been taken') if User.
              where(username: user.username).
              count > 0

          render_validation_error!(user)
94 95
        end
      end
96 97 98 99 100 101 102 103 104 105

      # Update user. Available only for admin
      #
      # Parameters:
      #   email                             - Email
      #   name                              - Name
      #   password                          - Password
      #   skype                             - Skype ID
      #   linkedin                          - Linkedin
      #   twitter                           - Twitter account
J
Jerome Dalbert 已提交
106
      #   website_url                       - Website url
K
Kevin Lyda 已提交
107
      #   projects_limit                    - Limit projects each user can create
108
      #   bio                               - Bio
109 110
      #   admin                             - User is admin - true or false (default)
      #   can_create_group                  - User can create groups - true or false
111
      #   external                          - Flags the user as external - true or false(default)
112 113 114 115
      # Example Request:
      #   PUT /users/:id
      put ":id" do
        authenticated_as_admin!
116

117
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :website_url, :projects_limit, :username, :bio, :can_create_group, :admin, :external]
118
        user = User.find(params[:id])
J
jubianchi 已提交
119
        not_found!('User') unless user
120

121 122
        admin = attrs.delete(:admin)
        user.admin = admin unless admin.nil?
J
jubianchi 已提交
123 124 125 126 127 128 129 130 131

        conflict!('Email has already been taken') if attrs[:email] &&
            User.where(email: attrs[:email]).
                where.not(id: user.id).count > 0

        conflict!('Username has already been taken') if attrs[:username] &&
            User.where(username: attrs[:username]).
                where.not(id: user.id).count > 0

132 133 134 135 136 137 138 139 140 141 142
        identity_attrs = attributes_for_keys [:provider, :extern_uid]
        if identity_attrs.any?
          identity = user.identities.find_by(provider: identity_attrs[:provider])
          if identity
            identity.update_attributes(identity_attrs)
          else
            identity = user.identities.build(identity_attrs)
            identity.save
          end
        end

143
        if user.update_attributes(attrs)
144
          present user, with: Entities::UserFull
145
        else
J
jubianchi 已提交
146
          render_validation_error!(user)
147 148 149
        end
      end

A
Angus MacArthur 已提交
150 151 152
      # Add ssh key to a specified user. Only available to admin users.
      #
      # Parameters:
D
Douwe Maan 已提交
153 154 155
      #   id (required) - The ID of a user
      #   key (required) - New SSH Key
      #   title (required) - New SSH Key's title
A
Angus MacArthur 已提交
156
      # Example Request:
D
Douwe Maan 已提交
157
      #   POST /users/:id/keys
A
Angus MacArthur 已提交
158 159
      post ":id/keys" do
        authenticated_as_admin!
J
jubianchi 已提交
160 161
        required_attributes! [:title, :key]

A
Angus MacArthur 已提交
162 163 164 165 166 167
        user = User.find(params[:id])
        attrs = attributes_for_keys [:title, :key]
        key = user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
J
jubianchi 已提交
168
          render_validation_error!(key)
A
Angus MacArthur 已提交
169 170 171
        end
      end

172 173 174
      # Get ssh keys of a specified user. Only available to admin users.
      #
      # Parameters:
D
Douwe Maan 已提交
175
      #   uid (required) - The ID of a user
176
      # Example Request:
D
Douwe Maan 已提交
177
      #   GET /users/:uid/keys
178 179 180
      get ':uid/keys' do
        authenticated_as_admin!
        user = User.find_by(id: params[:uid])
J
jubianchi 已提交
181 182 183
        not_found!('User') unless user

        present user.keys, with: Entities::SSHKey
184 185 186 187 188 189 190 191 192 193 194 195 196
      end

      # Delete existing ssh key of a specified user. Only available to admin
      # users.
      #
      # Parameters:
      #   uid (required) - The ID of a user
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /users/:uid/keys/:id
      delete ':uid/keys/:id' do
        authenticated_as_admin!
        user = User.find_by(id: params[:uid])
J
jubianchi 已提交
197 198 199 200 201 202 203
        not_found!('User') unless user

        begin
          key = user.keys.find params[:id]
          key.destroy
        rescue ActiveRecord::RecordNotFound
          not_found!('Key')
204 205 206
        end
      end

207 208 209
      # Add email to a specified user. Only available to admin users.
      #
      # Parameters:
D
Douwe Maan 已提交
210 211
      #   id (required) - The ID of a user
      #   email (required) - Email address
212
      # Example Request:
D
Douwe Maan 已提交
213
      #   POST /users/:id/emails
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
      post ":id/emails" do
        authenticated_as_admin!
        required_attributes! [:email]

        user = User.find(params[:id])
        attrs = attributes_for_keys [:email]
        email = user.emails.new attrs
        if email.save
          NotificationService.new.new_email(email)
          present email, with: Entities::Email
        else
          render_validation_error!(email)
        end
      end

      # Get emails of a specified user. Only available to admin users.
      #
      # Parameters:
D
Douwe Maan 已提交
232
      #   uid (required) - The ID of a user
233
      # Example Request:
D
Douwe Maan 已提交
234
      #   GET /users/:uid/emails
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
      get ':uid/emails' do
        authenticated_as_admin!
        user = User.find_by(id: params[:uid])
        not_found!('User') unless user

        present user.emails, with: Entities::Email
      end

      # Delete existing email of a specified user. Only available to admin
      # users.
      #
      # Parameters:
      #   uid (required) - The ID of a user
      #   id (required) - Email ID
      # Example Request:
      #   DELETE /users/:uid/emails/:id
      delete ':uid/emails/:id' do
        authenticated_as_admin!
        user = User.find_by(id: params[:uid])
        not_found!('User') unless user

        begin
          email = user.emails.find params[:id]
          email.destroy

          user.update_secondary_emails!
        rescue ActiveRecord::RecordNotFound
          not_found!('Email')
        end
      end

266 267 268 269 270 271
      # Delete user. Available only for admin
      #
      # Example Request:
      #   DELETE /users/:id
      delete ":id" do
        authenticated_as_admin!
S
skv 已提交
272
        user = User.find_by(id: params[:id])
273 274

        if user
275
          DeleteUserService.new(current_user).execute(user)
276
        else
J
jubianchi 已提交
277
          not_found!('User')
278 279
        end
      end
280 281 282 283 284 285 286 287 288

      # Block user. Available only for admin
      #
      # Example Request:
      #   PUT /users/:id/block
      put ':id/block' do
        authenticated_as_admin!
        user = User.find_by(id: params[:id])

289 290 291
        if !user
          not_found!('User')
        elsif !user.ldap_blocked?
292 293
          user.block
        else
294
          forbidden!('LDAP blocked users cannot be modified by the API')
295 296 297 298 299 300 301 302 303 304 305
        end
      end

      # Unblock user. Available only for admin
      #
      # Example Request:
      #   PUT /users/:id/unblock
      put ':id/unblock' do
        authenticated_as_admin!
        user = User.find_by(id: params[:id])

306 307
        if !user
          not_found!('User')
G
Gabriel Mazetto 已提交
308
        elsif user.ldap_blocked?
309
          forbidden!('LDAP blocked users cannot be unblocked by the API')
G
Gabriel Mazetto 已提交
310 311
        else
          user.activate
312 313
        end
      end
N
Nihad Abbasov 已提交
314 315
    end

316 317 318 319 320 321
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
322
        present @current_user, with: Entities::UserLogin
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
      end

      # Get currently authenticated user's keys
      #
      # Example Request:
      #   GET /user/keys
      get "keys" do
        present current_user.keys, with: Entities::SSHKey
      end

      # Get single key owned by currently authenticated user
      #
      # Example Request:
      #   GET /user/keys/:id
      get "keys/:id" do
        key = current_user.keys.find params[:id]
        present key, with: Entities::SSHKey
      end

      # Add new ssh key to currently authenticated user
      #
      # Parameters:
      #   key (required) - New SSH Key
      #   title (required) - New SSH Key's title
      # Example Request:
      #   POST /user/keys
      post "keys" do
350
        required_attributes! [:title, :key]
351

352 353 354 355 356
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
J
jubianchi 已提交
357
          render_validation_error!(key)
358 359 360
        end
      end

361
      # Delete existing ssh key of currently authenticated user
362 363 364 365 366 367
      #
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /user/keys/:id
      delete "keys/:id" do
368 369
        begin
          key = current_user.keys.find params[:id]
370
          key.destroy
371 372
        rescue
        end
373
      end
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425

      # Get currently authenticated user's emails
      #
      # Example Request:
      #   GET /user/emails
      get "emails" do
        present current_user.emails, with: Entities::Email
      end

      # Get single email owned by currently authenticated user
      #
      # Example Request:
      #   GET /user/emails/:id
      get "emails/:id" do
        email = current_user.emails.find params[:id]
        present email, with: Entities::Email
      end

      # Add new email to currently authenticated user
      #
      # Parameters:
      #   email (required) - Email address
      # Example Request:
      #   POST /user/emails
      post "emails" do
        required_attributes! [:email]

        attrs = attributes_for_keys [:email]
        email = current_user.emails.new attrs
        if email.save
          NotificationService.new.new_email(email)
          present email, with: Entities::Email
        else
          render_validation_error!(email)
        end
      end

      # Delete existing email of currently authenticated user
      #
      # Parameters:
      #   id (required) - EMail ID
      # Example Request:
      #   DELETE /user/emails/:id
      delete "emails/:id" do
        begin
          email = current_user.emails.find params[:id]
          email.destroy

          current_user.update_secondary_emails!
        rescue
        end
      end
N
Nihad Abbasov 已提交
426 427 428
    end
  end
end