Skip to content

Commit

Permalink
Added support for projects.
Browse files Browse the repository at this point in the history
Fixes issue hub4j#425
  • Loading branch information
martinvanzijl authored and bitwiseman committed Oct 4, 2019
1 parent 78abb2e commit b20c2ba
Show file tree
Hide file tree
Showing 5 changed files with 259 additions and 0 deletions.
39 changes: 39 additions & 0 deletions src/main/java/org/kohsuke/github/GHOrganization.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import static org.kohsuke.github.Previews.INERTIA;

/**
* @author Kohsuke Kawaguchi
Expand Down Expand Up @@ -193,6 +194,44 @@ public void conceal(GHUser u) throws IOException {
root.retrieve().method("DELETE").to("/orgs/" + login + "/public_members/" + u.getLogin(), null);
}

/**
* Returns the projects for this organization.
* @param status The status filter (all, open or closed).
*/
public PagedIterable<GHProject> listProjects(final GHProject.ProjectStateFilter status) throws IOException {
return new PagedIterable<GHProject>() {
public PagedIterator<GHProject> _iterator(int pageSize) {
return new PagedIterator<GHProject>(root.retrieve().withPreview(INERTIA)
.with("state", status)
.asIterator(String.format("/orgs/%s/projects", login), GHProject[].class, pageSize)) {
@Override
protected void wrapUp(GHProject[] page) {
for (GHProject c : page)
c.wrap(root);
}
};
}
};
}

/**
* Returns all open projects for the organization.
*/
public PagedIterable<GHProject> listProjects() throws IOException {
return listProjects(GHProject.ProjectStateFilter.OPEN);
}

/**
* Creates a project for the organization.
*/
public GHProject createProject(String name, String body) throws IOException {
return root.retrieve().method("POST")
.withPreview(INERTIA)
.with("name", name)
.with("body", body)
.to(String.format("/orgs/%s/projects", login), GHProject.class).wrap(root);
}

public enum Permission { ADMIN, PUSH, PULL }

/**
Expand Down
159 changes: 159 additions & 0 deletions src/main/java/org/kohsuke/github/GHProject.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
/*
* The MIT License
*
* Copyright 2018 Martin van Zijl.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.kohsuke.github;

import java.io.IOException;
import java.net.URL;
import static org.kohsuke.github.Previews.INERTIA;

/**
* A GitHub project.
* @see https://developer.github.com/v3/projects/
* @author Martin van Zijl
*/
public class GHProject extends GHObject {
private GitHub root;
private GHRepository owner;

private String owner_url;
private String html_url;
private String columns_url;
private String node_id;
private String name;
private String body;
private int number;
private String state;
private GHUser creator;

@Override
public URL getHtmlUrl() throws IOException {
return GitHub.parseURL(html_url);
}

public GitHub getRoot() {
return root;
}

public GHRepository getOwner() {
return owner;
}

public String getOwner_url() {
return owner_url;
}

public String getHtml_url() {
return html_url;
}

public String getColumns_url() {
return columns_url;
}

public String getNode_id() {
return node_id;
}

public String getName() {
return name;
}

public String getBody() {
return body;
}

public int getNumber() {
return number;
}

public String getState() {
return state;
}

public GHUser getCreator() {
return creator;
}

public GHProject wrap(GHRepository repo) {
this.owner = repo;
this.root = repo.root;
return this;
}

public GHProject wrap(GitHub root) {
this.root = root;
return this;
}

private void edit(String key, Object value) throws IOException {
new Requester(root).withPreview(INERTIA)._with(key, value).method("PATCH").to(getApiRoute());
}

protected String getApiRoute() {
return "/projects/" + id;
}

public void setName(String name) throws IOException {
edit("name", name);
}

public void setBody(String body) throws IOException {
edit("body", body);
}

public enum ProjectState {
OPEN,
CLOSED
}

public void setState(ProjectState state) throws IOException {
edit("state", state.toString().toLowerCase());
}

public static enum ProjectStateFilter {
ALL,
OPEN,
CLOSED
}

/**
* Set the permission level that all members of the project's organization will have on this project.
* Only applicable for organization-owned projects.
*/
public void setOrganizationPermission(GHPermissionType permission) throws IOException {
edit("organization_permission", permission.toString().toLowerCase());
}

/**
* Sets visibility of the project within the organization.
* Only applicable for organization-owned projects.
*/
public void setPublic(boolean isPublic) throws IOException {
edit("public", isPublic);
}

public void delete() throws IOException {
new Requester(root).withPreview(INERTIA).method("DELETE").to(getApiRoute());
}
}
38 changes: 38 additions & 0 deletions src/main/java/org/kohsuke/github/GHRepository.java
Original file line number Diff line number Diff line change
Expand Up @@ -1646,6 +1646,44 @@ public boolean equals(Object obj) {
}
}

/**
* Create a project for this repository.
*/
public GHProject createProject(String name, String body) throws IOException {
return root.retrieve().method("POST")
.withPreview(INERTIA)
.with("name", name)
.with("body", body)
.to(getApiTailUrl("projects"), GHProject.class).wrap(this);
}

/**
* Returns the projects for this repository.
* @param status The status filter (all, open or closed).
*/
public PagedIterable<GHProject> listProjects(final GHProject.ProjectStateFilter status) throws IOException {
return new PagedIterable<GHProject>() {
public PagedIterator<GHProject> _iterator(int pageSize) {
return new PagedIterator<GHProject>(root.retrieve().withPreview(INERTIA)
.with("state", status)
.asIterator(getApiTailUrl("projects"), GHProject[].class, pageSize)) {
@Override
protected void wrapUp(GHProject[] page) {
for (GHProject c : page)
c.wrap(GHRepository.this);
}
};
}
};
}

/**
* Returns open projects for this repository.
*/
public PagedIterable<GHProject> listProjects() throws IOException {
return listProjects(GHProject.ProjectStateFilter.OPEN);
}

/**
* Render a Markdown document.
*
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/org/kohsuke/github/GitHub.java
Original file line number Diff line number Diff line change
Expand Up @@ -745,6 +745,10 @@ public boolean isCredentialValid() {
return user;
}

public GHProject getProject(long id) throws IOException {
return retrieve().withPreview(INERTIA).to("/projects/"+id,GHProject.class).wrap(this);
}

private static class GHApiInfo {
private String rate_limit_url;

Expand Down
19 changes: 19 additions & 0 deletions src/main/java/org/kohsuke/github/Previews.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,25 @@
* @see <a href="https://developer.github.com/v3/previews/#require-signed-commits">GitHub API Previews</a>
*/
static final String ZZZAX = "application/vnd.github.zzzax-preview+json";

/**
* Manage projects
*
* @see <a href="https://developer.github.com/v3/previews/#projects">GitHub API Previews</a>
*/
static final String INERTIA = "application/vnd.github.inertia-preview+json";

/**
* Manage integrations through the API
*
* @see <a href="https://developer.github.com/v3/previews/#integrations">GitHub API Previews</a>
*/
static final String MACHINE_MAN = "application/vnd.github.machine-man-preview+json";

/**
* Owners of GitHub Apps can now uninstall an app using the Apps API
*
* @see <a href="https://developer.github.com/v3/previews/#uninstall-a-github-app">GitHub API Previews</a>
*/
static final String GAMBIT = "application/vnd.github.gambit-preview+json";
}

0 comments on commit b20c2ba

Please sign in to comment.