Merge pull request #16 from OpenSTFoundation/santhosh/balances_and_ledger

Refactoring + Balance and Ledger API changes

Author: sunilkhedar

.editorconfig

@@ -12,4 +12,4 @@ end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 indent_style = space
-indent_size = 4
+indent_size = 2

.gitignore

@@ -3,3 +3,4 @@ docs
 composer.lock
 .idea
 .env
+.env.example

README.md

@@ -265,3 +265,33 @@ $executeParams['amount'] = '1';
 $response = $transferService->execute($executeParams)->wait();
 var_dump($response);
 ```
+
+### Balance Module 
+
+```php
+$balanceService = $ostObj->services->balances;
+```
+Get User balance:
+
+```php
+$getParams = array();
+$getParams['id'] = 'ad03a99e-e7c4-4f5a-9fab-ef9a3e422621';
+$response = $balanceService->get($getParams)->wait();
+var_dump($response);
+```
+
+### Ledger Module
+
+```php
+$ledgerService = $ostObj->services->ledger;
+```
+
+Get User Ledger:
+
+```php
+$getParams = array();
+$getParams['id'] = 'ad03a99e-e7c4-4f5a-9fab-ef9a3e422621';
+$response = $ledgerService->get($getParams)->wait();
+var_dump($response);
+```
+

src/Lib/Request.php

@@ -82,7 +82,7 @@ function ($response) {
                 return $this->parseResponse($response);
             },
             // $onRejected
-            function () {
+            function ($reason) {
                 return $this->customGenericErrorResponse('g_1');
             }
         );
@@ -120,7 +120,7 @@ function ($response) {
                 return $this->parseResponse($response);
             },
             // $onRejected
-            function () {
+            function ($reason) {
                 return $this->customGenericErrorResponse('p_1');
             }
         );

src/OSTSdk.php

@@ -26,10 +26,10 @@ class OSTSdk
     public function __construct(array $params)
     {
         // Extract API major version
-        $apiEndpointVersion = explode('/', $params['apiBaseUrl']);
-        if (empty($apiEndpointVersion[3])) {
+        $apiEndpointVersion = explode('/', $params['apiBaseUrl'])[3];
+        if (empty($apiEndpointVersion)) {
             $this->services = new \OST\V0\Manifest($params);
-        } elseif (!empty($apiEndpointVersion[3]) && strtolower($apiEndpointVersion[3]) === 'v1') {
+        } elseif (!empty($apiEndpointVersion) && strtolower($apiEndpointVersion) === 'v1') {
             $this->services = new \OST\V1\Manifest($params);
         } else {
             throw new \Exception('Api endpoint is invalid');

src/Services/V1/Airdrops.php

@@ -5,10 +5,12 @@
 
 namespace OST\V1;
 
+use OST\Base;
+
 /**
  * Class encapsulating methods to interact with V1 API's for Airdrops module
  */
-class Airdrops extends \OST\Base
+class Airdrops extends Base
 {
     const PREFIX = '/airdrops';
 

src/Services/V1/Balances.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Balances class
+ */
+
+namespace OST\V1;
+
+use OST\Base;
+
+/**
+ * Class encapsulating methods to interact with V1 API's for Balances module
+ */
+class Balances extends Base
+{
+
+  const PREFIX = '/balances';
+
+  /**
+   * Get balance of user
+   *
+   * @param array $params params for fetching balance of user
+   *
+   * @throws \Exception
+   *
+   * @return object
+   *
+   */
+  public function get($params = array()) {
+    return $this->requestObj->get($this->getPrefix() . '/' . $this->getId($params) . '/', $params);
+  }
+
+}

src/Services/V1/Ledger.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * Ledger class
+ */
+
+namespace OST\V1;
+
+use OST\Base;
+
+/**
+ * Class encapsulating methods to interact with V1 API's for Ledger module
+ */
+class Ledger extends Base
+{
+
+  const PREFIX = '/ledger';
+
+  /**
+   * Get ledger for user
+   *
+   * @param array $params params for fetching ledger for an user
+   *
+   * @throws \Exception
+   *
+   * @return object
+   *
+   */
+  public function get($params = array()) {
+    return $this->requestObj->get($this->getPrefix() . '/' . $this->getId($params) . '/', $params);
+  }
+
+}

src/Services/V1/Manifest.php

@@ -30,28 +30,39 @@ class Manifest
     /** @var Transfers object which has methods to fire API's belonging to Transfers module */
     public $transfers;
 
-    /**
-     * Constructor
-     *
-     * @param array $params Array containing the necessary params {
-     * @type string $apiKey API Key.
-     * @type string $apiSecret API Secret.
-     * @type string $baseUrl Base API URL.
-     * }
-     *
-     * @throws \Exception
-     *
-     */
-    public function __construct($params)
-    {
-        $requestObj = new Request($params);
-
-        // Define services available in V1
-        $this->users = new Users($requestObj);
-        $this->actions = new Actions($requestObj);
-        $this->airdrops = new Airdrops($requestObj);
-        $this->token = new Token($requestObj);
-        $this->transactions = new Transactions($requestObj);
-        $this->transfers = new Transfers($requestObj);
-    }
+    /** @var Balances object which has methods to fire API's belonging to Balances module */
+    public $balances;
+
+    /** @var Ledger object which has methods to fire API's belonging to Ledger module */
+    public $ledger;
+
+  /**
+   * Constructor
+   *
+   * @param array $params Array containing the necessary params {
+   *      @type string $apiKey API Key.
+   *      @type string $apiSecret API Secret.
+   *      @type string $baseUrl Base API URL.
+   * }
+   *
+   * @throws \Exception
+   *
+   */
+  public function __construct($params)
+  {
+
+    $requestObj = new Request($params);
+
+    // Define services available in V1
+    $this->users = new Users($requestObj);
+    $this->actions = new Actions($requestObj);
+    $this->airdrops = new Airdrops($requestObj);
+    $this->token = new Token($requestObj);
+    $this->transactions = new Transactions($requestObj);
+    $this->transfers = new Transfers($requestObj);
+    $this->balances = new Balances($requestObj);
+    $this->ledger = new Ledger($requestObj);
+
+  }
+
 }

src/Services/V1/Token.php

@@ -12,7 +12,7 @@
  */
 class Token extends Base
 {
-    const TOKEN = '/token';
+    const PREFIX = '/token';
 
     /**
      * Get token details