TwitterRetweet

Welcome to the Nairuby TwitterBot

This is a simple web application created for @NairubyKE, the goal of the application is to find tweets with a specific topic and retweet those.

The web application is built fully in Ruby.

It uses the Twitter Gem for integrating with the Twitter API. It uses Sinatra for its web application framework. The application uses Slim for HTML templating and Twitter Bootstrap for HTML, CSS and JS. Datamapper is used for database and deploys using Heroku.

For more indepth description on the different techniques used, see below.

Added application to Codeship and Travis CI for CI builds. Added code coverage checks using Codeclimate.

Add PROCFILE for Heroku. Improve error handling. Add some tests. Refactor code. Enable editing of the database entries - for instance un-retweet tweets from the database. Fix the static footer. Implement a fixed top nav bar. Ensure database deployment and continious integration.

#Twitter Ruby Twitter gem For integration to Twitter the Ruby Twitter Gem is being used.

##Installation

gem install twitter

##Configuration

client = Twitter::REST::Client.new do |config|
	config.consumer_key        = "YOUR_CONSUMER_KEY"
	config.consumer_secret     = "YOUR_CONSUMER_SECRET"
	config.access_token        = "YOUR_ACCESS_TOKEN"
	config.access_token_secret = "YOUR_ACCESS_SECRET"
end

##Examples Searching for tweets This will search for all resents tweets and will take the first 100 results.

client.search(topic, result_type: "recent").take(100)

##Retweeting This will retweet the id

client.retweet(id)

#Sinatra The application uses Sinatra as the web application framework. It enabled a quick and easy way to get the application running.

##Installation

gem install sinatra

##Examples

# myapp.rb
require 'sinatra'

get '/' do
	'Hello world!'
end

##Running the application

rackup config.ru

#Slim In conjunction with Sinatra, Slim is used for html templating.

##Examples

doctype html
	html
		head
			meta charset="utf-8"
			title Nairuby TwitterBot
			link rel="shortcut icon" type="image/x-icon" href="/img/favicon.ico"
			link rel="stylesheet" href="/css/bootstrap.min.css"
			link rel="stylesheet" href="/css/sticky-footer.css"
		
		body
			h1 Nairuby TwitterBot

			== yield

			script src="/js/bootstrap.min.js"

For more example visit the Slim hompepage.

#Twitter Bootstrap For HTML, CSS and JS framework, the Twitter Bootstrap was chosen.

##Project setup For this application the simplest form for this was chosen, the bootstrap css files was direclty copied into the folders as statied below. The same was done for the js.

project/
├── public/
│   ├── css/
│   ├── js/
│   ├── fonts/
│   └── img/
└── views/

The CSS and the JS was then imported, as seen in the Slim example previous.

#Datamapper Datamapper is used for the database, it enabled fast and simple database setup and comes with several adapters for commonly used datastores. For this application the apatders used were; SQLite and Postgresql.

At the moment the database only contains one table, which is used for storing all retweets. It is used when searching for new tweets to retweet - if there already exists a tweet in the databse with the same ID as a tweet found it will not retweet that tweet. If the tweet is not in the databse - the application will add it to the database and retweet the tweet found.

class TweetsDB
	include DataMapper::Resource
	property :id, Serial
	property :tweet_id, String, :required => true
	property :tweet_user_screen_name, String
	property :tweet_text, String
	property :retweeted, Boolean
	property :retweeted_at, DateTime
end 

Enable editing of the database entries - for instance un-retweet tweets from the database.

#Heroku For deployment Heroku is being used. There is a great tutorial on how to get started on their webpage: Getting Started with Runy on Heroku