Fjuul SDK

This repository contains the Fjuul SDK for Android and iOS. Its primary capabilities are:

1. managing the state of a user's body parameters
2. managing connections to activity sources and collecting daily activities and related user metrics from on-device sources
3. providing the unified and aggregated health and fitness metrics of a user

General Architecture

The Fjuul SDK is structured as a set of independent modules, each of which is delimited by its own responsibilities. At the moment, they are as follows:

• Core - the root module that configures the behavior of all the others and shares the common things between them. You can use it to initialize the SDK with the API credentials and set the user on whose behalf it operates.
• User - the module for working with users of the Fjuul SDK. For example, you can use it to create a user, get the latest state of the user profile, and update its properties.
• Activity Sources - the module responsible for setting up activity sources for the user, as well as collecting activity data from on-device sources.
• Analytics - the module for accessing aggregated statistics from the collected data sources.

Versioning

This project follows the semantic versioning principles, with the restriction that all modules of both Android and iOS SDKs will receive version bumps in lockstep. This means that a major version bump is not necessarily always a breaking release, and there can be version-only bump releases without actual changes in a module. Breaking changes and version-only bumps will be especially highlighted in the changelog.

Android

Fjuul SDK for Android is written in plain Java, so there shouldn't be any problems with integrating it to your Java project. In addition, the project follows the interoperability rules for working with Kotlin (the ExampleApp demonstrating the usage of the SDK is implemented in Kotlin).

Restrictions

• Fjuul SDK for Android runs on devices with Android 5.0 Lollipop (API level 21) or above. So, the SDK requires minSdkVersion to be set to 21 or higher.
• Fjuul SDK for Android uses Java 8+ API. Explore the official guide about java 8 desugaring if you plan to support older api levels (Android Gradle Plugin 4.0+).
• The 'activitysources' module requires google-play-services on an Android device to work with the Google Fit API. This means that devices with missing Google Play services (for example, phones manufactured by Huawei) wouldn't be able to connect to Google Fit.

Distribution

Fjuul SDK for Android is published to the Github Packages registry with the url https://maven.pkg.github.com/fjuul/sdk. In order to access its modules you need to:

1. get an authentication token with 'read:packages' access to fjuul/sdk repository on GitHub
2. declare a maven repository in your build.gradle in the following way:

allprojects {
    ...
    repositories {
        ...
        maven {
            name = 'GitHubPackages'
            url = uri('https://maven.pkg.github.com/fjuul/sdk')
            credentials {
                username = 'GITHUB_ACTOR'
                password = 'GITHUB_TOKEN'
            }
        }
    }
}

Installation

Add SDK module dependencies as needed in your app/build.grade:

dependencies {
    implementation 'com.fjuul.sdk:user:+'
    implementation 'com.fjuul.sdk:activitysources:+'
    implementation 'com.fjuul.sdk:analytics:+'
}

Getting started

A collection of examples showcasing the usage of the SDK is available here.

You can also refer to the ExampleApp which demonstrates the integration and usage of the SDK.

Development and Contribution

Code style

The code style of the android project (java/kotlin) is checked by spotless plugin according to the eclipse config.
If you want to adjust the config, please refer to the guide at spotless GitHub repo.

Check the code style:

cd android/
./gradlew spotlessCheck

Auto-Fix all found issues with the code style:

cd android/
./gradlew spotlessApply

Tests

The android project uses junit4 with androidx/robolectric test utils.
Run all unit tests from the scratch:

cd android/
./gradlew clean testRelease

Android Linter

In spite of the project is written in Java, it is developed taking into account the possibility of invocation from Kotlin too.
Java/Kotlin interoperability can be checked by the android linter:

cd android/
./gradlew lint

Check the root build.gradle to see all code restrictions for interoperability between Java and Kotlin.

iOS

Fjuul SDK for iOS is written in Swift, and published as an SPM package.

Restrictions

• Fjuul SDK for iOS runs on devices with iOS 11+
• Fjuul SDK for iOS requires Xcode 12.4+ and Swift 5.2+

Distribution

Fjuul SDK for iOS is published in this repository. In order to access its modules you need to:

1. Select File > Swift Packages > Add Package Dependency from the main menu in XCode
2. Fill the package repository URL with either https://github.com/fjuul/sdk or [email protected]:fjuul/sdk.git
3. Choose package products as needed: FjuulCore, FjuulUser, FjuulActivitySources, FjuulAnalytics

Getting started

A collection of examples showcasing the usage of the SDK is available here.

You can also refer to the ExampleApp which demonstrates the integration and usage of the SDK.