revised SprintService

Author: lesstif

src/Sprint/Sprint.php

@@ -1,55 +1,64 @@
-<?php
-/**
- * Created by PhpStorm.
- * User: meshulam
- * Date: 23/09/2017
- * Time: 14:17.
- */
+<?php declare(strict_types=1);
 
 namespace JiraCloud\Sprint;
 
+use DateTimeInterface;
 use JiraCloud\JsonSerializableTrait;
 
 class Sprint implements \JsonSerializable
 {
     use JsonSerializableTrait;
 
-    /* @var string */
-    public $self;
+    public string $self;
 
-    /* @var int */
-    public $id;
+    public int $id;
 
-    /* @var string */
-    public $name;
+    public string $name;
 
-    /* @var string */
-    public $state;
+    public string $state;
+    public string $startDate;
 
-    /* @var string */
-    public $startDate;
+    public string $endDate;
 
-    /* @var string */
-    public $endDate;
+    public string $activatedDate;
 
-    /* @var string */
-    public $completeDate;
+    public string $completeDate;
 
-    /* @var int */
-    public $originBoardId;
+    public int $originBoardId;
 
-    /** @var string */
-    public $goal;
+    public string $goal;
 
-    public function setName(string $sprintName): string
+    public function setNameAsString(string $sprintName): self
     {
         $this->name = $sprintName;
 
-        return $sprintName;
+        return $this;
     }
 
-    public function getName(): string
+    public function setGoalAsString(string $sprintGoal): self
     {
-        return $this->name;
+        $this->goal = $sprintGoal;
+
+        return $this;
+    }
+
+    public function setOriginBoardIdAsStringOrInt(string|int $originBoardId) : self
+    {
+        $this->originBoardId = $originBoardId;
+
+        return $this;
+    }
+    public function setStartDateAsDateTime(DateTimeInterface $startDate, $format = 'Y-m-d'): static
+    {
+        $this->startDate = $startDate->format($format);
+
+        return $this;
+    }
+
+    public function setEndDateAsDateTime(DateTimeInterface $endDate, $format = 'Y-m-d'): static
+    {
+        $this->endDate = $endDate->format($format);
+
+        return $this;
     }
 }

src/Sprint/SprintService.php

@@ -1,10 +1,6 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: meshulam
- * Date: 11/08/2017
- * Time: 17:28.
- */
+
+declare(strict_types=1);
 
 namespace JiraCloud\Sprint;
 
@@ -16,7 +12,6 @@
 
 class SprintService extends JiraClient
 {
-    //https://jira01.devtools.intel.com/rest/agile/1.0/board?projectKeyOrId=34012
     private $uri = '/sprint';
 
     public function __construct(ConfigurationInterface $configuration = null, LoggerInterface $logger = null, $path = './')
@@ -32,7 +27,7 @@ public function __construct(ConfigurationInterface $configuration = null, Logger
      *
      * @return Sprint
      */
-    public function getSprintFromJSON($json)
+    public function getSprintFromJSON(object $json) : Sprint
     {
         $sprint = $this->json_mapper->map(
             $json,
@@ -42,38 +37,26 @@ public function getSprintFromJSON($json)
         return $sprint;
     }
 
-    /**
-     *  get all Sprint list.
-     *
-     * @param string $sprintId
-     *
-     * @throws JiraException
-     * @throws \JsonMapper_Exception
-     *
-     * @return Sprint
-     */
-    public function getSprint(string $sprintId)
+    public function getSprint(string|int $sprintId) :Sprint
     {
         $ret = $this->exec($this->uri.'/'.$sprintId, null);
 
         $this->log->info("Result=\n".$ret);
 
-        return $sprint = $this->json_mapper->map(
+        return $this->json_mapper->map(
             json_decode($ret),
             new Sprint()
         );
     }
 
     /**
-     * @param string|int $sprintId
-     * @param array      $paramArray
      *
      * @throws JiraException
      * @throws \JsonMapper_Exception
      *
      * @return Issue[] array of Issue
      */
-    public function getSprintIssues($sprintId, $paramArray = [])
+    public function getSprintIssues(string|int $sprintId, array $paramArray = [])
     {
         $json = $this->exec($this->uri.'/'.$sprintId.'/issue'.$this->toHttpQueryParameter($paramArray), null);
 
@@ -85,4 +68,18 @@ public function getSprintIssues($sprintId, $paramArray = [])
 
         return $issues;
     }
+
+    public function createSprint(Sprint $sprint) : Sprint
+    {
+        $data = json_encode($sprint);
+
+        $ret = $this->exec($this->uri, $data);
+
+        $this->log->debug('createSprint result='.var_export($ret, true));
+
+        return $this->json_mapper->map(
+            json_decode($ret),
+            new Sprint()
+        );
+    }
 }

tests/SPrintTest.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace JiraCloud\Test;
+
+use DateInterval;
+use DateTime;
+use JiraCloud\Sprint\Sprint;
+use JiraCloud\Sprint\SprintService;
+use PHPUnit\Framework\TestCase;
+use JiraCloud\Dumper;
+use JiraCloud\Issue\Comment;
+use JiraCloud\Issue\IssueService;
+use JiraCloud\JiraException;
+
+class SPrintTest extends TestCase
+{
+    /**
+     * @test
+     *
+    */
+    public function create_sprint() : int
+    {
+        $start = (new DateTime('NOW'))->add(DateInterval::createFromDateString('1 month 5 day'));
+
+        $sp = (new Sprint())
+                ->setNameAsString("My Sprint 1")
+                ->setGoalAsString("goal")
+                ->setOriginBoardIdAsStringOrInt(2)
+                ->setStartDateAsDateTime($start)
+                ->setEndDateAsDateTime($start->add(DateInterval::createFromDateString('3 week')))
+        ;
+
+        try {
+            $sps = new SprintService();
+
+            $sprint = $sps->createSprint($sp);
+
+            $this->assertNotNull($sprint->name);
+
+            return $sprint->id;
+
+        } catch (JiraException $e) {
+            $this->assertTrue(false, 'testSearch Failed : '.$e->getMessage());
+        }
+    }
+
+    /**
+     * @test
+     *
+     * @depends create_sprint
+     *
+     * @throws \JsonMapper_Exception
+     */
+    public function get_sprints(int $sprintId) : int
+    {
+        try {
+            $sps = new SprintService();
+
+            $sprint = $sps->getSprint($sprintId);
+
+            $this->assertNotNull($sprint->name);
+            Dumper::dump($sprint);
+
+            return $sprintId;
+        } catch (JiraException $e) {
+            $this->assertTrue(false, 'testSearch Failed : '.$e->getMessage());
+        }
+    }
+
+    /**
+     * @test
+     * @depends get_sprints
+     *
+     * @param int $sprintId
+     * @return void
+     */
+    public function get_issues_in_sprints(int $sprintId)
+    {
+        try {
+            $sps = new SprintService();
+
+            $sprint = $sps->getSprintIssues($sprintId);
+
+            $this->assertNotNull($sprint);
+            Dumper::dump($sprint);
+        } catch (JiraException $e) {
+            $this->assertTrue(false, 'testSearch Failed : '.$e->getMessage());
+        }
+    }
+}