Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matteocrippa/Raincoat
🧥 Analytics abstraction layer for Kotlin
https://github.com/matteocrippa/Raincoat
analytics android fabric-analytics flurry-analytics google-analytics kotlin localytics mixpanel
Last synced: 2 months ago
JSON representation
🧥 Analytics abstraction layer for Kotlin
- Host: GitHub
- URL: https://github.com/matteocrippa/Raincoat
- Owner: matteocrippa
- License: mit
- Created: 2017-12-26T17:47:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T11:22:50.000Z (about 7 years ago)
- Last Synced: 2024-09-21T00:31:23.745Z (4 months ago)
- Topics: analytics, android, fabric-analytics, flurry-analytics, google-analytics, kotlin, localytics, mixpanel
- Language: Kotlin
- Size: 145 KB
- Stars: 24
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - Raincoat - Analytics abstraction layer. (Libraries / Analytics)
README
# 🧥 Raincoat
Analytics abstraction layer for Kotlin inspired by [Umbrella](https://github.com/devxoul/Umbrella).
## Table of Contents
* [Getting Started](#getting-started)
* [Example](#example)
* [Providers](#providers)
* [Custom Provider](#custom-provider)
* [Creating Custom Providers](#creating-custom-providers)
* [Installation](#installation)
* [License](#license)
## Getting Started
As you can see it is really simple to log with different analytics with a simple function:
```kotlin
val analytics = Raincoat()
analytics.register(FirebaseProvider(context))
analytics.register(MixpanelProvider(context))
analytics.log(MyEvent.SignUp("username"))
```
### Example
Using `Kotlin` sealed class we can easily setup all things that we will have to track:
```kotlin
sealed class MyEvent : EventType {
class SignUp(username: String) : MyEvent()
class Register(username: String, password: String) : MyEvent()
override fun name(provider: ProviderType): String? {
return when (this) {
is SignUp -> "signUp"
is Register -> "register"
}
}
override fun parameters(provider: ProviderType): HashMap? {
return when (this) {
is SignUp -> {
hashMapOf()
}
is Register -> {
hashMapOf("username" to this.username, "password" to this.password))
}
}
}
}
```
### Providers
At this very moment we developed the following built-in providers:
- [Firebase Analytics](https://firebase.google.com/docs/analytics/android/start/)
- [Flurry](https://developer.yahoo.com/flurry/docs/analytics/gettingstarted/android/)
- [Localytics](https://docs.localytics.com/dev/android.html#standard-event-logged-out-android)
- [Mixpanel](https://mixpanel.com/help/reference/android)
In order to use them, you have to add to your project the library of the provider, otherwise the build will fail.
#### Custom Provider
You can easily create your own providers, you can use this for reference:
```kotlin
class MixpanelProvider(private val context: Context, private val projectToken: String) : ProviderType {
override var className = Class.forName("com.mixpanel.android.mpmetrics.MixpanelAPI")
override var classInstance = className.getDeclaredMethod("getInstance", Context::class.java, String::class.java)
override var classFunction = className.getDeclaredMethod("track", String::class.java, JSONObject::class.java)
init {
classInstance?.let {
// get context
try {
it.invoke(className, context, projectToken)
} catch (e: Exception) {
Log.e("Raincoat", e.localizedMessage)
}
}
}
override fun log(eventName: String, parameters: HashMap?) {
try {
classFunction.invoke(classInstance, eventName, JSONObject(parameters))
} catch (e: Exception) {
Log.e("Raincoat", e.localizedMessage)
}
}
}
```
## Installation
Add to your `build.gradle`:
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
then add the repository
```aidl
compile 'com.github.matteocrippa:Raincoat:master-SNAPSHOT'
```
## License
Raincoat is under MIT license. See the [LICENSE](LICENSE) file for more info.