Add support for german print prefixes

Author: ajungg

build.gradle

@@ -24,7 +24,7 @@ allprojects {
     }
 
     project.ext {
-        sdkVersion='0.8.1'
+        sdkVersion='0.8.2'
         versionCode=1
 
         compileSdkVersion=27

core/src/main/java/io/snabble/sdk/SnabbleSdk.java

@@ -29,102 +29,7 @@
 
 public class SnabbleSdk {
 
-    public static class Config {
-        /**
-         * The endpoint url of the snabble backend. For example "snabble.io" for the Production environment.
-         */
-        public String endpointBaseUrl;
-
-        /**
-         * The project identifier, which is used in the communication with the backend.
-         */
-        public String projectId;
-
-        /**
-         * The JWT based client token required for all requests to the backend.
-         */
-        public String clientToken;
-
-        /**
-         * Relative url to the metadata.
-         * <p>
-         * In the format: /api/{projectId}/metadata/app/{platform}/{version}
-         */
-        public String metadataUrl;
-
-        /**
-         * Relative path from the assets folder which points to a bundled file which contains the metadata
-         * from the metadataUrl specified before.
-         * <p>
-         * 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.
-         * <p>
-         * Optional. If no file is specified every time the sdk is initialized we wait for a network response
-         * from the backend.
-         * <p>
-         * It is HIGHLY recommended to provide bundled metadata to allow the sdk to function
-         * without having a network connection.
-         */
-        public String bundledMetadataAssetPath;
-
-        /**
-         * The name if the product database which will be used to store the database under
-         * the default android database directory.
-         * <p>
-         * The resulting path is the path from {@link android.content.Context#getDatabasePath(String)}
-         *
-         * If set to null, only online lookup of products is available.
-         *
-         */
-        public String productDbName;
-
-        /**
-         * Relative path from the assets folder which points to a bundled file which contains the products
-         * as an sqlite3 database.
-         * <p>
-         * This file gets initially used to initialize the product database before network requests are made,
-         * or be able to use the product database in the case of no network connection.
-         * <p>
-         * Optional. If no file is specified and no product database is already present, the sdk initialization
-         * is delayed until the network request for the product db is successful.
-         * <p>
-         * It is HIGHLY recommended to provide a bundled database to allow the sdk to function
-         * without having a network connection.
-         */
-        public String productDbBundledAssetPath;
-
-        /**
-         * This is the revision id of the bundled product database. This is used to prevent
-         * extracting the bundled database when the stored database is already newer.
-         * <p>
-         * When the bundled database revision is newer then the stored database, the stored
-         * database will be overwritten by the bundled database
-         */
-        public int productDbBundledRevisionId = -1;
-
-        /**
-         * The bundled major schema version.
-         */
-        public int productDbBundledSchemaVersionMajor = -1;
-
-        /**
-         * The bundled minor schema version.
-         */
-        public int productDbBundledSchemaVersionMinor = -1;
-
-        /**
-         * If set to true, allows the database to be downloaded even if no seed is provided.
-         *
-         * When set to false, calls to {@link ProductDatabase#update()} will still download
-         * the database if its missing, allowing for the ability of database downloads after
-         * sdk initialization
-         */
-        public boolean productDbDownloadIfMissing = true;
-
-        public String encodedCodesPrefix = null;
-        public String encodedCodesSeperator = null;
-        public String encodedCodesSuffix = null;
-    }
+    private boolean useGermanPrintPrefix = false;
 
     private String endpointBaseUrl;
     private String metadataUrl;
@@ -159,70 +64,6 @@ public static class Config {
     private String encodedCodesSeperator = null;
     private String encodedCodesSuffix = null;
 
-    private SnabbleSdk() {
-
-    }
-
-    /**
-     * Initializes the snabble SDK. Returns a {@link SnabbleSdk} context without requiring network access in
-     * {@link SetupCompletionListener#onReady(SnabbleSdk)} when
-     * {@link Config#bundledMetadataAssetPath} and {@link Config#productDbBundledAssetPath} is set.
-     * <p>
-     * Otherwise a network request will be made and after successfully downloading the metadata and product database,
-     * {@link SetupCompletionListener#onReady(SnabbleSdk)} will be called.
-     * <p>
-     * If no network request could be made and no {@link Config#bundledMetadataAssetPath} is provided
-     * {@link Error#CONNECTION_TIMEOUT} will be called.
-     */
-    public static void setup(Application app, Config config,
-                             SetupCompletionListener setupCompletionListener) {
-        final SnabbleSdk sdk = new SnabbleSdk();
-        sdk.init(app, config, setupCompletionListener);
-    }
-
-    /**
-     * The blocking version of {@link SnabbleSdk#setup(Application, Config, SetupCompletionListener)}
-     * <p>
-     * Blocks until every initialization is completed, that includes waiting for necessary
-     * network calls if bundled data is not provided.
-     * <p>
-     * If all needed bundled data is provided (See {@link Config}), initialization requires
-     * no network calls and returns after initialization of the product database.
-     *
-     * @throws SnabbleException If an error occurs while initializing the sdk.
-     */
-    public static SnabbleSdk setupBlocking(Application app, Config config) throws SnabbleException {
-        final CountDownLatch countDownLatch = new CountDownLatch(1);
-        final SnabbleSdk[] snabbleSdk = new SnabbleSdk[1];
-        final Error[] snabbleError = new Error[1];
-
-        setup(app, config, new SetupCompletionListener() {
-            @Override
-            public void onReady(SnabbleSdk sdk) {
-                snabbleSdk[0] = sdk;
-                countDownLatch.countDown();
-            }
-
-            @Override
-            public void onError(Error error) {
-                snabbleError[0] = error;
-                countDownLatch.countDown();
-            }
-        });
-
-        try {
-            countDownLatch.await();
-        } catch (InterruptedException e) {
-            throw new SnabbleException(Error.UNSPECIFIED_ERROR);
-        }
-
-        if (snabbleError[0] != null) {
-            throw new SnabbleException(snabbleError[0]);
-        }
-
-        return snabbleSdk[0];
-    }
-
     private void init(final Application app,
                       final Config config,
                       final SetupCompletionListener setupCompletionListener) {
@@ -279,6 +120,8 @@ private void init(final Application app,
         encodedCodesSeperator = config.encodedCodesSeperator != null ? config.encodedCodesSeperator : "\n";
         encodedCodesSuffix = config.encodedCodesSuffix != null ? config.encodedCodesSuffix : "";
 
+        useGermanPrintPrefix = config.useGermanPrintPrefix;
+
         updateShops();
 
         if (config.bundledMetadataAssetPath != null) {
@@ -302,6 +145,74 @@ protected void onError() {
         }
     }
 
+    private SnabbleSdk() {
+
+    }
+
+    /**
+     * Initializes the snabble SDK. Returns a {@link SnabbleSdk} context without requiring network access in
+     * {@link SetupCompletionListener#onReady(SnabbleSdk)} when
+     * {@link Config#bundledMetadataAssetPath} and {@link Config#productDbBundledAssetPath} is set.
+     * <p>
+     * Otherwise a network request will be made and after successfully downloading the metadata and product database,
+     * {@link SetupCompletionListener#onReady(SnabbleSdk)} will be called.
+     * <p>
+     * If no network request could be made and no {@link Config#bundledMetadataAssetPath} is provided
+     * {@link Error#CONNECTION_TIMEOUT} will be called.
+     */
+    public static void setup(Application app, Config config,
+                             SetupCompletionListener setupCompletionListener) {
+        final SnabbleSdk sdk = new SnabbleSdk();
+        sdk.init(app, config, setupCompletionListener);
+    }
+
+    /**
+     * The blocking version of {@link SnabbleSdk#setup(Application, Config, SetupCompletionListener)}
+     * <p>
+     * Blocks until every initialization is completed, that includes waiting for necessary
+     * network calls if bundled data is not provided.
+     * <p>
+     * If all needed bundled data is provided (See {@link Config}), initialization requires
+     * no network calls and returns after initialization of the product database.
+     *
+     * @throws SnabbleException If an error occurs while initializing the sdk.
+     */
+    public static SnabbleSdk setupBlocking(Application app, Config config) throws SnabbleException {
+        final CountDownLatch countDownLatch = new CountDownLatch(1);
+        final SnabbleSdk[] snabbleSdk = new SnabbleSdk[1];
+        final Error[] snabbleError = new Error[1];
+
+        setup(app, config, new SetupCompletionListener() {
+            @Override
+            public void onReady(SnabbleSdk sdk) {
+                snabbleSdk[0] = sdk;
+                countDownLatch.countDown();
+            }
+
+            @Override
+            public void onError(Error error) {
+                snabbleError[0] = error;
+                countDownLatch.countDown();
+            }
+        });
+
+        try {
+            countDownLatch.await();
+        } catch (InterruptedException e) {
+            throw new SnabbleException(Error.UNSPECIFIED_ERROR);
+        }
+
+        if (snabbleError[0] != null) {
+            throw new SnabbleException(snabbleError[0]);
+        }
+
+        return snabbleSdk[0];
+    }
+
+    public boolean isUsingGermanPrintPrefix() {
+        return useGermanPrintPrefix;
+    }
+
     private void updateShops() {
         String shopsJson = metadataDownloader.getExtras().get("shops");
         if (shopsJson != null) {
@@ -497,6 +408,105 @@ public String getEncodedCodesSuffix() {
         return encodedCodesSuffix;
     }
 
+    public static class Config {
+        /**
+         * The endpoint url of the snabble backend. For example "snabble.io" for the Production environment.
+         */
+        public String endpointBaseUrl;
+
+        /**
+         * The project identifier, which is used in the communication with the backend.
+         */
+        public String projectId;
+
+        /**
+         * The JWT based client token required for all requests to the backend.
+         */
+        public String clientToken;
+
+        /**
+         * Relative url to the metadata.
+         * <p>
+         * In the format: /api/{projectId}/metadata/app/{platform}/{version}
+         */
+        public String metadataUrl;
+
+        /**
+         * Relative path from the assets folder which points to a bundled file which contains the metadata
+         * from the metadataUrl specified before.
+         * <p>
+         * 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.
+         * <p>
+         * Optional. If no file is specified every time the sdk is initialized we wait for a network response
+         * from the backend.
+         * <p>
+         * It is HIGHLY recommended to provide bundled metadata to allow the sdk to function
+         * without having a network connection.
+         */
+        public String bundledMetadataAssetPath;
+
+        /**
+         * The name if the product database which will be used to store the database under
+         * the default android database directory.
+         * <p>
+         * The resulting path is the path from {@link android.content.Context#getDatabasePath(String)}
+         *
+         * If set to null, only online lookup of products is available.
+         *
+         */
+        public String productDbName;
+
+        /**
+         * Relative path from the assets folder which points to a bundled file which contains the products
+         * as an sqlite3 database.
+         * <p>
+         * This file gets initially used to initialize the product database before network requests are made,
+         * or be able to use the product database in the case of no network connection.
+         * <p>
+         * Optional. If no file is specified and no product database is already present, the sdk initialization
+         * is delayed until the network request for the product db is successful.
+         * <p>
+         * It is HIGHLY recommended to provide a bundled database to allow the sdk to function
+         * without having a network connection.
+         */
+        public String productDbBundledAssetPath;
+
+        /**
+         * This is the revision id of the bundled product database. This is used to prevent
+         * extracting the bundled database when the stored database is already newer.
+         * <p>
+         * When the bundled database revision is newer then the stored database, the stored
+         * database will be overwritten by the bundled database
+         */
+        public int productDbBundledRevisionId = -1;
+
+        /**
+         * The bundled major schema version.
+         */
+        public int productDbBundledSchemaVersionMajor = -1;
+
+        /**
+         * The bundled minor schema version.
+         */
+        public int productDbBundledSchemaVersionMinor = -1;
+
+        /**
+         * If set to true, allows the database to be downloaded even if no seed is provided.
+         *
+         * When set to false, calls to {@link ProductDatabase#update()} will still download
+         * the database if its missing, allowing for the ability of database downloads after
+         * sdk initialization
+         */
+        public boolean productDbDownloadIfMissing = true;
+
+        public boolean useGermanPrintPrefix = false;
+
+        public String encodedCodesPrefix = null;
+        public String encodedCodesSeperator = null;
+        public String encodedCodesSuffix = null;
+    }
+
     String absoluteUrl(String url) {
         if (url.startsWith("http")) {
             return url;