Fixed the getReadme() method.

kohsuke · kohsuke · commit 1dbcc4b77659 · 2015-02-15T06:31:22.000-08:00
It was calling the wrong endpoint. Fixed issue hub4j#99.
diff --git a/src/main/java/org/kohsuke/github/GHGist.java b/src/main/java/org/kohsuke/github/GHGist.java
@@ -15,6 +15,7 @@
  * @see GHUser#listGists()
  * @see GitHub#getGist(String)
  * @see GitHub#createGist()
+ * @see <a href="https://developer.github.com/v3/gists/">documentation</a>
  */
 public class GHGist extends GHObject {
     /*package almost final*/ GHUser owner;
diff --git a/src/main/java/org/kohsuke/github/GHRepository.java b/src/main/java/org/kohsuke/github/GHRepository.java
@@ -964,8 +964,12 @@ public List<GHContent> getDirectoryContent(String path, String ref) throws IOExc
         return Arrays.asList(files);
     }
 
-    public GHContent getReadme() throws Exception {
-        return getFileContent("readme");
+    /**
+     * https://developer.github.com/v3/repos/contents/#get-the-readme
+     */
+    public GHContent getReadme() throws IOException {
+        Requester requester = root.retrieve();
+        return requester.to(getApiTailUrl("readme"), GHContent.class).wrap(this);
     }
 
     public GHContentUpdateResponse createContent(String content, String commitMessage, String path) throws IOException {
diff --git a/src/test/java/org/kohsuke/github/AppTest.java b/src/test/java/org/kohsuke/github/AppTest.java
@@ -658,6 +658,13 @@ public void testIssueSearch() throws IOException {
         }
     }
 
+    @Test   // issue #99
+    public void testReadme() throws IOException {
+        GHContent readme = gitHub.getRepository("github-api-test-org/test-readme").getReadme();
+        assertEquals(readme.getName(),"README.md");
+        assertEquals(readme.getContent(),"This is a markdown readme.\n");
+    }
+
     private void kohsuke() {
         String login = getUser().getLogin();
         Assume.assumeTrue(login.equals("kohsuke") || login.equals("kohsuke2"));

Original file line number	Diff line number	Diff line change
`@@ -964,8 +964,12 @@ public List<GHContent> getDirectoryContent(String path, String ref) throws IOExc`
`964`	`964`	`return Arrays.asList(files);`
`965`	`965`	`}`
`966`	`966`
`967`		`- public GHContent getReadme() throws Exception {`
`968`		`- return getFileContent("readme");`
	`967`	`+ /**`
	`968`	`+ * https://developer.github.com/v3/repos/contents/#get-the-readme`
	`969`	`+ */`
	`970`	`+ public GHContent getReadme() throws IOException {`
	`971`	`+ Requester requester = root.retrieve();`
	`972`	`+ return requester.to(getApiTailUrl("readme"), GHContent.class).wrap(this);`
`969`	`973`	`}`
`970`	`974`
`971`	`975`	`public GHContentUpdateResponse createContent(String content, String commitMessage, String path) throws IOException {`
Original file line number	Diff line number	Diff line change
`@@ -658,6 +658,13 @@ public void testIssueSearch() throws IOException {`
`658`	`658`	`}`
`659`	`659`	`}`
`660`	`660`
	`661`	`+ @Test // issue #99`
	`662`	`+ public void testReadme() throws IOException {`
	`663`	`+ GHContent readme = gitHub.getRepository("github-api-test-org/test-readme").getReadme();`
	`664`	`+ assertEquals(readme.getName(),"README.md");`
	`665`	`+ assertEquals(readme.getContent(),"This is a markdown readme.\n");`
	`666`	`+ }`
	`667`	`+`
`661`	`668`	`private void kohsuke() {`
`662`	`669`	`String login = getUser().getLogin();`
`663`	`670`	`Assume.assumeTrue(login.equals("kohsuke") \|\| login.equals("kohsuke2"));`