Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Sawicki2012-12-03 16:35:04 -0500
committerKevin Sawicki2013-04-30 11:00:59 -0400
commit76a5242f8971f7649ab44422b5dd11aa9cad3a3a (patch)
tree488e07e5670fe41ca0207706c6ae5b08ebe0f54a
parent7717433453a8572834091cc1a530298a810f1016 (diff)
downloadegit-github-76a5242f8971f7649ab44422b5dd11aa9cad3a3a.tar.gz
egit-github-76a5242f8971f7649ab44422b5dd11aa9cad3a3a.tar.xz
egit-github-76a5242f8971f7649ab44422b5dd11aa9cad3a3a.zip
Add service support for contents API
-rw-r--r--org.eclipse.egit.github.core.tests/META-INF/MANIFEST.MF4
-rw-r--r--org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/AllHeadlessTests.java2
-rw-r--r--org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/ContentsServiceTest.java116
-rw-r--r--org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/RepositoryContentsTest.java53
-rw-r--r--org.eclipse.egit.github.core/META-INF/MANIFEST.MF7
-rw-r--r--org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/RepositoryContents.java156
-rw-r--r--org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubClient.java62
-rw-r--r--org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubRequest.java20
-rw-r--r--org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/IGitHubConstants.java4
-rw-r--r--org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/service/ContentsService.java152
10 files changed, 559 insertions, 17 deletions
diff --git a/org.eclipse.egit.github.core.tests/META-INF/MANIFEST.MF b/org.eclipse.egit.github.core.tests/META-INF/MANIFEST.MF
index 9fefe3d2..fdc29ed4 100644
--- a/org.eclipse.egit.github.core.tests/META-INF/MANIFEST.MF
+++ b/org.eclipse.egit.github.core.tests/META-INF/MANIFEST.MF
@@ -5,8 +5,8 @@ Bundle-SymbolicName: org.eclipse.egit.github.core.tests
Bundle-Version: 2.4.0.qualifier
Bundle-Localization: plugin
Bundle-RequiredExecutionEnvironment: J2SE-1.5
-Import-Package: com.google.gson;version="[1.6.0,2.0.0)",
- com.google.gson.reflect;version="[1.6.0,2.0.0)",
+Import-Package: com.google.gson;version="[1.6.0,2.2.0]",
+ com.google.gson.reflect;version="[1.6.0,2.2.0]",
org.eclipse.egit.github.core;version="[2.4.0,2.5.0)",
org.eclipse.egit.github.core.client;version="[2.4.0,2.5.0)",
org.eclipse.egit.github.core.event;version="[2.4.0,2.5.0)",
diff --git a/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/AllHeadlessTests.java b/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/AllHeadlessTests.java
index 9808ae6c..d6a2c49f 100644
--- a/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/AllHeadlessTests.java
+++ b/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/AllHeadlessTests.java
@@ -32,6 +32,7 @@ import org.junit.runners.Suite.SuiteClasses;
CommitStatusTest.class, //
CommitTest.class, //
CommitUserTest.class, //
+ ContentsServiceTest.class, //
ContributorTest.class, //
DataServiceTest.class, //
DateFormatterTest.class, //
@@ -79,6 +80,7 @@ import org.junit.runners.Suite.SuiteClasses;
RepositoryBranchTest.class, //
RepositoryCommitCompareTest.class, //
RepositoryCommitTest.class, //
+ RepositoryContentsTest.class, //
RepositoryHookResponseTest.class, //
RepositoryHookTest.class, //
RepositoryIdTest.class, //
diff --git a/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/ContentsServiceTest.java b/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/ContentsServiceTest.java
new file mode 100644
index 00000000..a1771446
--- /dev/null
+++ b/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/ContentsServiceTest.java
@@ -0,0 +1,116 @@
+/******************************************************************************
+ * Copyright (c) 2012 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 org.eclipse.egit.github.core.tests;
+
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.verify;
+
+import java.io.IOException;
+
+import org.eclipse.egit.github.core.RepositoryId;
+import org.eclipse.egit.github.core.client.GitHubClient;
+import org.eclipse.egit.github.core.client.GitHubRequest;
+import org.eclipse.egit.github.core.client.GitHubResponse;
+import org.eclipse.egit.github.core.service.ContentsService;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+/**
+ * Unit tests of {@link ContentsService}
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class ContentsServiceTest {
+
+ @Mock
+ private GitHubClient client;
+
+ @Mock
+ private GitHubResponse response;
+
+ private ContentsService service;
+
+ /**
+ * Test case set up
+ *
+ * @throws IOException
+ */
+ @Before
+ public void before() throws IOException {
+ doReturn(response).when(client).get(any(GitHubRequest.class));
+ service = new ContentsService(client);
+ }
+
+ /**
+ * Get readme for null repository
+ *
+ * @throws Exception
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void getReadmeNullRepository() throws Exception {
+ service.getReadme(null);
+ }
+
+ /**
+ * Get readme for repository
+ *
+ * @throws Exception
+ */
+ @Test
+ public void getReadme() throws Exception {
+ RepositoryId repo = new RepositoryId("o", "n");
+ service.getReadme(repo);
+ GitHubRequest request = new GitHubRequest();
+ request.setUri("/repos/o/n/readme");
+ verify(client).get(request);
+ }
+
+ /**
+ * Get contents for null repository
+ *
+ * @throws Exception
+ */
+ @Test(expected = IllegalArgumentException.class)
+ public void getContentsNullRepository() throws Exception {
+ service.getContents(null);
+ }
+
+ /**
+ * Get contents at root in repository
+ *
+ * @throws Exception
+ */
+ @Test
+ public void getRootContents() throws Exception {
+ RepositoryId repo = new RepositoryId("o", "n");
+ service.getContents(repo);
+ GitHubRequest request = new GitHubRequest();
+ request.setUri("/repos/o/n/contents");
+ verify(client).get(request);
+ }
+
+ /**
+ * Get contents at path in repository
+ *
+ * @throws Exception
+ */
+ @Test
+ public void getContents() throws Exception {
+ RepositoryId repo = new RepositoryId("o", "n");
+ service.getContents(repo, "a/b");
+ GitHubRequest request = new GitHubRequest();
+ request.setUri("/repos/o/n/contents/a/b");
+ verify(client).get(request);
+ }
+}
diff --git a/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/RepositoryContentsTest.java b/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/RepositoryContentsTest.java
new file mode 100644
index 00000000..5568ed38
--- /dev/null
+++ b/org.eclipse.egit.github.core.tests/src/org/eclipse/egit/github/core/tests/RepositoryContentsTest.java
@@ -0,0 +1,53 @@
+/******************************************************************************
+ * Copyright (c) 2012 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 org.eclipse.egit.github.core.tests;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+
+import org.eclipse.egit.github.core.RepositoryContents;
+import org.junit.Test;
+
+/**
+ * Unit tests of {@link RepositoryContents}
+ */
+public class RepositoryContentsTest {
+
+ /**
+ * Test default state of contents
+ */
+ @Test
+ public void defaultState() {
+ RepositoryContents contents = new RepositoryContents();
+ assertNull(contents.getContent());
+ assertNull(contents.getEncoding());
+ assertNull(contents.getName());
+ assertNull(contents.getPath());
+ assertNull(contents.getSha());
+ assertEquals(0, contents.getSize());
+ assertNull(contents.getType());
+ }
+
+ /**
+ * Test updating contents fields
+ */
+ @Test
+ public void updateFields() {
+ RepositoryContents contents = new RepositoryContents();
+ assertEquals("abc", contents.setContent("abc").getContent());
+ assertEquals("64", contents.setEncoding("64").getEncoding());
+ assertEquals("file.txt", contents.setName("file.txt").getName());
+ assertEquals("a/b", contents.setPath("a/b").getPath());
+ assertEquals("abcdef", contents.setSha("abcdef").getSha());
+ assertEquals(12345, contents.setSize(12345).getSize());
+ assertEquals("dir", contents.setType("dir").getType());
+ }
+}
diff --git a/org.eclipse.egit.github.core/META-INF/MANIFEST.MF b/org.eclipse.egit.github.core/META-INF/MANIFEST.MF
index 05bb4c9e..5d9de7c2 100644
--- a/org.eclipse.egit.github.core/META-INF/MANIFEST.MF
+++ b/org.eclipse.egit.github.core/META-INF/MANIFEST.MF
@@ -6,9 +6,10 @@ Bundle-SymbolicName: org.eclipse.egit.github.core
Bundle-Version: 2.4.0.qualifier
Bundle-Vendor: %providerName
Bundle-RequiredExecutionEnvironment: J2SE-1.5
-Import-Package: com.google.gson;version="[1.6.0,2.2.0)",
- com.google.gson.annotations;version="[1.6.0,2.2.0)",
- com.google.gson.reflect;version="[1.6.0,2.2.0)"
+Import-Package: com.google.gson;version="[1.6.0,2.2.0]",
+ com.google.gson.annotations;version="[1.6.0,2.2.0]",
+ com.google.gson.reflect;version="[1.6.0,2.2.0]",
+ com.google.gson.stream;version="[1.6.0,2.2.0]
Export-Package: org.eclipse.egit.github.core;version="2.4.0",
org.eclipse.egit.github.core.client;version="2.4.0",
org.eclipse.egit.github.core.event;version="2.4.0",
diff --git a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/RepositoryContents.java b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/RepositoryContents.java
new file mode 100644
index 00000000..f5527fe7
--- /dev/null
+++ b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/RepositoryContents.java
@@ -0,0 +1,156 @@
+/******************************************************************************
+ * Copyright (c) 2012 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 org.eclipse.egit.github.core;
+
+import java.io.Serializable;
+
+/**
+ * Contents of a path in a repository
+ */
+public class RepositoryContents implements Serializable {
+
+ private static final long serialVersionUID = -70974727412738287L;
+
+ /** ENCODING_BASE64 */
+ public static final String ENCODING_BASE64 = "base64"; //$NON-NLS-1$
+
+ /** TYPE_FILE */
+ public static final String TYPE_FILE = "file"; //$NON-NLS-1$
+
+ /** TYPE_DIR */
+ public static final String TYPE_DIR = "dir"; //$NON-NLS-1$
+
+ private long size;
+
+ private String content;
+
+ private String encoding;
+
+ private String name;
+
+ private String path;
+
+ private String sha;
+
+ private String type;
+
+ /**
+ * @return size
+ */
+ public long getSize() {
+ return size;
+ }
+
+ /**
+ * @param size
+ * @return this contents
+ */
+ public RepositoryContents setSize(long size) {
+ this.size = size;
+ return this;
+ }
+
+ /**
+ * @return content
+ */
+ public String getContent() {
+ return content;
+ }
+
+ /**
+ * @param content
+ * @return this contents
+ */
+ public RepositoryContents setContent(String content) {
+ this.content = content;
+ return this;
+ }
+
+ /**
+ * @return encoding
+ */
+ public String getEncoding() {
+ return encoding;
+ }
+
+ /**
+ * @param encoding
+ * @return this contents
+ */
+ public RepositoryContents setEncoding(String encoding) {
+ this.encoding = encoding;
+ return this;
+ }
+
+ /**
+ * @return name
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * @param name
+ * @return this contents
+ */
+ public RepositoryContents setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ /**
+ * @return path
+ */
+ public String getPath() {
+ return path;
+ }
+
+ /**
+ * @param path
+ * @return this contents
+ */
+ public RepositoryContents setPath(String path) {
+ this.path = path;
+ return this;
+ }
+
+ /**
+ * @return type
+ */
+ public String getType() {
+ return type;
+ }
+
+ /**
+ * @param type
+ * @return this contents
+ */
+ public RepositoryContents setType(String type) {
+ this.type = type;
+ return this;
+ }
+
+ /**
+ * @return sha
+ */
+ public String getSha() {
+ return sha;
+ }
+
+ /**
+ * @param sha
+ * @return this contents
+ */
+ public RepositoryContents setSha(String sha) {
+ this.sha = sha;
+ return this;
+ }
+}
diff --git a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubClient.java b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubClient.java
index ea8359e5..a5c1fe48 100644
--- a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubClient.java
+++ b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubClient.java
@@ -11,6 +11,7 @@
*******************************************************************************/
package org.eclipse.egit.github.core.client;
+import static com.google.gson.stream.JsonToken.BEGIN_ARRAY;
import static java.net.HttpURLConnection.HTTP_ACCEPTED;
import static java.net.HttpURLConnection.HTTP_BAD_REQUEST;
import static java.net.HttpURLConnection.HTTP_CONFLICT;
@@ -33,6 +34,7 @@ import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_V3_AP
import com.google.gson.Gson;
import com.google.gson.JsonParseException;
+import com.google.gson.stream.JsonReader;
import java.io.BufferedOutputStream;
import java.io.BufferedReader;
@@ -398,20 +400,56 @@ public class GitHubClient {
* @throws IOException
*/
protected <V> V parseJson(InputStream stream, Type type) throws IOException {
+ return parseJson(stream, type, null);
+ }
+
+ /**
+ * Parse JSON to specified type
+ *
+ * @param <V>
+ * @param stream
+ * @param type
+ * @param listType
+ * @return parsed type
+ * @throws IOException
+ */
+ protected <V> V parseJson(InputStream stream, Type type, Type listType)
+ throws IOException {
BufferedReader reader = new BufferedReader(new InputStreamReader(
stream, CHARSET_UTF8), bufferSize);
- try {
- return gson.fromJson(reader, type);
- } catch (JsonParseException jpe) {
- IOException ioe = new IOException(
- "Parse exception converting JSON to object"); //$NON-NLS-1$
- ioe.initCause(jpe);
- throw ioe;
- } finally {
+ if (listType == null)
try {
- reader.close();
- } catch (IOException ignored) {
- // Ignored
+ return gson.fromJson(reader, type);
+ } catch (JsonParseException jpe) {
+ IOException ioe = new IOException(
+ "Parse exception converting JSON to object"); //$NON-NLS-1$
+ ioe.initCause(jpe);
+ throw ioe;
+ } finally {
+ try {
+ reader.close();
+ } catch (IOException ignored) {
+ // Ignored
+ }
+ }
+ else {
+ JsonReader jsonReader = new JsonReader(reader);
+ try {
+ if (jsonReader.peek() == BEGIN_ARRAY)
+ return gson.fromJson(jsonReader, listType);
+ else
+ return gson.fromJson(jsonReader, type);
+ } catch (JsonParseException jpe) {
+ IOException ioe = new IOException(
+ "Parse exception converting JSON to object"); //$NON-NLS-1$
+ ioe.initCause(jpe);
+ throw ioe;
+ } finally {
+ try {
+ jsonReader.close();
+ } catch (IOException ignored) {
+ // Ignored
+ }
}
}
}
@@ -488,7 +526,7 @@ public class GitHubClient {
throws IOException {
Type type = request.getType();
if (type != null)
- return parseJson(stream, type);
+ return parseJson(stream, type, request.getArrayType());
else
return null;
}
diff --git a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubRequest.java b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubRequest.java
index e4edca46..23502747 100644
--- a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubRequest.java
+++ b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/GitHubRequest.java
@@ -32,6 +32,8 @@ public class GitHubRequest {
private String responseContentType;
+ private Type arrayType;
+
/**
* Create empty request
*/
@@ -40,6 +42,24 @@ public class GitHubRequest {
}
/**
+ * Set type to expect if first token is a beginning of an array
+ *
+ * @param arrayType
+ * @return this request
+ */
+ public GitHubRequest setArrayType(Type arrayType) {
+ this.arrayType = arrayType;
+ return this;
+ }
+
+ /**
+ * @return arrayType
+ */
+ public Type getArrayType() {
+ return arrayType;
+ }
+
+ /**
* @return uri
*/
public String getUri() {
diff --git a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/IGitHubConstants.java b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/IGitHubConstants.java
index 8ff5a476..83dc0206 100644
--- a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/IGitHubConstants.java
+++ b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/client/IGitHubConstants.java
@@ -83,6 +83,8 @@ public interface IGitHubConstants {
/** */
String SEGMENT_COMMENTS = "/comments"; //$NON-NLS-1$
/** */
+ String SEGMENT_CONTENTS= "/contents"; //$NON-NLS-1$
+ /** */
String SEGMENT_CONTRIBUTORS = "/contributors"; //$NON-NLS-1$
/** */
String SEGMENT_COMMITS = "/commits"; //$NON-NLS-1$
@@ -143,6 +145,8 @@ public interface IGitHubConstants {
/** */
String SEGMENT_PULLS = "/pulls"; //$NON-NLS-1$
/** */
+ String SEGMENT_README = "/readme"; //$NON-NLS-1$
+ /** */
String SEGMENT_RECEIVED_EVENTS = "/received_events"; //$NON-NLS-1$
/** */
String SEGMENT_REFS = "/refs"; //$NON-NLS-1$
diff --git a/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/service/ContentsService.java b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/service/ContentsService.java
new file mode 100644
index 00000000..02326f5f
--- /dev/null
+++ b/org.eclipse.egit.github.core/src/org/eclipse/egit/github/core/service/ContentsService.java
@@ -0,0 +1,152 @@
+/******************************************************************************
+ * 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 org.eclipse.egit.github.core.service;
+
+import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_CONTENTS;
+import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_README;
+import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_REPOS;
+
+import com.google.gson.reflect.TypeToken;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+
+import org.eclipse.egit.github.core.IRepositoryIdProvider;
+import org.eclipse.egit.github.core.RepositoryContents;
+import org.eclipse.egit.github.core.client.GitHubClient;
+import org.eclipse.egit.github.core.client.GitHubRequest;
+
+/**
+ * Service for accessing repository contents
+ *
+ * @see <a href="http://developer.github.com/v3/repos/contents">GitHub contents
+ * API documentation</a>
+ */
+public class ContentsService extends GitHubService {
+
+ /**
+ * Create contents service
+ */
+ public ContentsService() {
+ super();
+ }
+
+ /**
+ * Create contents service
+ *
+ * @param client
+ */
+ public ContentsService(final GitHubClient client) {
+ super(client);
+ }
+
+ /**
+ * Get repository README
+ *
+ * @param repository
+ * @return README
+ * @throws Exception
+ */
+ public RepositoryContents getReadme(IRepositoryIdProvider repository)
+ throws Exception {
+ return getReadme(repository, null);
+ }
+
+ /**
+ * Get repository README
+ *
+ * @param repository
+ * @param ref
+ * @return README
+ * @throws IOException
+ */
+ public RepositoryContents getReadme(IRepositoryIdProvider repository,
+ String ref) throws IOException {
+ String id = getId(repository);
+
+ StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
+ uri.append('/').append(id);
+ uri.append(SEGMENT_README);
+ GitHubRequest request = createRequest();
+ request.setUri(uri);
+ if (ref != null && ref.length() > 0)
+ request.setParams(Collections.singletonMap("ref", ref));
+ request.setType(RepositoryContents.class);
+ return (RepositoryContents) client.get(request).getBody();
+ }
+
+ /**
+ * Get contents at the root of the given repository on master branch
+ *
+ * @param repository
+ * @return list of contents at root
+ * @throws IOException
+ */
+ public List<RepositoryContents> getContents(IRepositoryIdProvider repository)
+ throws IOException {
+ return getContents(repository, null);
+ }
+
+ /**
+ * Get contents at path in the given repository on master branch
+ *
+ * @param repository
+ * @param path
+ * @return list of contents at path
+ * @throws IOException
+ */
+ public List<RepositoryContents> getContents(
+ IRepositoryIdProvider repository, String path) throws IOException {
+ return getContents(repository, path, null);
+ }
+
+ /**
+ * Get contents of path at reference in given repository
+ * <p>
+ * For file paths this will return a list with one entry corresponding to
+ * the file contents at the given path
+ *
+ * @param repository
+ * @param path
+ * @param ref
+ * @return list of contents at path
+ * @throws IOException
+ */
+ @SuppressWarnings("unchecked")
+ public List<RepositoryContents> getContents(
+ IRepositoryIdProvider repository, String path, String ref)
+ throws IOException {
+ String id = getId(repository);
+
+ StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
+ uri.append('/').append(id);
+ uri.append(SEGMENT_CONTENTS);
+ if (path != null && path.length() > 0) {
+ if (path.charAt(0) != '/')
+ uri.append('/');
+ uri.append(path);
+ }
+ GitHubRequest request = createRequest();
+ request.setUri(uri);
+ request.setType(RepositoryContents.class);
+ request.setArrayType(new TypeToken<List<RepositoryContents>>() {
+ }.getType());
+ if (ref != null && ref.length() > 0)
+ request.setParams(Collections.singletonMap("ref", ref));
+
+ Object body = client.get(request).getBody();
+ if (body instanceof RepositoryContents)
+ return Collections.singletonList((RepositoryContents) body);
+ else
+ return (List<RepositoryContents>) body;
+ }
+}

Back to the top