Merge pull request #10 from OpenSTFoundation/develop

Readme changes and bug fixes

Author: sunilkhedar

README.md

@@ -39,11 +39,11 @@ Initialize the SDK object:
 ```php
 
 $params = array();
-$params['apiKey']='API_KEY';
-$params['apiSecret']='API_SECRET';
+$params['apiKey']=API_KEY;
+$params['apiSecret']=API_SECRET;
 $params['apiBaseUrl']='https://sandboxapi.ost.com/v1/';
 
-$ostObj = new OSTSDK($params);
+$ostObj = new OSTSdk($params);
 
 ```
 
@@ -72,6 +72,15 @@ $response = $userService->edit($editUserParams)->wait();
 var_dump($response);
 ```
 
+Get a user:
+
+```php
+$getUserParams = array();
+$getUserParams['id'] = '7ac1da33-b1d2-4f03-b39c-fbac0f1e2b92';
+$response = $userService->get($getUserParams)->wait();
+var_dump($response);
+```
+
 Get a list of users and other data:
 
 ```php
@@ -170,21 +179,8 @@ $response = $actionService->get($getActionParams)->wait();
 var_dump($response);
 ```
 
-### Token Module 
-
-```php
-$tokenService = $ostObj->services->token;
-```
-
-Get Token Detail:
-
-```php
-$getParams = array();
-$response = $tokenService->get($getParams)->wait();
-var_dump($response);
-```
 
-### Transaction Module 
+### Transactions Module 
 
 ```php
 $transactionService = $ostObj->services->transactions;
@@ -221,7 +217,21 @@ $response = $transactionService->execute($executeParams)->wait();
 var_dump($response);
 ```
 
-### Transfer Module 
+### Token Module 
+
+```php
+$tokenService = $ostObj->services->token;
+```
+
+Get Token Detail:
+
+```php
+$getParams = array();
+$response = $tokenService->get($getParams)->wait();
+var_dump($response);
+```
+
+### Transfers Module 
 
 ```php
 $transferService = $ostObj->services->transfers;

README_V0.md

@@ -39,11 +39,11 @@ Initialize the SDK object:
 ```php
 
 $params = array();
-$params['apiKey']='API_KEY';
-$params['apiSecret']='API_SECRET';
+$params['apiKey']=API_KEY;
+$params['apiSecret']=API_SECRET;
 $params['apiBaseUrl']='https://playgroundapi.ost.com/';
 
-$ostObj = new OSTSDK($params);
+$ostObj = new OSTSdk($params);
 
 ```
 

src/Lib/Request.php

@@ -229,9 +229,9 @@ private function isInternalResponse($jsonObject) {
   /**
    * copy over the passed input args and process
    *
-   * @param object $arguments json object
+   * @param array $arguments json object
    *
-   * @return object
+   * @return array
    *
    */
   private function copyAndSanitizeArgs($arguments) {

src/Services/Base.php

@@ -43,7 +43,7 @@ public function __construct($requestObj, $urlPrefix)
   protected function getId($params)
   {
     if (\Lib\Validate::isPresent($params['id'])) {
-      return $params['id'];
+      return urlencode($params['id']);
     } else {
       throw new \Exception('id missing in request params');
     }