Using PeerIndex with Codenvy

Get started with PeerIndex API through Codenvy Factory:


This document will explain the details of integrating the PeerIndex API into Codenvy. PeerIndex is a social media analytics company that is building the Influence Graph: who influences whom in which topics across the social platforms. With the PeerIndex API, you will have programmatic access to PeerIndex’s analytics data, allowing you to integrate PeerIndex’s Influence Graph into your applications and analytics platforms. The explanation has been done with a very basic Java servlet project that makes use of the PeerIndex API to explain some basic features provided by the API.

Before proceeding to the creation of the Java project, please register at https://developers.peerindex.com/member/register with your email id and then create a PeerIndex application that will generate keys which will be used for the integration:
peerindex

On registering the application, you can see your keys at the ‘My Account’ section:
apikeys

The PeerIndex API has various methods to integrate with PeerIndex for various analytics information. You can get more information about the API methods at https://developers.peerindex.com/docs

To assist the integration with the different methods, the PeerIndex API website has a IO Docs section at https://developers.peerindex.com/io-docs which will give you the HTTP Request URL that will be required to invoke the method from your Codenvy application and the response that you would get. For example, if you want to invoke the PeerIndex API, you would do the following steps in your PeerIndex account under your registered application –

a) Navigating to this section will list all methods for the PeerIndex API:

console

b) Now expand any one method such as the Basic method. This will have the option to enter different input parameters such as Twitter screen name or twitter id and this will return the basic influence data for a given social media user: PeerIndex score, name and profile image –

console_1

c) On clicking Try it, you will get the Request URL generated that will be used from your application in Codenvy and the request and response headers and response body in JSON format that you will capture in your Codenvy application:
request_url

Create a Project

Now, login to your Codenvy workspace and create a WAR project named as ‘PeerIndexSample’. This will have the following structure :
project_structure

Create pom.xml File

To make use of the PeerIndex API through HttpClient as a servlet, please update the pom.xml to include the HttpClient and Java EE Web API jars and the servletapi jar into your project as Maven dependencies –

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
<groupId>com.codenvy</groupId>
<artifactId>PeerIndexSample</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>PeerIndexSample</name>
  <dependencies>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>2.5</version>
    </dependency>
    <dependency>
      <groupId>org.apache.httpcomponents</groupId>
      <artifactId>httpclient</artifactId>
      <version>4.2.5</version>
    </dependency>
    <dependency>
      <groupId>javax</groupId>
      <artifactId>javaee-web-api</artifactId>
      <version>6.0</version>
    </dependency>
  </dependencies>
  <repositories>
     <repository>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
      <id>central</id>
      <name>Maven Repository Switchboard</name>
      <url>http://repo1.maven.org/maven2</url>
     </repository>
  </repositories>
  <build>
    <finalName>PeerIndexSample</finalName>
  </build>
</project>

Create Java Class

Now create a Java servlet class named ‘PeerIndexServlet.java’ that will talk to the PeerIndex website with the Http request URL that was generated above in the PeerIndex IO Docs section and then get a Http response back with the response header and the response body in the JSON format which will be then displayed on the browser through a JSP. All this is done inside the method doGet() in the sample source Java class.

package com.codenvy;

import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.BasicResponseHandler;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;

import java.io.IOException;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class PeerIndexServlet extends HttpServlet {

  private HttpClient client = new DefaultHttpClient();

  protected void doGet(HttpServletRequest request, HttpServletResponse response)
        throws ServletException, IOException {

        StringBuffer sb = null;
        try {
            String getURL = "https://api.peerindex.com/1/actor/basic?twitter_screen_name=andrewkill&api_key=behtkjv8hh29tyz8vf53mhpu";

            HttpGet req = new HttpGet(getURL);
            req.addHeader("X-Originating-Ip", "80.254.147.148");
            HttpResponse res = client.execute(req);
            HttpEntity entity = res.getEntity();
            String responseString = new BasicResponseHandler().handleResponse(res);
            if (entity != null) {
                EntityUtils.consume(entity);
            }

            sb = new StringBuffer("<br/>Simple GET request to url : "+ getURL +"<br/><br/>");
            sb.append("*** Request headers ***").append("<br/>");
            Header[] requestHeaders = req.getAllHeaders();
            for (Header header : requestHeaders) {
                sb.append(header.toString()).append("<br/>");
            }
            sb.append("***********************").append("<br/><br/>");

            sb.append("*** Response headers ***").append("<br/>");
            sb.append(res.getStatusLine()).append("<br/>");
            Header[] headers = res.getAllHeaders();
            for (Header header : headers) {
                sb.append(header.toString()).append("<br/>");
            }
            sb.append("***********************").append("<br/><br/>");

            sb.append("*** Response Body ***").append("<br/>");
            sb.append(responseString).append("<br/>");

        } catch (Exception ex) {
            sb = new StringBuffer(ex.toString());
        }

        request.setAttribute("data", sb.toString());
        RequestDispatcher rd = request.getRequestDispatcher("/success.jsp");
        rd.forward(request, response);
   }
}

Create index.jsp File

Your Codenvy project will have an index.jsp which will invoke the Servlet class -

<%
response.sendRedirect("/hello");
%>

Create success.jsp File

Your Codenvy project will have a success.jsp which will be invoked from the PeerIndexServlet class to display the response on the browser -

<html>
<body>
<div>
<p>Data : <br/><%=request.getAttribute("data") %></p>
<br/>
</div>
</body>
</html>

Create web.xml File

The servlet mapping ‘/hello’ is defined in the web.xml as follows –

<web-app>
<display-name>PeerIndex Servlet App</display-name>
<servlet>
<servlet-name>hello</servlet-name>
<servlet-class>com.codenvy.PeerIndexServlet</servlet-class>
</servlet>

<servlet-mapping>
<servlet-name>hello</servlet-name>
<url-pattern>/hello</url-pattern>
</servlet-mapping>
</web-app>

Now you build and run your Codenvy project and the Http response from the PeerIndex website with the basic influence data for the social media user supplied in the input parameter will be displayed in the browser:
app

You can use this JSON format response in a way that you would like to meet your needs for your custom application.

The PeerIndex API provides more methods that can be used in a similar way as above to retrieve various types of influence data information. More details would be available on their website – https://developers.peerindex.com/docs and https://developers.peerindex.com/io-docs