summaryrefslogtreecommitdiff
path: root/lib/ci/api/projects.rb
blob: d719ad9e8d592f8dfb85084b97ad850e2fbe567d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
188
189
190
191
192
193
194
195
module Ci
  module API
    # Projects API
    class Projects < Grape::API
      before { authenticate! }

      resource :projects do
        # Register new webhook for project
        #
        # Parameters
        #   project_id (required) - The ID of a project
        #   web_hook (required) - WebHook URL
        # Example Request
        #   POST /projects/:project_id/webhooks
        post ":project_id/webhooks" do
          required_attributes! [:web_hook]

          project = Ci::Project.find(params[:project_id])

          unauthorized! unless can?(current_user, :admin_project, project.gl_project)

          web_hook = project.web_hooks.new({ url: params[:web_hook] })

          if web_hook.save
            present web_hook, with: Entities::WebHook
          else
            errors = web_hook.errors.full_messages.join(", ")
            render_api_error!(errors, 400)
          end
        end

        # Retrieve all Gitlab CI projects that the user has access to
        #
        # Example Request:
        #   GET /projects
        get do
          gitlab_projects = current_user.authorized_projects
          gitlab_projects = filter_projects(gitlab_projects)
          gitlab_projects = paginate gitlab_projects

          ids = gitlab_projects.map { |project| project.id }

          projects = Ci::Project.where("gitlab_id IN (?)", ids).load
          present projects, with: Entities::Project
        end

        # Retrieve all Gitlab CI projects that the user owns
        #
        # Example Request:
        #   GET /projects/owned
        get "owned" do
          gitlab_projects = current_user.owned_projects
          gitlab_projects = filter_projects(gitlab_projects)
          gitlab_projects = paginate gitlab_projects

          ids = gitlab_projects.map { |project| project.id }

          projects = Ci::Project.where("gitlab_id IN (?)", ids).load
          present projects, with: Entities::Project
        end

        # Retrieve info for a Gitlab CI project
        #
        # Parameters:
        #   id (required) - The ID of a project
        # Example Request:
        #   GET /projects/:id
        get ":id" do
          project = Ci::Project.find(params[:id])
          unauthorized! unless can?(current_user, :read_project, project.gl_project)

          present project, with: Entities::Project
        end

        # Create Gitlab CI project using Gitlab project info
        #
        # Parameters:
        #   gitlab_id (required)       - The gitlab id of the project
        #   default_ref                - The branch to run against (defaults to `master`)
        # Example Request:
        #   POST /projects
        post do
          required_attributes! [:gitlab_id]

          filtered_params = {
            gitlab_id:       params[:gitlab_id],
            # we accept gitlab_url for backward compatibility for a while (added to 7.11)
            default_ref:     params[:default_ref] || 'master'
          }

          project = Ci::Project.new(filtered_params)
          project.build_missing_services

          if project.save
            present project, with: Entities::Project
          else
            errors = project.errors.full_messages.join(", ")
            render_api_error!(errors, 400)
          end
        end

        # Update a Gitlab CI project
        #
        # Parameters:
        #   id (required)   - The ID of a project
        #   default_ref      - The branch to run against (defaults to `master`)
        # Example Request:
        #   PUT /projects/:id
        put ":id" do
          project = Ci::Project.find(params[:id])

          unauthorized! unless can?(current_user, :admin_project, project.gl_project)

          attrs = attributes_for_keys [:default_ref]

          if project.update_attributes(attrs)
            present project, with: Entities::Project
          else
            errors = project.errors.full_messages.join(", ")
            render_api_error!(errors, 400)
          end
        end

        # Remove a Gitlab CI project
        #
        # Parameters:
        #   id (required) - The ID of a project
        # Example Request:
        #   DELETE /projects/:id
        delete ":id" do
          project = Ci::Project.find(params[:id])

          unauthorized! unless can?(current_user, :admin_project, project.gl_project)

          project.destroy
        end

        # Link a Gitlab CI project to a runner
        #
        # Parameters:
        #   id (required) - The ID of a CI project
        #   runner_id (required) - The ID of a runner
        # Example Request:
        #   POST /projects/:id/runners/:runner_id
        post ":id/runners/:runner_id" do
          project = Ci::Project.find(params[:id])
          runner  = Ci::Runner.find(params[:runner_id])

          unauthorized! unless can?(current_user, :admin_project, project.gl_project)

          options = {
            project_id: project.id,
            runner_id:  runner.id
          }

          runner_project = Ci::RunnerProject.new(options)

          if runner_project.save
            present runner_project, with: Entities::RunnerProject
          else
            errors = project.errors.full_messages.join(", ")
            render_api_error!(errors, 400)
          end
        end

        # Remove a Gitlab CI project from a runner
        #
        # Parameters:
        #   id (required) - The ID of a CI project
        #   runner_id (required) - The ID of a runner
        # Example Request:
        #   DELETE /projects/:id/runners/:runner_id
        delete ":id/runners/:runner_id" do
          project = Ci::Project.find(params[:id])
          runner  = Ci::Runner.find(params[:runner_id])

          unauthorized! unless can?(current_user, :admin_project, project.gl_project)

          options = {
            project_id: project.id,
            runner_id:  runner.id
          }

          runner_project = Ci::RunnerProject.find_by(options)

          if runner_project.present?
            runner_project.destroy
          else
            not_found!
          end
        end
      end
    end
  end
end