@managed-api/gitlab-v4-core

Managed API for GitLab

Managed API for GitLab is an API Client for GitLab by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.

This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.

Platform specific ports

• ScriptRunner Connect

Supported API calls

• fetch
• Branch
  • createBranch
  • deleteBranch
  • deleteMergedBranches
  • getBranch
  • getBranches
• Commit
  • cherryPickCommit
  • createComment
  • createCommit
  • getComments
  • getCommit
  • getCommitDiff
  • getCommitReferences
  • getCommits
  • getDiscussions
  • getGPGSignature
  • getMergeRequests
  • revertCommit
  • Status
    • createBuildStatus
    • getStatuses
• Epic
  • createEpic
  • createTodoItem
  • deleteEpic
  • getEpic
  • getEpicsForGroup
  • updateEpic
• Issue
  • addSpentTimeForIssue
  • cloneIssue
  • createIssue
  • createTodoItem
  • deleteIssue
  • editIssue
  • getGroupIssues
  • getIssue
  • getIssues
  • getMergeRequestsRelatedToIssue
  • getMergeRequestsThatClosedAnIssue
  • getParticipants
  • getProjectIssue
  • getProjectIssues
  • getTimeTrackingStatsForIssue
  • getUserAgentDetails
  • moveIssue
  • promoteToEpic
  • reorderIssue
  • resetSpentTimeForIssue
  • resetTimeEstimateForIssue
  • setTimeEstimateForIssue
  • subscribeToIssue
  • unsubscribeFromIssue
• Link
  • Issue
    • createLink
    • deleteLink
    • getRelations
• Repository
  • addChangelog
  • compare
  • generateChangelog
  • getBlob
  • getContributors
  • getFileArchive
  • getRawBlobContent
  • getRepositoryTree
  • mergeBase
  • File
    • createFile
    • deleteFile
    • getFile
    • getFileBlame
    • getRawFile
    • updateFile

Porting to other runtimes

While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.

You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:

{
    buffer: {
        encode(input: string): ArrayBuffer;
        decode(input: ArrayBuffer): string;
    },
    performHttpCall(request: Request): Promise<Response>
}

Here is an example how to create a Node port of the Managed API:

import { GitlabApiCore } from "@managed-api/gitlab-v4-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class GitlabApi extends GitlabApiCore {
    constructor(private baseUrl: string, private authToken: string) {
        super();
    }

    protected getPlatformImplementation(): PlatformImplementation {
        return {
            buffer: {
                encode: (input) => Buffer.from(input, 'utf-8'),
                decode: (input) => Buffer.from(input).toString('utf-8')
            },
            performHttpCall: (request) => this.performHttpCall(request)
        };
    }

    private async performHttpCall(request: Request): Promise<Response> {
        const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
        request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
        const response = await fetch(requestUrl, {
            method: request.method,
            headers: request.headers as any,
            body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
        });

        const apiHeaders = new Headers();
        response.headers.forEach((value, key) => apiHeaders.append(key, value));

        const body = await response.arrayBuffer();

        return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
    }
}

Please note that the authentication handling details may not be accurate and serve as an example. If you wish yo use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [e-mail] for ideas, suggestions and improvements.

Changelog

• 2.2.0

  • Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

• 2.1.0

  • Url-encoded the following properties:
    • id in all Repository, Commit, Epic, Link and Branch methods.
    • id in the following Issue Methods: getGroupIssues, getProjectIssues, getProjectIssue, createIssue, editIssue, deleteIssue, reorderIssue, moveIssue, cloneIssue, subscribeToIssue, unsubscribeFromIssue, createTodoItem, promoteToEpic, setTimeEstimateForIssue, resetTimeEstimateForIssue, addSpentTimeForIssue, resetSpentTimeForIssue, getTimeTrackingStatsForIssue, getMergeRequestsRelatedToIssue, getMergeRequestsThatClosedAnIssue, getParticipants, getUserAgentDetails.
    • branch in Branch.getBranch and Branch.deleteBranch.
    • file_path in all Repository.File methods.

Copyright Adaptavist 2022 (c) All rights reserved