TrueTime 4.0 : Kotlin & coroutines

README.md

@@ -2,26 +2,68 @@
 
 ![TrueTime](truetime.png "TrueTime for Android")
 
+*⚠️ See work in progress section below. TrueTime is undergoing some changes*
+
+----------------------------------------
+
 *Make sure to check out our counterpart too: [TrueTime](https://github.com/instacart/TrueTime.swift), an NTP library for Swift.*
 
 NTP client for Android. Calculate the date and time "now" impervious to manual changes to device clock time.
 
-In certain applications it becomes important to get the real or "true" date and time. On most devices, if the clock has been changed manually, then a `new Date()` instance gives you a time impacted by local settings.
+In certain applications it becomes important to get the real or "true" date and time. On most devices, if the clock has been changed manually, then a `Date()` instance gives you a time impacted by local settings.
 
 Users may do this for a variety of reasons, like being in different timezones, trying to be punctual by setting their clocks 5 – 10 minutes early, etc. Your application or service may want a date that is unaffected by these changes and reliable as a source of truth. TrueTime gives you that.
 
 You can read more about the use case in our [blog post](https://tech.instacart.com/truetime/).
 
-In a [recent conference talk](https://vimeo.com/190922794), we explained how the full NTP implementation works with Rx. Check the [video](https://vimeo.com/190922794) and [slides](https://speakerdeck.com/kaushikgopal/learning-rx-by-example-2?slide=31) out for implementation details.
+In a [conference talk](https://vimeo.com/190922794), we explained how the full NTP implementation works (with Rx). Check the [video](https://vimeo.com/190922794#t=1466s) and [slides](https://speakerdeck.com/kaushikgopal/learning-rx-by-example-2?slide=31) out for implementation details.
+
+
+# Work in Progress 4.0
+
+With the move to Kotlin & Coroutines TrueTime 4 was a [major overhaul](https://github.com/instacart/truetime-android/pull/129). We still haven't ported some of the additional bells & whistles. This section keeps track of those features (that will come in the near future). TrueTime is completely functional without these additional features, so feel free to start using it.
+
+- [ ] Fix Jitpack import
+
+I may have busted the jitpack import. Got to fix this first.
+
+- [ ] Introduce a Cache provider
+
+* Add an `interface CacheProvider` so folks can inject in their preferred caching mechanisms
+* Provide a default cache implementation (probably using the non-android version of [DataStore](https://developer.android.com/topic/libraries/architecture/datastore#kts))
+* ? Provide example of using this with a Database like Realm
+
+- [ ] BootCompletedBroadcastReceiver sample
 
-Also, once we have this information it's valid until the next time you boot your device. This means if you enable the disk caching feature, after a single successful NTP request you can use the information on disk directly without ever making another network request. This applies even across application kills which can happen frequently if your users have a memory starved device.
+Everytime a device is rebooted, the Truetime info is invalid. Previous libraries included an actual `BroadcastReceiver` but this is better handled by the application than the library. For safe measure, I'll include an example of how this can be done in case folks are curious.
+
+- [ ] Utilize all ntp pool addresses from `TrueTimeParameters.ntpHostPool`
+
+We currently only take the first ntp host pool address from the supplied parameters. In the future, it would be nice to provide multiple ntp "pool" addresses like `time.google.com`, `time.apple.com` and utilize all of those to get the "best" value.
+
+- [ ] Algorithmic improvements
+
+There are some exciting improvements that we have planned and use internally. Will have to upstream these changes (with a cleaner api + implementation)
 
 # Installation
 
-[See the wiki instructions](https://github.com/instacart/truetime-android/wiki/How-to-use-this-library).
+*⚠️ The Wiki has not been updated to the latest version of TrueTime*
+
+[See the wiki for full instructions](https://github.com/instacart/truetime-android/wiki/How-to-use-this-library).
+
+## Usage
+
+```kt
+val trueTime = TrueTimeImpl()
+trueTime.sync()
+trueTime.now()
+```
+
+💥
 
 # Wiki has a lot of useful information
 
+*⚠️ The Wiki has not been updated to the latest version of TrueTime*
 Take a look at [the wiki sidebar](https://github.com/instacart/truetime-android/wiki) which should have a lot of useful information.
 
 # License

app/build.gradle

@@ -1,43 +1,54 @@
 apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
 
 android {
     compileSdkVersion rootProject.ext.compileSdkVersion
 
     defaultConfig {
-        applicationId "com.instacart.library.truetime"
+        applicationId "com.instacart.truetime"
         minSdkVersion 14
         targetSdkVersion rootProject.ext.targetSdkVersion
 
         versionCode rootProject.ext.versionCode
         versionName rootProject.ext.versionName
 
-        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
     buildTypes {
         release {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
+
+    buildFeatures {
+        viewBinding true
+    }
 }
 
 repositories {
     maven {
         url "https://jitpack.io"
     }
+    mavenCentral()
 }
 
-ext {
-    butterknifeVersion = '8.8.1'
-}
 dependencies {
     implementation project(path: ':library')
-    implementation project(path: ':library-extension-rx')
-//    compile 'com.github.instacart.truetime-android:library-extension-rx:master-SNAPSHOT'
-
-    implementation 'com.android.support:appcompat-v7:27.1.1'
-    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
-    implementation "com.jakewharton:butterknife:$butterknifeVersion"
-    annotationProcessor "com.jakewharton:butterknife-compiler:$butterknifeVersion"
-    implementation "io.reactivex.rxjava2:rxandroid:2.0.2"
+//    implementation project(path: ':library-extension-rx')
+    implementation 'com.github.instacart.truetime-android:library-extension-rx:3.5'
+
+    implementation "org.jetbrains.kotlin:kotlin-stdlib"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines_version"
+
+    implementation 'androidx.appcompat:appcompat:1.5.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
+
+    implementation "io.reactivex.rxjava2:rxandroid:2.1.1"
 }

app/src/main/AndroidManifest.xml

@@ -10,12 +10,13 @@
         android:name=".App"
         android:theme="@style/AppTheme">
 
-        <activity android:name=".Sample2Activity">
+        <activity android:name=".SampleActivity">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+
     </application>
 
-</manifest>
+</manifest>

app/src/main/java/com/instacart/library/sample/App.kt

@@ -0,0 +1,19 @@
+package com.instacart.library.sample
+
+import android.app.Application
+import com.instacart.truetime.time.TrueTime
+import com.instacart.truetime.time.TrueTimeImpl
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
+
+@Suppress("unused")
+class App : Application() {
+
+//    val trueTime = TrueTimeImpl()
+
+    override fun onCreate() {
+        super.onCreate()
+//        trueTime.sync()
+    }
+
+}