com.smartcar.sdk.SmartcarCompatibilityRequest Maven / Gradle / Ivy

Go to download
package com.smartcar.sdk;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * Class encompassing optional arguments for Smartcar compatibility requests
 */
public final class SmartcarCompatibilityRequest {
    private final String vin;
    private final String[] scope;
    private final String country;
    private final String version;
    private final String flags;
    private final String clientId;
    private final String clientSecret;
    private final String mode;
    private final String testModeCompatibilityLevel;

    public static class Builder {
        private String vin;
        private String[] scope;
        private String country;
        private String version;
        private final List flags;
        private String clientId;
        private String clientSecret;
        private String mode;
        private String testModeCompatibilityLevel;
        private final Set validModes = Stream.of("test", "live", "simulated").collect(Collectors.toSet());

        public Builder() {
            this.vin = "";
            this.scope = null;
            this.country = "US";
            this.version = Smartcar.API_VERSION;
            this.flags = new ArrayList<>();
            this.clientId = System.getenv("SMARTCAR_CLIENT_ID");
            this.clientSecret = System.getenv("SMARTCAR_CLIENT_SECRET");
            this.mode = null;
            this.testModeCompatibilityLevel = null;
        }

        public Builder vin(String vin) {
            this.vin = vin;
            return this;
        }

        public Builder scope(String[] scope) {
            this.scope = scope;
            return this;
        }

        public Builder country(String country) {
            this.country = country;
            return this;
        }

        public Builder version(String version) {
            this.version = version;
            return this;
        }

        public Builder addFlag(String key, String value) {
            this.flags.add(key + ":" + value);
            return this;
        }

        public Builder addFlag(String key, boolean value) {
            this.flags.add(key + ":" + value);
            return this;
        }

        public Builder clientId(String clientId) {
            this.clientId = clientId;
            return this;
        }

        public Builder clientSecret(String clientSecret) {
            this.clientSecret = clientSecret;
            return this;
        }

        /**
         * @deprecated use {@link #mode(String)} instead.
         */
        @Deprecated
        public Builder testMode(boolean testMode) {
            this.mode = testMode ? "test" : "live";
            return this;
        }

        public Builder mode(String mode) throws Exception {
            if (!this.validModes.contains(mode)) {
                throw new Exception(
                "The \"mode\" parameter MUST be one of the following: \"test\", \"live\", \"simulated\""
                );
            }

            this.mode = mode;
            return this;
        }

        public Builder testModeCompatibilityLevel(String level) {
            this.mode = "test";
            this.testModeCompatibilityLevel = level;
            return this;
        }

        public SmartcarCompatibilityRequest build() throws Exception {
            if (this.clientId == null) {
                throw new Exception("clientId must be defined");
            }
            if (this.clientSecret == null) {
                throw new Exception("clientSecret must be defined");
            }
            return new SmartcarCompatibilityRequest(this);
        }
    }

    private SmartcarCompatibilityRequest(Builder builder) {
        this.vin = builder.vin;
        this.scope = builder.scope;
        this.country = builder.country;
        this.version = builder.version;
        if (builder.flags.size() > 0) {
            String[] flagStrings = builder.flags.toArray(new String[0]);
            this.flags = Utils.join(flagStrings, " ");
        } else {
            this.flags = null;
        }
        this.clientId = builder.clientId;
        this.clientSecret = builder.clientSecret;
        this.mode = builder.mode;
        this.testModeCompatibilityLevel = builder.testModeCompatibilityLevel;
    }

    public String getVin() {
        return this.vin;
    }

    public String[] getScope() { return this.scope; }

    public String getCountry() { return this.country; }

    public String getVersion() { return this.version; }

    public String getFlags() { return this.flags; }

    public String getClientId() { return this.clientId; }

    public String getClientSecret() { return this.clientSecret; }

    /**
     * @deprecated use {@link Builder#getMode()} which returns the mode as a String.
     */
    @Deprecated
    public boolean getTestMode() { return this.mode.equals("test"); }

    public String getMode() { return this.mode; }

    public String getTestModeCompatibilityLevel() { return this.testModeCompatibilityLevel; }
}