Added shorthand releaseVersion() and added tests

Author: jpastoor

src/Jira/Api.php

@@ -222,6 +222,7 @@ public function getRoleDetails($projectKey, $roleId)
      * @param $issuetypeIds array    Combined with issuetypeNames, lists the issue types with which to filter the results.
      *                               If null, all issue types are returned. Specifiying an issue type that does not exist is
      *                               not an error.
+     *
      * @param $issuetypeNames array  Combined with issuetypeIds, lists the issue types with which to filter the results.
      *                               If null, all issue types are returned. This parameter can be specified multiple times,
      *                               but is NOT interpreted as a comma-separated list. Specifiying an issue type that does
@@ -487,6 +488,8 @@ public function createVersion($projectId, $name, $options = array())
 
     /**
      * Update JIRA Version
+     *
+     * https://docs.atlassian.com/jira/REST/latest/#api/2/version-updateVersion
      * 
      * @param int $versionId Version identifier
      * @param array $params Key->Value list to update the version with. 
@@ -497,6 +500,32 @@ public function updateVersion($versionId, $params = array()) {
         return $this->api(self::REQUEST_PUT, sprintf('/rest/api/2/version/%d', $versionId), $params);
     }
 
+    /**
+     * Shorthand to mark a version as Released
+     *
+     * @param int $versionId  Version identifier
+     * @param string|null $releaseDate Date in Y-m-d format. Defaults to today
+     * @param array $params Optionally extra parameters.
+     *
+     * @return Result|false
+     */
+    public function releaseVersion($versionId, $releaseDate = null, $params = array()) {
+        if(!$releaseDate) {
+            $releaseDate = date("Y-m-d");
+        }
+
+        // TODO Not entirely sure what to do yet with userReleaseDate
+        $params = array_merge(
+            array(
+                "releaseDate" => $releaseDate,
+                'released' => true
+            ),
+            $params
+        );
+
+        return $this->updateVersion($versionId, $params);
+    }
+
     /**
      * Create JIRA Attachment
      *

tests/Jira/ApiTest.php

@@ -47,4 +47,51 @@ public function testUpdateVersion()
 
         $api->updateVersion(111000, $params);
     }
+
+    /**
+     * Tests that the releaseVersion call constructs the correct api call
+     */
+    public function testReleaseVersion()
+    {
+        $params = [
+            "released" => true,
+            "releaseDate" => date("Y-m-d"),
+        ];
+
+        // Stub the api method and keep the rest intact
+        /** @var Api|\PHPUnit_Framework_MockObject_MockObject $api */
+        $api = $this->getMockBuilder(Api::class)->setMethods(["api"])->disableOriginalConstructor()->getMock();
+        $api->expects($this->once())->method("api")->with(
+            $this->equalTo(Api::REQUEST_PUT),
+            $this->equalTo("/rest/api/2/version/111000"),
+            $this->equalTo($params)
+        );
+
+        $api->releaseVersion(111000);
+    }
+
+    /**
+     * Tests that the releaseVersion call constructs the correct api call with overriden release data and params
+     */
+    public function testReleaseVersionAdvanced()
+    {
+        $releaseDate = "2010-07-06";
+
+        $params = [
+            "released" => true,
+            "releaseDate" => $releaseDate,
+            "test" => "extra"
+        ];
+
+        // Stub the api method and keep the rest intact
+        /** @var Api|\PHPUnit_Framework_MockObject_MockObject $api */
+        $api = $this->getMockBuilder(Api::class)->setMethods(["api"])->disableOriginalConstructor()->getMock();
+        $api->expects($this->once())->method("api")->with(
+            $this->equalTo(Api::REQUEST_PUT),
+            $this->equalTo("/rest/api/2/version/111000"),
+            $this->equalTo($params)
+        );
+
+        $api->releaseVersion(111000, $releaseDate, ["test" => "extra"]);
+    }
 }