Merge pull request #4 from freshbits/v2.1

Add Kotlin App

Author: jhabr

.gitignore

@@ -5,5 +5,5 @@ local.properties
 .DS_Store
 build/
 /captures
-repo/
+PathshareSDK/
 *.iml

README.md

@@ -1,7 +1,10 @@
 # Pathshare SDK for Android
 
+
+![GitHub release](https://img.shields.io/github/release/freshbits/pathshare-sdk-android.svg?style=flat)
 ![Platform](https://img.shields.io/badge/platform-android-green.svg?style=flat)
 ![Language](https://img.shields.io/badge/language-java-brightgreen.svg?style=flat)
+![Language](https://img.shields.io/badge/language-kotlin-brightgreen.svg?style=flat)
 
 **Pathshare** is a realtime location sharing platform. For more information please visit the [Pathshare Developer Page](https://pathsha.re/professional/developers).
 
@@ -26,11 +29,11 @@
 
 The installation of the `PathshareSDK` is simple. Download the latest `pathshare-sdk-android-[version].zip` from [Releases](https://github.com/freshbits/pathshare-sdk-android/releases), unzip and copy the `repo` folder into the root of your project.
 
-Next, reference the `repo` folder in your application `build.gradle` file:
+Next, reference the `PathareSDK` folder in your application `build.gradle` file:
 
 ```gradle
 repositories {
-    maven { url "file://$projectDir/../repo" }
+    maven { url "file://$projectDir/../PathshareSDK" }
 }
 
 dependencies {
@@ -54,6 +57,7 @@ In order to initialize the `PathshareSDK`, create a file named `pathshare.xml` i
 
 Next, add the following to the `onCreate` method of your `Application` class:
 
+###### Java
 ```java
 public class ExampleApplication extends Application {
     @Override
@@ -64,6 +68,17 @@ public class ExampleApplication extends Application {
     }
 }
 ```
+###### Kotlin
+```kotlin
+class ExampleApplication: Application() {
+
+    override fun onCreate() {
+        super.onCreate()
+
+        Pathshare.initialize(this, getString(R.string.pathshare_account_token), TrackingMode.SMART)
+    }
+}
+```
 
 Optionally, you can specify a tracking mode to configure the behavior of the location tracker. The following tracking modes are available:
 
@@ -78,6 +93,7 @@ Tracking Mode      | Description
 
 Before creating a session, you need to set a username:
 
+###### Java
 ```java
 Pathshare.client().saveUser("Candice", "+12345678901", UserType.DRIVER, new ResponseListener() {
     @Override
@@ -92,6 +108,19 @@ Pathshare.client().saveUser("Candice", "+12345678901", UserType.DRIVER, new Resp
 });
 ```
 
+###### Kotlin
+```kotlin
+Pathshare.client().saveUser("SDK User Android", "+12345678901", UserType.DRIVER, object: ResponseListener {
+    override fun onSuccess() {
+        // ...
+    }
+
+    override fun onError() {
+        // ...
+    }
+})
+```
+
 There are different types of users for specific industries:
 
 User Types                  | Description
@@ -104,18 +133,28 @@ User Types                  | Description
 
 To create a session, use the session builder:
 
+###### Java
 ```java
 session = new Session.Builder()
     .setExpirationDate(expirationDate)
     .setName("Shopping")
     .build();
 ```
 
+###### Kotlin
+```kotlin
+session = Session.Builder()
+    .setExpirationDate(expirationDate)
+    .setName("Shopping")
+    .build()
+```
+
 A session needs an expiration date and a name. You can create multiple sessions at the same time, the SDK will manage them for you.
 
 
 Make sure to save the session after building:
 
+###### Java
 ```java
 session.save(new ResponseListener() { ... });
 
@@ -124,10 +163,20 @@ session.isExpired() // => false
 session.getURL() // => https://pathsha.re/6d39d5
 ```
 
+###### Kotlin
+```kotlin
+session.save(object: ResponseListener { ... })
+
+session.identifier // => 3fd919fe824d8e7b78e2c11c1570a6f168d2c...
+session.isExpired // => false
+session.url // => https://pathsha.re/6d39d5
+```
+
 #### Expiration
 
 In order to react to the expiration of the session, add an `ExpirationListener`:
 
+###### Java
 ```java
 session = new Session.Builder()
     // ...
@@ -140,10 +189,19 @@ session = new Session.Builder()
     .build();
 ```
 
+###### Kotlin
+```kotlin
+session = Session.Builder()
+    // ...
+    .setSessionExpirationListener { // ... }
+    .build()
+```
+
 #### Destination
 
 Optionally, you can add a destination to the session. Sessions with destination will show the estimated time of arrival (ETA) for each user. The destination identifier is used to group sessions by destination.
 
+###### Java
 ```java
 Destination destination = new Destination.Builder()
     .setIdentifier("W2342")
@@ -157,24 +215,47 @@ session = new Session.Builder()
     .build();
 ```
 
+###### Kotlin
+```kotlin
+val destination = Destination.Builder()
+    .setIdentifier("W2342")
+    .setLatitude(47.378178)
+    .setLongitude(8.539256)
+    .build()
+
+session = Session.Builder()
+    // ...
+    .setDestination(destination)
+    .build()
+```
+
 ### Join Session
 
 To join the session you created, call the `joinUser()` method on the session object:
 
+###### Java
 ```java
 session.join(new ResponseListener() { ... });
 
 session.isUserJoined() // => true
 ```
 
+###### Kotlin
+```kotlin
+session.join(object: ResponseListener { ... })
+
+session.isUserJoined // => true
+```
+
 This call will add your Pathshare user to the session and you will be able to see his location on a map in realtime in the Pathshare Professional web interface.
 
 ### Invite customer
 
 To invite a customer to the session, call the `inviteUser()` method on the session object:
 
+###### Java
 ```java
-session.inviteUser("Customer name", UserType.CLIENT, "customer@email.com", "+12345678901", new InvitationResponseListener() {
+session.inviteUser("Customer", UserType.CLIENT, "customer@email.com", "+12345678901", new InvitationResponseListener() {
     @Override
     public void onSuccess(URL url) {
         // ...
@@ -187,6 +268,20 @@ session.inviteUser("Customer name", UserType.CLIENT, "customer@email.com", "+123
 });
 ```
 
+###### Kotlin
+```kotlin
+session.inviteUser("Customer", UserType.CLIENT, "customer@me.com", "+12345678901", object: InvitationResponseListener {
+    override fun onSuccess(url: URL?) {
+        // ...
+        Log.d("URL", url.toString()) // => https://m.pathsha.re/12s83a
+    }
+
+    override fun onError() {
+        // ...
+    }
+})
+```
+
 This call will create a customer user and return an invitation URL that can be sent to the customer using your preffered channel. The customer will then see the driver's location in realtime as well as the ETA in a white-labeled view with your corporate identity.
 
 The customer will be able to enjoy the full realtime experience in the web browser of their smartphone:
@@ -197,14 +292,21 @@ The customer will be able to enjoy the full realtime experience in the web brows
 
 In order to stop sending user location and remove the user from the session, call the `leaveUser()` method:
 
+###### Java
 ```java
 session.leave(new ResponseListener() { ... });
 ```
 
+###### Kotlin
+```kotlin
+session.leave(object: ResponseListener { ... })
+```
+
 ### Find Session
 
 To find an existing session, use the `findSession()` method with the corresponding session identifier:
 
+###### Java
 ```java
 Pathshare.client().findSession(identifier, new SessionResponseListener() {
     @Override
@@ -218,3 +320,14 @@ Pathshare.client().findSession(identifier, new SessionResponseListener() {
     public void onError() { ... }
 }
 ```
+
+###### Kotlin
+```kotlin
+Pathshare.client().findSession(identifier, object: SessionResponseListener {
+    override fun onSuccess(session: Session?) {
+        session.sessionExpirationListener = SessionExpirationListener { ... }
+    }
+
+    override fun onError() { ... }
+})
+```

android-example-app/app-kotlin/.gitignore

@@ -0,0 +1 @@
+/build

android-example-app/app-kotlin/build.gradle

@@ -0,0 +1,47 @@
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-android-extensions'
+android {
+    compileSdkVersion 27
+
+    defaultConfig {
+        applicationId "ch.freshbits.pathshare.example"
+        minSdkVersion 21
+        targetSdkVersion 27
+        versionCode 2_1_0
+        versionName "2.1.0"
+
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+    }
+
+    lintOptions {
+        abortOnError false
+    }
+
+    buildTypes {
+        debug {
+            debuggable true
+            zipAlignEnabled false
+            minifyEnabled false
+        }
+
+        release {
+            debuggable false
+            zipAlignEnabled true
+            minifyEnabled false
+        }
+    }
+}
+
+repositories {
+    maven { url "file://$projectDir/../PathshareSDK" }
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation 'com.android.support:appcompat-v7:27.1.1'
+    implementation 'ch.freshbits.pathshare.sdk:pathshare-sdk:2.1.0'
+    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
+    implementation 'com.android.support:design:27.1.1'
+}

android-example-app/app-kotlin/src/main/AndroidManifest.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="ch.freshbits.pathshare.example">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application
+        android:name="ch.freshbits.pathshare.example.ExampleApplication"
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:theme="@style/AppTheme" >
+        <activity
+            android:name="ch.freshbits.pathshare.example.MainActivity"
+            android:label="@string/app_name" >
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

android-example-app/app-kotlin/src/main/java/ch/freshbits/pathshare/example/ExampleApplication.kt

@@ -0,0 +1,14 @@
+package ch.freshbits.pathshare.example
+
+import android.app.Application
+import ch.freshbits.pathshare.sdk.Pathshare
+import ch.freshbits.pathshare.sdk.location.TrackingMode
+
+class ExampleApplication: Application() {
+
+    override fun onCreate() {
+        super.onCreate()
+
+        Pathshare.initialize(this, getString(R.string.pathshare_account_token), TrackingMode.SMART)
+    }
+}