add Move issues to sprint and rank in SprintService

Author: lesstif

src/Sprint/Sprint.php

@@ -4,7 +4,6 @@
 
 namespace JiraCloud\Sprint;
 
-use DateTimeInterface;
 use JiraCloud\JsonSerializableTrait;
 
 class Sprint implements \JsonSerializable
@@ -30,6 +29,12 @@ class Sprint implements \JsonSerializable
 
     public string $goal;
 
+    public ?string $rankBeforeIssue;
+    public ?string $rankAfterIssue;
+    public int $rankCustomFieldId;
+
+    public array $issues;
+
     public function setNameAsString(string $sprintName): self
     {
         $this->name = $sprintName;
@@ -51,17 +56,38 @@ public function setOriginBoardIdAsStringOrInt(string|int $originBoardId): self
         return $this;
     }
 
-    public function setStartDateAsDateTime(DateTimeInterface $startDate, $format = 'Y-m-d'): static
+    public function setStartDateAsDateTime(\DateTimeInterface $startDate, string $format = 'Y-m-d'): static
     {
         $this->startDate = $startDate->format($format);
 
         return $this;
     }
 
-    public function setEndDateAsDateTime(DateTimeInterface $endDate, $format = 'Y-m-d'): static
+    public function setStartDateAsString(string $startDate): static
+    {
+        $this->startDate = $startDate;
+
+        return $this;
+    }
+
+    public function setEndDateAsDateTime(\DateTimeInterface $endDate, string $format = 'Y-m-d'): static
     {
         $this->endDate = $endDate->format($format);
 
         return $this;
     }
+
+    public function setEndDateAsString(string $endDate): static
+    {
+        $this->endDate = $endDate;
+
+        return $this;
+    }
+
+    public function setMoveIssues(array $issues): static
+    {
+        $this->issues = $issues;
+
+        return $this;
+    }
 }

src/Sprint/SprintService.php

@@ -54,6 +54,8 @@ public function getSprint(string|int $sprintId): Sprint
      * @throws \JsonMapper_Exception
      *
      * @return Issue[] array of Issue
+     *
+     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-rest-agile-1-0-sprint-sprintid-get
      */
     public function getSprintIssues(string|int $sprintId, array $paramArray = [])
     {
@@ -68,6 +70,9 @@ public function getSprintIssues(string|int $sprintId, array $paramArray = [])
         return $issues;
     }
 
+    /**
+     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-rest-agile-1-0-sprint-post
+     */
     public function createSprint(Sprint $sprint): Sprint
     {
         $data = json_encode($sprint);
@@ -81,4 +86,22 @@ public function createSprint(Sprint $sprint): Sprint
             new Sprint()
         );
     }
+
+    /**
+     * @param int $sprintId
+     * @param Sprint $sprint
+     * @return bool
+     * @throws JiraException
+     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-rest-agile-1-0-sprint-sprintid-issue-post
+     */
+    public function moveIssues2Sprint(int $sprintId, Sprint $sprint): bool
+    {
+        $data = json_encode($sprint);
+
+        $ret = $this->exec($this->uri.'/'.$sprintId.'/issue', $data);
+
+        $this->log->debug('moveIssues2Sprint result='.var_export($ret, true));
+
+        return $ret;
+    }
 }

tests/SPrintTest.php

@@ -21,14 +21,16 @@ class SPrintTest extends TestCase
     */
     public function create_sprint() : int
     {
-        $start = (new DateTime('NOW'))->add(DateInterval::createFromDateString('1 month 5 day'));
+        $sprintStartDate = (new DateTime('NOW'))->add(DateInterval::createFromDateString('1 month 5 day'));
+
+        $sprintBoardId = 2;
 
         $sp = (new Sprint())
+                ->setOriginBoardIdAsStringOrInt($sprintBoardId)
                 ->setNameAsString("My Sprint 1")
-                ->setGoalAsString("goal")
-                ->setOriginBoardIdAsStringOrInt(2)
-                ->setStartDateAsDateTime($start)
-                ->setEndDateAsDateTime($start->add(DateInterval::createFromDateString('3 week')))
+                ->setGoalAsString("Sprint 1 Goal")
+                ->setStartDateAsDateTime($sprintStartDate)
+                ->setEndDateAsDateTime($sprintStartDate->add(DateInterval::createFromDateString('3 week')))
         ;
 
         try {
@@ -41,7 +43,7 @@ public function create_sprint() : int
             return $sprint->id;
 
         } catch (Exception $e) {
-            $this->fail( 'testSearch Failed : '.$e->getMessage());
+            $this->fail( 'create_sprint Failed : '.$e->getMessage());
         }
     }
 
@@ -63,7 +65,7 @@ public function get_sprints(int $sprintId) : int
 
             return $sprintId;
         } catch (Exception $e) {
-            $this->fail('testSearch Failed : '.$e->getMessage());
+            $this->fail('get_sprints Failed : '.$e->getMessage());
         }
     }
 
@@ -72,18 +74,50 @@ public function get_sprints(int $sprintId) : int
      * @depends get_sprints
      *
      * @param int $sprintId
-     * @return void
+     * @return int
      */
-    public function get_issues_in_sprints(int $sprintId)
+    public function get_issues_in_sprints(int $sprintId) : int
     {
         try {
             $sps = new SprintService();
 
             $sprint = $sps->getSprintIssues($sprintId);
 
             $this->assertNotNull($sprint);
+
+            return $sprintId;
+        } catch (Exception $e) {
+            $this->fail('get_issues_in_sprints Failed : '.$e->getMessage());
+        }
+    }
+
+    /**
+     * @test
+     * @depends get_issues_in_sprints
+     *
+     * @param int $sprintId
+     * @return int
+     */
+    public function move_issues_to_sprints(int $sprintId) : int
+    {
+        try {
+            $sp = (new Sprint())
+                ->setMoveIssues([
+                    "MOBL-1",
+                    "MOBL-5",
+                ])
+
+            ;
+
+            $sps = new SprintService();
+
+            $sprint = $sps->moveIssues2Sprint($sprintId, $sp);
+
+            $this->assertNotNull($sprint);
+
+            return $sprintId;
         } catch (Exception $e) {
-            $this->fail('testSearch Failed : '.$e->getMessage());
+            $this->fail('move_issues_to_sprints Failed : '.$e->getMessage());
         }
     }
 }