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

    resource :users do
      # Get a users list
      #
      # Example Request:
      #  GET /users
      get do
12
        @users = User.scoped
13
        @users = @users.active if params[:active].present?
14
        @users = @users.search(params[:search]) if params[:search].present?
15
        @users = paginate @users
16
        present @users, with: Entities::User
N
Nihad Abbasov 已提交
17 18 19 20 21 22 23 24 25 26
      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])
27
        present @user, with: Entities::User
N
Nihad Abbasov 已提交
28
      end
29

30 31 32 33 34
      # Create user. Available only for admin
      #
      # Parameters:
      #   email (required)                  - Email
      #   password (required)               - Password
35
      #   name                              - Name
36
      #   skype                             - Skype ID
V
Valeriy Sizov 已提交
37
      #   linkedin                          - Linkedin
38
      #   twitter                           - Twitter account
39
      #   projects_limit                    - Number of projects user can create
40 41 42
      #   extern_uid                        - External authentication provider UID
      #   provider                          - External provider
      #   bio                               - Bio
43 44 45 46
      # Example Request:
      #   POST /users
      post do
        authenticated_as_admin!
47
        required_attributes! [:email, :password, :name, :username]
48

49
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :extern_uid, :provider, :bio]
50
        user = User.new attrs, as: :admin
51 52 53 54 55 56
        if user.save
          present user, with: Entities::User
        else
          not_found!
        end
      end
57 58 59 60 61 62 63 64 65 66

      # Update user. Available only for admin
      #
      # Parameters:
      #   email                             - Email
      #   name                              - Name
      #   password                          - Password
      #   skype                             - Skype ID
      #   linkedin                          - Linkedin
      #   twitter                           - Twitter account
K
Kevin Lyda 已提交
67
      #   projects_limit                    - Limit projects each user can create
68 69 70 71 72 73 74
      #   extern_uid                        - External authentication provider UID
      #   provider                          - External provider
      #   bio                               - Bio
      # Example Request:
      #   PUT /users/:id
      put ":id" do
        authenticated_as_admin!
75

76
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :extern_uid, :provider, :bio]
77 78
        user = User.find(params[:id])
        not_found!("User not found") unless user
79

80
        if user.update_attributes(attrs)
81 82 83 84 85 86
          present user, with: Entities::User
        else
          not_found!
        end
      end

A
Angus MacArthur 已提交
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
      # 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!
        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
          not_found!
        end
      end

107 108 109 110 111 112 113 114 115 116 117 118 119 120
      # Delete user. Available only for admin
      #
      # Example Request:
      #   DELETE /users/:id
      delete ":id" do
        authenticated_as_admin!
        user = User.find_by_id(params[:id])

        if user
          user.destroy
        else
          not_found!
        end
      end
N
Nihad Abbasov 已提交
121 122
    end

123 124 125 126 127 128
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
129
        present @current_user, with: Entities::UserLogin
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
      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
157
        required_attributes! [:title, :key]
158

159 160 161 162 163 164 165 166 167
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
          not_found!
        end
      end

168
      # Delete existing ssh key of currently authenticated user
169 170 171 172 173 174
      #
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /user/keys/:id
      delete "keys/:id" do
175 176 177 178 179
        begin
          key = current_user.keys.find params[:id]
          key.delete
        rescue
        end
180
      end
N
Nihad Abbasov 已提交
181 182 183
    end
  end
end