Merge pull request #133 from smartcar/lock-status

feat: get VehicleLockStatus

README.md

@@ -10,24 +10,24 @@ The recommended method for obtaining the SDK is via Gradle or Maven through the
 
 ### Gradle
 ```groovy
-compile "com.smartcar.sdk:java-sdk:3.7.0"
+compile "com.smartcar.sdk:java-sdk:3.8.0"
 ```
 
 ### Maven
 ```xml
 <dependency>
   <groupId>com.smartcar.sdk</groupId>
   <artifactId>java-sdk</artifactId>
-  <version>3.7.0</version>
+  <version>3.8.0</version>
 </dependency>
 ```
 
 ### Jar Direct Download
-* [java-sdk-3.7.0.jar](https://search.maven.org/remotecontent?filepath=com/smartcar/sdk/java-sdk/3.7.0/java-sdk-3.7.0.jar)
-* [java-sdk-3.7.0-sources.jar](https://search.maven.org/remotecontent?filepath=com/smartcar/sdk/java-sdk/3.7.0/java-sdk-3.7.0-sources.jar)
-* [java-sdk-3.7.0-javadoc.jar](https://search.maven.org/remotecontent?filepath=com/smartcar/sdk/java-sdk/3.7.0/java-sdk-3.7.0-javadoc.jar)
+* [java-sdk-3.8.0.jar](https://search.maven.org/remotecontent?filepath=com/smartcar/sdk/java-sdk/3.8.0/java-sdk-3.8.0.jar)
+* [java-sdk-3.8.0-sources.jar](https://search.maven.org/remotecontent?filepath=com/smartcar/sdk/java-sdk/3.8.0/java-sdk-3.8.0-sources.jar)
+* [java-sdk-3.8.0-javadoc.jar](https://search.maven.org/remotecontent?filepath=com/smartcar/sdk/java-sdk/3.8.0/java-sdk-3.8.0-javadoc.jar)
 
-Signatures and other downloads available at [Maven Central](https://search.maven.org/artifact/com.smartcar.sdk/java-sdk/3.7.0/jar).
+Signatures and other downloads available at [Maven Central](https://search.maven.org/artifact/com.smartcar.sdk/java-sdk/3.8.0/jar).
 
 ## Usage
 
@@ -136,5 +136,5 @@ In accordance with the Semantic Versioning specification, the addition of suppor
 [ci-url]: https://travis-ci.com/smartcar/java-sdk
 [coverage-image]: https://codecov.io/gh/smartcar/java-sdk/branch/master/graph/badge.svg?token=nZAITx7w3X
 [coverage-url]: https://codecov.io/gh/smartcar/java-sdk
-[javadoc-image]: https://img.shields.io/badge/javadoc-3.7.0-brightgreen.svg
+[javadoc-image]: https://img.shields.io/badge/javadoc-3.8.0-brightgreen.svg
 [javadoc-url]: https://smartcar.github.io/java-sdk

gradle.properties

@@ -1,4 +1,4 @@
 libGroup=com.smartcar.sdk
 libName=java-sdk
-libVersion=3.7.0
+libVersion=3.8.0
 libDescription=Smartcar Java SDK

src/integration/java/com/smartcar/sdk/SmartcarTest.java

@@ -12,9 +12,9 @@
 public class SmartcarTest {
     private String accessToken;
     private VehicleIds vehicleIds;
-    private String clientId = System.getenv("E2E_SMARTCAR_CLIENT_ID");
-    private String clientSecret = System.getenv("E2E_SMARTCAR_CLIENT_SECRET");
-    private String amt = System.getenv("E2E_SMARTCAR_AMT");
+    private String clientId;
+    private String clientSecret;
+    private String amt;
     private AuthClient client;
     private String authorizeUrl;
     private String[] scope = {"read_odometer"};
@@ -27,6 +27,9 @@ public void beforeSuite() throws Exception {
         this.accessToken = client.exchangeCode(code).getAccessToken();
         VehicleIds vehicleIds = Smartcar.getVehicles(this.accessToken);
         this.vehicleIds = vehicleIds;
+        this.clientId = AuthHelpers.getClientId();
+        this.clientSecret = AuthHelpers.getClientSecret();
+        this.amt = AuthHelpers.getApplicationManagementToken();
     }
 
     @Test

src/main/java/com/smartcar/sdk/Vehicle.java

@@ -359,6 +359,16 @@ public ActionResponse stopCharge() throws SmartcarException {
     return this.call("charge", "POST", body, ActionResponse.class);
   }
 
+  /**
+   * Send request to the /security endpoint to get the vehicle's lock status
+   *
+   * @return VehicleLockStatus
+   * @throws SmartcarException
+   */
+  public VehicleLockStatus lockStatus() throws SmartcarException {
+    return this.call("security", "GET", null, VehicleLockStatus.class);
+  }
+
   /**
    * Subscribe vehicle to a webhook
    *

src/main/java/com/smartcar/sdk/data/BatchResponse.java

@@ -200,6 +200,17 @@ public VehicleChargeLimit chargeLimit()
       return get("/charge/limit", VehicleChargeLimit.class);
     }
 
+    /**
+   * Get response from the /security endpoint
+   *
+   * @return the lock status of the vehicle
+   * @throws SmartcarException if the request for this endpoint returned an HTTP error code
+   */
+  public VehicleLockStatus lockStatus()
+    throws SmartcarException {
+      return get("/security", VehicleLockStatus.class);
+    }
+
   /** @return a stringified representation of BatchResponse */
   @Override
   public String toString() {

src/main/java/com/smartcar/sdk/data/VehicleChargingPort.java

@@ -0,0 +1,32 @@
+package com.smartcar.sdk.data;
+
+public class VehicleChargingPort extends ApiData {
+    private String type;
+    private String status;
+
+    /**
+     * Returns the charging port type
+     *
+     * @return charging port type
+     */
+    public String getType() {
+        return this.type;
+    }
+
+    /**
+     * Returns the charging port status
+     *
+     * @return charging port status
+     */
+    public String getStatus() {
+        return this.status;
+    }
+
+    /**
+     * @return a stringified representation of VehicleChargingPort
+     */
+    @Override
+    public String toString() {
+        return this.getClass().getName() + "{" + "type=" + type + ", status=" + status + '}';
+    }
+}

src/main/java/com/smartcar/sdk/data/VehicleDoor.java

@@ -0,0 +1,32 @@
+package com.smartcar.sdk.data;
+
+public class VehicleDoor extends ApiData {
+    private String type;
+    private String status;
+
+    /**
+     * Returns the door type
+     *
+     * @return door type
+     */
+    public String getType() {
+        return this.type;
+    }
+
+    /**
+     * Returns the door status
+     *
+     * @return door status
+     */
+    public String getStatus() {
+        return this.status;
+    }
+
+    /**
+     * @return a stringified representation of VehicleDoor
+     */
+    @Override
+    public String toString() {
+        return this.getClass().getName() + "{" + "type=" + type + ", status=" + status + '}';
+    }
+}

src/main/java/com/smartcar/sdk/data/VehicleLockStatus.java

@@ -0,0 +1,83 @@
+package com.smartcar.sdk.data;
+
+import java.util.Arrays;
+
+public class VehicleLockStatus extends ApiData {
+    private boolean isLocked;
+    private VehicleDoor[] doors;
+    private VehicleWindow[] windows;
+    private VehicleStorage[] storage;
+    private VehicleSunroof[] sunroof;
+    private VehicleChargingPort[] chargingPort;
+
+    /**
+     * Check if the vehicle currently locked.
+     *
+     * @return {boolean} True if the vehicle is locked, otherwise false.
+     */
+    public boolean isLocked() {
+        return this.isLocked;
+    }
+
+    /**
+     * Returns the vehicle doors
+     *
+     * @return vehicle doors
+     */
+    public VehicleDoor[] getDoors() {
+        return this.doors;
+    }
+
+    /**
+     * Returns the vehicle's windows
+     *
+     * @return vehicle windows
+     */
+    public VehicleWindow[] getWindows() {
+        return this.windows;
+    }
+
+    /**
+     * Returns the vehicle's storage
+     *
+     * @return vehicle storage
+     */
+    public VehicleStorage[] getStorage() {
+        return this.storage;
+    }
+
+    /**
+     * Returns the vehicle's sunroofs
+     *
+     * @return vehicle sunroof
+     */
+    public VehicleSunroof[] getSunroof() {
+        return this.sunroof;
+    }
+
+    /**
+     * Returns the vehicle's charging ports
+     *
+     * @return vehicle charging port
+     */
+    public VehicleChargingPort[] getChargingPort() {
+        return this.chargingPort;
+    }
+
+    /**
+     * Returns a stringified representation of the VehicleLockStatus object.
+     *
+     * @return A string describing the lock status and other vehicle attributes.
+     */
+    @Override
+    public String toString() {
+        return this.getClass().getName() + "{" +
+                "isLocked=" + this.isLocked +
+                ", doors=" + Arrays.toString(this.doors) +
+                ", windows=" + Arrays.toString(this.windows) +
+                ", storage=" + Arrays.toString(this.storage) +
+                ", sunroof=" + Arrays.toString(this.sunroof) +
+                ", chargingPort=" + Arrays.toString(this.chargingPort) +
+                '}';
+    }
+}

src/main/java/com/smartcar/sdk/data/VehicleStorage.java

@@ -0,0 +1,32 @@
+package com.smartcar.sdk.data;
+
+public class VehicleStorage extends ApiData {
+    private String type;
+    private String status;
+
+    /**
+     * Returns the storage type
+     *
+     * @return storage type
+     */
+    public String getType() {
+        return this.type;
+    }
+
+    /**
+     * Returns the storage status
+     *
+     * @return storage status
+     */
+    public String getStatus() {
+        return this.status;
+    }
+
+    /**
+     * @return a stringified representation of VehicleStorage
+     */
+    @Override
+    public String toString() {
+        return this.getClass().getName() + "{" + "type=" + type + ", status=" + status + '}';
+    }
+}

src/main/java/com/smartcar/sdk/data/VehicleSunroof.java

@@ -0,0 +1,32 @@
+package com.smartcar.sdk.data;
+
+public class VehicleSunroof extends ApiData {
+    private String type;
+    private String status;
+
+    /**
+     * Returns the sunroof type
+     *
+     * @return sunroof type
+     */
+    public String getType() {
+        return this.type;
+    }
+
+    /**
+     * Returns the sunroof status
+     *
+     * @return sunroof status
+     */
+    public String getStatus() {
+        return this.status;
+    }
+
+    /**
+     * @return a stringified representation of VehicleSunroof
+     */
+    @Override
+    public String toString() {
+        return this.getClass().getName() + "{" + "type=" + type + ", status=" + status + '}';
+    }
+}

src/main/java/com/smartcar/sdk/data/VehicleWindow.java

@@ -0,0 +1,32 @@
+package com.smartcar.sdk.data;
+
+public class VehicleWindow extends ApiData {
+    private String type;
+    private String status;
+
+    /**
+     * Returns the window type
+     *
+     * @return window type
+     */
+    public String getType() {
+        return this.type;
+    }
+
+    /**
+     * Returns the window status
+     *
+     * @return window status
+     */
+    public String getStatus() {
+        return this.status;
+    }
+
+    /**
+     * @return a stringified representation of VehicleWindow
+     */
+    @Override
+    public String toString() {
+        return this.getClass().getName() + "{" + "type=" + type + ", status=" + status + '}';
+    }
+}