Merge pull request #13 from akreisman-epam/get-client-token

Add Get Client Token endpoint

Author: Peter Joseph Olamit

CHANGELOG.md

@@ -4,6 +4,7 @@ Changelog
 0.2.0 (2018-10-19)
 -------------------
 
+- Added ClientToken endpoint
 - Added PayPal endpoint
 - Added transfer endpoint
 - Added Layer 7 encryption

src/Hyperwallet/Hyperwallet.php

@@ -23,6 +23,7 @@
 use Hyperwallet\Model\TransferMethod;
 use Hyperwallet\Model\TransferMethodConfiguration;
 use Hyperwallet\Model\User;
+use Hyperwallet\Model\ClientToken;
 use Hyperwallet\Model\UserStatusTransition;
 use Hyperwallet\Model\WebhookNotification;
 use Hyperwallet\Response\ListResponse;
@@ -184,6 +185,28 @@ public function listUserStatusTransitions($userToken, array $options = array())
         });
     }
 
+    //--------------------------------------
+    // Client Token
+    //--------------------------------------
+
+    /**
+     * Get client token
+     *
+     * @param $userToken The user token
+     * @return ClientToken
+     *
+     * @throws HyperwalletApiException
+     */
+    public function getClientToken($userToken) {
+        if (empty($userToken)) {
+            throw new HyperwalletArgumentException('userToken is required!');
+        }
+        $body = $this->client->doPost('/rest/v3/users/{user-token}/client-token', array(
+            'user-token' => $userToken,
+        ), null, array());
+        return new ClientToken($body);
+    }
+
     //--------------------------------------
     // Paper Checks
     //--------------------------------------

src/Hyperwallet/Model/ClientToken.php

@@ -0,0 +1,42 @@
+<?php
+namespace Hyperwallet\Model;
+
+/**
+ * Represents a V3 Client Token
+ *
+ * @property string $value The client token value
+
+ *
+ * @package Hyperwallet\Model
+ */
+
+class ClientToken extends BaseModel {
+
+    /**
+     * @internal
+     *
+     * Read only fields
+     *
+     * @var string[]
+     */
+    private static $READ_ONLY_FIELDS = array('value');
+
+    /**
+     * Creates a instance of ClientToken
+     *
+     * @param string[] $properties The default properties
+     */
+    public function __construct(array $properties = array()) {
+        parent::__construct(self::$READ_ONLY_FIELDS, $properties);
+    }
+
+    /**
+     * Get the client token value
+     *
+     * @return string
+     */
+    public function getValue() {
+        return $this->value;
+    }
+
+}

tests/Hyperwallet/Tests/HyperwalletTest.php

@@ -320,6 +320,38 @@ public function testListUserStatusTransitions_withParameters() {
         \Phake::verify($apiClientMock)->doGet('/rest/v3/users/{user-token}/status-transitions', array('user-token' => 'test-user-token'), array('test' => 'value'));
     }
 
+    //--------------------------------------
+    // Client Token
+    //--------------------------------------
+
+    public function testGetClientToken_noUserToken() {
+        // Setup
+        $client = new Hyperwallet('test-username', 'test-password');
+
+        try {
+            $client->getClientToken('');
+            $this->fail('HyperwalletArgumentException expected');
+        } catch (HyperwalletArgumentException $e) {
+            $this->assertEquals('userToken is required!', $e->getMessage());
+        }
+    }
+
+    public function testGetClientToken_allParameters() {
+        // Setup data
+        $client = new Hyperwallet('test-username', 'test-password', 'test-program-token');
+        $apiClientMock = $this->createAndInjectApiClientMock($client);
+
+        \Phake::when($apiClientMock)->doPost('/rest/v3/users/{user-token}/client-token', array('user-token' => 'test-user-token'), null, array())->thenReturn(array('value' => 'true'));
+
+        // Run test
+        $clientToken = $client->getClientToken('test-user-token');
+        $this->assertNotNull($clientToken);
+        $this->assertEquals(array('value' => 'true'), $clientToken->getProperties());
+
+        // Validate mock
+        \Phake::verify($apiClientMock)->doPost('/rest/v3/users/{user-token}/client-token', array('user-token' => 'test-user-token'), null, array());
+    }
+
     //--------------------------------------
     // Paper Checks
     //--------------------------------------

tests/Hyperwallet/Tests/Model/ClientTokenTest.php

@@ -0,0 +1,37 @@
+<?php
+namespace Hyperwallet\Tests\Model;
+
+class ClientTokenTest extends ModelTestCase {
+
+    protected function getModelName() {
+        return 'ClientToken';
+    }
+
+    /**
+     * @dataProvider ignoredPropertiesProvider
+     *
+     * @param string $property The property to look for
+     */
+    public function testGettersForIgnoredProperties($property) {
+        $this->performGettersForIgnoredPropertiesTest($property);
+    }
+
+    /**
+     * @dataProvider propertiesProvider
+     *
+     * @param string $property The property to look for
+     */
+    public function testGetterReturnValueIsSet($property) {
+        $this->performGetterReturnValueIsSetTest($property);
+    }
+
+    /**
+     * @dataProvider propertiesProvider
+     *
+     * @param string $property The property to look for
+     */
+    public function testGetterReturnValueIsNotSet($property) {
+        $this->performGetterReturnValueIsNotSetTest($property);
+    }
+
+}