|
#!/usr/bin/env ruby |
|
# |
|
# Quick & dirty script to generate some Twitter statistics for events. |
|
# |
|
# Usage: |
|
# 1. gem install twitter |
|
# 2. Register your “app” on https://apps.twitter.com/apps and set OAuth |
|
# credentials here. |
|
# 3. Profit! |
|
# |
|
# License: |
|
# Creative Commons CC-Zero This file is made available under the Creative |
|
# Commons CC0 1.0 Universal Public Domain Dedication. |
|
# https://creativecommons.org/publicdomain/zero/1.0/deed.en |
|
# |
|
# Author: Jakub Jirutka |
|
# Version: 2017-03-07 |
|
|
|
require 'ostruct' |
|
require 'twitter' |
|
require 'yaml' |
|
|
|
|
|
######## Configuration ######## |
|
|
|
HASHTAGS = ['#InstallFest'] |
|
DATE_FROM = '2017-03-03' |
|
DATE_TO = '2017-03-06' |
|
|
|
USERS_LIST_LIMIT = 7 |
|
FAVORITES_LIST_LIMIT = 7 |
|
RETWEETS_LIST_LIMIT = 5 |
|
|
|
CACHE_FILE = 'data.yml' |
|
|
|
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 |
|
|
|
year = DATE_FROM.split('-').first |
|
|
|
|
|
######## Functions ######## |
|
|
|
def top_tweets_by(field, tweets) |
|
tweets.lazy |
|
.group_by { |tw| tw.public_send(field) } |
|
.sort.reverse |
|
.map { |count, tweets| [count, tweets.sort_by(&:created_at)] } |
|
end |
|
|
|
def top_users_by_tweets_count(tweets) |
|
tweets.lazy |
|
.group_by(&:user) |
|
.map { |user, tweets| [user, tweets.count] } |
|
.group_by(&:last) # group by number of tweets |
|
.sort.reverse |
|
.map { |count, tuples| [count, tuples.map(&:first)] } # extract users as value of the entry |
|
.map { |count, users| [count, users.sort_by(&:screen_name)] } |
|
end |
|
|
|
def title(level, text) |
|
puts "\n\n#{'=' * level} #{text}\n\n" |
|
end |
|
|
|
def table(headers, data, &block) |
|
lines = ['|===', '| ' + headers.join(' | '), ''] |
|
data.each_with_index do |item, idx| |
|
(yield item, idx + 1).each do |col| |
|
lines << "| #{col}" |
|
end |
|
lines << '' |
|
end |
|
lines << '|===' << '' |
|
puts lines.join("\n") |
|
end |
|
|
|
def format_tweet_text(text) |
|
text.gsub(/@(\w+)/, 'https://twitter.com/\1[@\1]') |
|
.gsub(/(#\w+)/, '_\1_') |
|
.gsub(/^\./, '') |
|
end |
|
|
|
def format_date(date) |
|
date.strftime('%a %k:%M').squeeze(' ') |
|
end |
|
|
|
format_user = ->(user) { "#{user.uri}[@#{user.screen_name}]" } |
|
format_tweet = ->(tweet) { "@#{tweet.user.screen_name}: #{tweet.uri}[#{tweet.text}]" } |
|
|
|
|
|
######## Main ######## |
|
|
|
tweets = |
|
if File.exist? CACHE_FILE |
|
YAML.load(File.read(CACHE_FILE)) |
|
else |
|
client.search("#{HASHTAGS.join(' OR ')} since:#{DATE_FROM} until:#{DATE_TO}", result_type: :all) |
|
.reject(&:retweet?) |
|
.tap { |tweets| File.write(CACHE_FILE, YAML.dump(tweets)) } |
|
end |
|
|
|
users = tweets.map(&:user).uniq |
|
favourites_count = tweets.map(&:favorite_count).reduce(:+) |
|
retweets_count = tweets.map(&:retweet_count).reduce(:+) |
|
top_users = top_users_by_tweets_count(tweets).take(USERS_LIST_LIMIT) |
|
top_favorites = top_tweets_by(:favorite_count, tweets).take(FAVORITES_LIST_LIMIT) |
|
top_retweets = top_tweets_by(:retweet_count, tweets).take(RETWEETS_LIST_LIMIT) |
|
|
|
|
|
# Print report in AsciiDoc |
|
|
|
title 1, "Twitter statistics for #{HASHTAGS.join(' and ')} in #{year}" |
|
|
|
puts "_Includes tweets created between #{DATE_FROM} and #{DATE_TO}_\n\n" |
|
|
|
puts "* Number of tweets (excluding RTs): #{tweets.count}" |
|
puts "* Number of likes: #{favourites_count}" |
|
puts "* Number of retweets: #{retweets_count}" |
|
puts "* Number of tweeting users: #{users.count}" |
|
|
|
|
|
title 2, 'TOP tweeting users' |
|
|
|
puts "List of most active users sorted by number of their tweets with hashtag #{HASHTAGS.join(' or ')}.\n\n" |
|
|
|
table ['Rank', 'User(s)', 'Tweets'], top_users do |(count, users), idx| |
|
["#{idx}.", users.map(&format_user).join(', '), count] |
|
end |
|
|
|
|
|
title 2, 'TOP liked tweets' |
|
|
|
table ['Rank', 'Tweet(s)', 'Likes'], top_favorites do |(count, tweets), idx| |
|
["#{idx}.", tweets.map(&format_tweet).join("\n\n"), count] |
|
end |
|
|
|
|
|
title 2, 'TOP retweeted tweets' |
|
|
|
table ['Rank', 'Tweet(s)', 'Retweets'], top_retweets do |(count, tweets), idx| |
|
["#{idx}.", tweets.map(&format_tweet).join("\n\n"), count] |
|
end |
|
|
|
puts "\n\n''''" |
|
puts "_Generated on #{Time.now}._" |
|
|
|
|
|
title 1, "Archive of tweets with #{HASHTAGS.join(' and ')} in #{year}" |
|
|
|
puts "_Includes tweets created between #{DATE_FROM} and #{DATE_TO}_\n\n" |
|
|
|
tweets.sort_by { |tw| [tw.user.screen_name, tw.created_at] }.group_by(&:user).each do |user, tweets| |
|
title 2, "@#{user.screen_name}" |
|
|
|
tweets.each do |tweet| |
|
puts "* #{tweet.uri}[#{format_date(tweet.created_at)}]: #{format_tweet_text(tweet.text)}" |
|
end |
|
end |
|
|
|
puts "\n\n''''" |
|
puts "_Generated on #{Time.now}._" |
