[DEV-3393] Add new methods to fetch metadata.

Author: frazjp65

src/Document/Document.php

@@ -37,7 +37,7 @@ class Document
      *
      * @var string
      */
-    private $_id = '';
+    private $_id = "";
 
     /**
      * Document key/value store
@@ -89,9 +89,62 @@ public function getId()
      */
     public function getProgramId()
     {
-        $program_id = &$this->_meta[ 'programId' ];
+        return $this->_getMetaByName( "programId" );
+    }
+
+
+    /**
+     * Get agent identifier
+     *
+     * @return string agent id or empty string if unknown
+     */
+    public function getAgentId()
+    {
+        return $this->_getMetaByName( "agentId" );
+    }
+
+
+    /**
+     * Get agent entity identifier (i.e. the user id)
+     *
+     * @return string agent entity id or empty string if unknown
+     */
+    public function getAgentEntityId()
+    {
+        return $this->_getMetaByName( "agentEntityId" );
+    }
+
+
+    /**
+     * Get the initial rated date.
+     *
+     * @return int A unix timestamp for the initial rating date
+     */
+    public function getInitialRatedDate()
+    {
+        return $this->_getMetaByName( "initialRatedDate" );
+    }
+
 
-        return (string)$program_id;
+    /**
+     * Get the start date.
+     *
+     * @return int A unix timestamp for the start date
+     */
+    public function getStartDate()
+    {
+        return $this->_getMetaByName( "startDate" );
+    }
+
+
+    /**
+     * Get agent name
+     *
+     * @return string agent name or empty string if unknown
+     */
+    public function getAgentName()
+    {
+        return $this->_getMetaByName( "agentName" );
     }
 
 
@@ -104,4 +157,18 @@ public function getBucket()
     {
         return $this->_bucket;
     }
+
+
+    /**
+     * Get metadata by key name
+     *
+     * @param String The name of the key holding the data.
+     *
+     * @return string metadata or empty string if unknown
+     */
+    private function _getMetaByName( $name )
+    {
+        $data = &$this->_meta[ $name ];
+        return (string)$data;
+    }
 }

test/Document/DocumentTest.php

@@ -31,9 +31,9 @@ class DocumentTest
     protected function getDummyBucket()
     {
         return $this->getMockBuilder(
-            'Lovullo\Liza\Bucket\Bucket'
+            "Lovullo\Liza\Bucket\Bucket"
         )
-            ->setMethods( array( 'getDataByName', 'hasData' ) )
+            ->setMethods( array( "getDataByName", "hasData" ) )
             ->getMock();
     }
 
@@ -46,7 +46,7 @@ protected function createSut( $id, $bucket, $meta = [] )
 
     public function testReturnsDocumentId()
     {
-        $id = '123456';
+        $id = "123456";
 
         $this->assertEquals(
             $id,
@@ -58,45 +58,85 @@ public function testReturnsDocumentId()
     public function testIdReturnedAsAString()
     {
         $this->assertSame(
-            '1234',
+            "1234",
             $this->createSut( 1234, $this->getDummyBucket() )->getId()
         );
     }
 
 
-    public function programIdDataProvider()
+    public function testReturnsBucket()
+    {
+        $bucket = $this->getDummyBucket();
+
+        $this->assertSame(
+            $bucket,
+            $this->createSut( "foo", $bucket )->getBucket()
+        );
+    }
+
+
+    public function gettersDataProvider()
     {
         return [
-            [ [ 'programId' => 'fooprog' ], 'fooprog' ],
-            [ [ 'programId' => '' ], '' ],
-            [ [], '' ],
+            [ [ "agentId" => "fooagentid" ], "fooagentid" ],
+            [ [ "agentId" => "" ], "" ],
+            [ [ "agentName" => "fooagentname" ], "fooagentname" ],
+            [ [ "agentName" => "" ], "" ],
+            [ [ "programId" => "fooprog" ], "fooprog" ],
+            [ [ "programId" => "" ], "" ],
+            [ [ "agentEntityId" => "fooaei" ], "fooaei" ],
+            [ [ "agentEntityId" => "" ], "" ],
+            [ [ "initialRatedDate" => "fooird" ], "fooird" ],
+            [ [ "initialRatedDate" => "" ], "" ],
+            [ [ "startDate" => "foosd" ], "foosd" ],
+            [ [ "startDate" => "" ], "" ],
         ];
     }
 
 
     /**
-     * @dataProvider programIdDataProvider
+     * @dataProvider gettersDataProvider
      */
-    public function testProgramIdReturnedAsString( array $meta, $expected )
+    public function testGetters( array $meta, $expected )
     {
+        $methodName = "get" . ucfirst( array_keys( $meta )[0] );
+
         $this->assertEquals(
             $expected,
             $this->createSut(
                 1234,
                 $this->getDummyBucket(),
                 $meta
-            )->getProgramId()
+            )->$methodName()
         );
     }
 
 
-    public function testReturnsBucket()
+    public function emptyGettersDataProvider()
     {
-        $bucket = $this->getDummyBucket();
+        return [
+            [ "getProgramId" ],
+            [ "getAgentId" ],
+            [ "getAgentName" ],
+            [ "getAgentEntityId" ],
+            [ "getInitialRatedDate" ],
+            [ "getStartDate" ],
+        ];
+    }
 
-        $this->assertSame(
-            $bucket,
-            $this->createSut( 'foo', $bucket )->getBucket()
+
+    /**
+     * @dataProvider emptyGettersDataProvider
+     */
+    public function testEmptyGetters( $methodName )
+    {
+        $this->assertEquals(
+            "",
+            $this->createSut(
+                1234,
+                $this->getDummyBucket(),
+                []
+            )->$methodName()
         );
     }
 }