Handles running on ancient Android devices (#32)

- Fixes typos
- Adds api level annotations to SDK methods
- Makes test app and android modules compile time min sdk 10
- Adds runtime check to to no-op and log if Android api is less than 14
- Tested on a API 10 emulator
- Can't really be tested without excessive wrapping of Build.VERSION.SDK_INIT

Author: jophde

README.md

@@ -73,11 +73,11 @@ Tests can be run by right clicking the file in the project pane or by clicking t
 
 ## Releasing
 
-The default branch is devel.  Feature branch PRs are automatically made against it. When PRs are reviewed and pass checks they should be squased and merged into devel.  The version of the SDK in devel should always be the version of the next release plus `-SNAPSHOT`.  
+The default branch is devel.  Feature branch PRs are automatically made against it. When PRs are reviewed and pass checks they should be squashed and merged into devel.  The version of the SDK in devel should always be the version of the next release plus `-SNAPSHOT`.  
 
 If a beta, or snapshot, build needs to be published simply checkout beta and merge devel.  The beta branch should fast forward.  Push devel and Travis will start.  If the tests pass the build will be sent to our Maven repos on Bintray.  
 
-When a release version needs to be published checkout the master branch and merge devel.  The master branch should be fast forwared.  Remove the `-SNAPSHOT` from the version in `build.gradle` and commit directly onto master. Push master and if the tests pass Travis will publish the version to our Maven repos on Bintray.  if the version already exists on Bintray the upload will be rejected.  The commit that updates the version should also be tagged with the version number.
+When a release version needs to be published checkout the master branch and merge devel.  The master branch should be fast forwarded.  Remove the `-SNAPSHOT` from the version in `build.gradle` and commit directly onto master. Push master and if the tests pass Travis will publish the version to our Maven repos on Bintray.  if the version already exists on Bintray the upload will be rejected.  The commit that updates the version should also be tagged with the version number.
 
 Once the next release has been published from the master branch the snapshot version in devel should be bumped to the next targeted version.
 

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/DatafileServiceTest.java

@@ -17,7 +17,9 @@
 
 import android.content.Context;
 import android.content.Intent;
+import android.os.Build;
 import android.os.IBinder;
+import android.support.annotation.RequiresApi;
 import android.support.test.InstrumentationRegistry;
 import android.support.test.rule.ServiceTestRule;
 
@@ -42,6 +44,7 @@ public class DatafileServiceTest {
     @Rule
     public final ServiceTestRule mServiceRule = new ServiceTestRule();
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     @Ignore
     public void testBinding() throws TimeoutException {
@@ -56,6 +59,7 @@ public void testBinding() throws TimeoutException {
         assertTrue(dataFileService.isBound());
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     @Ignore
     public void testValidStart() throws TimeoutException {
@@ -70,6 +74,7 @@ public void testValidStart() throws TimeoutException {
         verify(logger).info("Started watching project {} in the background", "1");
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void testNullIntentStart() throws TimeoutException {
         Context context = InstrumentationRegistry.getTargetContext();
@@ -82,6 +87,7 @@ public void testNullIntentStart() throws TimeoutException {
         verify(logger).warn("Data file service received a null intent");
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     @Ignore
     public void testNoProjectIdIntentStart() throws TimeoutException {

android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyManagerTest.java

@@ -17,6 +17,8 @@
 
 import android.content.Context;
 import android.content.Intent;
+import android.os.Build;
+import android.support.annotation.RequiresApi;
 import android.support.test.espresso.core.deps.guava.util.concurrent.ListeningExecutorService;
 import android.support.test.espresso.core.deps.guava.util.concurrent.MoreExecutors;
 import android.support.test.runner.AndroidJUnit4;
@@ -109,6 +111,7 @@ public void stop() {
         verify(appContext).unbindService(dataFileServiceConnection);
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void injectOptimizely() {
         Context context = mock(Context.class);
@@ -130,6 +133,7 @@ public void injectOptimizely() {
         verify(startListener).onStart(any(AndroidOptimizely.class));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void injectOptimizelyNullListener() {
         Context context = mock(Context.class);
@@ -154,6 +158,7 @@ public void injectOptimizelyNullListener() {
         assertEquals(optimizelyManager.getProjectId(), intent.getStringExtra(DataFileService.EXTRA_PROJECT_ID));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void injectOptimizelyHandlesInvalidDataFile() {
         Context context = mock(Context.class);
@@ -178,6 +183,7 @@ public void injectOptimizelyHandlesInvalidDataFile() {
         assertEquals(optimizelyManager.getProjectId(), intent.getStringExtra(DataFileService.EXTRA_PROJECT_ID));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void injectOptimizelyDoesNotDuplicateCallback() {
         Context context = mock(Context.class);
@@ -209,9 +215,4 @@ public void injectOptimizelyDoesNotDuplicateCallback() {
 
         verify(logger).info("No listener to send Optimizely to");
     }
-
-//    @Test
-//    public void getOptimizelyFromCompiledDataFile() {
-//
-//    }
 }

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileLoader.java

@@ -17,8 +17,10 @@
 package com.optimizely.ab.android.sdk;
 
 import android.os.AsyncTask;
+import android.os.Build;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.support.annotation.RequiresApi;
 
 import com.optimizely.ab.android.shared.Cache;
 import com.optimizely.ab.android.shared.Client;
@@ -44,6 +46,7 @@ class DataFileLoader {
         this.taskChain = taskChain;
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     boolean getDataFile(@NonNull String projectId, @Nullable DataFileLoadedListener dataFileLoadedListener) {
         taskChain.start(projectId, dataFileLoadedListener);
 
@@ -62,6 +65,7 @@ static class TaskChain {
             this.executor = Executors.newSingleThreadExecutor();
         }
 
+        @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
         void start(@NonNull String projectId, @Nullable DataFileLoadedListener dataFileLoadedListener) {
             DataFileClient dataFileClient = new DataFileClient(
                     new Client(new OptlyStorage(dataFileService), LoggerFactory.getLogger(OptlyStorage.class)),

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileService.java

@@ -19,8 +19,10 @@
 import android.app.Service;
 import android.content.Intent;
 import android.os.Binder;
+import android.os.Build;
 import android.os.IBinder;
 import android.support.annotation.NonNull;
+import android.support.annotation.RequiresApi;
 
 import com.optimizely.ab.android.shared.Cache;
 
@@ -42,6 +44,7 @@ public class DataFileService extends Service {
      * @hide
      * @see Service#onStartCommand(Intent, int, int)
      */
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
         if (intent != null) {
@@ -93,6 +96,7 @@ void stop() {
         stopSelf();
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     void getDataFile(String projectId, DataFileLoader dataFileLoader, DataFileLoadedListener loadedListener) {
         dataFileLoader.getDataFile(projectId, loadedListener);
     }

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyManager.java

@@ -16,6 +16,7 @@
 
 package com.optimizely.ab.android.sdk;
 
+import android.annotation.TargetApi;
 import android.app.Activity;
 import android.app.AlarmManager;
 import android.app.Application;
@@ -25,11 +26,13 @@
 import android.content.ServiceConnection;
 import android.content.res.Resources;
 import android.os.AsyncTask;
+import android.os.Build;
 import android.os.Bundle;
 import android.os.IBinder;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 import android.support.annotation.RawRes;
+import android.support.annotation.RequiresApi;
 
 import com.optimizely.ab.Optimizely;
 import com.optimizely.ab.android.event_handler.OptlyEventHandler;
@@ -121,7 +124,11 @@ void setOptimizelyStartListener(@Nullable OptimizelyStartListener optimizelyStar
      * @param activity                an Activity, used to automatically unbind {@link DataFileService}
      * @param optimizelyStartListener callback that {@link AndroidOptimizely} instances are sent to.
      */
+    @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
     public void start(@NonNull Activity activity, @NonNull OptimizelyStartListener optimizelyStartListener) {
+        if (!isAndroidVersionSupported()) {
+            return;
+        }
         activity.getApplication().registerActivityLifecycleCallbacks(new OptlyActivityLifecycleCallbacks(this));
         start(activity.getApplication(), optimizelyStartListener);
     }
@@ -135,12 +142,16 @@ public void start(@NonNull Activity activity, @NonNull OptimizelyStartListener o
      * @param optimizelyStartListener callback that {@link AndroidOptimizely} instances are sent to.
      */
     public void start(@NonNull Context context, @NonNull OptimizelyStartListener optimizelyStartListener) {
+        if (!isAndroidVersionSupported()) {
+            return;
+        }
         this.optimizelyStartListener = optimizelyStartListener;
         this.dataFileServiceConnection = new DataFileServiceConnection(this);
         final Intent intent = new Intent(context.getApplicationContext(), DataFileService.class);
         context.getApplicationContext().bindService(intent, dataFileServiceConnection, Context.BIND_AUTO_CREATE);
     }
 
+    @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
     void stop(@NonNull Activity activity, @NonNull OptlyActivityLifecycleCallbacks optlyActivityLifecycleCallbacks) {
         stop(activity);
         activity.getApplication().unregisterActivityLifecycleCallbacks(optlyActivityLifecycleCallbacks);
@@ -156,6 +167,9 @@ void stop(@NonNull Activity activity, @NonNull OptlyActivityLifecycleCallbacks o
      */
     @SuppressWarnings("WeakerAccess")
     public void stop(@NonNull Context context) {
+        if (!isAndroidVersionSupported()) {
+            return;
+        }
         if (dataFileServiceConnection != null && dataFileServiceConnection.isBound()) {
             context.getApplicationContext().unbindService(dataFileServiceConnection);
         }
@@ -178,6 +192,7 @@ public void stop(@NonNull Context context) {
      */
     @NonNull
     public AndroidOptimizely getOptimizely() {
+        isAndroidVersionSupported();
         return androidOptimizely;
     }
 
@@ -194,6 +209,10 @@ public AndroidOptimizely getOptimizely() {
      */
     @NonNull
     public AndroidOptimizely getOptimizely(@NonNull Context context, @RawRes int dataFileRes) {
+        if (!isAndroidVersionSupported()) {
+            return androidOptimizely;
+        }
+
         AndroidUserExperimentRecord userExperimentRecord =
                 (AndroidUserExperimentRecord) AndroidUserExperimentRecord.newInstance(getProjectId(), context);
         // Blocking File I/O is necessary here in order to provide a synchronous API
@@ -229,6 +248,7 @@ String getProjectId() {
         return projectId;
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     void injectOptimizely(@NonNull final Context context, final @NonNull AndroidUserExperimentRecord userExperimentRecord, @NonNull final ServiceScheduler serviceScheduler, @NonNull final String dataFile) {
         AsyncTask<Void, Void, UserExperimentRecord> initUserExperimentRecordTask = new AsyncTask<Void, Void, UserExperimentRecord>() {
             @Override
@@ -275,6 +295,7 @@ private AndroidOptimizely buildOptimizely(@NonNull Context context, @NonNull Str
         return new AndroidOptimizely(optimizely, LoggerFactory.getLogger(AndroidOptimizely.class));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.ICE_CREAM_SANDWICH)
     static class OptlyActivityLifecycleCallbacks implements Application.ActivityLifecycleCallbacks {
 
         @NonNull private OptimizelyManager optimizelyManager;
@@ -360,6 +381,7 @@ static class DataFileServiceConnection implements ServiceConnection {
          * @see ServiceConnection#onServiceConnected(ComponentName, IBinder)
          * @hide
          */
+        @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
         @Override
         public void onServiceConnected(ComponentName className,
                                        IBinder service) {
@@ -464,4 +486,14 @@ public OptimizelyManager build() {
 
         }
     }
+
+    private boolean isAndroidVersionSupported() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
+            return true;
+        } else {
+            logger.warn("Optimizely will not work on this phone.  It's Android version {} is less the minimum supported" +
+                    "version {}", Build.VERSION.SDK_INT, Build.VERSION_CODES.ICE_CREAM_SANDWICH);
+            return false;
+        }
+    }
 }

android-sdk/src/test/java/com/optimizely/ab/android/sdk/DataFileLoaderTest.java

@@ -15,6 +15,9 @@
  */
 package com.optimizely.ab.android.sdk;
 
+import android.os.Build;
+import android.support.annotation.RequiresApi;
+
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
@@ -129,6 +132,7 @@ public void loadFromCacheNullDataFile() {
         verify(dataFileLoadedListener, never()).onDataFileLoaded(any(String.class));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void getDataFile() {
         DataFileLoader.TaskChain taskChain = mock(DataFileLoader.TaskChain.class);

android-sdk/src/test/java/com/optimizely/ab/android/sdk/OptimizelyManagerDataFileServiceConnectionTest.java

@@ -16,6 +16,8 @@
 package com.optimizely.ab.android.sdk;
 
 import android.content.Context;
+import android.os.Build;
+import android.support.annotation.RequiresApi;
 
 import com.optimizely.ab.android.shared.ServiceScheduler;
 import com.optimizely.user_experiment_record.AndroidUserExperimentRecord;
@@ -50,6 +52,7 @@ public void setup() {
         dataFileServiceConnection = new OptimizelyManager.DataFileServiceConnection(optimizelyManager);
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void onServiceConnected() {
         DataFileService.LocalBinder binder = mock(DataFileService.LocalBinder.class);
@@ -66,6 +69,7 @@ public void onServiceConnected() {
         verify(optimizelyManager).injectOptimizely(any(Context.class), any(AndroidUserExperimentRecord.class), any(ServiceScheduler.class), eq(""));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void onServiceConnectedNotBoundWhenDataFileLoaded() {
         DataFileService.LocalBinder binder = mock(DataFileService.LocalBinder.class);
@@ -86,6 +90,7 @@ public void onServiceConnectedNotBoundWhenDataFileLoaded() {
         verify(optimizelyManager, never()).injectOptimizely(any(Context.class), any(AndroidUserExperimentRecord.class), any(ServiceScheduler.class), eq(""));
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Test
     public void onServiceConnectedNullServiceFromBinder() {
         DataFileService.LocalBinder binder = mock(DataFileService.LocalBinder.class);

android-sdk/src/test/java/com/optimizely/ab/android/sdk/OptimizelyManagerOptlyActivityLifecycleCallbacksTest.java

@@ -16,6 +16,8 @@
 package com.optimizely.ab.android.sdk;
 
 import android.app.Activity;
+import android.os.Build;
+import android.support.annotation.RequiresApi;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -35,11 +37,13 @@ public class OptimizelyManagerOptlyActivityLifecycleCallbacksTest {
     @Mock Activity activity;
     private OptimizelyManager.OptlyActivityLifecycleCallbacks optlyActivityLifecycleCallbacks;
 
+    @RequiresApi(api = Build.VERSION_CODES.ICE_CREAM_SANDWICH)
     @Before
     public void setup() {
         optlyActivityLifecycleCallbacks = new OptimizelyManager.OptlyActivityLifecycleCallbacks(optimizelyManager);
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.ICE_CREAM_SANDWICH)
     @Test
     public void onActivityStopped() {
         optlyActivityLifecycleCallbacks.onActivityStopped(activity);

event-handler/src/androidTest/java/com/optimizely/ab/android/event_handler/EventDAOTest.java

@@ -17,6 +17,8 @@
 package com.optimizely.ab.android.event_handler;
 
 import android.content.Context;
+import android.os.Build;
+import android.support.annotation.RequiresApi;
 import android.support.test.InstrumentationRegistry;
 import android.support.test.runner.AndroidJUnit4;
 import android.util.Pair;
@@ -47,6 +49,7 @@ public class EventDAOTest {
     private Logger logger;
     private Context context;
 
+    @RequiresApi(api = Build.VERSION_CODES.HONEYCOMB)
     @Before
     public void setupEventDAO() {
         logger = mock(Logger.class);