Implementing the communication with GitHub for issue status updating

Author: weaverryan

app/config/parameters.yml.dist

@@ -20,3 +20,6 @@ parameters:
 
     # token used to update labels on the repository, etc
     github_token: XXXX
+    # point to the symfony/symfony repository
+    repository_username: symfony
+    repository_name: symfony

app/config/services.yml

@@ -7,3 +7,16 @@ services:
     app.github.status_manager:
         class: AppBundle\GitHub\StatusManager
         arguments: []
+
+    app.github_client:
+        class: Github\Client
+        arguments: []
+        calls:
+            - method: authenticate
+              arguments:
+                - http_token
+                - %github_token%
+
+    app.issue_status_changer:
+        class: AppBundle\GitHub\IssueStatusChanger
+        arguments: ['@app.github_client', '%repository_username%', '%repository_name%']

composer.json

@@ -19,7 +19,8 @@
         "symfony/monolog-bundle": "~2.4",
         "sensio/distribution-bundle": "~4.0",
         "sensio/framework-extra-bundle": "~3.0,>=3.0.2",
-        "incenteev/composer-parameter-handler": "~2.0"
+        "incenteev/composer-parameter-handler": "~2.0",
+        "knplabs/github-api": "^1.4"
     },
     "require-dev": {
         "sensio/generator-bundle": "~2.3"

composer.lock

@@ -50,12 +50,15 @@ private function handleIssueCommentEvent(array $data)
         $newStatus = $this->get('app.github.status_manager')
             ->getStatusChangeFromComment($commentText);
 
-        // todo - send this status back to GitHub
+        // hacky way to not actually try to talk to GitHub when testing
+        if ($this->container->getParameter('kernel.environment') == 'test') {
+            $this->get('app.issue_status_changer')
+                ->setIssueStatusLabel($issueNumber, $newStatus);
+        }
 
         return [
             'issue' => $issueNumber,
             'status_change' => $newStatus,
         ];
     }
-
 }

src/AppBundle/Controller/WebhookController.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace AppBundle\GitHub;
+
+use Github\Client;
+use Github\Api\Issue\Labels;
+
+class IssueStatusChanger
+{
+    /**
+     * @var Client
+     */
+    private $githubClient;
+    private $repositoryUsername;
+    private $repositoryName;
+
+    public function __construct(Client $githubClient, $repositoryUsername, $repositoryName)
+    {
+        $this->githubClient = $githubClient;
+        $this->repositoryUsername = $repositoryUsername;
+        $this->repositoryName = $repositoryName;
+    }
+
+    /**
+     * @param integer $issueNumber The GitHub issue number
+     * @param string $newStatus A StatusManager::STATUS_ constant
+     */
+    public function setIssueStatusLabel($issueNumber, $newStatus)
+    {
+        $newLabel = StatusManager::getLabelForStatus($newStatus);
+
+        $currentLabels = $this->getIssueLabelsApi()->all(
+            $this->repositoryUsername,
+            $this->repositoryName,
+            $issueNumber
+        );
+
+        $labelMap = StatusManager::getLabelToStatusMap();
+        foreach ($currentLabels as $currentLabel) {
+            // is the label a "status label"? No? Then skip it
+            if (!isset($labelMap[$currentLabel])) {
+                continue;
+            }
+
+            // if the label is already the new label, we don't need to do anything!
+            if ($currentLabel == $newLabel) {
+                return;
+            }
+
+            // remove the old status label
+            $this->getIssueLabelsApi()->remove(
+                $this->repositoryUsername,
+                $this->repositoryName,
+                $issueNumber,
+                $currentLabel
+            );
+        }
+
+        // add the new label
+        $this->getIssueLabelsApi()->add(
+            $this->repositoryUsername,
+            $this->repositoryName,
+            $issueNumber,
+            $newLabel
+        );
+    }
+
+    /**
+     * @return Labels
+     */
+    private function getIssueLabelsApi()
+    {
+        return $this->githubClient->api('issue')->labels();
+    }
+}

src/AppBundle/GitHub/IssueStatusChanger.php

@@ -16,6 +16,13 @@ class StatusManager
         self::STATUS_REVIEWED => ['reviewed'],
     ];
 
+    private static $labels = [
+        self::STATUS_NEEDS_REVIEW => 'Status: Needs Review',
+        self::STATUS_NEEDS_WORK => 'Status: Needs Work',
+        self::STATUS_WORKS_FOR_ME => 'Status: Works for me',
+        self::STATUS_REVIEWED => 'Status: Reviewed',
+    ];
+
     /**
      * Parses the text of the comment and looks for keywords to see
      * if this should cause any status change.
@@ -54,6 +61,29 @@ public function getStatusChangeFromComment($comment)
         return $newStatus;
     }
 
+    /**
+     * Returns the name of the label we use on GitHub for a status
+     *
+     * @param $status
+     * @return string
+     */
+    public static function getLabelForStatus($status)
+    {
+        if (!isset(self::$labels[$status])) {
+            throw new \InvalidArgumentException(sprintf('Invalid status "%s"', $status));
+        }
+
+        return self::$labels[$status];
+    }
+
+    /**
+     * @return array
+     */
+    public static function getLabelToStatusMap()
+    {
+        return array_keys(self::$labels);
+    }
+
     /**
      * Finds the position where the status string will start - e.g.
      * for "Status: Needs review", this would return the position