co.aurasphere.botmill.kik.network.NetworkUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kik-botmill Show documentation
Show all versions of kik-botmill Show documentation
Event-driven framework for Kik Messenger's bots
/**
*
* MIT License
*
* Copyright (c) 2017 BotMill.io
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package co.aurasphere.botmill.kik.network;
import java.io.BufferedInputStream;
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import org.apache.http.HttpResponse;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import co.aurasphere.botmill.kik.KikBotMillContext;
import co.aurasphere.botmill.kik.exception.KikError;
import co.aurasphere.botmill.kik.exception.KikErrorMessage;
import co.aurasphere.botmill.kik.json.JsonUtils;
/**
* Class that contains methods that allows KikBotMill to communicate through the
* network.
*
* @author Alvin P. Reyes
*
*/
public class NetworkUtils {
/**
* The logger.
*/
private static final Logger logger = LoggerFactory.getLogger(NetworkUtils.class);
/**
* Post json config.
*
* @param input the input
* @return the string
*/
public static String postJsonConfig(Object input) {
StringEntity stringEntity = toStringEntity(input);
HttpPost post = new HttpPost(KikBotMillNetworkConstants.CONFIG_ENDPOINT);
post.setHeader("Content-Type", "application/json");
post.setEntity(stringEntity);
return send(post);
}
/**
* Post json message.
*
* @param input the input
* @return the string
*/
public static String postJsonMessage(Object input) {
StringEntity stringEntity = toStringEntity(input);
HttpPost post = new HttpPost(KikBotMillNetworkConstants.MESSAGE_ENDPOINT);
post.setHeader("Content-Type", "application/json");
post.setEntity(stringEntity);
return send(post);
}
/**
* Post json message broadcast.
*
* @param input the input
* @return the string
*/
public static String postJsonMessageBroadcast(Object input) {
StringEntity stringEntity = toStringEntity(input);
HttpPost post = new HttpPost(KikBotMillNetworkConstants.BROADCAST_ENDPOINT);
post.setHeader("Content-Type", "application/json");
post.setEntity(stringEntity);
return send(post);
}
/**
* Post json message.
*
* @param username the username
* @return the string
*/
public static String getJsonUserMessage(String username) {
HttpGet post = new HttpGet(KikBotMillNetworkConstants.USER_ENDPOINT + username);
post.setHeader("Content-Type", "application/json");
return send(post);
}
/**
* Send.
*
* @param request the request
* @return the string
*/
private static String send(HttpRequestBase request) {
CredentialsProvider provider = new BasicCredentialsProvider();
UsernamePasswordCredentials credentials =
new UsernamePasswordCredentials(
KikBotMillContext.getInstance().getUser(),
KikBotMillContext.getInstance().getApiKey());
provider.setCredentials(AuthScope.ANY, credentials);
CloseableHttpClient httpClient = HttpClientBuilder.create()
.setDefaultCredentialsProvider(provider)
.build();
logger.debug(request.getRequestLine().toString());
HttpResponse httpResponse = null;
String response = null;
try {
httpResponse = httpClient.execute(request);
response = logResponse(httpResponse);
} catch (Exception e) {
logger.error("Error during HTTP connection to Kik: ", e);
} finally {
try {
httpClient.close();
} catch (IOException e) {
logger.error("Error while closing HTTP connection: ", e);
}
}
return response;
}
/**
* Logs the response before returning it.
*
* @param response
* the response to log.
* @return the string
* @throws IOException
* Signals that an I/O exception has occurred.
*/
private static String logResponse(HttpResponse response) throws IOException {
int statusCode = response.getStatusLine().getStatusCode();
// Logs the raw JSON for debug purposes.
String output = getResponseContent(response);
logger.debug("HTTP Status Code: {}", statusCode);
logger.debug("Response: {}", output);
if (statusCode >= 400) {
logger.error("HTTP connection failed with error code {}.", statusCode);
// Parses the error message and logs it.
KikErrorMessage errorMessage = JsonUtils.fromJson(output, KikErrorMessage.class);
KikError error = errorMessage.getError();
logger.error("Error message from Kik. Message: [{}], Code: [{}], Type: [{}], FbTraceID: [{}].",
error.getMessage(), error.getCode(), error.getType(), error.getFbTraceId());
}
return output;
}
/**
* Utility method that converts an HttpResponse to a String.
*
* @param response
* the response to convert.
* @return a String with the response content.
* @throws IOException
* Signals that an I/O exception has occurred.
*/
private static String getResponseContent(HttpResponse response) throws IOException {
InputStream inputStream = response.getEntity().getContent();
BufferedInputStream bufferedInputStream = new BufferedInputStream(inputStream);
InputStreamReader inputStreamReader = new InputStreamReader(bufferedInputStream);
BufferedReader br = new BufferedReader(inputStreamReader);
StringBuilder builder = new StringBuilder();
String output = null;
while ((output = br.readLine()) != null) {
builder.append(output);
}
return builder.toString();
}
/**
* DELETEs a JSON string to Facebook.
*
* @param input
* the JSON data to send.
*/
public static void delete(Object input) {
StringEntity stringEntity = toStringEntity(input);
delete(stringEntity);
}
/**
* Post.
*
* @param url the url
* @param entity the entity
* @return the string
*/
public static String post(String url, StringEntity entity) {
HttpPost post = new HttpPost(url);
post.setHeader("Content-Type", "application/x-www-form-urlencoded");
post.setEntity(entity);
return send(post);
}
/**
* Utility to send a GET request.
*
* @param url
* the url we need to send the get request to.
* @return {@link String}
*/
public static String get(String url) {
HttpGet get = new HttpGet(url);
return send(get);
}
/**
* To string entity.
*
* @param object the object
* @return the string entity
*/
private static StringEntity toStringEntity(Object object) {
StringEntity input = null;
try {
String json = JsonUtils.toJson(object);
input = new StringEntity(json);
input.setContentType("application/json");
logger.debug("Request: {}", inputStreamToString(input.getContent()));
} catch (Exception e) {
logger.error("Error during JSON message creation: ", e);
}
return input;
}
/**
* Utility method which converts an InputStream to a String.
*
* @param stream
* the InputStream to convert.
* @return a String with the InputStream content.
* @throws IOException
* Signals that an I/O exception has occurred.
*/
private static String inputStreamToString(InputStream stream) throws IOException {
ByteArrayOutputStream result = new ByteArrayOutputStream();
byte[] buffer = new byte[1024];
int length;
String resultString = null;
while ((length = stream.read(buffer)) != -1) {
result.write(buffer, 0, length);
}
resultString = result.toString("UTF-8");
return resultString;
}
}