com.jdroid.github.service.WatcherService Maven / Gradle / Ivy
/******************************************************************************
* Copyright (c) 2011 GitHub Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Kevin Sawicki (GitHub Inc.) - initial API and implementation
*****************************************************************************/
package com.jdroid.github.service;
import static com.jdroid.github.client.IGitHubConstants.SEGMENT_REPOS;
import static com.jdroid.github.client.IGitHubConstants.SEGMENT_USER;
import static com.jdroid.github.client.IGitHubConstants.SEGMENT_USERS;
import static com.jdroid.github.client.IGitHubConstants.SEGMENT_WATCHED;
import static com.jdroid.github.client.IGitHubConstants.SEGMENT_WATCHERS;
import static com.jdroid.github.client.PagedRequest.PAGE_FIRST;
import static com.jdroid.github.client.PagedRequest.PAGE_SIZE;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.util.List;
import com.jdroid.github.IRepositoryIdProvider;
import com.jdroid.github.Repository;
import com.jdroid.github.User;
import com.jdroid.github.client.GitHubClient;
import com.jdroid.github.client.PageIterator;
import com.jdroid.github.client.PagedRequest;
/**
* Service class for dealing with users watching GitHub repositories.
*
* @see GitHub watcher
* API documentation
*/
public class WatcherService extends GitHubService {
/**
* Create watcher service
*/
public WatcherService() {
super();
}
/**
* Create watcher service
*
* @param client
*/
public WatcherService(GitHubClient client) {
super(client);
}
/**
* Create page watcher request
*
* @param repository
* @param start
* @param size
* @return request
*/
protected PagedRequest createWatcherRequest(
IRepositoryIdProvider repository, int start, int size) {
String id = getId(repository);
PagedRequest request = createPagedRequest(start, size);
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(id);
uri.append(SEGMENT_WATCHERS);
request.setUri(uri);
request.setType(new TypeToken>() {
}.getType());
return request;
}
/**
* Get user watching given repository
*
* @param repository
* @return non-null but possibly empty list of users
* @throws IOException
*/
public List getWatchers(IRepositoryIdProvider repository)
throws IOException {
PagedRequest request = createWatcherRequest(repository,
PAGE_FIRST, PAGE_SIZE);
return getAll(request);
}
/**
* Page watches of given repository
*
* @param repository
* @return page iterator
*/
public PageIterator pageWatchers(IRepositoryIdProvider repository) {
return pageWatchers(repository, PAGE_SIZE);
}
/**
* Page watches of given repository
*
* @param repository
* @param size
* @return page iterator
*/
public PageIterator pageWatchers(IRepositoryIdProvider repository,
int size) {
return pageWatchers(repository, PAGE_FIRST, size);
}
/**
* Page watches of given repository
*
* @param repository
* @param start
* @param size
* @return page iterator
*/
public PageIterator pageWatchers(IRepositoryIdProvider repository,
int start, int size) {
PagedRequest request = createWatcherRequest(repository, start,
size);
return createPageIterator(request);
}
/**
* Create page watched request
*
* @param user
* @param start
* @param size
* @return request
*/
protected PagedRequest createWatchedRequest(String user,
int start, int size) {
if (user == null)
throw new IllegalArgumentException("User cannot be null"); //$NON-NLS-1$
if (user.length() == 0)
throw new IllegalArgumentException("User cannot be empty"); //$NON-NLS-1$
PagedRequest request = createPagedRequest(start, size);
StringBuilder uri = new StringBuilder(SEGMENT_USERS);
uri.append('/').append(user);
uri.append(SEGMENT_WATCHED);
request.setUri(uri);
request.setType(new TypeToken>() {
}.getType());
return request;
}
/**
* Create page watched request
*
* @param start
* @param size
* @return request
*/
protected PagedRequest createWatchedRequest(int start, int size) {
PagedRequest request = createPagedRequest(start, size);
request.setUri(SEGMENT_USER + SEGMENT_WATCHED);
request.setType(new TypeToken>() {
}.getType());
return request;
}
/**
* Get repositories watched by the given user
*
* @param user
* @return non-null but possibly empty list of repositories
* @throws IOException
*/
public List getWatched(String user) throws IOException {
PagedRequest request = createWatchedRequest(user,
PAGE_FIRST, PAGE_SIZE);
return getAll(request);
}
/**
* Page repositories being watched by given user
*
* @param user
* @return page iterator
* @throws IOException
*/
public PageIterator pageWatched(String user) throws IOException {
return pageWatched(user, PAGE_SIZE);
}
/**
* Page repositories being watched by given user
*
* @param user
* @param size
* @return page iterator
* @throws IOException
*/
public PageIterator pageWatched(String user, int size)
throws IOException {
return pageWatched(user, PAGE_FIRST, size);
}
/**
* Page repositories being watched by given user
*
* @param user
* @param start
* @param size
* @return page iterator
* @throws IOException
*/
public PageIterator pageWatched(String user, int start, int size)
throws IOException {
PagedRequest request = createWatchedRequest(user, start,
size);
return createPageIterator(request);
}
/**
* Get repositories watched by the currently authenticated user
*
* @return non-null but possibly empty list of repositories
* @throws IOException
*/
public List getWatched() throws IOException {
PagedRequest request = createWatchedRequest(PAGE_FIRST,
PAGE_SIZE);
return getAll(request);
}
/**
* Page repositories being watched by the currently authenticated user
*
* @return page iterator
* @throws IOException
*/
public PageIterator pageWatched() throws IOException {
return pageWatched(PAGE_SIZE);
}
/**
* Page repositories being watched by the currently authenticated user
*
* @param size
* @return page iterator
* @throws IOException
*/
public PageIterator pageWatched(int size) throws IOException {
return pageWatched(PAGE_FIRST, size);
}
/**
* Page repositories being watched by the currently authenticated user
*
* @param start
* @param size
* @return page iterator
* @throws IOException
*/
public PageIterator pageWatched(int start, int size)
throws IOException {
PagedRequest request = createWatchedRequest(start, size);
return createPageIterator(request);
}
/**
* Is currently authenticated user watching given repository?
*
* @param repository
* @return true if watch, false otherwise
* @throws IOException
*/
public boolean isWatching(IRepositoryIdProvider repository)
throws IOException {
String id = getId(repository);
StringBuilder uri = new StringBuilder(SEGMENT_USER);
uri.append(SEGMENT_WATCHED);
uri.append('/').append(id);
return check(uri.toString());
}
/**
* Add currently authenticated user as a watcher of the given repository
*
* @param repository
* @throws IOException
*/
public void watch(IRepositoryIdProvider repository) throws IOException {
String id = getId(repository);
StringBuilder uri = new StringBuilder(SEGMENT_USER);
uri.append(SEGMENT_WATCHED);
uri.append('/').append(id);
client.put(uri.toString());
}
/**
* Remove currently authenticated user as a watcher of the given repository
*
* @param repository
* @throws IOException
*/
public void unwatch(IRepositoryIdProvider repository) throws IOException {
String id = getId(repository);
StringBuilder uri = new StringBuilder(SEGMENT_USER);
uri.append(SEGMENT_WATCHED);
uri.append('/').append(id);
client.delete(uri.toString());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy