summaryrefslogtreecommitdiff
path: root/src/mining/AbstractRequester.java
blob: a42eb80c88f71812a0ced0094aac323e502f0b4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
package mining;

import java.io.IOException;
import java.io.StringWriter;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import org.apache.commons.io.Charsets;
import org.apache.commons.io.IOUtils;
import org.json.JSONException;
import org.json.JSONObject;

/**
 * Performs an API Request.
 *
 * @author Peter Wu
 */
public abstract class AbstractRequester implements Requester {

    @Override
    public JSONObject getJSON(String resource) throws IOException {
        HttpURLConnection conn = open(buildUrl(resource));
        preconnect(conn);
        if (conn.getResponseCode() != 200) {
            // TODO: print more helpful details
            throw new IOException("Unexpected response code");
        }
        return getResponseAsJson(conn);
    }

    protected final URL buildUrl(String resource) throws IOException {
        String spec = "https://api.twitter.com/1.1/";
        // TODO: detect API version? For example, drop 1.1 for oauth2/token
        spec += resource;
        return new URL(spec);
    }

    /**
     * Opens a connection to the URL.
     */
    protected final HttpURLConnection open(URL url) throws IOException {
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        // set default param: fail if no response within 5 seconds
        conn.setReadTimeout(5000);
        return conn;
    }

    /**
     * Reads the response body from a connection (in JSON format).
     */
    protected final JSONObject getResponseAsJson(URLConnection conn)
            throws IOException {
        StringWriter writer = new StringWriter();
        IOUtils.copy(conn.getInputStream(), writer, Charsets.UTF_8);
        try {
            return new JSONObject(writer.toString());
        } catch (JSONException ex) {
            // treat JSON errors as if an I/O error occurred
            throw new IOException(ex);
        }
    }

    /**
     * Prepare the request before it gets send.
     *
     * @param conn A connection for the request.
     * @throws java.io.IOException on failing to prepare the request.
     */
    protected abstract void preconnect(URLConnection conn)
            throws IOException;
}