users.rb 5.2 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 13
        @users = User.scoped
        @users = @users.search(params[:search]) if params[:search].present?
14
        present @users, with: Entities::User
N
Nihad Abbasov 已提交
15 16 17 18 19 20 21 22 23 24
      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])
25
        present @user, with: Entities::User
N
Nihad Abbasov 已提交
26
      end
27

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

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

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

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

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

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

105 106 107 108 109 110 111 112 113 114 115 116 117 118
      # 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 已提交
119 120
    end

121 122 123 124 125 126 127 128 129 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
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
        present @current_user, with: Entities::User
      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
155
        required_attributes! [:title, :key]
156

157 158 159 160 161 162 163 164 165
        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

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