Skip to content
Snippets Groups Projects
projects.rb 10.3 KiB
Newer Older
  • Learn to ignore specific revisions
  •   # Projects API
      class Projects < Grape::API
        before { authenticate! }
    
        resource :projects do
    
            def map_public_to_visibility_level(attrs)
              publik = attrs.delete(:public)
    
              attrs[:visibility_level] = Gitlab::VisibilityLevel::PUBLIC if !attrs[:visibility_level].present? && publik == true
              attrs
            end
    
          # Get a projects list for authenticated user
          #
          # Example Request:
          #   GET /projects
          get do
    
            @projects = current_user.authorized_projects
    
            sort = params[:sort] == 'desc' ? 'desc' : 'asc'
    
    
            @projects = case params["order_by"]
    
                        when 'id' then @projects.reorder("id #{sort}")
                        when 'name' then @projects.reorder("name #{sort}")
                        when 'created_at' then @projects.reorder("created_at #{sort}")
                        when 'last_activity_at' then @projects.reorder("last_activity_at #{sort}")
                        else @projects
    
            # If the archived parameter is passed, limit results accordingly
            if params[:archived].present?
    
              @projects = @projects.where(archived: parse_boolean(params[:archived]))
    
            if params[:search].present?
              @projects = @projects.search(params[:search])
            end
    
    
            @projects = paginate @projects
    
            present @projects, with: Entities::Project
    
          # Get an owned projects list for authenticated user
          #
          # Example Request:
          #   GET /projects/owned
          get '/owned' do
    
            sort = params[:sort] == 'desc' ? 'desc' : 'asc'
    
            @projects = current_user.owned_projects
            @projects = case params["order_by"]
    
                        when 'id' then @projects.reorder("id #{sort}")
                        when 'name' then @projects.reorder("name #{sort}")
                        when 'created_at' then @projects.reorder("created_at #{sort}")
                        when 'last_activity_at' then @projects.reorder("last_activity_at #{sort}")
                        else @projects
    
                        end
    
            @projects = paginate @projects
    
          # Get all projects for admin user
          #
          # Example Request:
          #   GET /projects/all
          get '/all' do
            authenticated_as_admin!
    
            sort = params[:sort] == 'desc' ? 'desc' : 'asc'
    
    
            @projects = case params["order_by"]
    
                        when 'id' then Project.order("id #{sort}")
                        when 'name' then Project.order("name #{sort}")
                        when 'created_at' then Project.order("created_at #{sort}")
                        when 'last_activity_at' then Project.order("last_activity_at #{sort}")
                        else Project
    
                        end
    
            @projects = paginate @projects
    
            present @projects, with: Entities::Project
          end
    
    
          # Get a single project
          #
          # Parameters:
    
          #   id (required) - The ID of a project
    
          # Example Request:
          #   GET /projects/:id
          get ":id" do
    
            present user_project, with: Entities::ProjectWithAccess, user: current_user
    
    Dmitriy Zaporozhets's avatar
    Dmitriy Zaporozhets committed
          # Get a single project events
          #
          # Parameters:
          #   id (required) - The ID of a project
          # Example Request:
    
          #   GET /projects/:id/events
    
    Dmitriy Zaporozhets's avatar
    Dmitriy Zaporozhets committed
          get ":id/events" do
            limit = (params[:per_page] || 20).to_i
            offset = (params[:page] || 0).to_i * limit
            events = user_project.events.recent.limit(limit).offset(offset)
    
            present events, with: Entities::Event
          end
    
    
          # Create new project
          #
          # Parameters:
          #   name (required) - name for new project
    
          #   description (optional) - short project description
    
          #   issues_enabled (optional)
          #   merge_requests_enabled (optional)
          #   wiki_enabled (optional)
    
          #   snippets_enabled (optional)
    
          #   namespace_id (optional) - defaults to user namespace
    
          #   public (optional) - if true same as setting visibility_level = 20
          #   visibility_level (optional) - 0 by default
    
          # Example Request
          #   POST /projects
          post do
    
                                         :path,
                                         :description,
                                         :issues_enabled,
                                         :merge_requests_enabled,
                                         :wiki_enabled,
                                         :snippets_enabled,
                                         :namespace_id,
    
                                         :visibility_level,
                                         :import_url]
    
            attrs = map_public_to_visibility_level(attrs)
    
            @project = ::Projects::CreateService.new(current_user, attrs).execute
    
            if @project.saved?
              present @project, with: Entities::Project
            else
    
              if @project.errors[:limit_reached].present?
                error!(@project.errors[:limit_reached], 403)
              end
    
              render_validation_error!(@project)
    
    Angus MacArthur's avatar
    Angus MacArthur committed
          # Create new project for a specified user.  Only available to admin users.
          #
          # Parameters:
          #   user_id (required) - The ID of a user
          #   name (required) - name for new project
          #   description (optional) - short project description
          #   default_branch (optional) - 'master' by default
    
          #   issues_enabled (optional)
          #   merge_requests_enabled (optional)
    
          #   wiki_enabled (optional)
          #   snippets_enabled (optional)
    
          #   public (optional) - if true same as setting visibility_level = 20
          #   visibility_level (optional)
    
    Angus MacArthur's avatar
    Angus MacArthur committed
          # Example Request
          #   POST /projects/user/:user_id
          post "user/:user_id" do
            authenticated_as_admin!
            user = User.find(params[:user_id])
            attrs = attributes_for_keys [:name,
    
                                         :description,
                                         :default_branch,
                                         :issues_enabled,
                                         :merge_requests_enabled,
                                         :wiki_enabled,
                                         :snippets_enabled,
    
            attrs = map_public_to_visibility_level(attrs)
    
            @project = ::Projects::CreateService.new(user, attrs).execute
    
    Angus MacArthur's avatar
    Angus MacArthur committed
            if @project.saved?
              present @project, with: Entities::Project
            else
    
              render_validation_error!(@project)
    
          # Fork new project for the current user.
          #
          # Parameters:
          #   id (required) - The ID of a project
          # Example Request
          #   POST /projects/fork/:id
          post 'fork/:id' do
            @forked_project =
              ::Projects::ForkService.new(user_project,
                                          current_user).execute
            if @forked_project.errors.any?
              conflict!(@forked_project.errors.messages)
            else
              present @forked_project, with: Entities::Project
            end
          end
    
    
          # Remove project
          #
          # Parameters:
          #   id (required) - The ID of a project
          # Example Request:
          #   DELETE /projects/:id
          delete ":id" do
            authorize! :remove_project, user_project
    
    Vinnie Okada's avatar
    Vinnie Okada committed
            ::Projects::DestroyService.new(user_project, current_user, {}).execute
    
          # Mark this project as forked from another
          #
          # Parameters:
          #   id: (required) - The ID of the project being marked as a fork
          #   forked_from_id: (required) - The ID of the project it was forked from
          # Example Request:
          #   POST /projects/:id/fork/:forked_from_id
          post ":id/fork/:forked_from_id" do
            authenticated_as_admin!
            forked_from_project = find_project(params[:forked_from_id])
            unless forked_from_project.nil?
              if user_project.forked_from_project.nil?
                user_project.create_forked_project_link(forked_to_project_id: user_project.id, forked_from_project_id: forked_from_project.id)
              else
                render_api_error!("Project already forked", 409)
              end
            else
    
              not_found!("Source Project")
    
            end
    
          end
    
          # Remove a forked_from relationship
          #
          # Parameters:
          # id: (required) - The ID of the project being marked as a fork
          # Example Request:
          #  DELETE /projects/:id/fork
          delete ":id/fork" do
            authenticated_as_admin!
            unless user_project.forked_project_link.nil?
              user_project.forked_project_link.destroy
            end
          end
    
          # search for projects current_user has access to
          #
          # Parameters:
          #   query (required) - A string contained in the project name
    
          #   per_page (optional) - number of projects to return per page
          #   page (optional) - the page to retrieve
    
          # Example Request:
          #   GET /projects/search/:query
          get "/search/:query" do
            ids = current_user.authorized_projects.map(&:id)
    
            visibility_levels = [ Gitlab::VisibilityLevel::INTERNAL, Gitlab::VisibilityLevel::PUBLIC ]
            projects = Project.where("(id in (?) OR visibility_level in (?)) AND (name LIKE (?))", ids, visibility_levels, "%#{params[:query]}%")
    
            sort = params[:sort] == 'desc' ? 'desc' : 'asc'
    
    
            projects = case params["order_by"]
    
                       when 'id' then projects.order("id #{sort}")
                       when 'name' then projects.order("name #{sort}")
                       when 'created_at' then projects.order("created_at #{sort}")
                       when 'last_activity_at' then projects.order("last_activity_at #{sort}")
                       else projects
    
            present paginate(projects), with: Entities::Project
    
    
    
          # Get a users list
          #
          # Example Request:
          #  GET /users
          get ':id/users' do
            @users = User.where(id: user_project.team.users.map(&:id))
            @users = @users.search(params[:search]) if params[:search].present?
            @users = paginate @users
    
            present @users, with: Entities::UserBasic