tlpinney / lumify-twitter

Twitter plugin for the Lumify open source open analytic platform

Lumify-Twitter

Lumify-Twitter is an open source ingest example for the Lumify project. See the Lumify website for more information about Lumify.

Build Requirements

• Please ensure that [Lumify] (https://github.com/altamiracorp/lumify/blob/master/README.md) has been installed before building.

Integrating with Lumify

1. Generate Twitter API Keys.
   • For instructions, please visit the Twitter Developers site or Generating Twitter API Keys below.
2. Add the following properties names and corresponding Twitter API keys to your /opt/lumify/config/configuration.properties:

twitter.consumerKey= 
twitter.consumerSecret=
twitter.token=
twitter.tokenSecret=
twitter.query= # Keywords to search Twitter for, e.g. twitter
# When searching for multiple phrases it must be a semi-colon separated list, e.g. twitter; face book; instagram

3. Clone the repository from github using either of the links from the main page
4. cd into your lumify-twitter directory
5. mvn clean package -Puber-jar
6. cd target
7. Copy the jar file to location of where you are running your Storm Topology for Lumify.
   • In the Lumify Pre-Built VM, please run the following command /opt/storm/bin/storm jar [location of jar file] com.altamiracorp.lumify.twitter.storm.StormRunner

Proceed if you are not using the Pre-built VM provided by Lumify

1. Deploy lumify storm topology.
2. Deploy lumify-twitter storm topology.
3. Deploy web war file.

Generating Twitter API Keys

1. Sign In to Twitter Developers site using your Twitter credentials.


2. In the top right corner hover over your Twitter Handler’s picture and select **My Applications** from the drop-down menu.


3. Select **Create a new application** and fill out the form.


4. Once completed, scroll down and select **Create my access token**.


5. Refresh the page until you see Access Token, Access Token Secret, and Access Level under **Your Access Token**.

Documentation

Customizing Ontology

From the lumify-twitter directory:

1. cd data/ontology.
2. Modify twitter.owl, to customize different concepts (e.g. person, phone number), properties for each concept, relationships between concepts, and/or glyphIcons associated with concepts.
   • After modifications, cd lumify-twitter/bin/importOntology.sh.
3. Proceed from step 5 in Integrating with Lumify