users.rb 11.8 KB
Newer Older
1
module API
N
Nihad Abbasov 已提交
2 3 4 5 6 7 8 9 10 11
  # Users API
  class Users < Grape::API
    before { authenticate! }

    resource :users do
      # Get a users list
      #
      # Example Request:
      #  GET /users
      get do
S
skv 已提交
12
        @users = User.all
13
        @users = @users.active if params[:active].present?
14
        @users = @users.search(params[:search]) if params[:search].present?
15
        @users = paginate @users
16 17 18 19 20 21

        if current_user.is_admin?
          present @users, with: Entities::UserFull
        else
          present @users, with: Entities::UserBasic
        end
N
Nihad Abbasov 已提交
22 23 24 25 26 27 28 29 30 31
      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])
32 33 34 35 36 37

        if current_user.is_admin?
          present @user, with: Entities::UserFull
        else
          present @user, with: Entities::UserBasic
        end
N
Nihad Abbasov 已提交
38
      end
39

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

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

75
        if user.save
76
          present user, with: Entities::UserFull
77
        else
J
jubianchi 已提交
78 79 80 81 82 83 84 85 86
          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)
87 88
        end
      end
89 90 91 92 93 94 95 96 97 98

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

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

113 114
        admin = attrs.delete(:admin)
        user.admin = admin unless admin.nil?
J
jubianchi 已提交
115 116 117 118 119 120 121 122 123

        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

124
        if user.update_attributes(attrs)
125
          present user, with: Entities::UserFull
126
        else
J
jubianchi 已提交
127
          render_validation_error!(user)
128 129 130
        end
      end

A
Angus MacArthur 已提交
131 132 133 134 135 136 137 138 139 140
      # Add ssh key to a specified user. Only available to admin users.
      #
      # Parameters:
      # id (required) - The ID of a user
      # key (required) - New SSH Key
      # title (required) - New SSH Key's title
      # Example Request:
      # POST /users/:id/keys
      post ":id/keys" do
        authenticated_as_admin!
J
jubianchi 已提交
141 142
        required_attributes! [:title, :key]

A
Angus MacArthur 已提交
143 144 145 146 147 148
        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 已提交
149
          render_validation_error!(key)
A
Angus MacArthur 已提交
150 151 152
        end
      end

153 154 155 156 157 158 159 160 161
      # Get ssh keys of a specified user. Only available to admin users.
      #
      # Parameters:
      # uid (required) - The ID of a user
      # Example Request:
      # GET /users/:uid/keys
      get ':uid/keys' do
        authenticated_as_admin!
        user = User.find_by(id: params[:uid])
J
jubianchi 已提交
162 163 164
        not_found!('User') unless user

        present user.keys, with: Entities::SSHKey
165 166 167 168 169 170 171 172 173 174 175 176 177
      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 已提交
178 179 180 181 182 183 184
        not_found!('User') unless user

        begin
          key = user.keys.find params[:id]
          key.destroy
        rescue ActiveRecord::RecordNotFound
          not_found!('Key')
185 186 187
        end
      end

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
      # Add email to a specified user. Only available to admin users.
      #
      # Parameters:
      # id (required) - The ID of a user
      # email (required) - Email address
      # Example Request:
      # POST /users/:id/emails
      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:
      # uid (required) - The ID of a user
      # Example Request:
      # GET /users/:uid/emails
      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

247 248 249 250 251 252
      # Delete user. Available only for admin
      #
      # Example Request:
      #   DELETE /users/:id
      delete ":id" do
        authenticated_as_admin!
S
skv 已提交
253
        user = User.find_by(id: params[:id])
254 255

        if user
256
          DeleteUserService.new(current_user).execute(user)
257
        else
J
jubianchi 已提交
258
          not_found!('User')
259 260
        end
      end
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

      # 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 已提交
291 292
    end

293 294 295 296 297 298
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
299
        present @current_user, with: Entities::UserLogin
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
      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
327
        required_attributes! [:title, :key]
328

329 330 331 332 333
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
J
jubianchi 已提交
334
          render_validation_error!(key)
335 336 337
        end
      end

338
      # Delete existing ssh key of currently authenticated user
339 340 341 342 343 344
      #
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /user/keys/:id
      delete "keys/:id" do
345 346
        begin
          key = current_user.keys.find params[:id]
347
          key.destroy
348 349
        rescue
        end
350
      end
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 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

      # 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 已提交
403 404 405
    end
  end
end