users.rb 7.93 KB
Newer Older
1
module API
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
skv's avatar
skv committed
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
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
38
      end
39

40 41 42 43 44
      # Create user. Available only for admin
      #
      # Parameters:
      #   email (required)                  - Email
      #   password (required)               - Password
45 46
      #   name (required)                   - Name
      #   username (required)               - Name
47
      #   skype                             - Skype ID
Valeriy Sizov's avatar
Valeriy Sizov committed
48
      #   linkedin                          - Linkedin
49
      #   twitter                           - Twitter account
Jerome Dalbert's avatar
Jerome Dalbert committed
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
57 58 59 60
      # Example Request:
      #   POST /users
      post do
        authenticated_as_admin!
61
        required_attributes! [:email, :password, :name, :username]
62
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :extern_uid, :provider, :bio, :can_create_group, :admin]
63
        user = User.build_user(attrs)
64 65
        admin = attrs.delete(:admin)
        user.admin = admin unless admin.nil?
66
        if user.save
67
          present user, with: Entities::UserFull
68
        else
69 70 71 72 73 74 75 76 77
          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)
78 79
        end
      end
80 81 82 83 84 85 86 87 88 89

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

Jerome Dalbert's avatar
Jerome Dalbert committed
102
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :website_url, :projects_limit, :username, :extern_uid, :provider, :bio, :can_create_group, :admin]
103
        user = User.find(params[:id])
104
        not_found!('User') unless user
105

106 107
        admin = attrs.delete(:admin)
        user.admin = admin unless admin.nil?
108 109 110 111 112 113 114 115 116

        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

117
        if user.update_attributes(attrs)
118
          present user, with: Entities::UserFull
119
        else
120
          render_validation_error!(user)
121 122 123
        end
      end

Angus MacArthur's avatar
Angus MacArthur committed
124 125 126 127 128 129 130 131 132 133
      # 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!
134 135
        required_attributes! [:title, :key]

Angus MacArthur's avatar
Angus MacArthur committed
136 137 138 139 140 141
        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
142
          render_validation_error!(key)
Angus MacArthur's avatar
Angus MacArthur committed
143 144 145
        end
      end

146 147 148 149 150 151 152 153 154
      # 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])
155 156 157
        not_found!('User') unless user

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

        begin
          key = user.keys.find params[:id]
          key.destroy
        rescue ActiveRecord::RecordNotFound
          not_found!('Key')
178 179 180
        end
      end

181 182 183 184 185 186
      # Delete user. Available only for admin
      #
      # Example Request:
      #   DELETE /users/:id
      delete ":id" do
        authenticated_as_admin!
skv's avatar
skv committed
187
        user = User.find_by(id: params[:id])
188 189 190 191

        if user
          user.destroy
        else
192
          not_found!('User')
193 194
        end
      end
195 196
    end

197 198 199 200 201 202
    resource :user do
      # Get currently authenticated user
      #
      # Example Request:
      #   GET /user
      get do
203
        present @current_user, with: Entities::UserLogin
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
      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
231
        required_attributes! [:title, :key]
232

233 234 235 236 237
        attrs = attributes_for_keys [:title, :key]
        key = current_user.keys.new attrs
        if key.save
          present key, with: Entities::SSHKey
        else
238
          render_validation_error!(key)
239 240 241
        end
      end

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