projects.rb 7.7 KB
Newer Older
1
module API
N
Nihad Abbasov 已提交
2 3 4 5 6
  # Projects API
  class Projects < Grape::API
    before { authenticate! }

    resource :projects do
7
      helpers do
8 9 10 11 12 13
        def map_public_to_visibility_level(attrs)
          publik = attrs.delete(:public)
          publik = [ true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON' ].include?(publik)
          attrs[:visibility_level] = Gitlab::VisibilityLevel::PUBLIC if !attrs[:visibility_level].present? && publik == true
          attrs
        end
14 15
      end

N
Nihad Abbasov 已提交
16 17 18 19 20
      # Get a projects list for authenticated user
      #
      # Example Request:
      #   GET /projects
      get do
21
        @projects = paginate current_user.authorized_projects
22
        present @projects, with: Entities::Project
N
Nihad Abbasov 已提交
23 24
      end

25 26 27 28 29 30 31 32 33
      # Get an owned projects list for authenticated user
      #
      # Example Request:
      #   GET /projects/owned
      get '/owned' do
        @projects = paginate current_user.owned_projects
        present @projects, with: Entities::Project
      end

34 35 36 37 38 39 40 41 42 43
      # Get all projects for admin user
      #
      # Example Request:
      #   GET /projects/all
      get '/all' do
        authenticated_as_admin!
        @projects = paginate Project
        present @projects, with: Entities::Project
      end

N
Nihad Abbasov 已提交
44 45 46
      # Get a single project
      #
      # Parameters:
47
      #   id (required) - The ID of a project
N
Nihad Abbasov 已提交
48 49 50
      # Example Request:
      #   GET /projects/:id
      get ":id" do
51
        present user_project, with: Entities::ProjectWithAccess, user: current_user
N
Nihad Abbasov 已提交
52 53
      end

D
Dmitriy Zaporozhets 已提交
54 55 56 57 58 59 60 61 62 63 64 65 66 67
      # Get a single project events
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   GET /projects/:id
      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

68 69 70 71
      # Create new project
      #
      # Parameters:
      #   name (required) - name for new project
72
      #   description (optional) - short project description
73 74 75
      #   issues_enabled (optional)
      #   merge_requests_enabled (optional)
      #   wiki_enabled (optional)
76
      #   snippets_enabled (optional)
77
      #   namespace_id (optional) - defaults to user namespace
78 79
      #   public (optional) - if true same as setting visibility_level = 20
      #   visibility_level (optional) - 0 by default
80 81 82
      # Example Request
      #   POST /projects
      post do
83
        required_attributes! [:name]
84
        attrs = attributes_for_keys [:name,
85 86 87 88 89 90 91
                                     :path,
                                     :description,
                                     :issues_enabled,
                                     :merge_requests_enabled,
                                     :wiki_enabled,
                                     :snippets_enabled,
                                     :namespace_id,
92
                                     :public,
93 94
                                     :visibility_level,
                                     :import_url]
95
        attrs = map_public_to_visibility_level(attrs)
96
        @project = ::Projects::CreateService.new(current_user, attrs).execute
97 98 99
        if @project.saved?
          present @project, with: Entities::Project
        else
100 101 102
          if @project.errors[:limit_reached].present?
            error!(@project.errors[:limit_reached], 403)
          end
103
          not_found!
104 105 106
        end
      end

A
Angus MacArthur 已提交
107 108 109 110 111 112 113
      # 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
114 115
      #   issues_enabled (optional)
      #   merge_requests_enabled (optional)
116 117
      #   wiki_enabled (optional)
      #   snippets_enabled (optional)
118 119
      #   public (optional) - if true same as setting visibility_level = 20
      #   visibility_level (optional)
A
Angus MacArthur 已提交
120 121 122 123 124 125
      # 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,
126 127 128 129 130 131
                                     :description,
                                     :default_branch,
                                     :issues_enabled,
                                     :merge_requests_enabled,
                                     :wiki_enabled,
                                     :snippets_enabled,
132 133 134
                                     :public,
                                     :visibility_level]
        attrs = map_public_to_visibility_level(attrs)
135
        @project = ::Projects::CreateService.new(user, attrs).execute
A
Angus MacArthur 已提交
136 137 138 139 140 141 142
        if @project.saved?
          present @project, with: Entities::Project
        else
          not_found!
        end
      end

143 144 145 146 147 148 149 150 151 152
      # Remove project
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   DELETE /projects/:id
      delete ":id" do
        authorize! :remove_project, user_project
        user_project.destroy
      end
A
Angus MacArthur 已提交
153

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
      # 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!
        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
188 189 190 191
      # search for projects current_user has access to
      #
      # Parameters:
      #   query (required) - A string contained in the project name
192 193
      #   per_page (optional) - number of projects to return per page
      #   page (optional) - the page to retrieve
194 195 196 197
      # Example Request:
      #   GET /projects/search/:query
      get "/search/:query" do
        ids = current_user.authorized_projects.map(&:id)
198 199
        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]}%")
200
        present paginate(projects), with: Entities::Project
201
      end
202 203 204 205 206 207 208 209 210 211 212 213


      # 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::User
      end
214

215
      # Get a project labels
216
      #
217 218
      # Parameters:
      #   id (required) - The ID of a project
219
      # Example Request:
220
      #   GET /projects/:id/labels
221 222 223 224
      get ':id/labels' do
        @labels = user_project.issues_labels
        present @labels, with: Entities::Label
      end
N
Nihad Abbasov 已提交
225 226 227
    end
  end
end