users.rb 12.4 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 65 66 67
      # Example Request:
      #   POST /users
      post do
        authenticated_as_admin!
68
        required_attributes! [:email, :password, :name, :username]
69
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :bio, :can_create_group, :admin, :confirm]
70
        admin = attrs.delete(:admin)
71
        confirm = !(attrs.delete(:confirm) =~ (/(false|f|no|0)$/i))
72 73
        user = User.build_user(attrs)
        user.admin = admin unless admin.nil?
M
Matthew Monaco 已提交
74
        user.skip_confirmation! unless confirm
75 76 77 78 79 80

        identity_attrs = attributes_for_keys [:provider, :extern_uid]
        if identity_attrs.any?
          user.identities.build(identity_attrs)
        end

81
        if user.save
82
          present user, with: Entities::UserFull
83
        else
J
jubianchi 已提交
84 85 86 87 88 89 90 91 92
          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)
93 94
        end
      end
95 96 97 98 99 100 101 102 103 104

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

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

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

        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

130 131 132 133 134 135 136 137 138 139 140
        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

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

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

A
Angus MacArthur 已提交
160 161 162 163 164 165
        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 已提交
166
          render_validation_error!(key)
A
Angus MacArthur 已提交
167 168 169
        end
      end

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

        present user.keys, with: Entities::SSHKey
182 183 184 185 186 187 188 189 190 191 192 193 194
      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 已提交
195 196 197 198 199 200 201
        not_found!('User') unless user

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

205 206 207
      # Add email to a specified user. Only available to admin users.
      #
      # Parameters:
D
Douwe Maan 已提交
208 209
      #   id (required) - The ID of a user
      #   email (required) - Email address
210
      # Example Request:
D
Douwe Maan 已提交
211
      #   POST /users/:id/emails
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
      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 已提交
230
      #   uid (required) - The ID of a user
231
      # Example Request:
D
Douwe Maan 已提交
232
      #   GET /users/:uid/emails
233 234 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
      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

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

        if user
273
          DeleteUserService.new(current_user).execute(user)
274
        else
J
jubianchi 已提交
275
          not_found!('User')
276 277
        end
      end
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307

      # 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])

        if user
          user.block
        else
          not_found!('User')
        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])

        if user
          user.activate
        else
          not_found!('User')
        end
      end
N
Nihad Abbasov 已提交
308 309
    end

310 311 312 313 314 315
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
316
        present @current_user, with: Entities::UserLogin
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
      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
344
        required_attributes! [:title, :key]
345

346 347 348 349 350
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
J
jubianchi 已提交
351
          render_validation_error!(key)
352 353 354
        end
      end

355
      # Delete existing ssh key of currently authenticated user
356 357 358 359 360 361
      #
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /user/keys/:id
      delete "keys/:id" do
362 363
        begin
          key = current_user.keys.find params[:id]
364
          key.destroy
365 366
        rescue
        end
367
      end
368 369 370 371 372 373 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

      # 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 已提交
420 421 422
    end
  end
end