Class: Lolcommits::Plugin::LolTwitter

Inherits:
Base
  • Object
show all
Defined in:
lib/lolcommits/plugin/lol_twitter.rb

Constant Summary collapse

TWITTER_API_ENDPOINT = 
'https://api.twitter.com'.freeze
TWITTER_CONSUMER_KEY = 
'qc096dJJCxIiqDNUqEsqQ'.freeze
TWITTER_CONSUMER_SECRET = 
'rvjNdtwSr1H0TvBvjpk6c4bvrNydHmmbvv7gXZQI'.freeze
TWITTER_RESERVED_MEDIA_CHARS = 
24
TWITTER_RETRIES = 
2
TWITTER_PIN_REGEX =

4 or more digits

/^\d{4,}$/
DEFAULT_SUFFIX = 
'#lolcommits'.freeze

Instance Attribute Summary

Attributes inherited from Base

#options, #runner

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#configuration, #debug, #enabled?, #execute_postcapture, #execute_precapture, #initialize, #log_error, #parse_user_input, #puts, #run_precapture, #valid_configuration?

Constructor Details

This class inherits a constructor from Lolcommits::Plugin::Base

Class Method Details

.name ⇒ Object 



167
168
169
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 167

def self.name
  'twitter'
end

.runner_order ⇒ Object 



171
172
173
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 171

def self.runner_order
  :postcapture
end

Instance Method Details

#build_tweet(commit_message) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 50

def build_tweet(commit_message)
  prefix = config_with_default('prefix', '')
  suffix = " #{config_with_default('suffix', DEFAULT_SUFFIX)}"
  prefix = "#{prefix} " unless prefix.empty?

  available_commit_msg_size = max_tweet_size - (prefix.length + suffix.length)
  if commit_message.length > available_commit_msg_size
    commit_message = "#{commit_message[0..(available_commit_msg_size - 3)]}..."
  end

  "#{prefix}#{commit_message}#{suffix}"
end

#config_with_default(key, default = nil) ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 155

def config_with_default(key, default = nil)
  if configuration[key]
    configuration[key].strip.empty? ? default : configuration[key]
  else
    default
  end
end

#configure_auth! ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 74

def configure_auth!
  puts '---------------------------'
  puts 'Need to grab twitter tokens'
  puts '---------------------------'

  request_token = oauth_consumer.get_request_token
  rtoken        = request_token.token
  rsecret       = request_token.secret

  print "\n1) Please open this url in your browser to get a PIN for lolcommits:\n\n"
  puts request_token.authorize_url
  print "\n2) Enter PIN, then press enter: "
  twitter_pin = gets.strip.downcase.to_s

  unless twitter_pin =~ TWITTER_PIN_REGEX
    puts "\nERROR: '#{twitter_pin}' is not a valid Twitter Auth PIN"
    return
  end

  begin
    debug "Requesting Twitter OAuth Token with PIN: #{twitter_pin}"
    OAuth::RequestToken.new(oauth_consumer, rtoken, rsecret)
    access_token = request_token.get_access_token(oauth_verifier: twitter_pin)
  rescue OAuth::Unauthorized
    puts "\nERROR: Twitter PIN Auth FAILED!"
    return
  end

  return unless access_token.token && access_token.secret
  puts ''
  puts '------------------------------'
  puts 'Thanks! Twitter Auth Succeeded'
  puts '------------------------------'
  {
    'access_token' => access_token.token,
    'secret'       => access_token.secret
  }
end

#configure_options! ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 63

def configure_options!
  options = super
  # ask user to configure tokens if enabling
  if options['enabled']
    auth_config = configure_auth!
    return unless auth_config
    options = options.merge(auth_config).merge(configure_prefix_suffix)
  end
  options
end

#configure_prefix_suffix ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 113

def configure_prefix_suffix
  print "\n3) Prefix all tweets with something? e.g. @user (leave blank for no prefix): "
  prefix = gets.strip
  print "\n4) End all tweets with something? e.g. #hashtag (leave blank for default suffix #{DEFAULT_SUFFIX}): "
  suffix = gets.strip

  config = {}
  config['prefix'] = prefix unless prefix.empty?
  config['suffix'] = suffix unless suffix.empty?
  config
end

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
128
129
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 125

def configured?
  !configuration['enabled'].nil? &&
    configuration['access_token'] &&
    configuration['secret']
end

#max_tweet_size ⇒ Object 



163
164
165
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 163

def max_tweet_size
  139 - TWITTER_RESERVED_MEDIA_CHARS
end

#oauth_consumer ⇒ Object 



145
146
147
148
149
150
151
152
153
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 145

def oauth_consumer
  @oauth_consumer ||= OAuth::Consumer.new(
    TWITTER_CONSUMER_KEY,
    TWITTER_CONSUMER_SECRET,
    site: TWITTER_API_ENDPOINT,
    request_endpoint: TWITTER_API_ENDPOINT,
    sign_in: true
  )
end

#oauth_credentials ⇒ Object 



136
137
138
139
140
141
142
143
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 136

def oauth_credentials
  {
    consumer_key: TWITTER_CONSUMER_KEY,
    consumer_secret: TWITTER_CONSUMER_SECRET,
    token: configuration['access_token'],
    token_secret: configuration['secret']
  }
end

#oauth_header ⇒ Object 



131
132
133
134
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 131

def oauth_header
  uri = Addressable::URI.parse(post_url)
  SimpleOAuth::Header.new(:post, uri, {}, oauth_credentials)
end

#post_tweet(status, media) ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 40

def post_tweet(status, media)
  RestClient.post(
    post_url,
    {
      'media[]' => media,
      'status'  => status
    }, Authorization: oauth_header
  )
end

#post_url ⇒ Object 



34
35
36
37
38
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 34

def post_url
  # TODO: this endpoint is deprecated, use the new approach instead
  # https://dev.twitter.com/rest/reference/post/statuses/update_with_mediath_media
  @post_url ||= TWITTER_API_ENDPOINT + '/1.1/statuses/update_with_media.json'
end

#run_postcapture ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/lolcommits/plugin/lol_twitter.rb', line 18

def run_postcapture
  tweet = build_tweet(runner.message)

  attempts = 0
  begin
    attempts += 1
    puts "Tweeting: #{tweet}"
    debug "--> Tweeting! (attempt: #{attempts}, tweet length: #{tweet.length} chars)"
    post_tweet(tweet, File.open(runner.main_image, 'r'))
  rescue StandardError => e
    debug "Tweet FAILED! #{e.class} - #{e.message}"
    retry if attempts < TWITTER_RETRIES
    puts "ERROR: Tweet FAILED! (after #{attempts} attempts) - #{e.message}"
  end
end