Merge pull request #31 from EbenezerGH/clean-up

Handle some tech debt

Author: EbenezerGH

app/src/main/AndroidManifest.xml

@@ -2,6 +2,8 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
           package="jfyg.etherscan.helloetherescan">
 
+    <uses-permission android:name="android.permission.INTERNET"/>
+
     <application
         android:name=".HelloEtherscanApplication"
         android:allowBackup="true"
@@ -22,6 +24,4 @@
         </activity>
     </application>
 
-    <uses-permission android:name="android.permission.INTERNET"/>
-
 </manifest>

app/src/main/java/jfyg/etherscan/helloetherescan/HelloEtherscanApplication.kt

@@ -1,11 +1,13 @@
 package jfyg.etherscan.helloetherescan
 
 import android.app.Application
-import jfyg.etherscanapi.ApiKey
+import jfyg.ApiKey
 
 class HelloEtherscanApplication : Application() {
     override fun onCreate() {
         super.onCreate()
+
+        //************************************************  Used To Test Library
         ApiKey.takeOff.setApiKey("1I7CRNU2QIU253UBPFVB5UV2C2PBDURAIYZ")
     }
 }

app/src/main/java/jfyg/etherscan/helloetherescan/MainActivity.kt

@@ -3,21 +3,34 @@ package jfyg.etherscan.helloetherescan
 import android.os.Bundle
 import android.support.v7.app.AppCompatActivity
 import android.util.Log
-import jfyg.etherscanapi.stats.EthereumStat
+import jfyg.stat.Stat
 import kotlinx.android.synthetic.main.activity_main.*
 
 
 class MainActivity : AppCompatActivity() {
-    private val stat = EthereumStat()
+    private val TAG = javaClass.name
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
         setSupportActionBar(toolbar)
 
+        //************************************************  Used To Test Library
+        val stat = Stat() //TODO #29
+
         fab.setOnClickListener {
-            Log.d("Ebenezer", stat.getLastPriceInBtc())
+
+            Log.d(TAG, "The Status is ${stat.getNetworkStatus()}")
+            Log.d(TAG, "The Message is ${stat.getNetworkMessage()}")
+            Log.d(TAG, "The current price of Ether in Btc:  ${stat.getLastPriceInBtc()}")
+            Log.d(TAG, "Timestamp price in Btc:  ${stat.getBtcTimestamp()}")
+            Log.d(TAG, "Timestamp price in Ether:  ${stat.getEthTimestamp()}")
+            Log.d(TAG, "The current price of Ether in Usd:  ${stat.getLastPriceInUsd()}")
+            Log.d(TAG, "The total supply of Ether:  ${stat.getTotalSupply()}")
+            Log.d(TAG, "The total supply of Ether in Wei:  ${stat.getTotalSupplyInWei()}")
+
         }
     }
 
+
 }

app/src/main/res/values/strings.xml

@@ -1,5 +1,5 @@
 <resources>
-    <string name="app_name">Hello Ethere Scan</string>
+    <string name="app_name">Hello Etherscan</string>
     <string name="action_settings">Settings</string>
 
     <string name="base_url">http://api.etherscan.io/</string>

etherscanapi/src/main/java/jfyg/etherscanapi/ApiKey.kt renamed to etherscanapi/src/main/java/jfyg/ApiKey.kt

@@ -1,8 +1,15 @@
-package jfyg.etherscanapi
+package jfyg
 
 import android.util.Log
 
+/**
+ * Retrieves and stores the user's Api key
+ */
 class ApiKey private constructor() {
+    private val TAG = javaClass.name
+
+    private var apiKey: String? = null
+
     private object Holder {
         val TakeOff = ApiKey()
     }
@@ -11,11 +18,9 @@ class ApiKey private constructor() {
         val takeOff: ApiKey by lazy { Holder.TakeOff }
     }
 
-    private var apiKey: String? = null
-
     fun callApiKey(): String? {
         if (apiKey == null) {
-            Log.w("", "No api key seems to be added.  No record of your queries will be kept in your " +
+            Log.w(TAG, "No api key seems to be added.  No record of your queries will be kept in your " +
                     "https://etherscan.io/ console")
         }
         return takeOff.apiKey

etherscanapi/src/main/java/jfyg/etherscanapi/Queries.kt

@@ -1,7 +1,7 @@
-package jfyg.etherscanapi.network
+package jfyg.network
 
 import io.reactivex.Single
-import jfyg.etherscanapi.responses.MainResponse
+import jfyg.response.MainResponse
 import retrofit2.http.GET
 import retrofit2.http.Query
 
@@ -14,4 +14,5 @@ interface NetworkService {
     fun getEtherStats(@Query("module") module: String,
                       @Query("action") action: String,
                       @Query("apikey") apikey: String?): Single<MainResponse>
+
 }

etherscanapi/src/main/java/jfyg/etherscanapi/model/BaseModel.kt

@@ -1,4 +1,4 @@
-package jfyg.etherscanapi.network
+package jfyg.network
 
 import retrofit2.Retrofit
 import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
@@ -10,8 +10,7 @@ import com.google.gson.GsonBuilder
  */
 class RestClient {
 
-    //TODO: Retrieve baseUrl from string resources
-    private var baseUrl: String = "http://api.etherscan.io/"
+    private var baseUrl: String = "http://api.etherscan.io/" //TODO: #28
     private var networkService: NetworkService
 
     init {

etherscanapi/src/main/java/jfyg/etherscanapi/model/EtherPriceModel.kt

@@ -0,0 +1,37 @@
+package jfyg.queries
+
+import android.util.Log
+import io.reactivex.android.schedulers.AndroidSchedulers
+import io.reactivex.disposables.Disposable
+import io.reactivex.schedulers.Schedulers
+import jfyg.ApiKey
+import jfyg.network.RestClient
+import jfyg.response.MainResponse
+
+/**
+ * A mediator between the responses and errors that come from every query
+ */
+class Queries : StatQueries {
+    private val TAG = javaClass.name
+
+    private var statInfo = MainResponse()
+
+    override fun stats(module: String, action: String): Disposable =
+            RestClient().getQuery()
+                    .getEtherStats(module, action, ApiKey.takeOff.callApiKey())
+                    .observeOn(AndroidSchedulers.mainThread())
+                    .subscribeOn(Schedulers.io())
+                    .subscribe(this::handleResponse, this::handleError)
+
+
+    override fun handleResponse(response: MainResponse) {
+        statInfo = response
+    }
+
+    private fun handleError(error: Throwable) {
+        Log.d(TAG, "The error " + error.message)
+    }
+
+    fun fetchStatResponse(): MainResponse? = statInfo
+
+}

etherscanapi/src/main/java/jfyg/etherscanapi/responses/EtherPriceResponse.kt

@@ -0,0 +1,12 @@
+package jfyg.queries
+
+import io.reactivex.disposables.Disposable
+import jfyg.response.MainResponse
+
+interface StatQueries {
+
+    fun stats(module: String, action: String): Disposable?
+
+    fun handleResponse(response: MainResponse)
+
+}

etherscanapi/src/main/java/jfyg/etherscanapi/responses/MainResponse.kt

@@ -0,0 +1,17 @@
+package jfyg.response
+
+import com.google.gson.annotations.SerializedName
+
+/**
+ * Base response that all queries will utilize
+ */
+class MainResponse {
+
+    var status: String? = null
+
+    var message: String? = null
+
+    @SerializedName("result") //TODO Issue #26
+    var statResult: StatResponse? = null
+
+}