net.worcade.client.internal.WorcadeApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation
Show all versions of api-client Show documentation
A library for interacting with the Worcade API
// Copyright (c) 2017, Worcade. Please see the AUTHORS file for details.
// All rights reserved. Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package net.worcade.client.internal;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import lombok.extern.slf4j.Slf4j;
import net.worcade.client.Code;
import net.worcade.client.Result;
import net.worcade.client.api.ApplicationApi;
import net.worcade.client.api.AssetApi;
import net.worcade.client.api.AttachmentApi;
import net.worcade.client.api.ChecklistApi;
import net.worcade.client.api.CompanyApi;
import net.worcade.client.api.ContactsApi;
import net.worcade.client.api.ConversationApi;
import net.worcade.client.api.GroupApi;
import net.worcade.client.api.LabelApi;
import net.worcade.client.api.ReclaimApi;
import net.worcade.client.api.RoomApi;
import net.worcade.client.api.SearchApi;
import net.worcade.client.api.SiteApi;
import net.worcade.client.api.UserApi;
import net.worcade.client.api.WebhookApi;
import net.worcade.client.api.WorkOrderApi;
import net.worcade.client.create.WebhookCreate;
import net.worcade.client.create.WorkOrderCreate;
import net.worcade.client.get.ApiKey;
import net.worcade.client.get.Asset;
import net.worcade.client.get.BinaryData;
import net.worcade.client.get.Contact;
import net.worcade.client.get.Conversation;
import net.worcade.client.get.CreateWithApiKey;
import net.worcade.client.get.ExternalNumber;
import net.worcade.client.get.Group;
import net.worcade.client.get.Reference;
import net.worcade.client.get.ReferenceWithName;
import net.worcade.client.get.ReferenceWithNumber;
import net.worcade.client.get.RemoteId;
import net.worcade.client.get.RemoteIdSearchResult;
import net.worcade.client.get.Room;
import net.worcade.client.get.Site;
import net.worcade.client.get.Webhook;
import net.worcade.client.get.WebhookTestResult;
import net.worcade.client.get.WorkOrder;
import net.worcade.client.modify.ApplicationModification;
import net.worcade.client.modify.AssetModification;
import net.worcade.client.modify.CompanyModification;
import net.worcade.client.modify.ConversationModification;
import net.worcade.client.modify.EntityModification;
import net.worcade.client.modify.GroupModification;
import net.worcade.client.modify.LabelModification;
import net.worcade.client.modify.RoomModification;
import net.worcade.client.modify.SiteModification;
import net.worcade.client.modify.UserModification;
import net.worcade.client.modify.WorkOrderModification;
import net.worcade.client.modify.WorkOrderRowModification;
import net.worcade.client.query.AssetField;
import net.worcade.client.query.ContactField;
import net.worcade.client.query.ConversationField;
import net.worcade.client.query.GroupField;
import net.worcade.client.query.LabelField;
import net.worcade.client.query.MemberField;
import net.worcade.client.query.Query;
import net.worcade.client.query.RoomField;
import net.worcade.client.query.SiteField;
import net.worcade.client.query.WebhookField;
import javax.annotation.Nullable;
import java.io.InputStream;
import java.math.BigInteger;
import java.security.PublicKey;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;
import static com.google.common.base.Preconditions.*;
@Slf4j
class WorcadeApi implements ApplicationApi, AssetApi, AttachmentApi, ChecklistApi, CompanyApi, ContactsApi, ConversationApi, GroupApi,
LabelApi, ReclaimApi, RoomApi, SearchApi, SiteApi, UserApi, WebhookApi, WorkOrderApi {
private final WorcadeClient worcadeClient;
private final String entityUrl;
WorcadeApi(WorcadeClient worcadeClient, String entityUrl) {
this.worcadeClient = worcadeClient;
this.entityUrl = entityUrl;
}
@Override
public Modification createBuilder() {
return Modification.create();
}
@Override
public Result get(String id) {
return worcadeClient.get(entityUrl + "/" + WorcadeClient.checkId(id));
}
@Override
public Result getWithHtmlMessages(String id) {
return worcadeClient.get(entityUrl + "/" + WorcadeClient.checkId(id) + "?html=true");
}
@Override
public Result getProfile(String id) {
return worcadeClient.get(entityUrl + "/" + WorcadeClient.checkId(id) + "/profile");
}
@Override
public Result create(ApplicationModification subject) {
return createInternal(subject);
}
@Override
public Result create(AssetModification subject) {
return createInternal(subject);
}
@Override
public Result create(CompanyModification subject) {
return createInternal(subject);
}
@Override
public Result create(ConversationModification subject) {
return createInternal(subject);
}
@Override
public Result create(GroupModification subject) {
return createInternal(subject);
}
@Override
public Result create(LabelModification subject) {
return createInternal(subject);
}
@Override
public Result create(RoomModification subject) {
return createInternal(subject);
}
@Override
public Result create(SiteModification subject) {
return createInternal(subject);
}
@Override
public Result create(UserModification subject) {
return createInternal(subject);
}
@Override
public Result create(String ownerId, WebhookCreate subject) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(ownerId), ((Modification) subject).getData());
}
@Override
public Result create(String conversationId, WorkOrderCreate subject) {
return worcadeClient.post("conversation/" + WorcadeClient.checkId(conversationId) + "/content/workorder",
((Modification) subject).getData());
}
@Override
public Result update(AssetModification subject) {
return updateInternal(subject, "", true);
}
@Override
public Result update(ConversationModification subject) {
return updateInternal(subject, "", false);
}
@Override
public Result update(LabelModification subject) {
return updateInternal(subject, "", true);
}
@Override
public Result update(RoomModification subject) {
return updateInternal(subject, "", true);
}
@Override
public Result update(SiteModification subject) {
return updateInternal(subject, "", true);
}
@Override
public Result update(WorkOrderModification subject) {
return updateInternal(subject, "", true);
}
@Override
public Result updateProfile(ApplicationModification subject) {
return updateInternal(subject, "/profile", true);
}
@Override
public Result updateProfile(CompanyModification subject) {
return updateInternal(subject, "/profile", true);
}
@Override
public Result updateProfile(GroupModification subject) {
return updateInternal(subject, "/profile", true);
}
@Override
public Result updateProfile(UserModification subject) {
return updateInternal(subject, "/profile", true);
}
@Override
public Result delete(String id) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id));
}
@Override
public Result createWithApiKey(ApplicationModification subject, String apiKeyDescription) {
Result result = worcadeClient.post(entityUrl + "?apiKeyDescription=" + Util.escapeUrlQueryParameter(apiKeyDescription), ((Modification) subject).getData());
return result.map(d -> {
Iterable messages = Iterables.filter(result.getMessages(),
m -> m.isCode(Code.GENERATED_API_KEY));
return new CreateWithApiKey(d, Iterables.getOnlyElement(messages).getMessage());
});
}
@Override
public Result> getAssetList(Query query) {
return getList(query);
}
@Override
public Result> getConversationList(Query query) {
return getList(query);
}
@Override
public Result> getGroupList(Query query) {
return getList(query);
}
@Override
public Result> getLabelList(Query query) {
return getList(query);
}
@Override
public Result> getRoomList(Query query) {
return getList(query);
}
@Override
public Result> getSiteList(Query query) {
return getList(query);
}
@Override
public Result addLabels(String id, Reference... labels) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/labels", Modification.cleanReferences(labels));
}
@Override
public Result removeLabels(String id, Reference... labels) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/labels", Modification.cleanReferences(labels));
}
@Override
public Result addRemoteIds(String id, RemoteId... remoteIds) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/remoteIds", Modification.cleanRemoteIds(remoteIds));
}
@Override
public Result removeRemoteIds(String id, RemoteId... remoteIds) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/remoteIds", Modification.cleanRemoteIds(remoteIds));
}
@Override
public Result> searchByEmail(String email) {
return worcadeClient.getList(entityUrl + "/email?email=" + Util.escapeUrlQueryParameter(email));
}
@Override
public Result> searchByRemoteId(String remoteIdType, String remoteId) {
if (Strings.isNullOrEmpty(remoteIdType)) {
return worcadeClient.getList(entityUrl + "/remoteId");
}
if (Strings.isNullOrEmpty(remoteId)) {
return worcadeClient.getList(entityUrl + "/remoteId?remoteIdType=" + Util.escapeUrlQueryParameter(remoteIdType));
}
return worcadeClient.getList(entityUrl + "/remoteId?remoteIdType=" + Util.escapeUrlQueryParameter(remoteIdType) + "&remoteId=" + Util.escapeUrlQueryParameter(remoteId));
}
@Override
public Result setupKeyExchange(String id, PublicKey applicationKey) {
return Util.getPublicKeySpec(applicationKey)
.flatMap(s -> worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/authentication",
ImmutableMap.of("modulus", s.getModulus(), "exponent", s.getPublicExponent())))
.flatMap(d -> Util.createPublicKey(new BigInteger(d.getString("modulus")), new BigInteger(d.getString("exponent"))));
}
@Override
public Result cancelAccount(String id, String password) {
Result result = worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id), new Header("Worcade-ConfirmPassword", Util.encodeBase64(password)));
if (result.isOk()) {
worcadeClient.logoutUser(); // ignore error
}
return result;
}
@Override
public Result view(String id) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/view", null);
}
@Override
public Result addContent(String id, Reference... content) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/content", Modification.cleanReferences(content));
}
@Override
public Result addMessage(String id, String message) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/content/message", ImmutableMap.of("text", message));
}
@Override
public Result addHtmlMessage(String id, String message) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/content/message/html", ImmutableMap.of("text", message));
}
@Override
public Result addEvaluation(String id, int rating) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/content/evaluation", ImmutableMap.of("rating", rating));
}
@Override
public Result addExternalNumbers(String id, ExternalNumber... numbers) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/externalNumbers", Modification.cleanExternalNumbers(numbers));
}
@Override
public Result addWatchers(String id, Reference... watchers) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/watchers", Modification.cleanReferences(watchers));
}
@Override
public Result removeWatchers(String id, Reference... watchers) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/watchers", Modification.cleanReferences(watchers));
}
@Override
public Result addOwners(String id, Reference... owners) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/owners", Modification.cleanReferences(owners));
}
@Override
public Result removeOwners(String id, Reference... owners) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/owners", Modification.cleanReferences(owners));
}
@Override
public Result addShares(String id, Reference... shares) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/sharedWith", Modification.cleanReferences(shares));
}
@Override
public Result removeShares(String id, Reference... shares) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/sharedWith", Modification.cleanReferences(shares));
}
@Override
public Result> getContacts(Query query) {
return worcadeClient.getList(entityUrl);
}
@Override
public Result> getWebhookList(Query query) {
return getList(query);
}
@Override
public Result> getLogs(String id, boolean includeDeleted) {
return worcadeClient.getList(entityUrl + "/" + WorcadeClient.checkId(id) + "/logs?deleted=" + includeDeleted);
}
@Override
public Result requestTest(String id) {
String url = entityUrl + "/test/" + WorcadeClient.checkId(id);
return worcadeClient.post(url, null);
}
@Override
public Result searchByNumber(String conversationNumber) {
return worcadeClient.get(entityUrl + "/number/" + Util.escapeUrlPathSegment(conversationNumber));
}
@Override
public Result> searchByContent(String contentId) {
return worcadeClient.getList(entityUrl + "/content/" + WorcadeClient.checkId(contentId));
}
@Override
public Result linkConversations(String firstId, String secondId) {
return worcadeClient.post(entityUrl + "/linked/" + WorcadeClient.checkId(firstId) + "/" + WorcadeClient.checkId(secondId), null);
}
@Override
public Result addVersions(String id, String... versions) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/versions", ImmutableList.copyOf(versions));
}
@Override
public Result getData(String id) {
return worcadeClient.getBinary(entityUrl + "/" + WorcadeClient.checkId(id) + "/data");
}
@Override
public Result create(String name, InputStream data, String contentType) {
checkArgument(!Strings.isNullOrEmpty(name), "Name is mandatory");
String url = entityUrl + "?name=" + Util.escapeUrlQueryParameter(name);
return worcadeClient.postBinary(url, data, contentType);
}
@Override
public Result addEmailAddress(String id, String... emails) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/email",
Stream.of(emails).map(e -> ImmutableMap.of("email", e)).collect(ImmutableList.toImmutableList()));
}
@Override
public Result removeEmailAddress(String id, String... emails) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/email",
Stream.of(emails).map(e -> ImmutableMap.of("email", e)).collect(ImmutableList.toImmutableList()));
}
@Override
public Result confirmEmailAddress(String id, String secret) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/confirmEmail", null, new Header("Worcade-Secret", secret));
}
@Override
public Result requestEmailConfirm(String id, String email) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/requestEmailConfirm", ImmutableMap.of("email", email));
}
@Override
public Result addMembers(String id, Reference... members) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/members", Modification.cleanReferences(members));
}
@Override
public Result addMembers(String id, Collection members) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/members", Modification.cleanReferences(members));
}
@Override
public Result removeMembers(String id, Reference... members) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/members", Modification.cleanReferences(members));
}
@Override
public Result searchByDomain(String domain) {
return worcadeClient.get(entityUrl + "/domain?domain=" + Util.escapeUrlQueryParameter(domain));
}
@Override
public Result addDomains(String id, String... domains) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/domains", ImmutableList.copyOf(domains));
}
@Override
public Result removeDomains(String id, String... domains) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/domains", ImmutableList.copyOf(domains));
}
@Override
public Result requestEmailReclaim(String email) {
return worcadeClient.post(entityUrl + "/email?email=" + Util.escapeUrlQueryParameter(email), null);
}
@Override
public Result confirmEmailReclaim(String id, String secret) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/email", new Header("Worcade-Secret", secret));
}
@Override
public Result changePassword(String id, String currentPassword, String newPassword) {
return worcadeClient.put(entityUrl + "/" + WorcadeClient.checkId(id) + "/password",
ImmutableMap.of("password", Util.encodeBase64(newPassword)),
new Header("Worcade-ConfirmPassword", Util.encodeBase64(currentPassword)));
}
@Override
public Result requestPasswordReset(String id) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/password", null);
}
@Override
public Result requestPasswordResetByEmail(String email) {
return worcadeClient.post(entityUrl + "/password/email?email=" + Util.escapeUrlQueryParameter(email), null);
}
@Override
public Result confirmPasswordReset(String id, String newPassword, String secret) {
return worcadeClient.put(entityUrl + "/" + WorcadeClient.checkId(id) + "/password",
ImmutableMap.of("password", Util.encodeBase64(newPassword)),
new Header("Worcade-Secret", secret));
}
@Override
public Result requestApplicationTrust(String userId, String applicationId) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(userId) + "/trust/" + WorcadeClient.checkId(applicationId), null);
}
@Override
public Result confirmApplicationTrust(String userId, String secret) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(userId) + "/trustedApplication", null,
new Header("Worcade-Secret", secret));
}
@Override
public Result unlinkApplication(String userId, String applicationId) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(userId) + "/trustedApplication",
ImmutableMap.of("id", WorcadeClient.checkId(applicationId)));
}
@Override
public Result requestSubscription(String id) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/mailinglist", null);
}
@Override
public Result addRows(String id, WorkOrder.Row... rows) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/row", Modification.cleanRows(rows));
}
@Override
public Result updateRow(String workOrderId, WorkOrderRowModification subject) {
Modification modification = ((Modification) subject);
String id = (String) modification.getData().get("id");
return worcadeClient.put(entityUrl + "/" + WorcadeClient.checkId(workOrderId) + "/row/" + WorcadeClient.checkId(id), ((Modification) subject).getData());
}
@Override
public Result removeRows(String id, String... rowIdsToRemove) {
return removeRows(id, Arrays.asList(rowIdsToRemove));
}
@Override
public Result removeRows(String id, Collection rowIdsToRemove) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/row",
rowIdsToRemove.stream().map(Modification::cleanReference).collect(ImmutableList.toImmutableList()));
}
@Override
public Result updateMemberProfile(UserModification modification) {
String userId = WorcadeClient.checkId((String) ((Modification) modification).getData().get("id"));
return worcadeClient.put(entityUrl + "/member/" + userId + "/profile", ((Modification) modification).getData());
}
@Override
public Result deleteMember(String userId) {
return worcadeClient.delete(entityUrl + "/member/" + WorcadeClient.checkId(userId));
}
@Override
public Result getSamlSettings(String companyId) {
return worcadeClient.get(entityUrl + "/" + WorcadeClient.checkId(companyId) + "/saml");
}
@Override
public Result setSamlSettings(String companyId, String entityId, String ssoServiceUrl, String certificate, @Nullable String attributeName, boolean allowCreate) {
ImmutableMap values = attributeName == null
? ImmutableMap.of("entityId", entityId, "ssoServiceUrl", ssoServiceUrl, "certificate", certificate, "allowCreateNewUsers", allowCreate)
: ImmutableMap.of("entityId", entityId, "ssoServiceUrl", ssoServiceUrl, "certificate", certificate, "attribute", attributeName, "allowCreateNewUsers", allowCreate);
return worcadeClient.put(entityUrl + "/" + WorcadeClient.checkId(companyId) + "/saml", values);
}
@Override
public Result setSamlSettings(String companyId, String entityId, String metadataUrl, @Nullable String attributeName, boolean allowCreate) {
ImmutableMap values = attributeName == null
? ImmutableMap.of("entityId", entityId, "metadataUrl", metadataUrl, "allowCreateNewUsers", allowCreate)
: ImmutableMap.of("entityId", entityId, "metadataUrl", metadataUrl, "attribute", attributeName, "allowCreateNewUsers", allowCreate);
return worcadeClient.put(entityUrl + "/" + WorcadeClient.checkId(companyId) + "/saml", values);
}
@Override
public Result> getByFingerprint(String fingerprint) {
return worcadeClient.getList(entityUrl + "/fingerprint/" + Util.escapeUrlPathSegment(fingerprint));
}
@Override
public Result> getApiKeys(String id) {
return worcadeClient.getList(entityUrl + "/" + WorcadeClient.checkId(id) + "/apikey/");
}
@Override
public Result createApiKey(String id, String description) {
Result result = worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(id) + "/apikey?apiKeyDescription=" + Util.escapeUrlQueryParameter(description), null);
if (!result.isOk()) return result.cast();
return Result.ok(Iterables.find(result.getMessages(), m -> m.isCode(Code.GENERATED_API_KEY)).getMessage());
}
@Override
public Result removeApiKey(String id, String keyId) {
return worcadeClient.delete(entityUrl + "/" + WorcadeClient.checkId(id) + "/apikey/" + WorcadeClient.checkId(keyId));
}
@Override
public Result inviteUser(String companyId, String userId) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(companyId) + "/invite/" + WorcadeClient.checkId(userId), null);
}
@Override
public Result addUser(String companyId, String userId) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(companyId) + "/addUser/" + WorcadeClient.checkId(userId), null);
}
@Override
public Result addApplication(String companyId, String applicationId) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(companyId) + "/addApplication/" + WorcadeClient.checkId(applicationId), null);
}
@Override
public Result confirmJoinCompany(String userId, String secret) {
return worcadeClient.post(entityUrl + "/" + WorcadeClient.checkId(userId) + "/acceptInvite", null, new Header("Worcade-Secret", secret));
}
@Override
public Result editMessage(String conversationId, String messageId, String message) {
return worcadeClient.put(entityUrl + "/" + WorcadeClient.checkId(conversationId) + "/message/" + WorcadeClient.checkId(messageId),
ImmutableMap.of("text", message));
}
private Result createInternal(EntityModification subject) {
return worcadeClient.post(entityUrl, ((Modification) subject).getData());
}
private Result updateInternal(EntityModification subject, String urlSuffix, boolean withVersionCheck) {
Modification modification = (Modification) subject;
String url = entityUrl + "/" + WorcadeClient.checkId((String) modification.getData().get("id")) + urlSuffix;
if (withVersionCheck) {
int version = (Integer) modification.getData().get("version");
return worcadeClient.put(url + "?version=" + version, modification.getData());
}
return worcadeClient.put(url, modification.getData());
}
private Result> getList(Query query) {
return worcadeClient.getList(entityUrl + "/" + ((WorcadeQuery) query).toQueryString());
}
}