1.2.0 (#1)

* ## 1.2.0

* Add new ``github.get_contents`` action which allows user to retrieve file and repository contents.
* Add new ``github.create_file`` action which allows user to create new files in repositories.
* Add new ``github.update_file`` action which allows user to update existing files in repositories.
* Bump libs version in requirements.txt

* fix typo

* token/password must be secret in pack's config

* fixing config schema's default token reference to datastore

* changelog update

* config schema update

Author: igcherkaev

CHANGES.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.2.0
+
+__IMPORTANT__: Configuration scheme changed to mark token and password as secret, if you were using st2 datastore, you might need to encrypt the values!
+ 
+* Add new ``github.get_contents`` action which allows user to retrieve file and repository contents.
+* Add new ``github.create_file`` action which allows user to create new files in repositories.
+* Add new ``github.update_file`` action which allows user to update existing files in repositories.
+* Bump libs version in requirements.txt
+
 ## 1.1.0
 
 * Add new ``github.get_pull`` action which allows user to retrieve details about

README.md

@@ -107,6 +107,9 @@ StackStorm webhook handler.
 * ``list_pulls`` - List all pull requests for a particular repo.
 * ``review_pull`` - Create a review for the provided pull request.
 * ``merge_pull`` - Merge the provided pull request.
+* ``get_contents`` - Get repository or file contents.
+* ``create_file`` - Create new file.
+* ``update_file`` - Update existing file.
 
 ## Rules
 

actions/create_file.py

@@ -0,0 +1,39 @@
+from lib.base import BaseGithubAction
+from lib.formatters import file_response_to_dict
+from github.GithubObject import NotSet
+
+__all__ = [
+    'CreateFileAction'
+]
+
+
+class CreateFileAction(BaseGithubAction):
+    def run(self, user, repo, path, message, content, branch=None, committer=None, author=None):
+        if not branch:
+            branch = NotSet
+        if not committer:
+            committer = NotSet
+        if not author:
+            author = NotSet
+
+        user = self._client.get_user(user)
+        repo = user.get_repo(repo)
+        api_response = repo.create_file(path=path, message=message, content=content, branch=branch,
+                                        committer=committer, author=author)
+        result = file_response_to_dict(api_response)
+        return result
+
+
+if __name__ == '__main__':
+    import os
+    GITHUB_TOKEN = os.environ.get('GITHUB_TOKEN')
+    GITHUB_ORG = os.environ.get('GITHUB_ORG')
+    GITHUB_REPO = os.environ.get('GITHUB_REPO')
+
+    act = CreateFileAction(config={'token': GITHUB_TOKEN, 'github_type': 'online'})
+    res = act.run(user=GITHUB_ORG, repo=GITHUB_REPO, path='README5.md', message='Test commit',
+                  content='Super duper read me file, pushed from Stackstorm github pack!\n',
+                  branch='branch1')
+    import pprint
+    pp = pprint.PrettyPrinter(indent=4)
+    pp.pprint(res)

actions/create_file.yaml

@@ -0,0 +1,39 @@
+---
+name: create_file
+runner_type: python-script
+description: Create a file in this repository.
+enabled: true
+entry_point: create_file.py
+parameters:
+  user:
+    type: "string"
+    description: "User / organization name."
+    required: true
+  repo:
+    type: "string"
+    description: "Repository name."
+    required: true
+  path:
+    type: "string"
+    description: "Path of the file in the repository."
+    required: true
+  message:
+    type: "string"
+    description: "Commit message."
+    required: true
+  content:
+    type: "string"
+    description: "The actual data in the file."
+    required: true
+  branch:
+    type: "string"
+    description: "Branch to create the commit on. Defaults to the default branch of the repository"
+    required: false
+  committer:
+    type: "string"
+    description: "If no information is given the authenticated user's information will be used. You must specify both a name and email."
+    required: false
+  author:
+    type: "string"
+    description: "If omitted this will be filled in with committer information. If passed, you must specify both a name and email."
+    required: false

actions/get_contents.py

@@ -0,0 +1,29 @@
+from lib.base import BaseGithubAction
+from lib.formatters import contents_to_dict
+
+__all__ = [
+    'GetContentsAction'
+]
+
+
+class GetContentsAction(BaseGithubAction):
+    def run(self, user, repo, ref, path, decode=False):
+
+        user = self._client.get_user(user)
+        repo = user.get_repo(repo)
+        contents = repo.get_contents(path, ref=ref)
+        result = contents_to_dict(contents=contents, decode=decode)
+        return result
+
+
+if __name__ == '__main__':
+    import os
+    GITHUB_TOKEN = os.environ.get('GITHUB_TOKEN')
+    GITHUB_ORG = os.environ.get('GITHUB_ORG')
+    GITHUB_REPO = os.environ.get('GITHUB_REPO')
+
+    act = GetContentsAction(config={'token': GITHUB_TOKEN, 'github_type': 'online'})
+    res = act.run(user=GITHUB_ORG, repo=GITHUB_REPO, ref='branch1', path='README.md', decode=True)
+    import pprint
+    pp = pprint.PrettyPrinter(indent=4)
+    pp.pprint(res)

actions/get_contents.yaml

@@ -0,0 +1,29 @@
+---
+name: get_contents
+runner_type: python-script
+description: Gets the contents of a file or directory in a repository.
+enabled: true
+entry_point: get_contents.py
+parameters:
+  user:
+    type: "string"
+    description: "User / organization name."
+    required: true
+  repo:
+    type: "string"
+    description: "Repository name."
+    required: true
+  ref:
+    type: "string"
+    description: "Git ref."
+    required: false
+    default: "HEAD"
+  path:
+    type: "string"
+    description: "Path to file."
+    required: true
+  decode:
+    type: boolean
+    description: "Decode content."
+    required: false
+    default: false

actions/lib/base.py

@@ -18,6 +18,9 @@
 
 
 class BaseGithubAction(Action):
+    def run(self, **kwargs):
+        pass
+
     def __init__(self, config):
         super(BaseGithubAction, self).__init__(config=config)
         token = self.config.get('token', None)
@@ -36,7 +39,7 @@ def __init__(self, config):
         self._session = requests.Session()
 
     def _web_session(self, web_url=DEFAULT_WEB_URL):
-        '''Returns a requests session to scrape off the web'''
+        """Returns a requests session to scrape off the web"""
         login_url = web_url + '/login'
         session = requests.Session()
         request = session.get(login_url).text
@@ -94,7 +97,7 @@ def _get_user_token(self, user, enterprise):
         token = self.action_service.get_value(token_name + user)
 
         # if a token is not returned, try using reversing changes made by
-        # GitHub Enterpise during LDAP sync'ing.
+        # GitHub Enterprise during LDAP sync'ing.
         if token is None:
             token = self.action_service.get_value(
                 token_name + user.replace("-", "."))
@@ -119,6 +122,7 @@ def _request(self, method, uri, payload, token, enterprise):
         else:
             url = "{}{}".format(DEFAULT_API_URL, uri)
 
+        r = None
         try:
             r = self._session.request(method,
                                       url,

actions/lib/formatters.py

@@ -7,7 +7,9 @@
     'pull_to_dict',
     'commit_to_dict',
     'label_to_dict',
-    'user_to_dict'
+    'user_to_dict',
+    'contents_to_dict',
+    'file_response_to_dict'
 ]
 
 
@@ -75,6 +77,7 @@ def pull_to_dict(pull):
     result['head'] = pull.head.ref
     result['state'] = pull.state
     result['merged'] = pull.merged
+    # noinspection SpellCheckingInspection
     result['mergeable_state'] = pull.mergeable_state
     result['merge_commit_sha'] = pull.merge_commit_sha
 
@@ -116,36 +119,93 @@ def pull_to_dict(pull):
 
 
 def commit_to_dict(commit):
-    result = {}
-    result['sha'] = commit.sha
+    result = {'sha': commit.sha}
     return result
 
 
 def label_to_dict(label):
-    result = {}
+    result = {'name': label.name, 'color': label.color, 'url': label.url}
 
-    result['name'] = label.name
-    result['color'] = label.color
-    result['url'] = label.url
     return result
 
 
 def user_to_dict(user):
     if not user:
         return None
 
-    result = {}
-    result['name'] = user.name
-    result['login'] = user.login
+    result = {'name': user.name, 'login': user.login}
     return result
 
 
 def team_to_dict(team):
     if not team:
         return None
 
-    result = {}
-    result['id'] = team.id
-    result['name'] = team.name
-    result['members_count'] = team.members_count
+    result = {'id': team.id, 'name': team.name, 'members_count': team.members_count}
+    return result
+
+
+def contents_to_dict(contents, decode=False):
+    if not contents:
+        return None
+
+    directory = False
+    if isinstance(contents, list):
+        directory = True
+    else:
+        contents = [contents]
+
+    result = []
+    data = {}
+
+    for item in contents:
+        item_type = item.type
+        data['type'] = item_type
+        if item_type == 'symlink':
+            data['target'] = item.target
+        elif item_type == 'submodule':
+            data['submodule_git_url'] = item.submodule_git_url
+        elif not directory:
+            encoding = item.encoding
+            content = item.content
+            data['encoding'] = encoding
+            if decode and encoding == 'base64':
+                content = decode_base64(content)
+            data['content'] = content
+
+        data['size'] = item.size
+        data['name'] = item.name
+        data['path'] = item.path
+        data['sha'] = item.sha
+        data['url'] = item.url
+        data['git_url'] = item.git_url
+        data['html_url'] = item.html_url
+        data['download_url'] = item.download_url
+        result.append(data)
+
+    if not directory:
+        return result[0]
+    else:
+        return result
+
+
+def decode_base64(data):
+    """Decode base64, padding being optional.
+
+    :param data: Base64 data as an ASCII byte string
+    :returns: The decoded byte string.
+
+    """
+    missing_padding = len(data) % 4
+    if missing_padding != 0:
+        data += b'=' * (4 - missing_padding)
+
+    import base64
+    data = data.encode("utf-8")
+    data = base64.b64decode(data).decode("utf-8")
+    return data
+
+
+def file_response_to_dict(response):
+    result = {'commit': response['commit'].sha}
     return result

actions/update_file.py

@@ -0,0 +1,42 @@
+from lib.base import BaseGithubAction
+from lib.formatters import file_response_to_dict
+from github.GithubObject import NotSet
+
+__all__ = [
+    'UpdateFileAction'
+]
+
+
+class UpdateFileAction(BaseGithubAction):
+    def run(self, user, repo, path, message, content, sha, branch=None, committer=None,
+            author=None):
+        if not branch:
+            branch = NotSet
+        if not committer:
+            committer = NotSet
+        if not author:
+            author = NotSet
+
+        user = self._client.get_user(user)
+        repo = user.get_repo(repo)
+        api_response = repo.update_file(path=path, message=message, content=content, sha=sha,
+                                        branch=branch, committer=committer, author=author)
+        result = file_response_to_dict(api_response)
+        return result
+
+
+if __name__ == '__main__':
+    import os
+    GITHUB_TOKEN = os.environ.get('GITHUB_TOKEN')
+    GITHUB_ORG = os.environ.get('GITHUB_ORG')
+    GITHUB_REPO = os.environ.get('GITHUB_REPO')
+
+    act = UpdateFileAction(config={'token': GITHUB_TOKEN, 'github_type': 'online'})
+    res = act.run(user=GITHUB_ORG, repo=GITHUB_REPO, path='README.md', message='Test commit',
+                  content='Super duper read me file, pushed from Stackstorm github pack!\n'
+                          '##new lines added!\n\n*YES*\n',
+                  sha='10ddd6d257e01349d514541981aeecea6b2e741d',
+                  branch='branch1')
+    import pprint
+    pp = pprint.PrettyPrinter(indent=4)
+    pp.pprint(res)