2.0.0 Release of the Android SDK. (#20)

* [Deeplink] Change Deeplink parameter for ride type into an enum. (#13)

* Add RideType enum for Deeplinks

* Update ride type names for button enum

* Remove button's enum

* Fix tests

* Fix NPE

* [Networking] Check and reject responses returned with partial data (#14)

* Add interface

* Update response models

* Implement null check converter

* Update riderequest response models

* Implement methods to disallow null checking

* Remove dead links

* Update documentation

* Address PR comments (ApiFactory)

* Address PR comments (ICompleteData -> Validatable)

* [SDK] Update Gradle Dependency Versions (#16)

* Update Gradle + Android Gradle Plugin

* Update dependency versions

* Unused cleanup

* RxJava -> RxJava 2

* Bump Lyft SDK version

* Fix Lint

* Update travis

* [Networking] Remove User API. (#17)

* Remove UserApi

* Remove user access token

* Remove related models

* LyftPublicApi -> LyftApi

* LyftPublicApiRx -> LyftApiRx

* Factory method renames

* [Networking] Document nullable fields in network responses (#18)

* CostEstimate documentation

* Eta documentation

* Nearby Drivers

* Pricing Detail

* Ride types

* Update Cost

* Fix Mock API

* Update CHANGELOG

* [Ride Type] Fix enum string values to reflect correct server rend… (#19)

* Fix Lux SUV enum

* Update ride type display names to match endpoints values

* Stamp release date in CHANGELOG

* Update README

Author: slowhill

.travis.yml

@@ -5,8 +5,8 @@ android:
   components:
     - platform-tools
     - tools
-    - build-tools-23.0.3
-    - android-23
+    - build-tools-28.0.3
+    - android-28
     - extra-android-m2repository
     - extra-google-m2repository
 

CHANGELOG.md

@@ -1,3 +1,30 @@
+Version 2.0.0 *(2019-07-12)*
+----------------------------
+* Update Gradle version from `2.14.1` to `4.10.1`, and Android Gradle Plugin from `2.2.2` to `3.3.2`
+* The compile SDK target for Android has been bumped to API 28.
+* The following dependencies have been updated:
+  * Android Build Tools `23.0.3` -> `28.0.3`
+  * Android Support Libraries `23.4.0` -> `28.0.0`
+  * Google Play Services `9.4.0` -> `17.0.0`
+  * Mockito `1.10.19` -> `2.25.0`
+  * Retrofit `2.1.0` -> `2.6.0`
+* `LyftUserApi`, `LyftUserApiRx` and all endpoints that require a Lyft User OAuth token **have been removed**. External clients will no longer have access to features that require user information.
+* `LyftPublicApi` and `LyftPublicApiRx` have been renamed to `LyftApi` and `LyftApiRx` respectively, to reflect new changes regarding the UserApi client.
+* The RxJava call adapter for Retrofit has been updated to RxJava2. Users of the RxJava Retrofit interface will have to update their codebase to take RxJava2 Observables.
+* All models returned by network calls have been documented with JetBrain `@Nullable` and `@NotNull` annotations.
+* `LyftApiFactory` now by default generates a `LyftApi` that **throws a `PartialResponseException`** when the server response doesn't abide by the `@Nullable` and `@NotNull` annotations of the parsed model. The client must be able to handle a `PartialResponseException` when calling for Lyft endpoints.
+  * If the client wishes to handle null checking manually, call `LyftApiFactory#getUncheckedLyftApi` to get a Retrofit client that does not massage responses.
+* `RideTypeEnum` has been moved from the Lyft Button module to the Deeplink module, with the following changes:
+  * `toString()` is no longer valid when fetching for a ride type key. Use `RideTypeEnum#getRideTypeKey()` instead.
+  * `getDisplayName()` is still valid for fetching human readable text for each ride type.
+* `RideTypeEnum` has been updated to reflect the current ride offerings  provided by Lyft:
+  * `LINE` has been replaced by `SHARED`
+  * `CLASSIC` has been replaced by `STANDARD`
+  * `PLUS` has been replaced by `XL`
+  * `LUX`, `LUX_BLACK`, `LUX_BLACK_XL` has been added into `RideTypeEnum`
+  * `null` can be used in place of `RideTypeEnum.ALL` in existing usages 
+* `DeepLinkParams` and its builder now takes in `RideTypeEnum` to specify a ride type, instead of a `String`.
+
 Version 1.0.3 *(2017-02-21)*
 ----------------------------
 Rename couponCode to promoCode

README.md

@@ -19,22 +19,22 @@ repositories {
 }
 
 dependencies {
-    compile 'com.lyft:lyft-android-sdk:1.0.3'
+    compile 'com.lyft:lyft-android-sdk:2.0.0'
 }
 ```
 
 If you only want to use the [Lyft API Wrapper](https://github.com/lyft/lyft-android-sdk#lyft-api-wrapper) or [Deeplink](https://github.com/lyft/lyft-android-sdk#deeplinking) portion of the SDK, you can pull them individually.
 ```gradle
-compile 'com.lyft:lyft-android-sdk-networking:1.0.3'  // Lyft API Wrapper
-compile 'com.lyft:lyft-android-sdk-deeplink:1.0.3'    // Deeplink
+compile 'com.lyft:lyft-android-sdk-networking:2.0.0'  // Lyft API Wrapper
+compile 'com.lyft:lyft-android-sdk-deeplink:2.0.0'    // Deeplink
 ```
 
 ### Maven:
 ```xml
 <dependency>
   <groupId>com.lyft</groupId>
   <artifactId>lyft-android-sdk</artifactId>
-  <version>1.0.3</version>
+  <version>2.0.0</version>
   <type>aar</type>
 </dependency>
 ```
@@ -66,7 +66,7 @@ lyftButton.setApiConfig(apiConfig);
 RideParams.Builder rideParamsBuilder = new RideParams.Builder()
         .setPickupLocation(37.7766048, -122.3943576)
         .setDropoffLocation(37.759234, -122.4135125);
-rideParamsBuilder.setRideTypeEnum(RideTypeEnum.CLASSIC);
+rideParamsBuilder.setRideTypeEnum(RideTypeEnum.STANDARD);
 
 lyftButton.setRideParams(rideParamsBuilder.build());
 lyftButton.load();
@@ -80,7 +80,7 @@ RideParams.Builder rideParamsBuilder = new RideParams.Builder()
 ```
 
 ### Ride types
-Lyft is growing very quickly and is currently available in [these cities](https://www.lyft.com/cities). Please keep in mind that some ride types (such as Lyft Line) are not yet available in all Lyft cities. If you set the ride type of the button  and it happens to be unavailable, the button will default to the Lyft Classic ride type. You can utilize the [`/v1/ridetypes`](https://developer.lyft.com/docs/availability-ride-types) endpoint to get a list of the available ride types in an area.
+Lyft is growing very quickly and is currently available in [these cities](https://www.lyft.com/cities). Please keep in mind that some ride types (such as Lyft Line) are not yet available in all Lyft cities. If you set the ride type of the button  and it happens to be unavailable, the button will default to the Lyft Standard ride type. You can utilize the [`/v1/ridetypes`](https://developer.lyft.com/docs/availability-ride-types) endpoint to get a list of the available ride types in an area.
 
 ### Button styles
 To specify the button style via XML, use the `lyft:lyftStyle` attribute or set it programmatically:
@@ -95,10 +95,10 @@ There are 5 styles to pick from:
 ## Lyft API Wrapper
 The SDK provides wrapper methods around Lyft's REST APIs - this can be helpful when you want to build a more custom integration with the Lyft platform vs making HTTP requests directly.
 
-The SDK uses Square's [Retrofit 2](http://square.github.io/retrofit/) networking library. For each [Lyft Public API endpoint](http://petstore.swagger.io/?url=https://api.lyft.com/v1/spec#!/Public/), there is a corresponding Java method. The return type is a `Call` object which can be executed synchronously or asynchronously. See [LyftPublicApi.java](https://github.com/lyft/lyft-android-sdk/blob/master/networking/src/main/java/com/lyft/networking/apis/LyftPublicApi.java) for all the API methods.
+The SDK uses Square's [Retrofit 2](http://square.github.io/retrofit/) networking library. For each Lyft API endpoint, there is a corresponding Java method. The return type is a `Call` object which can be executed synchronously or asynchronously. See [LyftApi.java](https://github.com/lyft/lyft-android-sdk/blob/master/networking/src/main/java/com/lyft/networking/apis/LyftApi.java) for all the API methods.
 
 ```java
-LyftPublicApi lyftPublicApi = new LyftApiFactory(apiConfig).getLyftPublicApi();
+LyftApi lyftPublicApi = new LyftApiFactory(apiConfig).getLyftApi();
 Call<EtaEstimateResponse> etaCall = lyftPublicApi.getEtas(37.7766048, -122.3943576, "lyft");
 ```
 Asynchronous:
@@ -124,7 +124,7 @@ Eta eta = etaEstimateResponse.eta_estimates.get(0);
 ```
 
 ### RxJava Observables
-If you already use RxJava (your app must have it as a dependency), then you can obtain an `Observable` instead of a `Call` object. Simply use [LyftPublicApiRx](https://github.com/lyft/lyft-android-sdk/blob/master/networking/src/main/java/com/lyft/networking/apis/LyftPublicApiRx.java) instead of LyftPublicApi.
+If you already use RxJava (your app must have it as a dependency), then you can obtain an `Observable` instead of a `Call` object. Simply use [LyftApiRx](https://github.com/lyft/lyft-android-sdk/blob/master/networking/src/main/java/com/lyft/networking/apis/LyftApiRx.java) instead of LyftApi.
 
 ```java
 LyftPublicApiRx lyftPublicApiRx = new LyftApiFactory(apiConfig).getLyftPublicApiRx();
@@ -139,7 +139,7 @@ The SDK provides direct [deeplinking](https://developer.lyft.com/docs/deeplinkin
 ```java
 DeepLinkParams deepLinkParams = new DeepLinkParams.Builder()
         .setClientId("your_client_id")
-        .setRideType("lyft_line")
+        .setRideType(RideTypeEnum.SHARED)
         .setPickupLocation(37.7766048, -122.3943576)
         .setDropoffLocation(37.759234, -122.4135125)
         .build();

build.gradle

@@ -3,15 +3,17 @@
 buildscript {
     repositories {
         jcenter()
+        google()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:2.2.2'
+        classpath 'com.android.tools.build:gradle:3.3.2'
     }
 }
 
 allprojects {
     repositories {
         jcenter()
+        google()
     }
 }
 
@@ -29,19 +31,19 @@ subprojects { subProject ->
 }
 
 subprojects {
-    ext.androidBuildToolsVersion = "23.0.3"
-    ext.androidCompileSDK = 23
+    ext.androidBuildToolsVersion = "28.0.3"
+    ext.androidCompileSDK = 28
     ext.androidMinSdk = 15
-    ext.androidSupportLibrariesVersion = '23.4.0'
+    ext.androidSupportLibrariesVersion = '28.0.0'
     ext.androidTargetSDK = 23
-    ext.googlePlayVersion = '9.4.0'
+    ext.googlePlayVersion = '17.0.0'
     ext.jetbrainsVersion = '15.0'
     ext.junitVersion = '4.12'
-    ext.lyftSdkVersionCode = 1
+    ext.lyftSdkVersionCode = 2
     ext.lyftSdkVersionName = VERSION_NAME
-    ext.mockitoVersion = '1.10.19'
+    ext.mockitoVersion = '2.25.0'
     ext.okhttpVersion = '3.3.1'
-    ext.retrofitVersion = '2.1.0'
+    ext.retrofitVersion = '2.6.0'
 }
 
 task clean(type: Delete) {

deeplink/build.gradle

@@ -19,8 +19,8 @@ android {
 }
 
 dependencies {
-    compile 'org.jetbrains:annotations-java5:' + jetbrainsVersion
-    testCompile 'junit:junit:' + junitVersion
+    implementation 'org.jetbrains:annotations-java5:' + jetbrainsVersion
+    testImplementation 'junit:junit:' + junitVersion
 }
 
 apply from: rootProject.file('gradle/gradle-mvn-push.gradle')

deeplink/src/main/java/com/lyft/deeplink/DeepLink.java

@@ -9,7 +9,7 @@
 public class DeepLink {
 
     private static final String LYFT_PACKAGE_NAME = "me.lyft.android";
-    private static final String SDK_VERSION = "1.0.3";
+    private static final String SDK_VERSION = "2.0.0";
 
     /**
      * @return true if Lyft app is installed on the device.
@@ -63,7 +63,12 @@ public static boolean launchLyftApp(Context context, DeepLinkParams deepLinkPara
     static String createDeepLinkString(DeepLinkParams deepLinkParams) {
         StringBuilder sb = new StringBuilder();
         sb.append("lyft://ridetype?id=");
-        sb.append(deepLinkParams.getRideType());
+
+        if (deepLinkParams.isRideTypeSet()) {
+            sb.append(deepLinkParams.getRideTypeEnum().getRideTypeKey());
+        } else {
+            sb.append(RideTypeEnum.STANDARD.getRideTypeKey());
+        }
 
         if (deepLinkParams.isPickupLatLngSet()) {
             sb.append("&pickup[latitude]=");

deeplink/src/main/java/com/lyft/deeplink/DeepLinkParams.java

@@ -5,7 +5,7 @@
 public class DeepLinkParams {
 
     private final String clientId;
-    private final String rideType;
+    private final RideTypeEnum rideTypeEnum;
     private final String promoCode;
     private final String pickupAddr;
     private final Double pickupLat;
@@ -14,10 +14,17 @@ public class DeepLinkParams {
     private final Double dropoffLat;
     private final Double dropoffLng;
 
-    private DeepLinkParams(String clientId, String rideType, String promoCode, String pickupAddr, Double pickupLat, Double pickupLng,
-            String dropoffAddr, Double dropoffLat, Double dropoffLng) {
+    private DeepLinkParams(String clientId,
+                           RideTypeEnum rideTypeEnum,
+                           String promoCode,
+                           String pickupAddr,
+                           Double pickupLat,
+                           Double pickupLng,
+                           String dropoffAddr,
+                           Double dropoffLat,
+                           Double dropoffLng) {
         this.clientId = clientId;
-        this.rideType = rideType;
+        this.rideTypeEnum = rideTypeEnum;
         this.promoCode = promoCode;
         this.pickupAddr = pickupAddr;
         this.pickupLat = pickupLat;
@@ -32,9 +39,8 @@ public String getClientId() {
         return clientId;
     }
 
-    @Nullable
-    public String getRideType() {
-        return rideType;
+    public RideTypeEnum getRideTypeEnum() {
+        return rideTypeEnum;
     }
 
     @Nullable
@@ -72,6 +78,10 @@ public Double getDropoffLng() {
         return dropoffLng;
     }
 
+    public boolean isRideTypeSet() {
+        return rideTypeEnum != null;
+    }
+
     public boolean isPickupLatLngSet() {
         return pickupLat != null && pickupLng != null;
     }
@@ -91,7 +101,7 @@ public boolean isDropoffAddressSet() {
     public static class Builder {
 
         private String clientId;
-        private String rideType = "lyft";
+        private RideTypeEnum rideTypeEnum = RideTypeEnum.STANDARD;
         private String promoCode;
         private String pickupAddr;
         private Double pickupLat;
@@ -101,16 +111,16 @@ public static class Builder {
         private Double dropoffLng;
 
         public DeepLinkParams build() {
-            return new DeepLinkParams(clientId, rideType, promoCode, pickupAddr, pickupLat, pickupLng, dropoffAddr, dropoffLat, dropoffLng);
+            return new DeepLinkParams(clientId, rideTypeEnum, promoCode, pickupAddr, pickupLat, pickupLng, dropoffAddr, dropoffLat, dropoffLng);
         }
 
         public Builder setClientId(String clientId) {
             this.clientId = clientId;
             return this;
         }
 
-        public Builder setRideType(String rideType) {
-            this.rideType = rideType;
+        public Builder setRideTypeEnum(RideTypeEnum rideTypeEnum) {
+            this.rideTypeEnum = rideTypeEnum;
             return this;
         }
 

deeplink/src/main/java/com/lyft/deeplink/RideTypeEnum.java

@@ -0,0 +1,27 @@
+package com.lyft.deeplink;
+
+public enum RideTypeEnum {
+    SHARED("lyft_line", "Shared"),
+    STANDARD("lyft", "Lyft"),
+    XL("lyft_plus", "Lyft XL"),
+    LUX("lyft_premier", "Lux"),
+    LUX_BLACK("lyft_lux", "Lux Black"),
+    LUX_BLACK_XL("lyft_luxsuv", "Lux Black XL");
+
+    private String rideTypeKey;
+    private String displayName;
+
+    RideTypeEnum(String rideTypeKey, String displayName) {
+        this.rideTypeKey = rideTypeKey;
+        this.displayName = displayName;
+    }
+
+    public String getRideTypeKey() {
+        return rideTypeKey;
+    }
+
+    public String getDisplayName() {
+        return displayName;
+    }
+}
+

deeplink/src/test/java/com/lyft/deeplink/DeepLinkTest.java

@@ -7,7 +7,7 @@
 public class DeepLinkTest {
 
     private static final String CLIENT_ID = "clientId";
-    private static final String RIDETYPE = "ridetype";
+    private static final RideTypeEnum RIDETYPE = RideTypeEnum.STANDARD;
     private static final Double PICKUP_LAT = 1.0;
     private static final Double PICKUP_LNG = 2.0;
     private static final Double DROPOFF_LAT = 3.0;
@@ -20,7 +20,7 @@ public class DeepLinkTest {
     public void createDeepLinkStringTest_full() {
         DeepLinkParams deepLinkParams = new DeepLinkParams.Builder()
                 .setClientId(CLIENT_ID)
-                .setRideType(RIDETYPE)
+                .setRideTypeEnum(RIDETYPE)
                 .setPickupLocation(PICKUP_LAT, PICKUP_LNG)
                 .setDropoffLocation(DROPOFF_LAT, DROPOFF_LNG)
                 .setPickupAddress(PICKUP_ADDR)
@@ -29,7 +29,7 @@ public void createDeepLinkStringTest_full() {
                 .build();
 
         String deeplinkString = DeepLink.createDeepLinkString(deepLinkParams);
-        assertEquals("lyft://ridetype?id=" + RIDETYPE + "&pickup[latitude]=" + PICKUP_LAT + "&pickup[longitude]=" +
+        assertEquals("lyft://ridetype?id=" + RIDETYPE.getRideTypeKey() + "&pickup[latitude]=" + PICKUP_LAT + "&pickup[longitude]=" +
                 PICKUP_LNG + "&pickup[address]=" + PICKUP_ADDR + "&destination[latitude]=" + DROPOFF_LAT +
                 "&destination[longitude]=" + DROPOFF_LNG + "&destination[address]=" + DROPOFF_ADDR + "&partner=" + CLIENT_ID +
                 "&credits=" + PROMO_CODE,
@@ -39,41 +39,41 @@ public void createDeepLinkStringTest_full() {
     @Test
     public void createDeepLinkStringTest_noClientId() {
         DeepLinkParams deepLinkParams = new DeepLinkParams.Builder()
-                .setRideType(RIDETYPE)
+                .setRideTypeEnum(RIDETYPE)
                 .setPickupLocation(PICKUP_LAT, PICKUP_LNG)
                 .setDropoffLocation(DROPOFF_LAT, DROPOFF_LNG)
                 .build();
 
         String deeplinkString = DeepLink.createDeepLinkString(deepLinkParams);
-        assertEquals("lyft://ridetype?id=" + RIDETYPE + "&pickup[latitude]=" + PICKUP_LAT + "&pickup[longitude]=" + PICKUP_LNG
+        assertEquals("lyft://ridetype?id=" + RIDETYPE.getRideTypeKey() + "&pickup[latitude]=" + PICKUP_LAT + "&pickup[longitude]=" + PICKUP_LNG
                         + "&destination[latitude]=" + DROPOFF_LAT + "&destination[longitude]=" + DROPOFF_LNG,
                 deeplinkString);
     }
 
     @Test
     public void createDeepLinkStringTest_noPickupLocation() {
         DeepLinkParams deepLinkParams = new DeepLinkParams.Builder()
-                .setRideType(RIDETYPE)
+                .setRideTypeEnum(RIDETYPE)
                 .setPickupLocation(PICKUP_LAT, null)
                 .setDropoffLocation(DROPOFF_LAT, DROPOFF_LNG)
                 .build();
 
         String deeplinkString = DeepLink.createDeepLinkString(deepLinkParams);
-        assertEquals("lyft://ridetype?id=" + RIDETYPE + "&destination[latitude]=" + DROPOFF_LAT + "&destination[longitude]=" + DROPOFF_LNG,
+        assertEquals("lyft://ridetype?id=" + RIDETYPE.getRideTypeKey() + "&destination[latitude]=" + DROPOFF_LAT + "&destination[longitude]=" + DROPOFF_LNG,
                 deeplinkString);
     }
 
     @Test
     public void createDeepLinkStringTest_addressOnly() {
         DeepLinkParams deepLinkParams = new DeepLinkParams.Builder()
                 .setClientId(CLIENT_ID)
-                .setRideType(RIDETYPE)
+                .setRideTypeEnum(RIDETYPE)
                 .setPickupAddress(PICKUP_ADDR)
                 .setDropoffAddress(DROPOFF_ADDR)
                 .build();
 
         String deeplinkString = DeepLink.createDeepLinkString(deepLinkParams);
-        assertEquals("lyft://ridetype?id=" + RIDETYPE + "&pickup[address]=" + PICKUP_ADDR +
+        assertEquals("lyft://ridetype?id=" + RIDETYPE.getRideTypeKey() + "&pickup[address]=" + PICKUP_ADDR +
                 "&destination[address]=" + DROPOFF_ADDR + "&partner=" + CLIENT_ID,
                 deeplinkString);
     }

gradle.properties

@@ -1,5 +1,5 @@
 GROUP=com.lyft
-VERSION_NAME=1.0.4-SNAPSHOT
+VERSION_NAME=2.0.0
 
 POM_DESCRIPTION=Lyft Android SDK