/* * The MIT License * * Copyright (c) 2010, Kohsuke Kawaguchi * * 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 com.infradna.tool.bridge_method_injector.WithBridgeMethods; import java.io.IOException; import java.util.*; /** * Represents an user of GitHub. * * @author Kohsuke Kawaguchi */ public class GHUser extends GHPerson { /** * Gets keys. * * @return the keys * @throws IOException * the io exception */ public List getKeys() throws IOException { return Collections.unmodifiableList( Arrays.asList(root.createRequest().withUrlPath(getApiTailUrl("keys")).fetchArray(GHKey[].class))); } /** * Follow this user. * * @throws IOException * the io exception */ public void follow() throws IOException { root.createRequest().method("PUT").withUrlPath("/user/following/" + login).send(); } /** * Unfollow this user. * * @throws IOException * the io exception */ public void unfollow() throws IOException { root.createRequest().method("DELETE").withUrlPath("/user/following/" + login).send(); } /** * Lists the users that this user is following * * @return the follows * @throws IOException * the io exception */ @WithBridgeMethods(Set.class) public GHPersonSet getFollows() throws IOException { return new GHPersonSet(listFollows().asList()); } /** * Lists the users that this user is following * * @return the paged iterable */ public PagedIterable listFollows() { return listUser("following"); } /** * Lists the users who are following this user. * * @return the followers * @throws IOException * the io exception */ @WithBridgeMethods(Set.class) public GHPersonSet getFollowers() throws IOException { return new GHPersonSet(listFollowers().asList()); } /** * Lists the users who are following this user. * * @return the paged iterable */ public PagedIterable listFollowers() { return listUser("followers"); } private PagedIterable listUser(final String suffix) { return root.createRequest() .withUrlPath(getApiTailUrl(suffix)) .toIterable(GHUser[].class, item -> item.wrapUp(root)); } /** * Lists all the subscribed (aka watched) repositories. *

* https://developer.github.com/v3/activity/watching/ * * @return the paged iterable */ public PagedIterable listSubscriptions() { return listRepositories("subscriptions"); } /** * Lists all the repositories that this user has starred. * * @return the paged iterable */ public PagedIterable listStarredRepositories() { return listRepositories("starred"); } private PagedIterable listRepositories(final String suffix) { return root.createRequest() .withUrlPath(getApiTailUrl(suffix)) .toIterable(GHRepository[].class, item -> item.wrap(root)); } /** * Returns true if this user belongs to the specified organization. * * @param org * the org * @return the boolean */ public boolean isMemberOf(GHOrganization org) { return org.hasMember(this); } /** * Returns true if this user belongs to the specified team. * * @param team * the team * @return the boolean */ public boolean isMemberOf(GHTeam team) { return team.hasMember(this); } /** * Returns true if this user belongs to the specified organization as a public member. * * @param org * the org * @return the boolean */ public boolean isPublicMemberOf(GHOrganization org) { return org.hasPublicMember(this); } static GHUser[] wrap(GHUser[] users, GitHub root) { for (GHUser f : users) f.root = root; return users; } /** * Gets the organization that this user belongs to publicly. * * @return the organizations * @throws IOException * the io exception */ @WithBridgeMethods(Set.class) public GHPersonSet getOrganizations() throws IOException { GHPersonSet orgs = new GHPersonSet(); Set names = new HashSet(); for (GHOrganization o : root.createRequest() .withUrlPath("/users/" + login + "/orgs") .fetchArray(GHOrganization[].class)) { if (names.add(o.getLogin())) // I've seen some duplicates in the data orgs.add(root.getOrganization(o.getLogin())); } return orgs; } /** * Lists events performed by a user (this includes private events if the caller is authenticated. */ public PagedIterable listEvents() throws IOException { return root.createRequest() .withUrlPath(String.format("/users/%s/events", login)) .toIterable(GHEventInfo[].class, item -> item.wrapUp(root)); } /** * Lists Gists created by this user. * * @return the paged iterable * @throws IOException * the io exception */ public PagedIterable listGists() throws IOException { return root.createRequest() .withUrlPath(String.format("/users/%s/gists", login)) .toIterable(GHGist[].class, item -> item.wrapUp(this)); } @Override public int hashCode() { return login.hashCode(); } @Override public boolean equals(Object obj) { if (obj instanceof GHUser) { GHUser that = (GHUser) obj; return this.login.equals(that.login); } return false; } String getApiTailUrl(String tail) { if (tail.length() > 0 && !tail.startsWith("/")) tail = '/' + tail; return "/users/" + login + tail; } GHUser wrapUp(GitHub root) { super.wrapUp(root); return this; } }