users.rb 8.1 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]
M
Matthew Monaco 已提交
63
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :extern_uid, :provider, :bio, :can_create_group, :confirm, :admin]
64
        user = User.build_user(attrs)
65 66
        admin = attrs.delete(:admin)
        user.admin = admin unless admin.nil?
M
Matthew Monaco 已提交
67 68
        confirm = ! (attrs.delete(:confirm) =~ (/(false|f|no|0)$/i))
        user.skip_confirmation! unless confirm
69
        if user.save
70
          present user, with: Entities::UserFull
71
        else
J
jubianchi 已提交
72 73 74 75 76 77 78 79 80
          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)
81 82
        end
      end
83 84 85 86 87 88 89 90 91 92

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

J
Jerome Dalbert 已提交
105
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :website_url, :projects_limit, :username, :extern_uid, :provider, :bio, :can_create_group, :admin]
106
        user = User.find(params[:id])
J
jubianchi 已提交
107
        not_found!('User') unless user
108

109 110
        admin = attrs.delete(:admin)
        user.admin = admin unless admin.nil?
J
jubianchi 已提交
111 112 113 114 115 116 117 118 119

        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

120
        if user.update_attributes(attrs)
121
          present user, with: Entities::UserFull
122
        else
J
jubianchi 已提交
123
          render_validation_error!(user)
124 125 126
        end
      end

A
Angus MacArthur 已提交
127 128 129 130 131 132 133 134 135 136
      # 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 已提交
137 138
        required_attributes! [:title, :key]

A
Angus MacArthur 已提交
139 140 141 142 143 144
        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 已提交
145
          render_validation_error!(key)
A
Angus MacArthur 已提交
146 147 148
        end
      end

149 150 151 152 153 154 155 156 157
      # 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 已提交
158 159 160
        not_found!('User') unless user

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

        begin
          key = user.keys.find params[:id]
          key.destroy
        rescue ActiveRecord::RecordNotFound
          not_found!('Key')
181 182 183
        end
      end

184 185 186 187 188 189
      # Delete user. Available only for admin
      #
      # Example Request:
      #   DELETE /users/:id
      delete ":id" do
        authenticated_as_admin!
S
skv 已提交
190
        user = User.find_by(id: params[:id])
191 192 193 194

        if user
          user.destroy
        else
J
jubianchi 已提交
195
          not_found!('User')
196 197
        end
      end
N
Nihad Abbasov 已提交
198 199
    end

200 201 202 203 204 205
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
206
        present @current_user, with: Entities::UserLogin
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
      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
234
        required_attributes! [:title, :key]
235

236 237 238 239 240
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
J
jubianchi 已提交
241
          render_validation_error!(key)
242 243 244
        end
      end

245
      # Delete existing ssh key of currently authenticated user
246 247 248 249 250 251
      #
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /user/keys/:id
      delete "keys/:id" do
252 253
        begin
          key = current_user.keys.find params[:id]
254
          key.destroy
255 256
        rescue
        end
257
      end
N
Nihad Abbasov 已提交
258 259 260
    end
  end
end