Allow "refs/" prefix in parameter to GHRepository.getRef().

Fixes #518.

Author: martinvanzijl

src/main/java/org/kohsuke/github/GHRepository.java

@@ -1559,6 +1559,11 @@ public PagedIterable<GHRef> listRefs(String refType) throws IOException {
      *             on failure communicating with GitHub, potentially due to an invalid ref type being requested
      */
     public GHRef getRef(String refName) throws IOException {
+        // Also accept e.g. "refs/heads/branch" for consistency with createRef().
+        if (refName.startsWith("refs/")) {
+            refName = refName.replaceFirst("refs/", "");
+        }
+
         return root.createRequest()
                 .withUrlPath(getApiTailUrl(String.format("git/refs/%s", refName)))
                 .fetch(GHRef.class)

src/test/java/org/kohsuke/github/GHRepositoryTest.java

@@ -424,6 +424,14 @@ public void listRefs() throws Exception {
         assertThat(refs.get(0).getRef(), equalTo("refs/heads/master"));
     }
 
+    @Test
+    public void getRefWithPrefix() throws Exception {
+        GHRepository repo = getTempRepository();
+        GHRef refWithoutPrefix = repo.getRef("heads/master");
+        GHRef refWithPrefix = repo.getRef("refs/heads/master");
+        assertThat(refWithoutPrefix.getRef(), equalTo(refWithPrefix.getRef()));
+    }
+
     @Test
     public void listRefsHeads() throws Exception {
         GHRepository repo = getTempRepository();

src/test/resources/org/kohsuke/github/GHRepositoryTest/wiremock/addCollaborators/__files/orgs_github-api-test-org-a3d2b552-58b8-4028-b731-d00420496ca8.json

@@ -0,0 +1,126 @@
+{
+  "id": 253282149,
+  "node_id": "MDEwOlJlcG9zaXRvcnkyNTMyODIxNDk=",
+  "name": "temp-getRefWithPrefix",
+  "full_name": "github-api-test-org/temp-getRefWithPrefix",
+  "private": false,
+  "owner": {
+    "login": "github-api-test-org",
+    "id": 7544739,
+    "node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
+    "avatar_url": "https://avatars3.githubusercontent.com/u/7544739?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/github-api-test-org",
+    "html_url": "https://github.com/github-api-test-org",
+    "followers_url": "https://api.github.com/users/github-api-test-org/followers",
+    "following_url": "https://api.github.com/users/github-api-test-org/following{/other_user}",
+    "gists_url": "https://api.github.com/users/github-api-test-org/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/github-api-test-org/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/github-api-test-org/subscriptions",
+    "organizations_url": "https://api.github.com/users/github-api-test-org/orgs",
+    "repos_url": "https://api.github.com/users/github-api-test-org/repos",
+    "events_url": "https://api.github.com/users/github-api-test-org/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/github-api-test-org/received_events",
+    "type": "Organization",
+    "site_admin": false
+  },
+  "html_url": "https://github.com/github-api-test-org/temp-getRefWithPrefix",
+  "description": "A test repository for testing the github-api project: temp-getRefWithPrefix",
+  "fork": false,
+  "url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix",
+  "forks_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/forks",
+  "keys_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/keys{/key_id}",
+  "collaborators_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/collaborators{/collaborator}",
+  "teams_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/teams",
+  "hooks_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/hooks",
+  "issue_events_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/issues/events{/number}",
+  "events_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/events",
+  "assignees_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/assignees{/user}",
+  "branches_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/branches{/branch}",
+  "tags_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/tags",
+  "blobs_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/blobs{/sha}",
+  "git_tags_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/tags{/sha}",
+  "git_refs_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/refs{/sha}",
+  "trees_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/trees{/sha}",
+  "statuses_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/statuses/{sha}",
+  "languages_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/languages",
+  "stargazers_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/stargazers",
+  "contributors_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/contributors",
+  "subscribers_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/subscribers",
+  "subscription_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/subscription",
+  "commits_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/commits{/sha}",
+  "git_commits_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/commits{/sha}",
+  "comments_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/comments{/number}",
+  "issue_comment_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/issues/comments{/number}",
+  "contents_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/contents/{+path}",
+  "compare_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/compare/{base}...{head}",
+  "merges_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/merges",
+  "archive_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/{archive_format}{/ref}",
+  "downloads_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/downloads",
+  "issues_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/issues{/number}",
+  "pulls_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/pulls{/number}",
+  "milestones_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/milestones{/number}",
+  "notifications_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/notifications{?since,all,participating}",
+  "labels_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/labels{/name}",
+  "releases_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/releases{/id}",
+  "deployments_url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/deployments",
+  "created_at": "2020-04-05T16:39:17Z",
+  "updated_at": "2020-04-05T16:39:21Z",
+  "pushed_at": "2020-04-05T16:39:19Z",
+  "git_url": "git://github.com/github-api-test-org/temp-getRefWithPrefix.git",
+  "ssh_url": "[email protected]:github-api-test-org/temp-getRefWithPrefix.git",
+  "clone_url": "https://github.com/github-api-test-org/temp-getRefWithPrefix.git",
+  "svn_url": "https://github.com/github-api-test-org/temp-getRefWithPrefix",
+  "homepage": "http://github-api.kohsuke.org/",
+  "size": 0,
+  "stargazers_count": 0,
+  "watchers_count": 0,
+  "language": null,
+  "has_issues": true,
+  "has_projects": true,
+  "has_downloads": true,
+  "has_wiki": true,
+  "has_pages": false,
+  "forks_count": 0,
+  "mirror_url": null,
+  "archived": false,
+  "disabled": false,
+  "open_issues_count": 0,
+  "license": null,
+  "forks": 0,
+  "open_issues": 0,
+  "watchers": 0,
+  "default_branch": "master",
+  "permissions": {
+    "admin": true,
+    "push": true,
+    "pull": true
+  },
+  "temp_clone_token": "",
+  "allow_squash_merge": true,
+  "allow_merge_commit": true,
+  "allow_rebase_merge": true,
+  "delete_branch_on_merge": false,
+  "organization": {
+    "login": "github-api-test-org",
+    "id": 7544739,
+    "node_id": "MDEyOk9yZ2FuaXphdGlvbjc1NDQ3Mzk=",
+    "avatar_url": "https://avatars3.githubusercontent.com/u/7544739?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/github-api-test-org",
+    "html_url": "https://github.com/github-api-test-org",
+    "followers_url": "https://api.github.com/users/github-api-test-org/followers",
+    "following_url": "https://api.github.com/users/github-api-test-org/following{/other_user}",
+    "gists_url": "https://api.github.com/users/github-api-test-org/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/github-api-test-org/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/github-api-test-org/subscriptions",
+    "organizations_url": "https://api.github.com/users/github-api-test-org/orgs",
+    "repos_url": "https://api.github.com/users/github-api-test-org/repos",
+    "events_url": "https://api.github.com/users/github-api-test-org/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/github-api-test-org/received_events",
+    "type": "Organization",
+    "site_admin": false
+  },
+  "network_count": 0,
+  "subscribers_count": 7
+}

src/test/resources/org/kohsuke/github/GHRepositoryTest/wiremock/addCollaborators/__files/repos_github-api-test-org_github-api-95ce4098-4e40-49f0-8661-0870614d5d78.json

@@ -0,0 +1,10 @@
+{
+  "ref": "refs/heads/master",
+  "node_id": "MDM6UmVmMjUzMjgyMTQ5Om1hc3Rlcg==",
+  "url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/refs/heads/master",
+  "object": {
+    "sha": "6d0ef2a84df4eb5222d9d1ff14203713f1833771",
+    "type": "commit",
+    "url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/commits/6d0ef2a84df4eb5222d9d1ff14203713f1833771"
+  }
+}

src/test/resources/org/kohsuke/github/GHRepositoryTest/wiremock/addCollaborators/__files/user-f20ea960-c1f4-440c-bdc1-a605956a351a.json

@@ -0,0 +1,10 @@
+{
+  "ref": "refs/heads/master",
+  "node_id": "MDM6UmVmMjUzMjgyMTQ5Om1hc3Rlcg==",
+  "url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/refs/heads/master",
+  "object": {
+    "sha": "6d0ef2a84df4eb5222d9d1ff14203713f1833771",
+    "type": "commit",
+    "url": "https://api.github.com/repos/github-api-test-org/temp-getRefWithPrefix/git/commits/6d0ef2a84df4eb5222d9d1ff14203713f1833771"
+  }
+}

src/test/resources/org/kohsuke/github/GHRepositoryTest/wiremock/addCollaborators/__files/users_jimmysombrero-6685376c-451b-486d-88cd-502af9a7c5d1.json

@@ -0,0 +1,33 @@
+{
+  "login": "martinvanzijl",
+  "id": 24422213,
+  "node_id": "MDQ6VXNlcjI0NDIyMjEz",
+  "avatar_url": "https://avatars0.githubusercontent.com/u/24422213?v=4",
+  "gravatar_id": "",
+  "url": "https://api.github.com/users/martinvanzijl",
+  "html_url": "https://github.com/martinvanzijl",
+  "followers_url": "https://api.github.com/users/martinvanzijl/followers",
+  "following_url": "https://api.github.com/users/martinvanzijl/following{/other_user}",
+  "gists_url": "https://api.github.com/users/martinvanzijl/gists{/gist_id}",
+  "starred_url": "https://api.github.com/users/martinvanzijl/starred{/owner}{/repo}",
+  "subscriptions_url": "https://api.github.com/users/martinvanzijl/subscriptions",
+  "organizations_url": "https://api.github.com/users/martinvanzijl/orgs",
+  "repos_url": "https://api.github.com/users/martinvanzijl/repos",
+  "events_url": "https://api.github.com/users/martinvanzijl/events{/privacy}",
+  "received_events_url": "https://api.github.com/users/martinvanzijl/received_events",
+  "type": "User",
+  "site_admin": false,
+  "name": "Martin van Zijl",
+  "company": null,
+  "blog": "",
+  "location": null,
+  "email": null,
+  "hireable": true,
+  "bio": "My strongest language is C++, but I also know C, Java, Python and SQL.",
+  "public_repos": 15,
+  "public_gists": 0,
+  "followers": 3,
+  "following": 0,
+  "created_at": "2016-12-07T00:18:58Z",
+  "updated_at": "2020-04-05T03:19:50Z"
+}