Skip to content
Snippets Groups Projects
users.rb 7.01 KiB
Newer Older
  • Learn to ignore specific revisions
  •   # 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
            @users = User.all
    
            @users = @users.active if params[:active].present?
    
            @users = @users.search(params[:search]) if params[:search].present?
    
            @users = paginate @users
    
            present @users, with: Entities::User
    
          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])
    
            present @user, with: Entities::User
    
          # Create user. Available only for admin
          #
          # Parameters:
          #   email (required)                  - Email
          #   password (required)               - Password
    
          #   skype                             - Skype ID
    
    Valeriy Sizov's avatar
    Valeriy Sizov committed
          #   linkedin                          - Linkedin
    
          #   twitter                           - Twitter account
    
    Jerome Dalbert's avatar
    Jerome Dalbert committed
          #   website_url                       - Website url
    
          #   projects_limit                    - Number of projects user can create
    
          #   extern_uid                        - External authentication provider UID
          #   provider                          - External provider
          #   bio                               - Bio
    
          #   admin                             - User is admin - true or false (default)
          #   can_create_group                  - User can create groups - true or false
    
          # Example Request:
          #   POST /users
          post do
            authenticated_as_admin!
    
            required_attributes! [:email, :password, :name, :username]
    
            attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :projects_limit, :username, :extern_uid, :provider, :bio, :can_create_group, :admin]
    
            user = User.build_user(attrs, as: :admin)
    
            admin = attrs.delete(:admin)
            user.admin = admin unless admin.nil?
    
            if user.save
              present user, with: Entities::User
            else
              not_found!
            end
          end
    
    
          # 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
          #   website_url                       - Website url
    
    Kevin Lyda's avatar
    Kevin Lyda committed
          #   projects_limit                    - Limit projects each user can create
    
          #   extern_uid                        - External authentication provider UID
          #   provider                          - External provider
          #   bio                               - Bio
    
          #   admin                             - User is admin - true or false (default)
          #   can_create_group                  - User can create groups - true or false
    
          # Example Request:
          #   PUT /users/:id
          put ":id" do
            authenticated_as_admin!
    
    Jerome Dalbert's avatar
    Jerome Dalbert committed
            attrs = attributes_for_keys [:email, :name, :password, :skype, :linkedin, :twitter, :website_url, :projects_limit, :username, :extern_uid, :provider, :bio, :can_create_group, :admin]
    
            user = User.find(params[:id])
            not_found!("User not found") unless user
    
            admin = attrs.delete(:admin)
            user.admin = admin unless admin.nil?
            if user.update_attributes(attrs, as: :admin)
    
              present user, with: Entities::User
            else
              not_found!
            end
          end
    
    
    Angus MacArthur's avatar
    Angus MacArthur committed
          # 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
    
    
          # 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])
            if user
              present user.keys, with: Entities::SSHKey
            else
              not_found!
            end
          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])
            if user
              begin
                key = user.keys.find params[:id]
                key.destroy
              rescue ActiveRecord::RecordNotFound
                not_found!
              end
            else
              not_found!
            end
          end
    
    
          # Delete user. Available only for admin
          #
          # Example Request:
          #   DELETE /users/:id
          delete ":id" do
            authenticated_as_admin!
    
    skv's avatar
    skv committed
            user = User.find_by(id: params[:id])
    
        resource :user do
          # Get currently authenticated user
          #
          # Example Request:
          #   GET /user
          get do
    
            present @current_user, with: Entities::UserLogin
    
          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 existing ssh key of currently authenticated user
    
          #
          # Parameters:
          #   id (required) - SSH Key ID
          # Example Request:
          #   DELETE /user/keys/:id
          delete "keys/:id" do
    
            begin
              key = current_user.keys.find params[:id]