assay-lua 0.10.4

General-purpose enhanced Lua runtime. Batteries-included scripting, automation, and web services.
Documentation
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
--- @module assay.gitlab
--- @description GitLab REST API v4 — projects, repositories, commits, merge requests, pipelines, issues, releases, container registry.
--- @keywords gitlab, git, ci, cd, merge-request, pipeline, repository, commit, registry, release
--- @quickref c.projects:get(id) -> table|nil | Get project details
--- @quickref c.files:raw(project, path, opts?) -> string|nil | Read raw file content
--- @quickref c.commits:create(project, opts) -> table | Atomic multi-file commit
--- @quickref c.merge_requests:list(project, opts?) -> [table] | List merge requests
--- @quickref c.merge_requests:create(project, opts) -> table | Create merge request
--- @quickref c.merge_requests:merge(project, iid, opts?) -> table | Accept a merge request
--- @quickref c.pipelines:list(project, opts?) -> [table] | List CI/CD pipelines
--- @quickref c.pipelines:create(project, opts) -> table | Trigger a new pipeline
--- @quickref c.branches:list(project, opts?) -> [table] | List branches
--- @quickref c.tags:list(project, opts?) -> [table] | List tags
--- @quickref c.releases:list(project, opts?) -> [table] | List releases
--- @quickref c.issues:list(project, opts?) -> [table] | List issues

local M = {}

