Add more info on session resource & getOne domain method

src/Api/Catalog/InventoryDomain.php

@@ -1,20 +1,19 @@
 <?php
 namespace ShoppingFeed\Sdk\Api\Catalog;
 
-use ShoppingFeed\Sdk\Api\Catalog as ApiCatalog;
-use ShoppingFeed\Sdk\Catalog;
 use ShoppingFeed\Sdk\Resource\AbstractDomainResource;
 
 /**
- * @method ApiCatalog\InventoryResource[] getIterator()
- * @method ApiCatalog\InventoryResource[] getAll($page = 1, $limit = 100)
+ * @method InventoryResource[] getIterator()
+ * @method InventoryResource[] getAll($page = 1, $limit = 100)
+ * @method InventoryResource getOne($identity)
  */
 class InventoryDomain extends AbstractDomainResource
 {
     /**
      * @var string
      */
-    protected $resourceClass = ApiCatalog\InventoryResource::class;
+    protected $resourceClass = InventoryResource::class;
 
     /**
      * @param string $reference the resource reference
@@ -24,8 +23,8 @@ class InventoryDomain extends AbstractDomainResource
     public function getByReference($reference)
     {
         $resource = $this->link->get([], ['query' => ['reference' => $reference]]);
-        if ($resource->getProperty('count') > 0) {
-            return new ApiCatalog\InventoryResource(
+        if ($resource && $resource->getProperty('count') > 0) {
+            return new InventoryResource(
                 $resource->getFirstResource('inventory'),
                 false
             );

src/Api/Order/OrderDomain.php

@@ -1,21 +1,21 @@
 <?php
 namespace ShoppingFeed\Sdk\Api\Order;
 
-use ShoppingFeed\Sdk\Api\Order as ApiOrder;
 use ShoppingFeed\Sdk\Resource\AbstractDomainResource;
 
 /**
- * @method ApiOrder\OrderResource[] getIterator()
- * @method ApiOrder\OrderResource[] getAll($criteria = [])
- * @method ApiOrder\OrderResource[] getPage(array $criteria = [])
- * @method ApiOrder\OrderResource[] getPages(array $criteria = [])
+ * @method OrderResource[] getIterator()
+ * @method OrderResource[] getAll($criteria = [])
+ * @method OrderResource[] getPage(array $criteria = [])
+ * @method OrderResource[] getPages(array $criteria = [])
+ * @method OrderResource getOne($identity)
  */
 class OrderDomain extends AbstractDomainResource
 {
     /**
      * @var string
      */
-    protected $resourceClass = ApiOrder\OrderResource::class;
+    protected $resourceClass = OrderResource::class;
 
     /**
      * @param OrderOperation $operation

src/Api/Session/SessionResource.php

@@ -6,32 +6,52 @@
 
 class SessionResource extends AbstractResource
 {
+    /**
+     * @return int|null NULL when account id is not found, id integer otherwise
+     */
+    public function getId()
+    {
+        if ($account = $this->resource->getFirstResource('account')) {
+            return $account->getProperty('id');
+        }
+
+        return null;
+    }
+
+    /**
+     * @return array A list of named roles
+     */
+    public function getRoles()
+    {
+        return $this->getProperty('roles') ?: [];
+    }
+
     /**
      * @return string
      */
     public function getLogin()
     {
-        return $this->resource->getProperty('login');
+        return (string) $this->resource->getProperty('login');
     }
 
     /**
      * @return string
      */
     public function getEmail()
     {
-        return $this->resource->getProperty('email');
+        return (string) $this->resource->getProperty('email');
     }
 
     /**
      * @return string
      */
     public function getToken()
     {
-        return $this->resource->getProperty('token');
+        return (string) $this->resource->getProperty('token');
     }
 
     /**
-     * @return Store\StoreCollection
+     * @return Store\StoreCollection|Store\StoreResource[]
      */
     public function getStores()
     {
@@ -40,6 +60,21 @@ public function getStores()
         );
     }
 
+    /**
+     * Return the language tag, as following:
+     *
+     * - en_US
+     * - fr_FR
+     *
+     * ...etc
+     *
+     * @return string
+     */
+    public function getLanguageTag()
+    {
+        return (string) $this->resource->getProperty('language');
+    }
+
     /**
      * @param int|string $idOrName
      *

src/Api/Store/StoreChannelDomain.php

@@ -8,6 +8,7 @@
  * @method StoreChannelResource[] getAll($criteria = [])
  * @method StoreChannelResource[] getPage(array $criteria = [])
  * @method StoreChannelResource[] getPages(array $criteria = [])
+ * @method StoreChannelResource getOne($identity)
  */
 class StoreChannelDomain extends Resource\AbstractDomainResource
 {

src/Api/Store/StoreChannelResource.php

@@ -66,7 +66,9 @@ public function isInstalled()
     public function getChannel()
     {
         if (null === $this->channel) {
-            $this->channel = new Channel\ChannelResource($this->resource->getFirstResource('channel'));
+            $this->channel = new Channel\ChannelResource(
+                $this->resource->getFirstResource('channel')
+            );
         }
 
         return $this->channel;

src/Api/Store/StoreResource.php

@@ -31,6 +31,18 @@ public function isActive()
         return $this->getProperty('status') === 'active';
     }
 
+    /**
+     * @return string One of the following status:
+     *  - active
+     *  - demo
+     *  - deleted
+     *  - suspended
+     */
+    public function getStatus()
+    {
+        return $this->getProperty('status');
+    }
+
     /**
      * @return string
      */

src/Hal/HalLink.php

@@ -107,12 +107,23 @@ public function getTitle()
         return $this->title;
     }
 
+    /**
+     * @param $path
+     *
+     * @return HalLink
+     */
+    public function withAddedHref($path)
+    {
+        $instance       = clone $this;
+        $instance->href = rtrim($instance->href, '/') . '/' . ltrim($path, '/');
+
+        return $instance;
+    }
+
     /**
      * @param array $variables
      *
      * @return null|string|string[]
-     *
-     * @throws \QL\UriTemplate\Exception
      */
     public function getUri(array $variables)
     {

src/Resource/AbstractDomainResource.php

@@ -25,6 +25,21 @@ public function __construct(Hal\HalLink $link)
         $this->link = $link;
     }
 
+    /**
+     * Get the resource by it's identity
+     *
+     * @param mixed $identity a scalar value that identity the resource
+     *
+     * @return AbstractResource
+     */
+    public function getOne($identity)
+    {
+        $link  = $this->link->withAddedHref($identity);
+        $class = $this->resourceClass;
+
+        return new $class($link->get());
+    }
+
     /**
      * @param array $criteria
      *

tests/unit/Api/AbstractResourceTest.php

@@ -42,7 +42,7 @@ protected function initHalResourceProperties(array $props = [])
 
         $resource = $this->initHalResource();
         $resource
-            ->expects($this->exactly(count($props)))
+            ->expects($this->any())
             ->method('getProperty')
             ->with($this->logicalOr(...array_keys($props)))
             ->will($this->returnCallback(function($prop) use($props) {

tests/unit/Api/Session/SessionResourceTest.php

@@ -12,11 +12,14 @@ class SessionResourceTest extends Sdk\Test\Api\AbstractResourceTest
 
     public function setUp()
     {
-        $this->props     = [
-            'login' => 'username',
-            'email' => 'user@mail.com',
-            'token' => 'fd9cf7c178a1efd30bb1aad0e302abde',
+        $this->props = [
+            'login'    => 'username',
+            'email'    => 'user@mail.com',
+            'token'    => 'fd9cf7c178a1efd30bb1aad0e302abde',
+            'language' => 'en_US',
+            'roles'    => ['user'],
         ];
+
         $this->resources = [
             $this->createMock(Sdk\Hal\HalResource::class),
             $this->createMock(Sdk\Hal\HalResource::class),
@@ -33,6 +36,31 @@ public function testPropertiesGetters()
         $this->assertEquals($this->props['email'], $instance->getEmail());
         $this->assertEquals($this->props['login'], $instance->getLogin());
         $this->assertEquals($this->props['token'], $instance->getToken());
+        $this->assertEquals($this->props['roles'], $instance->getRoles());
+        $this->assertEquals($this->props['language'], $instance->getLanguageTag());
+    }
+
+    public function testGetAccountIdWithMatchedOrNullAccount()
+    {
+        $halResource = $this->createMock(Sdk\Hal\HalResource::class);
+        $halResource
+            ->expects($this->exactly(2))
+            ->method('getFirstResource')
+            ->with('account')
+            ->willReturnOnConsecutiveCalls(
+                $halResource,
+                null
+            );
+
+        $halResource
+            ->expects($this->once())
+            ->method('getProperty')
+            ->with('id')
+            ->willReturn(12);
+
+        $instance = new Sdk\Api\Session\SessionResource($halResource);
+        $this->assertSame(12, $instance->getId(), 'First call resource will return mock');
+        $this->assertNull($instance->getId(), 'Second resource call return NULL');
     }
 
     public function testGetStores()

tests/unit/Api/Store/StoreResourceTest.php

@@ -21,9 +21,10 @@ public function testPropertiesGetters()
 
         $instance = new Sdk\Api\Store\StoreResource($this->halResource);
 
-        $this->assertEquals($this->props['id'], $instance->getId());
-        $this->assertEquals($this->props['name'], $instance->getName());
-        $this->assertEquals($this->props['country'], $instance->getCountryCode());
+        $this->assertSame($this->props['id'], $instance->getId());
+        $this->assertSame($this->props['name'], $instance->getName());
+        $this->assertSame($this->props['country'], $instance->getCountryCode());
+        $this->assertSame('active', $instance->getStatus());
         $this->assertTrue($instance->isActive());
     }