Merge pull request #48 from snabble/gradle_plugin

Gradle plugin support

Author: rekire

build.gradle

@@ -29,7 +29,6 @@ allprojects {
     repositories {
         google()
         mavenCentral()
-        maven { url 'https://jitpack.io' }
         maven { url 'https://datatrans.jfrog.io/artifactory/mobile-sdk/' }
     }
 

core/src/main/java/io/snabble/sdk/Config.kt

@@ -11,6 +11,9 @@ import java.lang.Exception
 import java.lang.reflect.Type
 import java.util.concurrent.TimeUnit
 
+/**
+ * Configuration of the snabble SDK.
+ */
 data class Config (
     /**
      * The endpoint url of the snabble backend. For example "https://api.snabble.io" for the Production environment.
@@ -31,13 +34,12 @@ data class Config (
     var secret: String? = null,
 
     /**
-     * Relative path from the assets folder which points to a bundled file which contains the metadata
+     * Relative path from the assets folder which points to a bundled file which contains the metadata.
      *
-     *
-     * This file gets initially used to initialize the sdk before network requests are made,
+     * This file gets initially used to initialize the SDK before network requests are made,
      * or be able to use the sdk in the case of no network connection.
      *
-     * Optional. If no file is specified every time the sdk is initialized we wait for a network response
+     * Optional. If no path and no res id are specified every time the SDK is initialized we wait for a network response
      * from the backend.
      *
      * It is HIGHLY recommended to provide bundled metadata to allow the sdk to function
@@ -47,14 +49,19 @@ data class Config (
     var bundledMetadataAssetPath: String? = null,
 
     /**
-     * Optional. Used to override the versionName appended to the metadata url.
+     * Resource id of the raw file which contains the metadata.
+     *
+     * This file gets initially used to initialize the SDK before network requests are made,
+     * or be able to use the sdk in the case of no network connection.
      *
-     * Defaults to the versionName in the app package.
+     * Optional. If no res id and no path are specified every time the SDK is initialized we wait for a network response
+     * from the backend.
      *
-     * Must be in the format %d.%d
+     * It is HIGHLY recommended to provide bundled metadata to allow the sdk to function
+     * without having a network connection.
      */
     @JvmField
-    var versionName: String? = null,
+    var bundledMetadataRawResId: Int = 0,
 
     /**
      * If set to true, creates an full text index to support searching in the product database
@@ -89,21 +96,23 @@ data class Config (
     @JvmField
     var maxShoppingCartAge: Long  = TimeUnit.HOURS.toMillis(4),
 
-    /** If set to true, disables certificate pinning  */
+    /** If set to true, disables certificate pinning. Not recommended for production!  */
     @JvmField
     var disableCertificatePinning: Boolean = false,
 
-    /** SQL queries that will get executed in order on the product database  */
+    /** SQL queries that will get executed in order on the product database. */
     @JvmField
     var initialSQL: List<String> = emptyList(),
 
-    /** Vibrate while adding a product to the cart, by default false  */
+    /** Vibrate while adding a product to the cart, by default false. */
     @JvmField
     var vibrateToConfirmCartFilled: Boolean = false,
 
-    /** Set to true, to load shops that are marked as pre launch
+    /**
+     * Set to true, to load shops that are marked as pre launch
      * and are not part of the original metadata in the backend
-     * (for example for testing shops in production before a go-live)  */
+     * (for example for testing shops in production before a go-live)
+     */
     @JvmField
     var loadActiveShops: Boolean = false,
 

core/src/main/java/io/snabble/sdk/MetadataDownloader.kt

@@ -5,15 +5,15 @@ import com.google.gson.JsonObject
 import okhttp3.OkHttpClient
 import io.snabble.sdk.utils.StringDownloader
 import io.snabble.sdk.utils.GsonHolder
-import io.snabble.sdk.Snabble
 import io.snabble.sdk.utils.Logger
 import java.io.File
 import java.lang.Exception
 
 @RestrictTo(RestrictTo.Scope.LIBRARY)
 internal class MetadataDownloader(
     okHttpClient: OkHttpClient?,
-    bundledFileAssetPath: String?)
+    bundledFileAssetPath: String?,
+    bundledFileRawResId: Int)
     : StringDownloader(okHttpClient) {
     var hasData = false
         private set
@@ -22,8 +22,8 @@ internal class MetadataDownloader(
 
     init {
         val storageFile = File(Snabble.internalStorageDirectory, "metadata_v2.json")
-        if (bundledFileAssetPath != null) {
-            setBundledData(Snabble.application, bundledFileAssetPath, storageFile)
+        if (bundledFileAssetPath != null || bundledFileRawResId != 0) {
+            setBundledData(Snabble.application, bundledFileAssetPath, bundledFileRawResId, storageFile)
         } else {
             setStorageFile(storageFile)
         }

core/src/main/java/io/snabble/sdk/OkHttpClientFactory.kt

@@ -42,9 +42,9 @@ internal object OkHttpClientFactory {
         builder.cache(Cache(application.cacheDir, 10 * 1024 * 1024))
         builder.retryOnConnectionFailure(true)
         builder.pingInterval(5, TimeUnit.SECONDS) // workaround for https://github.com/square/okhttp/issues/3146
-        builder.addInterceptor(OkHttpLogger(HttpLoggingInterceptor.Logger { message: String? ->
+        builder.addInterceptor(OkHttpLogger { message: String? ->
             Logger.i(message)
-        }))
+        })
         Snabble.config.networkInterceptor?.let {
             builder.addNetworkInterceptor(it)
         }

core/src/main/java/io/snabble/sdk/PropertiesExtensions.kt

@@ -0,0 +1,11 @@
+@file:JvmName("PropertiesExtensions")
+package io.snabble.sdk
+
+import java.util.*
+
+fun Properties.getBoolean(key: String, default: Boolean) =
+    getProperty(key)?.toBooleanStrictOrNull() ?: default
+fun Properties.getLong(key: String, default: Long) =
+    getProperty(key)?.toLongOrNull() ?: default
+fun Properties.getFloat(key: String, default: Float) =
+    getProperty(key)?.toFloatOrNull() ?: default

core/src/main/java/io/snabble/sdk/Snabble.kt

@@ -359,16 +359,12 @@ object Snabble {
             return
         }
 
-        var version = this.config.versionName
-        if (version == null) {
-            version = try {
-                val pInfo = application.packageManager.getPackageInfo(application.packageName, 0)
-                pInfo?.versionName?.lowercase(Locale.ROOT)?.replace(" ", "") ?: "1.0"
-            } catch (e: PackageManager.NameNotFoundException) {
-                "1.0"
-            }
+        val version = try {
+            val pInfo = application.packageManager.getPackageInfo(application.packageName, 0)
+            pInfo?.versionName?.lowercase(Locale.ROOT)?.replace(" ", "") ?: "1.0"
+        } catch (e: PackageManager.NameNotFoundException) {
+            "1.0"
         }
-        versionName = version
 
         internalStorageDirectory = File(application.filesDir, "snabble/${this.config.appId}/")
         internalStorageDirectory.mkdirs()
@@ -392,9 +388,9 @@ object Snabble {
             this.config.lastSeenThreshold
         )
 
-        metadataDownloader = MetadataDownloader(okHttpClient, this.config.bundledMetadataAssetPath)
+        metadataDownloader = MetadataDownloader(okHttpClient, this.config.bundledMetadataAssetPath, this.config.bundledMetadataRawResId)
 
-        if (this.config.bundledMetadataAssetPath != null) {
+        if (this.config.bundledMetadataAssetPath != null || this.config.bundledMetadataRawResId != 0) {
             dispatchOnReady()
         } else {
             metadataDownloader.loadAsync(object : Downloader.Callback() {

core/src/main/java/io/snabble/sdk/SnabbleInitializer.kt

@@ -3,16 +3,66 @@ package io.snabble.sdk
 import android.app.Application
 import android.content.Context
 import android.content.pm.PackageManager
+import android.content.res.Resources
 import androidx.startup.Initializer
 import io.snabble.sdk.utils.Logger
 import okhttp3.Interceptor
+import java.lang.IllegalStateException
+import java.util.*
 
 /**
  * Initializer for the snabble SDK using androidx.startup
  */
 class SnabbleInitializer : Initializer<Snabble> {
     override fun create(context: Context): Snabble {
         val app = context.applicationContext as Application
+
+        // load properties created by the gradle plugin
+        val env = UserPreferences(context).environment.name.lowercase()
+        val resId = context.resources.getIdentifier("snabble_${env}_config", "raw", app.packageName)
+        if (resId != Resources.ID_NULL) {
+            val properties = Properties()
+            properties.load(context.resources.openRawResource(resId))
+            val config = Config().apply {
+                appId = properties.getProperty("appId")
+                endpointBaseUrl = properties.getProperty("endpointBaseUrl") ?: endpointBaseUrl
+                secret = properties.getProperty("secret")
+                val assetPath = properties.getProperty("bundledMetadataAssetPath")?.let { path ->
+                    if (context.resources.assets.list(path)?.isEmpty() != false) {
+                        null
+                    } else {
+                        path
+                    }
+                }
+                bundledMetadataAssetPath = assetPath
+                bundledMetadataRawResId = context.resources.getIdentifier("snabble_${env}_metadata", "raw", app.packageName)
+                generateSearchIndex = properties.getBoolean("generateSearchIndex", generateSearchIndex)
+                maxProductDatabaseAge = properties.getLong("maxProductDatabaseAge", maxProductDatabaseAge)
+                maxShoppingCartAge = properties.getLong("maxShoppingCartAge", maxShoppingCartAge)
+                disableCertificatePinning = properties.getBoolean("disableCertificatePinning", disableCertificatePinning)
+                vibrateToConfirmCartFilled = properties.getBoolean("vibrateToConfirmCartFilled", vibrateToConfirmCartFilled)
+                loadActiveShops = properties.getBoolean("loadActiveShops", loadActiveShops)
+                checkInRadius = properties.getFloat("checkInRadius", checkInRadius)
+                checkOutRadius = properties.getFloat("checkOutRadius", checkOutRadius)
+                lastSeenThreshold = properties.getLong("lastSeenThreshold", lastSeenThreshold)
+                networkInterceptor =
+                    try {
+                        Class.forName(properties.getProperty("networkInterceptor", null))?.newInstance() as Interceptor?
+                    } catch (e: Throwable) {
+                        Logger.w("Could not instantiate network interceptor", e.message)
+                        null
+                    }
+                manualProductDatabaseUpdates = properties.getBoolean("manualProductDatabaseUpdates", manualProductDatabaseUpdates)
+            }
+
+            if (config.appId == null || config.secret == null) {
+                throw IllegalStateException("Please file a bug report with our build.gradle file. This state should not be possible.")
+            } else {
+                Snabble.setup(app, config)
+                return Snabble
+            }
+        }
+
         val applicationInfo = app.packageManager.getApplicationInfo(app.packageName, PackageManager.GET_META_DATA)
         with(applicationInfo.metaData) {
             if (getBoolean("snabble_auto_initialization_disabled")) {
@@ -24,12 +74,10 @@ class SnabbleInitializer : Initializer<Snabble> {
                 endpointBaseUrl = getString("snabble_endpoint_baseurl", endpointBaseUrl)
                 secret = getString("snabble_secret", secret)
                 bundledMetadataAssetPath = getString("snabble_bundled_metadata_asset_path", bundledMetadataAssetPath)
-                versionName = getString("snabble_version_name", versionName)
                 generateSearchIndex = getBoolean("snabble_generate_search_index", generateSearchIndex)
                 maxProductDatabaseAge = getLong("snabble_max_product_database_age", maxProductDatabaseAge)
                 maxShoppingCartAge = getLong("snabble_max_shopping_cart_age", maxShoppingCartAge)
                 disableCertificatePinning = getBoolean("snabble_disable_certificate_pinning")
-                initialSQL = getStringArrayList("snabble_initial_sql") ?: initialSQL
                 vibrateToConfirmCartFilled = getBoolean("snabble_vibrate_to_confirm_cart_filled", vibrateToConfirmCartFilled)
                 loadActiveShops = getBoolean("snabble_load_active_shops", loadActiveShops)
                 checkInRadius = getFloat("snabble_check_in_radius", checkInRadius)
@@ -56,7 +104,5 @@ class SnabbleInitializer : Initializer<Snabble> {
         }
     }
 
-    override fun dependencies(): List<Class<out Initializer<*>>> {
-        return emptyList()
-    }
+    override fun dependencies() = emptyList<Class<out Initializer<*>>>()
 }

core/src/main/java/io/snabble/sdk/UserPreferences.kt

@@ -40,6 +40,7 @@ class UserPreferences internal constructor(context: Context) {
         private const val SHARED_PREFERENCES_CONSENT_STATUS = "ConsentStatus"
         private const val SHARED_PREFERENCES_CONSENT_VERSION = "ConsentVersion"
         private const val SHARED_PREFERENCES_LAST_CHECKED_IN_SHOP = "lastShop"
+        private const val SHARED_PREFERENCES_BASE_URL = "base_url"
 
         @SuppressLint("SimpleDateFormat")
         private val BIRTHDAY_FORMAT = SimpleDateFormat("yyyy/MM/dd")
@@ -158,14 +159,27 @@ class UserPreferences internal constructor(context: Context) {
      * Does not contain any personalized information.
      */
     var clientId: String?
-        get() =
-            sharedPreferences.getString(SHARED_PREFERENCES_CLIENT_ID, null)
+        get() = sharedPreferences.getString(SHARED_PREFERENCES_CLIENT_ID, null)
         set(clientId) {
             sharedPreferences.edit()
                 .putString(SHARED_PREFERENCES_CLIENT_ID, clientId)
                 .apply()
         }
 
+    var environment: Environment
+        get() = Environment.getEnvironmentByUrl(baseUrl)
+        set(value) {
+            baseUrl = value.baseUrl
+        }
+
+    private var baseUrl: String
+        get() = sharedPreferences.getString(SHARED_PREFERENCES_BASE_URL, null) ?: Environment.PRODUCTION.baseUrl
+        set(value) {
+            sharedPreferences.edit()
+                .putString(SHARED_PREFERENCES_BASE_URL, value)
+                .apply()
+        }
+
     internal var lastCheckedInShopId: String?
         @RestrictTo(RestrictTo.Scope.LIBRARY)
         get() =

java-sample/src/main/java/io/snabble/testapp/App.java

@@ -16,14 +16,6 @@
 public class App extends Application {
     private static App instance;
 
-    private Project project;
-
-    public interface InitCallback {
-        void done();
-
-        void error(String text);
-    }
-
     @Override
     public void onCreate() {
         super.onCreate();

java-sample/src/main/java/io/snabble/testapp/BaseActivity.java

@@ -5,7 +5,6 @@
 import android.view.KeyEvent;
 import android.view.View;
 import android.widget.ProgressBar;
-import android.widget.TextView;
 import androidx.appcompat.app.AppCompatActivity;
 import androidx.fragment.app.Fragment;
 
@@ -14,24 +13,20 @@
 import io.snabble.sdk.ui.cart.ShoppingCartActivity;
 import io.snabble.sdk.ui.payment.PaymentCredentialsListActivity;
 import io.snabble.sdk.ui.payment.PaymentOptionsActivity;
+import io.snabble.sdk.ui.scanner.CombinedScannerActivity;
 import io.snabble.sdk.ui.scanner.SelfScanningActivity;
 import io.snabble.sdk.ui.utils.ZebraSupport;
 import io.snabble.sdk.ui.scanner.ProductResolver;
 
 public abstract class BaseActivity extends AppCompatActivity {
 
-    private ProgressBar progressIndicator;
-    private View content;
-    private TextView sdkError;
-
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
-        progressIndicator = findViewById(R.id.progress_indicator);
-        content = findViewById(R.id.content);
-        sdkError = findViewById(R.id.sdk_error);
+        final ProgressBar progressIndicator = findViewById(R.id.progress_indicator);
+        final View content = findViewById(R.id.content);
 
         progressIndicator.setVisibility(View.GONE);
         content.setVisibility(View.VISIBLE);
@@ -69,6 +64,11 @@ public void showScanner() {
         startActivity(intent);
     }
 
+    public void showCombinedScanner() {
+        Intent intent = new Intent(this, CombinedScannerActivity.class);
+        startActivity(intent);
+    }
+
     public void showPaymentCredentialsList() {
         Intent intent = new Intent(this, PaymentCredentialsListActivity.class);
         startActivity(intent);