Add API to get commit properties or check if sha is associated with a commit

Author: jcfr

CHANGES.md

@@ -4,14 +4,17 @@ Next Release
 Features (CLI and Python API)
 -----------------------------
 
-
 * ``release`` command:
 
   * ``edit``:
 
     * Add ``--publish`` flag having opposite effect of ``--draft``
     * Add ``--release`` flag having opposite effect of ``--prerelease``
 
+Python API
+----------
+
+* Add ``gh_commit_get`` allowing to commit properties or check if a commit exists.
 
 1.5.6
 =====

github_release.py

@@ -1025,6 +1025,25 @@ def gh_ref_delete(repo_name, pattern, keep_pattern=None, tags=False,
     return len(removed_refs) > 0
 
 
+#
+# Commits
+#
+
+def gh_commit_get(repo_name, sha):
+    try:
+        response = _request(
+            'GET',
+            GITHUB_API + '/repos/{0}/git/commits/{1}'.format(repo_name, sha))
+        response.raise_for_status()
+        return response.json()
+    except requests.exceptions.HTTPError as exc_info:
+        response = exc_info.response
+        if response.status_code == 404:
+            return None
+        else:
+            raise
+
+
 #
 # Script entry point
 #

tests/test_integration_commit.py

@@ -0,0 +1,26 @@
+
+from . import (
+    do_commit,
+    github_token_required,
+    git_user_email_required,
+    git_user_name_required,
+    integration_test_repo_name_required,
+    push_dir,
+    REPO_NAME
+)
+
+import github_release as ghr
+
+
+@git_user_email_required
+@git_user_name_required
+@github_token_required
+@integration_test_repo_name_required
+def test_get(gh_src_dir):
+    with push_dir(gh_src_dir):
+        expected_sha = do_commit(push=True)
+        response = ghr.gh_commit_get(REPO_NAME, expected_sha)
+        assert 'sha' in response
+        assert response['sha'] == expected_sha
+
+        assert ghr.gh_commit_get(REPO_NAME, "invalid") is None