BigW Consortium Gitlab

users.rb 2.76 KB
Newer Older
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
Nihad Abbasov committed
12
        @users = paginate User
13
        present @users, with: Entities::User
14 15 16 17 18 19 20 21 22 23
      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])
24
        present @user, with: Entities::User
25
      end
26

27 28 29 30 31
      # Create user. Available only for admin
      #
      # Parameters:
      #   email (required)                  - Email
      #   password (required)               - Password
32
      #   name                              - Name
33
      #   skype                             - Skype ID
Valeriy Sizov committed
34
      #   linkedin                          - Linkedin
35
      #   twitter                           - Twitter account
36
      #   projects_limit                    - Number of projects user can create
37 38 39 40
      # Example Request:
      #   POST /users
      post do
        authenticated_as_admin!
41
        attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username]
42
        user = User.new attrs, as: :admin
43 44 45 46 47 48
        if user.save
          present user, with: Entities::User
        else
          not_found!
        end
      end
49 50
    end

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
    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
        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

      # Delete existed ssh key of currently authenticated user
      #
      # Parameters:
      #   id (required) - SSH Key ID
      # Example Request:
      #   DELETE /user/keys/:id
      delete "keys/:id" do
        key = current_user.keys.find params[:id]
        key.delete
      end
104 105


106 107 108
    end
  end
end