Merge pull request #31 from ostdotcom/base_tokens_api

Added base tokens module to V2 API's

Author: kedarchandrayan

.travis.yml

@@ -1,10 +1,9 @@
 language: java
+dist: xenial
 # The cross product of the jdk and env settings form the matrix of builds Travis will run.
 jdk:
-  - oraclejdk8
-  - oraclejdk9
-  - openjdk7
   - openjdk8
+  - openjdk9
 notifications:
   email:
     recipients:

CHANGELOG.md

@@ -1,3 +1,8 @@
+[OST JAVA SDK v2.1.0](https://github.com/ostdotcom/ost-sdk-java/tree/v2.1.0)
+---
+
+* Added base tokens module to V2 API's
+
 [OST JAVA SDK v2.0.0](https://github.com/ostdotcom/ost-sdk-java/tree/v2.0.0)
 ---
 

README.md

@@ -9,16 +9,15 @@ OST is a complete technology solution enabling mainstream businesses
 to easily launch blockchain-based economies without 
 requiring blockchain development.
 
-At the core of OST is the concept of OST-powered Brand Tokens (BTs). 
-BTs are white-label cryptocurrency tokens with utility representations 
+Brand Tokens (BTs) are white-label cryptocurrency tokens with utility representations 
 running on highly-scalable Ethereum-based side blockchains, 
-backed by OST tokens staked on Ethereum mainnet. Within a business’s 
+backed by value token (such as OST, USDC) staked on Ethereum mainnet. Within a business’s 
 token economy, BTs can only be transferred to whitelisted user addresses. 
 This ensures that they stay within the token economy.
 
 The OST technology stack is designed to give businesses everything they need 
 to integrate, test, and deploy BTs. Within the OST suite of products, developers 
-can use OST Platform to create, test, and launch Brand Tokens backed by OST. 
+can use OST Platform to create, test, and launch Brand Tokens backed by value token (such as OST, USDC). 
 
 OST APIs and server-side SDKs make it simple and easy for developers to 
 integrate blockchain tokens into their apps.
@@ -43,7 +42,7 @@ with OST Platform, requiring only three steps:
 <dependency>
   <groupId>com.ost</groupId>
   <artifactId>ost-sdk-java</artifactId>
-  <version>2.0.0</version>
+  <version>2.1.0</version>
 </dependency>
 ```
 
@@ -293,7 +292,7 @@ System.out.println("response: " + response.toString() );
 
 #### Price Points Module
 
-To know the OST price point in USD and when it was last updated, 
+To know the value token (such as OST, USDC) price point in pay currency and when it was last updated, 
 use services provided by the Price Points module.
 
 ```java
@@ -414,12 +413,12 @@ arrayListAmount.add(amount);
 Gson gsonObj = new Gson();
 String tokenHolderSender = "0xa9632350057c2226c5a10418b1c3bc9acdf7e2ee";
 String payCurrencyCode = "USD";
-String ostToUsd = "23757000000000000";
+String intendedPricePoint = "23757000000000000";
 nestedarraylist.add(tokenHolderSender);
 nestedarraylist.add(arrayListForUser2TokenHolderAddress);
 nestedarraylist.add(arrayListAmount);
 nestedarraylist.add(payCurrencyCode);
-nestedarraylist.add(ostToUsd);
+nestedarraylist.add(intendedPricePoint);
 nestedparams.put("parameters", nestedarraylist);
 String jsonStr = gsonObj.toJson(nestedparams);
 params.put("raw_calldata", jsonStr);
@@ -543,3 +542,21 @@ params.put("chain_id", "200");
 JsonObject response = chainsService.get( params );
 System.out.println("response: " + response.toString() );
 ```
+
+### Base Tokens Module
+
+To get information about the value tokens (such as OST, USDC) available on the OST Platform interface, use services
+provided by the Base Tokens module. You can use this service to obtain the base token details
+on OST Platform interface.
+
+```java
+com.ost.services.BaseTokens baseTokensService = services.baseTokens;
+```
+
+Get Base Token Detail:
+
+```java
+HashMap <String,Object> params = new HashMap<String,Object>();
+JsonObject response = baseTokensService.get( params );
+System.out.println("response: " + response.toString() );
+```

VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.ost</groupId>
     <artifactId>ost-sdk-java</artifactId>
-    <version>2.0.0-SNAPSHOT</version>
+    <version>2.1.0-SNAPSHOT</version>
     <name>OST SDK for Java</name>
     <description>OST Platform SDK for Java</description>
     <packaging>jar</packaging>

src/main/java/com/ost/services/BaseTokens.java

@@ -0,0 +1,27 @@
+package com.ost.services;
+
+import com.google.gson.JsonObject;
+import com.ost.lib.OSTRequestClient;
+
+import java.io.IOException;
+import java.util.Map;
+
+public class BaseTokens extends OSTAPIService {
+    private static String servicePrefix = "/base-tokens";
+    private static String serviceSuffix = "";
+
+
+    public BaseTokens(OSTRequestClient ostRequestClient) {
+        super(ostRequestClient, servicePrefix, serviceSuffix);
+    }
+
+    /**
+     * Get base token details
+     * @param params Request Params
+     * @return API Response
+     */
+    public JsonObject get( Map<String,Object> params ) throws MissingParameter, IOException {
+        String resource = this.urlPrefix + "/";
+        return this.request.get(resource, params);
+    }
+}

src/main/java/com/ost/services/Manifest.java

@@ -15,6 +15,7 @@ public class Manifest extends OSTServiceManifest {
     public RecoveryOwners recoveryOwners;
     public Devices devices;
     public Chains chains;
+    public BaseTokens baseTokens;
 
 
     public Manifest( Map<String, Object> params) {
@@ -34,6 +35,7 @@ protected void init() {
         this.recoveryOwners = new RecoveryOwners( this.request );
         this.devices = new Devices( this.request );
         this.chains = new Chains( this.request );
+        this.baseTokens = new BaseTokens( this.request );
     }
 
 }

src/test/java/com/ost/services/BaseTokensTest.java

@@ -0,0 +1,38 @@
+package com.ost.services;
+
+import com.google.gson.JsonObject;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.HashMap;
+
+public class BaseTokensTest extends ServiceTestBase {
+    @Override
+    public BaseTokens getService() {
+        return (BaseTokens) super.getService();
+    }
+
+    @Before
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        setService(getServiceManifest().baseTokens);
+    }
+
+    @Override
+    public Manifest getServiceManifest() {
+        return (Manifest) super.getServiceManifest();
+    }
+
+    @Test
+    public void get() throws Exception {
+        HashMap<String, Object> params = new HashMap<String, Object>();
+
+        // Test-Case: Get a Base Token.
+        JsonObject response;
+        response = getService().get(params);
+        validateResponseWithSuccess(response);
+
+    }
+
+}