path: root/server/sonar-auth-github/src/main/java/org/sonar/auth/github/GithubBinding.java

/*
 * SonarQube
 * Copyright (C) 2009-2025 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.auth.github;

import com.google.gson.annotations.SerializedName;
import java.util.List;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;

import static org.sonar.auth.github.GithubApplicationClient.Repository;

public class GithubBinding {

  private GithubBinding() {
    // nothing to do
  }

  public record GsonOrganizationFull(@SerializedName("login") String login, @SerializedName("default_repository_permission") String defaultRepositoryPermissions) {
  }

  public static class GsonApp {

    @SerializedName("installations_count")
    private long installationsCount;

    @SerializedName("permissions")
    Permissions permissions;

    public GsonApp(long installationsCount, Permissions permissions) {
      this.installationsCount = installationsCount;
      this.permissions = permissions;
    }

    public GsonApp() {
      // http://stackoverflow.com/a/18645370/229031
    }

    public Permissions getPermissions() {
      return permissions;
    }

    public long getInstallationsCount() {
      return installationsCount;
    }
  }

  public static class GsonInstallations {
    @SerializedName("total_count")
    int totalCount;
    @SerializedName("installations")
    List<GsonInstallation> installations;

    public GsonInstallations() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public int getTotalCount() {
      return totalCount;
    }

    public List<GsonInstallation> getInstallations() {
      return installations;
    }
  }

  public static class GsonInstallation {
    @SerializedName("id")
    long id;
    @SerializedName("target_type")
    String targetType;
    @SerializedName("permissions")
    Permissions permissions;
    @SerializedName("account")
    GsonAccount account;
    @SerializedName("suspended_at")
    String suspendedAt;

    public GsonInstallation(long id, String targetType, Permissions permissions, GsonAccount account, String suspendedAt) {
      this.id = id;
      this.targetType = targetType;
      this.permissions = permissions;
      this.account = account;
      this.suspendedAt = suspendedAt;
    }

    public GsonInstallation() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public long getId() {
      return id;
    }

    public String getTargetType() {
      return targetType;
    }

    public Permissions getPermissions() {
      return permissions;
    }

    public GsonAccount getAccount() {
      return account;
    }

    public String getSuspendedAt() {
      return suspendedAt;
    }

    public static class GsonAccount {
      @SerializedName("id")
      long id;
      @SerializedName("login")
      String login;
      @SerializedName("type")
      String type;

      public GsonAccount() {
        // even if empty constructor is not required for Gson, it is strongly
        // recommended:
        // http://stackoverflow.com/a/18645370/229031
      }

      public long getId() {
        return id;
      }

      public String getLogin() {
        return login;
      }

      public String getType() {
        return type;
      }
    }
  }

  public static class Permissions {
    @SerializedName("checks")
    String checks;
    @SerializedName("members")
    String members;
    @SerializedName("emails")
    String emails;
    @SerializedName("contents")
    String contents;
    @SerializedName("metadata")
    String metadata;
    @SerializedName("administration")
    String repoAdministration;
    @SerializedName("organization_administration")
    String orgAdministration;
    @SerializedName("organization_copilot_seat_management")
    String orgCopilotSeatManagement;

    public Permissions(@Nullable String checks, @Nullable String members, @Nullable String emails, @Nullable String contents, @Nullable String metadata,
      @Nullable String repoAdministration, @Nullable String orgAdministration, @Nullable String orgCopilotSeatManagement) {
      this.checks = checks;
      this.members = members;
      this.emails = emails;
      this.contents = contents;
      this.metadata = metadata;
      this.repoAdministration = repoAdministration;
      this.orgAdministration = orgAdministration;
      this.orgCopilotSeatManagement = orgCopilotSeatManagement;
    }

    public Permissions() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public static Builder builder() {
      return new Builder();
    }

    @CheckForNull
    public String getMembers() {
      return members;
    }

    @CheckForNull
    public String getChecks() {
      return checks;
    }

    @CheckForNull
    public String getEmails() {
      return emails;
    }

    @CheckForNull
    public String getContents() {
      return contents;
    }

    @CheckForNull
    public String getMetadata() {
      return metadata;
    }

    @CheckForNull
    public String getRepoAdministration() {
      return repoAdministration;
    }

    @CheckForNull
    public String getOrgAdministration() {
      return orgAdministration;
    }

    @CheckForNull
    public String getOrgCopilotSeatManagement() {
      return orgCopilotSeatManagement;
    }

    public static class Builder {
      private String checks;
      private String members;
      private String emails;
      private String contents;
      private String metadata;
      private String repoAdministration;
      private String orgAdministration;
      private String orgCopilotSeatManagement;

      private Builder() {
        // Use static factory method
      }

      public Builder setChecks(String checks) {
        this.checks = checks;
        return this;
      }

      public Builder setMembers(String members) {
        this.members = members;
        return this;
      }

      public Builder setEmails(String emails) {
        this.emails = emails;
        return this;
      }

      public Builder setContents(String contents) {
        this.contents = contents;
        return this;
      }

      public Builder setMetadata(String metadata) {
        this.metadata = metadata;
        return this;
      }

      public Builder setRepoAdministration(String repoAdministration) {
        this.repoAdministration = repoAdministration;
        return this;
      }

      public Builder setOrgAdministration(String orgAdministration) {
        this.orgAdministration = orgAdministration;
        return this;
      }

      public Builder setOrgCopilotSeatManagement(String orgCopilotSeatManagement) {
        this.orgCopilotSeatManagement = orgCopilotSeatManagement;
        return this;
      }

      public GithubBinding.Permissions build() {
        return new GithubBinding.Permissions(checks, members, emails, contents, metadata, repoAdministration, orgAdministration, orgCopilotSeatManagement);
      }
    }
  }

  public static class GsonRepositorySearch {
    @SerializedName("total_count")
    int totalCount;
    @SerializedName("items")
    List<GsonGithubRepository> items;

    public GsonRepositorySearch() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public int getTotalCount() {
      return totalCount;
    }

    public List<GsonGithubRepository> getItems() {
      return items;
    }

  }

  public static class GsonGithubRepository {
    @SerializedName("id")
    long id;
    @SerializedName("name")
    String name;
    @SerializedName("full_name")
    String fullName;
    @SerializedName("private")
    boolean isPrivate;
    @SerializedName("html_url")
    String htmlUrl;
    @SerializedName("default_branch")
    String defaultBranch;

    public GsonGithubRepository() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public Repository toRepository() {
      return new Repository(this.id, this.name, this.isPrivate, this.fullName,
        this.htmlUrl, this.defaultBranch);
    }
  }

  public static class GsonGithubCodeScanningAlert {
    @SerializedName("number")
    long id;
    @SerializedName("state")
    GithubCodeScanningAlertState state;
    @SerializedName("dismissed_reason")
    String dismissedReason;
    @SerializedName("dismissed_comment")
    String dismissedComment;
    @SerializedName("tool")
    GsonGithubCodeScanningAlertTool tool;
    @SerializedName("most_recent_instance")
    GsonGithubCodeScanningAlertInstance mostRecentInstance;

    public GsonGithubCodeScanningAlert() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public long getId() {
      return id;
    }

    public GithubCodeScanningAlertState getState() {
      return state;
    }

    public String getDismissedReason() {
      return dismissedReason;
    }

    public String getDismissedComment() {
      return dismissedComment;
    }

    public GsonGithubCodeScanningAlertTool getTool() {
      return tool;
    }

    public GsonGithubCodeScanningAlertInstance getMostRecentInstance() {
      return mostRecentInstance;
    }

    public String getMessageText() {
      return getMostRecentInstance().getMessageText();
    }
  }

  public static class GsonGithubCodeScanningAlertWebhookPayload {
    @SerializedName("action")
    String action;
    @SerializedName("alert")
    GsonGithubCodeScanningAlert alert;
    @SerializedName("sender")
    GsonGithubCodeScanningAlertWebhookPayloadSender sender;

    public GsonGithubCodeScanningAlertWebhookPayload() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public String getAction() {
      return action;
    }

    public GsonGithubCodeScanningAlert getAlert() {
      return alert;
    }

    public GsonGithubCodeScanningAlertWebhookPayloadSender getSender() {
      return sender;
    }
  }

  public static class GsonGithubCodeScanningAlertInstance {
    @SerializedName("state")
    GithubCodeScanningAlertState state;
    @SerializedName("message")
    GsonGithubCodeScanningAlertMessage message;

    public GsonGithubCodeScanningAlertInstance() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public GsonGithubCodeScanningAlertMessage getMessage() {
      return message;
    }

    public String getMessageText() {
      return getMessage().getText();
    }
  }

  public enum GithubCodeScanningAlertState {
    @SerializedName("open")
    OPEN,
    @SerializedName("fixed")
    FIXED,
    @SerializedName("dismissed")
    DISMISSED
  }

  public static class GsonGithubCodeScanningAlertMessage {
    @SerializedName("text")
    String text;

    public GsonGithubCodeScanningAlertMessage() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public String getText() {
      return text;
    }
  }

  public static class GsonGithubCodeScanningAlertWebhookPayloadSender {
    @SerializedName("login")
    String login;

    public GsonGithubCodeScanningAlertWebhookPayloadSender() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public String getLogin() {
      return login;
    }
  }

  public static class GsonGithubCodeScanningAlertTool {
    @SerializedName("name")
    String name;

    public GsonGithubCodeScanningAlertTool() {
      // even if empty constructor is not required for Gson, it is strongly
      // recommended:
      // http://stackoverflow.com/a/18645370/229031
    }

    public String getName() {
      return name;
    }
  }

  public static class GsonInstallationToken {
    @SerializedName("token")
    String token;

    @SerializedName("expires_at")
    String expiresAt;

    public String getToken() {
      return token;
    }

    public String getExpiresAt() {
      return expiresAt;
    }
  }
}