com.smartystreets.api.international_street.Client Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartystreets-java-sdk Show documentation

A library to help Java developers easily access the SmartyStreets APIs.

There is a newer version: 3.18.3

Show newest version

package com.smartystreets.api.international_street;

import com.smartystreets.api.Request;
import com.smartystreets.api.Response;
import com.smartystreets.api.Sender;
import com.smartystreets.api.Serializer;
import com.smartystreets.api.exceptions.SmartyException;
import com.smartystreets.api.exceptions.UnprocessableEntityException;

import java.io.IOException;

/**
 * This client sends lookups to the SmartyStreets International Street API, 

 *     and attaches the results to the appropriate Lookup objects.
 */
public class Client {
    private final Sender sender;
    private final Serializer serializer;

    public Client(Sender sender, Serializer serializer) {
        this.sender = sender;
        this.serializer = serializer;
    }

    public Candidate[] send(Lookup lookup) throws IOException, SmartyException, InterruptedException {
        this.ensureEnoughInfo(lookup);
        Request request = this.buildRequest(lookup);

        Response response = this.sender.send(request);

        Candidate[] candidates = this.serializer.deserialize(response.getPayload(), Candidate[].class);
        lookup.setResult(candidates);
        return candidates;
    }

    private Request buildRequest(Lookup lookup) {
        Request request = new Request();

        request.putParameter("input_id", lookup.getInputId());
        request.putParameter("country", lookup.getCountry());
        request.putParameter("geocode", lookup.getGeocode());
        if (lookup.getLanguage() != null)
            request.putParameter("language", lookup.getLanguage().getName());
        request.putParameter("freeform", lookup.getFreeform());
        request.putParameter("address1", lookup.getAddress1());
        request.putParameter("address2", lookup.getAddress2());
        request.putParameter("address3", lookup.getAddress3());
        request.putParameter("address4", lookup.getAddress4());
        request.putParameter("organization", lookup.getOrganization());
        request.putParameter("locality", lookup.getLocality());
        request.putParameter("administrative_area", lookup.getAdministrativeArea());
        request.putParameter("postal_code", lookup.getPostalCode());

        return request;
    }

    private void ensureEnoughInfo(Lookup lookup) throws SmartyException {
        if (lookup.missingCountry())
            throw new UnprocessableEntityException("Country field is required.");

        if (lookup.hasFreeform())
            return;

        if (lookup.missingAddress1())
            throw new UnprocessableEntityException("Either freeform or address1 is required.");

        if (lookup.hasPostalCode())
            return;

        if (lookup.missingLocalityOrAdministrativeArea())
            throw new UnprocessableEntityException("Insufficient information: One or more required fields were not set on the lookup.");
    }
}