function M.client(url, opts)
  opts = opts or {}
  local base_url = url:gsub("/+$", "")
  local token = opts.token
  local oauth_token = opts.oauth_token

  -- Shared HTTP helpers (captured by all sub-object methods as upvalues)

  local function headers()
    local h = { ["Content-Type"] = "application/json" }
    if token then
      h["PRIVATE-TOKEN"] = token
    elseif oauth_token then
      h["Authorization"] = "Bearer " .. oauth_token
    end
    return h
  end

  local function urlencode(str)
    return tostring(str):gsub("([^%w%-%.%_%~])", function(ch)
      return string.format("%%%02X", string.byte(ch))
    end)
  end

  local function encode_project(project)
    if type(project) == "number" then return tostring(project) end
    return urlencode(tostring(project))
  end

  local function build_query(params)
    if not params then return "" end
    local parts = {}
    for k, v in pairs(params) do
      if v ~= nil then
        parts[#parts + 1] = urlencode(tostring(k)) .. "=" .. urlencode(tostring(v))
      end
    end
    table.sort(parts)
    return #parts > 0 and "?" .. table.concat(parts, "&") or ""
  end

  local function api_get(path_str, query_params)
    local resp = http.get(base_url .. "/api/v4" .. path_str .. build_query(query_params),
      { headers = headers() })
    if resp.status == 404 then return nil end
    if resp.status ~= 200 then
      error("gitlab: GET " .. path_str .. " HTTP " .. resp.status .. ": " .. (resp.body or ""))
    end
    return json.parse(resp.body)
  end

  local function api_get_raw(path_str, query_params)
    local h = headers()
    h["Content-Type"] = nil
    local resp = http.get(base_url .. "/api/v4" .. path_str .. build_query(query_params),
      { headers = h })
    if resp.status == 404 then return nil end
    if resp.status ~= 200 then
      error("gitlab: GET " .. path_str .. " HTTP " .. resp.status .. ": " .. (resp.body or ""))
    end
    return resp.body
  end

  local function api_post(path_str, payload)
    local resp = http.post(base_url .. "/api/v4" .. path_str, payload or {}, { headers = headers() })
    if resp.status ~= 200 and resp.status ~= 201 then
      error("gitlab: POST " .. path_str .. " HTTP " .. resp.status .. ": " .. (resp.body or ""))
    end
    return json.parse(resp.body)
  end

  local function api_put(path_str, payload)
    local resp = http.put(base_url .. "/api/v4" .. path_str, payload or {}, { headers = headers() })
    if resp.status ~= 200 then
      error("gitlab: PUT " .. path_str .. " HTTP " .. resp.status .. ": " .. (resp.body or ""))
    end
    return json.parse(resp.body)
  end

  local function api_delete(path_str)
    local resp = http.delete(base_url .. "/api/v4" .. path_str, { headers = headers() })
    if resp.status ~= 200 and resp.status ~= 204 then
      error("gitlab: DELETE " .. path_str .. " HTTP " .. resp.status .. ": " .. (resp.body or ""))
    end
    if resp.body and resp.body ~= "" then
      local ok, parsed = pcall(json.parse, resp.body)
      if ok then return parsed end
    end
    return nil
  end

  local function proj(id) return "/projects/" .. encode_project(id) end

  -- ===== Client =====

  local c = {}

  -- ===== Projects =====

  c.projects = {}

  function c.projects:list(query_opts)
    return api_get("/projects", query_opts)
  end

  function c.projects:get(id)
    return api_get(proj(id))
  end

  -- ===== Repository Files =====

  c.files = {}

  function c.files:get(project, file_path, file_opts)
    file_opts = file_opts or {}
    return api_get(proj(project) .. "/repository/files/" .. urlencode(file_path),
      { ref = file_opts.ref or "main" })
  end

  function c.files:raw(project, file_path, file_opts)
    file_opts = file_opts or {}
    return api_get_raw(proj(project) .. "/repository/files/" .. urlencode(file_path) .. "/raw",
      { ref = file_opts.ref or "main" })
  end

  function c.files:create(project, file_path, file_opts)
    return api_post(proj(project) .. "/repository/files/" .. urlencode(file_path), file_opts)
  end

  function c.files:update(project, file_path, file_opts)
    return api_put(proj(project) .. "/repository/files/" .. urlencode(file_path), file_opts)
  end

  function c.files:delete(project, file_path, file_opts)
    file_opts = file_opts or {}
    local h = headers()
    local resp = http.delete(base_url .. "/api/v4" .. proj(project)
      .. "/repository/files/" .. urlencode(file_path), {
      headers = h,
      body = json.encode(file_opts),
    })
    if resp.status ~= 204 then
      error("gitlab: DELETE file " .. file_path .. " HTTP " .. resp.status .. ": " .. (resp.body or ""))
    end
    return nil
  end

  -- ===== Repository =====

  c.repository = {}

  function c.repository:tree(project, tree_opts)
    return api_get(proj(project) .. "/repository/tree", tree_opts)
  end

  function c.repository:compare(project, from, to)
    return api_get(proj(project) .. "/repository/compare", { from = from, to = to })
  end

  -- ===== Commits =====

  c.commits = {}

  function c.commits:list(project, commit_opts)
    return api_get(proj(project) .. "/repository/commits", commit_opts)
  end

  function c.commits:get(project, sha)
    return api_get(proj(project) .. "/repository/commits/" .. sha)
  end

  function c.commits:create(project, commit_opts)
    return api_post(proj(project) .. "/repository/commits", commit_opts)
  end

  function c.commits:cherry_pick(project, sha, cherry_opts)
    return api_post(proj(project) .. "/repository/commits/" .. sha .. "/cherry_pick", cherry_opts)
  end

  -- ===== Branches =====

  c.branches = {}

  function c.branches:list(project, branch_opts)
    return api_get(proj(project) .. "/repository/branches", branch_opts)
  end

  function c.branches:get(project, name)
    return api_get(proj(project) .. "/repository/branches/" .. urlencode(name))
  end

  function c.branches:create(project, branch_opts)
    return api_post(proj(project) .. "/repository/branches", branch_opts)
  end

  function c.branches:delete(project, name)
    return api_delete(proj(project) .. "/repository/branches/" .. urlencode(name))
  end

  -- ===== Tags =====

  c.tags = {}

  function c.tags:list(project, tag_opts)
    return api_get(proj(project) .. "/repository/tags", tag_opts)
  end

  function c.tags:get(project, name)
    return api_get(proj(project) .. "/repository/tags/" .. urlencode(name))
  end

  function c.tags:create(project, tag_opts)
    return api_post(proj(project) .. "/repository/tags", tag_opts)
  end

  function c.tags:delete(project, name)
    return api_delete(proj(project) .. "/repository/tags/" .. urlencode(name))
  end

  -- ===== Merge Requests =====

  c.merge_requests = {}

  function c.merge_requests:list(project, mr_opts)
    return api_get(proj(project) .. "/merge_requests", mr_opts)
  end

  function c.merge_requests:get(project, iid)
    return api_get(proj(project) .. "/merge_requests/" .. iid)
  end

  function c.merge_requests:create(project, mr_opts)
    return api_post(proj(project) .. "/merge_requests", mr_opts)
  end

  function c.merge_requests:update(project, iid, mr_opts)
    return api_put(proj(project) .. "/merge_requests/" .. iid, mr_opts)
  end

  function c.merge_requests:merge(project, iid, merge_opts)
    return api_put(proj(project) .. "/merge_requests/" .. iid .. "/merge", merge_opts)
  end

  function c.merge_requests:approve(project, iid)
    return api_post(proj(project) .. "/merge_requests/" .. iid .. "/approve")
  end

  function c.merge_requests:changes(project, iid)
    return api_get(proj(project) .. "/merge_requests/" .. iid .. "/changes")
  end

  function c.merge_requests:notes(project, iid, note_opts)
    return api_get(proj(project) .. "/merge_requests/" .. iid .. "/notes", note_opts)
  end

  function c.merge_requests:create_note(project, iid, body)
    return api_post(proj(project) .. "/merge_requests/" .. iid .. "/notes", { body = body })
  end

  -- ===== Pipelines =====

  c.pipelines = {}

  function c.pipelines:list(project, pipe_opts)
    return api_get(proj(project) .. "/pipelines", pipe_opts)
  end

  function c.pipelines:get(project, id)
    return api_get(proj(project) .. "/pipelines/" .. id)
  end

  function c.pipelines:create(project, pipe_opts)
    return api_post(proj(project) .. "/pipeline", pipe_opts)
  end

  function c.pipelines:cancel(project, id)
    return api_post(proj(project) .. "/pipelines/" .. id .. "/cancel")
  end

  function c.pipelines:retry(project, id)
    return api_post(proj(project) .. "/pipelines/" .. id .. "/retry")
  end

  function c.pipelines:delete(project, id)
    return api_delete(proj(project) .. "/pipelines/" .. id)
  end

  function c.pipelines:jobs(project, pipeline_id, job_opts)
    return api_get(proj(project) .. "/pipelines/" .. pipeline_id .. "/jobs", job_opts)
  end

  -- ===== Jobs =====

  c.jobs = {}

  function c.jobs:list(project, job_opts)
    return api_get(proj(project) .. "/jobs", job_opts)
  end

  function c.jobs:get(project, id)
    return api_get(proj(project) .. "/jobs/" .. id)
  end

  function c.jobs:retry(project, id)
    return api_post(proj(project) .. "/jobs/" .. id .. "/retry")
  end

  function c.jobs:cancel(project, id)
    return api_post(proj(project) .. "/jobs/" .. id .. "/cancel")
  end

  function c.jobs:log(project, id)
    return api_get_raw(proj(project) .. "/jobs/" .. id .. "/trace")
  end

  -- ===== Releases =====

  c.releases = {}

  function c.releases:list(project, release_opts)
    return api_get(proj(project) .. "/releases", release_opts)
  end

  function c.releases:get(project, tag_name)
    return api_get(proj(project) .. "/releases/" .. urlencode(tag_name))
  end

  function c.releases:create(project, release_opts)
    return api_post(proj(project) .. "/releases", release_opts)
  end

  function c.releases:update(project, tag_name, release_opts)
    return api_put(proj(project) .. "/releases/" .. urlencode(tag_name), release_opts)
  end

  function c.releases:delete(project, tag_name)
    return api_delete(proj(project) .. "/releases/" .. urlencode(tag_name))
  end

  -- ===== Issues =====

  c.issues = {}

  function c.issues:list(project, issue_opts)
    if project then
      return api_get(proj(project) .. "/issues", issue_opts)
    end
    return api_get("/issues", issue_opts)
  end

  function c.issues:get(project, iid)
    return api_get(proj(project) .. "/issues/" .. iid)
  end

  function c.issues:create(project, issue_opts)
    return api_post(proj(project) .. "/issues", issue_opts)
  end

  function c.issues:update(project, iid, issue_opts)
    return api_put(proj(project) .. "/issues/" .. iid, issue_opts)
  end

  function c.issues:notes(project, iid, note_opts)
    return api_get(proj(project) .. "/issues/" .. iid .. "/notes", note_opts)
  end

  function c.issues:create_note(project, iid, body)
    return api_post(proj(project) .. "/issues/" .. iid .. "/notes", { body = body })
  end

  -- ===== Groups =====

  c.groups = {}

  function c.groups:list(group_opts)
    return api_get("/groups", group_opts)
  end

  function c.groups:get(id)
    return api_get("/groups/" .. encode_project(id))
  end

  function c.groups:projects(id, group_opts)
    return api_get("/groups/" .. encode_project(id) .. "/projects", group_opts)
  end

  -- ===== Container Registry =====

  c.registry = {}

  function c.registry:repositories(project)
    return api_get(proj(project) .. "/registry/repositories")
  end

  function c.registry:tags(project, repo_id)
    return api_get(proj(project) .. "/registry/repositories/" .. repo_id .. "/tags")
  end

  function c.registry:tag(project, repo_id, tag_name)
    return api_get(proj(project) .. "/registry/repositories/" .. repo_id
      .. "/tags/" .. urlencode(tag_name))
  end

  function c.registry:delete_tag(project, repo_id, tag_name)
    return api_delete(proj(project) .. "/registry/repositories/" .. repo_id
      .. "/tags/" .. urlencode(tag_name))
  end

  -- ===== Webhooks =====

  c.hooks = {}

  function c.hooks:list(project)
    return api_get(proj(project) .. "/hooks")
  end

  function c.hooks:get(project, id)
    return api_get(proj(project) .. "/hooks/" .. id)
  end

  function c.hooks:create(project, hook_opts)
    return api_post(proj(project) .. "/hooks", hook_opts)
  end

  function c.hooks:update(project, id, hook_opts)
    return api_put(proj(project) .. "/hooks/" .. id, hook_opts)
  end

  function c.hooks:delete(project, id)
    return api_delete(proj(project) .. "/hooks/" .. id)
  end

  -- ===== Users =====

  c.users = {}

  function c.users:current()
    return api_get("/user")
  end

  function c.users:list(user_opts)
    return api_get("/users", user_opts)
  end

  -- ===== Environments =====

  c.environments = {}

  function c.environments:list(project, env_opts)
    return api_get(proj(project) .. "/environments", env_opts)
  end

  function c.environments:get(project, id)
    return api_get(proj(project) .. "/environments/" .. id)
  end

  -- ===== Deploy Tokens =====

  c.deploy_tokens = {}

  function c.deploy_tokens:list(project)
    return api_get(proj(project) .. "/deploy_tokens")
  end

  function c.deploy_tokens:create(project, dt_opts)
    return api_post(proj(project) .. "/deploy_tokens", dt_opts)
  end

  function c.deploy_tokens:delete(project, id)
    return api_delete(proj(project) .. "/deploy_tokens/" .. id)
  end

  return c
end

return M