SquatchAndroid

Helper library for loading SaaSquatch widgets in Android WebView

Adding SquatchAndroid to your project

SquatchAndroid is hosted on JitPack.

Add JitPack repository:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Add the dependency:

dependencies {
    implementation 'com.github.saasquatch:squatch-android:0.1.0'
}

For more information and other built tools, please refer to the JitPack page.

This library relies on SaaSquatch Java SDK, which has transitive dependencies including RxJava 3, Gson, and Apache HttpClient 5. This library also has RxAndroid as a transitive dependency. It is recommended that you explicitly import the transitive dependencies if you intend to use them, since we may upgrade or switch to other libraries in the future. You do NOT, however, need to explicitly include SaaSquatch Java SDK, as it is exposed in public interfaces in this library.

Using the SDK

This library is a wrapper of SaaSquatch Java SDK with Android specific features, specifically loading widgets into a WebView. In fact, The SquatchAndroid interface has a method called getSaaSquatchClient(), which you can use to retrieve the underlying SaaSquatchClient. Depending on your use case, SaaSquatch Java SDK may be what you need.

The entry point of the SDK is SquatchAndroid. To create a SquatchAndroid for your tenant with default options, use:

SquatchAndroid.createForTenant("yourTenantAlias");

It is recommended that you keep a singleton SquatchAndroid for all your requests instead of creating a new SquatchAndroid for every request. SquatchAndroid implements Closeable, and it's a good idea to call close() to release resources when you are done with it.

SquatchAndroid returns Reactive Streams interfaces. Assuming you are using RxJava, then a typical API call made with this SDK would look something like this:

Flowable.fromPublisher(squatchAndroid.widgetUpsert(
    WidgetUpsertInput.newBuilder()
        .setUserInputWithUserJwt(userJwt)
        .setWidgetType(WidgetType.ofProgramWidget("referral-program", "referrerWidget"))
        .setEngagementMedium("MOBILE")
        .build(),
    null, AndroidRenderWidgetOptions.ofWebView(webView)))
    .onErrorComplete() // or provide your own error handling
    .subscribe();

In the code above, a widget upsert is performed asynchronously with the given userJwt, and the resulting widget is loaded into the given webView with the Android main thread.

More Code Samples

Widget upsert while setting a user's customFields

final Map<String, Object> userInput = new HashMap<>();
userInput.put("id", "a");
userInput.put("accountId", "a");
final Map<String, Object> customFields = new HashMap<>();
customFields.put("birthday", "--12-25");
userInput.put("customFields", customFields);
Flowable.fromPublisher(squatchAndroid.widgetUpsert(
    WidgetUpsertInput.newBuilder()
        .setUserInput(userInput)
        .setEngagementMedium("MOBILE")
        .build(),
    RequestOptions.newBuilder()
        .setAuthMethod(AuthMethod.ofJwt(userJwt))
        .build(),
    AndroidRenderWidgetOptions.ofWebView(webView)))
    .onErrorComplete() // or provide your own error handling
    .subscribe();

Rendering a widget for a user

Flowable.fromPublisher(squatchAndroid.renderWidget(
    RenderWidgetInput.newBuilder()
        .setUserWithUserJwt(userJwt) // Can be omitted to render a widget without user information
        .setWidgetType(WidgetType.ofProgramWidget("referral-program", "referrerWidget"))
        .setEngagementMedium("MOBILE")
        .build(),
    null, AndroidRenderWidgetOptions.ofWebView(webView)))
    .onErrorComplete() // or provide your own error handling
    .subscribe();

Logging an event for a user (using the underlying SaaSquatchClient)

final Map<String, Object> fields = new HashMap<>();
fields.put("currency", "CAD");
Flowable.fromPublisher(squatchAndroid.getSaaSquatchClient().logUserEvent(
    UserEventInput.newBuilder()
        .setAccountId("a")
        .setUserId("a")
        .addEvents(UserEventDataInput.newBuilder()
            .setKey("purchase")
            .setFields(fields)
            .build())
        .build(),
    RequestOptions.newBuilder()
        .setAuthMethod(AuthMethod.ofJwt(userJwt))
        .build()))
    // This is necessary so the main thread does not start the IO operation
    .subscribeOn(Schedulers.io())
    .onErrorComplete() // or provide your own error handling
    .subscribe();

License

Unless explicitly stated otherwise all files in this repository are licensed under the Apache License 2.0.

License boilerplate:

Copyright 2023 ReferralSaaSquatch.com, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.