Private beta 2

Author: Chuck Greb

.travis.yml

@@ -2,8 +2,8 @@ language: android
 
 env:
   global:
-    - ANDROID_API_LEVEL=26
-    - ANDROID_BUILD_TOOLS_VERSION=26.0.3
+    - ANDROID_API_LEVEL=27
+    - ANDROID_BUILD_TOOLS_VERSION=27.0.3
 
 before_cache:
   - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock

README.md

@@ -15,3 +15,9 @@ git clone https://github.com/button/button-merchant-android.git
 cd button-merchant-android
 ./gradlew clean installDebug
 ```
+
+In order to get the sample app to compile and run, you will need to define your Button App ID in your global or local `gradle.properties` file.
+
+```groovy
+buttonMerchantAppId="__YOUR_APP_ID__"
+```

build.gradle

@@ -32,7 +32,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.0.1'
+        classpath 'com.android.tools.build:gradle:3.1.2'
         classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:2.0'
 
@@ -51,3 +51,27 @@ allprojects {
 task clean(type: Delete) {
     delete rootProject.buildDir
 }
+
+subprojects {
+    apply plugin: 'checkstyle'
+
+    task('checkstyle', type: Checkstyle) {
+        group 'verification'
+        configFile rootProject.file('checkstyle.xml')
+        source 'src/main/java'
+        ignoreFailures false
+        showViolations true
+        include '**/*.java'
+
+        classpath = files()
+    }
+}
+
+ext {
+    supportLibVersion = '27.1.1'
+    playServicesVersion = '15.0.0'
+    junitVersion = '4.12'
+    mockitoVersion = '2.16.0'
+    espressoVersion = '3.0.2'
+    testRunnerVersion = '1.0.2'
+}

button-merchant/build.gradle

@@ -27,19 +27,19 @@ apply plugin: 'com.android.library'
 apply plugin: 'com.jfrog.bintray'
 
 group = 'com.usebutton.merchant'
-version = sdkVersionName
+version = libraryVersionName
 
 apply plugin: 'com.github.dcendents.android-maven'
 
 android {
-    compileSdkVersion 26
-    buildToolsVersion '26.0.3'
+    compileSdkVersion 27
+    buildToolsVersion '27.0.3'
 
     defaultConfig {
         minSdkVersion 15
-        targetSdkVersion 26
+        targetSdkVersion 27
         versionCode 1
-        versionName "1.0"
+        versionName version
 
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
     }
@@ -56,15 +56,6 @@ android {
     }
 }
 
-ext {
-    supportLibVersion = '26.1.0'
-    playServicesVersion = '12.0.0'
-
-    junitVersion = '4.12'
-    mockitoVersion = '2.16.0'
-    espressoVersion = '3.0.1'
-}
-
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
 
@@ -74,23 +65,25 @@ dependencies {
     testImplementation "org.mockito:mockito-core:$mockitoVersion"
     testImplementation 'com.squareup.okhttp3:mockwebserver:3.10.0'
     testImplementation 'org.json:json:20171018'
-    androidTestImplementation 'com.android.support.test:runner:1.0.1'
+    androidTestImplementation "com.android.support.test:runner:$testRunnerVersion"
     androidTestImplementation "com.android.support.test.espresso:espresso-core:$espressoVersion"
     androidTestImplementation "org.mockito:mockito-android:$mockitoVersion"
 }
 
 bintray {
-    user = project.hasProperty('bintrayUsername') ? project.property('bintrayUsername') : System.getenv('BINTRAY_USER')
-    key = project.hasProperty('bintrayApiKey') ? project.property('bintrayApiKey') : System.getenv('BINTRAY_API_KEY')
+    user = project.hasProperty('bintrayUsername') ? project.property('bintrayUsername') :
+            System.getenv('BINTRAY_USER')
+    key = project.hasProperty('bintrayApiKey') ? project.property('bintrayApiKey') :
+            System.getenv('BINTRAY_API_KEY')
 
     configurations = ['archives']
     publish = true
-    override = sdkVersionName.endsWith("-SNAPSHOT")
+    override = libraryVersionName.endsWith("-SNAPSHOT")
 
     pkg {
         repo = 'Internal'
         name = 'android-merchant-library'
-        desc = "Button Merchant Library for Android v${sdkVersionName}"
+        desc = "Button Merchant Library for Android v${libraryVersionName}"
         userOrg = 'button'
         websiteUrl = 'https://github.com/button/button-merchant-android'
         issueTrackerUrl = 'https://github.com/button/button-merchant-android/issues'
@@ -100,7 +93,7 @@ bintray {
         licenses = ['MIT']
 
         version {
-            name = sdkVersionName
+            name = libraryVersionName
         }
     }
 }

button-merchant/src/main/java/com/usebutton/merchant/ButtonApiImpl.java

@@ -56,22 +56,24 @@ final class ButtonApiImpl implements ButtonApi {
     private static final int READ_TIMEOUT = (int) TimeUnit.SECONDS.toMillis(15);
     private static final String CONTENT_TYPE_JSON = "application/json";
 
+    private final String userAgent;
+
     @VisibleForTesting
-    String BASE_URL = "https://api.usebutton.com";
+    String baseUrl = "https://api.usebutton.com";
 
     private static ButtonApi buttonApi;
 
-    static ButtonApi getInstance() {
+    static ButtonApi getInstance(String userAgent) {
         if (buttonApi == null) {
-            buttonApi = new ButtonApiImpl();
+            buttonApi = new ButtonApiImpl(userAgent);
         }
 
         return buttonApi;
     }
 
     @VisibleForTesting
-    ButtonApiImpl() {
-
+    ButtonApiImpl(String userAgent) {
+        this.userAgent = userAgent;
     }
 
     @Nullable
@@ -91,7 +93,7 @@ public PostInstallLink getPendingLink(String applicationId, String ifa,
             requestBody.put("signals", new JSONObject(signalsMap));
 
             // setup url connection
-            final URL url = new URL(BASE_URL + "/v1/web/deferred-deeplink");
+            final URL url = new URL(baseUrl + "/v1/web/deferred-deeplink");
             urlConnection = (HttpURLConnection) url.openConnection();
             initializeUrlConnection(urlConnection);
 
@@ -104,7 +106,7 @@ public PostInstallLink getPendingLink(String applicationId, String ifa,
             Log.d(TAG, "Request Body: " + requestBody);
             Log.d(TAG, "Response Code: " + urlConnection.getResponseCode());
             // check if it's successful
-            if (!(urlConnection.getResponseCode() >= 400)) {
+            if (urlConnection.getResponseCode() < 400) {
                 // read response body
                 final InputStream in = new BufferedInputStream(urlConnection.getInputStream());
                 final BufferedReader reader =
@@ -131,12 +133,17 @@ public PostInstallLink getPendingLink(String applicationId, String ifa,
                     JSONObject attributionJson = responseJson.optJSONObject("attribution");
                     if (attributionJson != null) {
                         String btnRef = attributionJson.getString("btn_ref");
-                        String utmSource = attributionJson.getString("utm_source");
+                        String utmSource = attributionJson.optString("utm_source", null);
                         attribution = new PostInstallLink.Attribution(btnRef, utmSource);
                     }
 
                     return new PostInstallLink(match, id, action, attribution);
                 }
+            } else {
+                String message =
+                        "Unsuccessful Request. HTTP StatusCode: " + urlConnection.getResponseCode();
+                Log.e(TAG, message);
+                throw new ButtonNetworkException(message);
             }
         } catch (MalformedURLException e) {
             Log.e(TAG, "MalformedURLException has occurred", e);
@@ -195,7 +202,7 @@ public Void postActivity(String applicationId, String sourceToken, String ifa,
             requestBody.put("order", orderJson);
 
             // setup url connection
-            final URL url = new URL(BASE_URL + "/v2/session/useractivity");
+            final URL url = new URL(baseUrl + "/v2/session/useractivity");
             urlConnection = (HttpURLConnection) url.openConnection();
             initializeUrlConnection(urlConnection);
 
@@ -227,13 +234,13 @@ public Void postActivity(String applicationId, String sourceToken, String ifa,
                 String status = responseJson.optJSONObject("meta").optString("status");
                 if (status.equals("error")) {
                     String error = responseJson.optJSONObject("error").optString("message");
-                    throw new ButtonNetworkException(new Exception(error));
+                    throw new ButtonNetworkException(error);
                 }
             } else {
                 String message =
                         "Unsuccessful Request. HTTP StatusCode: " + urlConnection.getResponseCode();
                 Log.e(TAG, message);
-                throw new ButtonNetworkException(new Exception(message));
+                throw new ButtonNetworkException(message);
             }
         } catch (MalformedURLException e) {
             Log.e(TAG, "MalformedURLException has occurred", e);
@@ -254,7 +261,6 @@ public Void postActivity(String applicationId, String sourceToken, String ifa,
     }
 
     private String getUserAgent() {
-        //TODO: Add User Agent
-        return "";
+        return userAgent;
     }
 }

button-merchant/src/main/java/com/usebutton/merchant/ButtonInternal.java

@@ -52,6 +52,6 @@ void removeAttributionTokenListener(ButtonRepository buttonRepository, @NonNull
 
     void clearAllData(ButtonRepository buttonRepository);
 
-    void handlePostInstallIntent(ButtonRepository buttonRepository, PostInstallIntentListener listener,
-            String packageName, DeviceManager deviceManager);
+    void handlePostInstallIntent(ButtonRepository buttonRepository,
+            PostInstallIntentListener listener, String packageName, DeviceManager deviceManager);
 }

button-merchant/src/main/java/com/usebutton/merchant/ButtonInternalImpl.java

@@ -37,7 +37,8 @@
 
 /**
  * ButtonInternalImpl class should implement everything needed for {@link ButtonMerchant}
- * The methods in the ButtonInternalImpl class should never be public because it will only be used by {@link ButtonMerchant}.
+ * The methods in the ButtonInternalImpl class should never be public because it will only be used
+ * by {@link ButtonMerchant}.
  */
 
 final class ButtonInternalImpl implements ButtonInternal {

button-merchant/src/main/java/com/usebutton/merchant/ButtonMerchant.java

@@ -62,7 +62,8 @@ public static void configure(@NonNull Context context, @NonNull String applicati
     /**
      * Checks the passed {@code Intent} for a Button attribution and if present stores the token.
      *
-     * @param context a {@link Context) instance that can be used to access app resources like SharedPreferences.
+     * @param context a {@link Context) instance that can be used to access app resources like
+     * SharedPreferences.
      * @param intent An intent that has entered your app from a third party source.
      */
     public static void trackIncomingIntent(@NonNull Context context, @NonNull Intent intent) {
@@ -82,14 +83,17 @@ public static void trackOrder(@NonNull Context context, @NonNull Order order,
     }
 
     /**
-     * The `attributionToken` from the last inbound Button attributed {@link Intent}.
+     * The {@code attributionToken} from the last inbound Button attributed {@link Intent}.
      *
      * For attribution to work correctly, you must:
-     * -Always access this token directly—*never cache it*.
-     * -Never manage the lifecycle of this token—Button manages the token validity window server-side.
-     * -Always include this value when reporting orders to your order API
+     * <ul>
+     *     <li>Always access this token directly—*never cache it*.</li>
+     *     <li>Never manage the lifecycle of this token—Button manages the token validity window
+     *         server-side.</li>
+     *     <li>Always include this value when reporting orders to your order API.</li>
+     * </ul>
      *
-     * @return the last tracked Button attribution token.
+     *  @return the last tracked Button attribution token.
      **/
     @Nullable
     public static String getAttributionToken(@NonNull Context context) {
@@ -130,15 +134,17 @@ public static void clearAllData(@NonNull Context context) {
     /**
      * Checks to see if the user visited a url prior to installing your app.
      *
-     * If a url is found, {@link PostInstallIntentListener#onPostInstallIntent(Intent)} will be called on the listener you passed and you
-     * are responsible for navigating the user to the relevant content in your app. If a url is not found
-     * or an error occurs, {@link PostInstallIntentListener#onNoPostInstallIntent(Throwable)}  will be called on your listener and you can continue
-     * with your normal launch sequence.
+     * If a url is found, {@link PostInstallIntentListener#onPostInstallIntent(Intent)} will be
+     * called on the listener you passed and you are responsible for navigating the user to the
+     * relevant content in your app. If a url is not found or an error occurs,
+     * {@link PostInstallIntentListener#onNoPostInstallIntent(Throwable)} will be called on your
+     * listener and you can continue with your normal launch sequence.
      *
-     * This method checks for a post-install url exactly *one time* after a user has installed your app.
-     * Subsequent calls will result in a call to {@link PostInstallIntentListener#onNoPostInstallIntent(Throwable)} on your listener. You do not need to wait
-     * for the listener before continuing with your normal launch sequence but you should be prepared to handle
-     * an intent if a post-install url is found.
+     * This method checks for a post-install url exactly *one time* after a user has installed your
+     * app. Subsequent calls will result in a call to
+     * {@link PostInstallIntentListener#onNoPostInstallIntent(Throwable)} on your listener. You do
+     * not need to wait for the listener before continuing with your normal launch sequence but you
+     * should be prepared to handle an intent if a post-install url is found.
      *
      * @param context context
      * @param listener The listener for be notified when a post install url is found.
@@ -152,7 +158,10 @@ public static void handlePostInstallIntent(@NonNull Context context, @NonNull
     private static ButtonRepository getButtonRepository(Context context) {
         PersistenceManager persistenceManager =
                 PersistenceManagerImpl.getInstance(context.getApplicationContext());
-        ButtonApi buttonApi = ButtonApiImpl.getInstance();
+
+        DeviceManager deviceManager = getDeviceManager(context);
+
+        ButtonApi buttonApi = ButtonApiImpl.getInstance(deviceManager.getUserAgent());
 
         return ButtonRepositoryImpl.getInstance(buttonApi, persistenceManager, executorService);
     }

button-merchant/src/main/java/com/usebutton/merchant/DeviceManager.java

@@ -50,4 +50,6 @@ interface DeviceManager {
      * @return true if the app was installed more than 12 hours ago.
      */
     boolean isOldInstallation();
+
+    String getUserAgent();
 }