lolcommits 0.5.1 → 0.5.2.pre1

data/lib/lolcommits/plugin.rb

@@ -1,40 +1,83 @@
 module Lolcommits
   class Plugin
     include Methadone::CLILogging
-    attr_accessor :default, :name, :runner, :options
 
-    def configuration
-      config = runner.config.user_configuration
-      return Hash.new if config.nil?
-      config[self.name] || Hash.new
-    end
+    attr_accessor :runner, :options
 
     def initialize(runner)
+      debug "Initializing"
       self.runner = runner
       self.options = ['enabled']
+    end
 
-      plugdebug "Initializing"
+    def execute
+      if is_enabled?
+        debug "I am enabled, about to run"
+        run
+      else
+        debug "Disabled, doing nothing for execution"
+      end
     end
 
-    def is_enabled?
-      enabled_config = configuration['enabled']
-      return self.default if enabled_config.nil? || enabled_config == ''
-      return enabled_config
+    def run
+      debug "base plugin, does nothing to anything"
     end
 
+    def configuration
+      config = runner.config.read_configuration if runner
+      return Hash.new unless config
+      config[self.class.name] || Hash.new
+    end
 
-    def execute
-      if is_enabled?
-        plugdebug "I am enabled, about to run"
-        run
+    # ask for plugin options
+    def configure_options!
+      puts "Configuring plugin: #{self.class.name}\n"
+      options.inject(Hash.new) do |acc, option|
+        print "#{option}: "
+        val = STDIN.gets.strip.downcase
+        if %w(true yes).include?(val)
+          val = true
+        elsif %(false no).include?(val)
+          val = false
+        end
+        acc.merge(option => val)
+      end
+    end
+
+    def is_enabled?
+      configuration['enabled'] == true
+    end
+
+    # check config is valid
+    def valid_configuration?
+      if is_configured?
+        true
       else
-        plugdebug "Disabled, doing nothing for execution"
+        puts "Missing #{self.class.name} config - configure with: lolcommits --config -p #{self.class.name}"
+        false
       end
     end
 
-    # uniform debug logging output for plugins
-    def plugdebug(msg)
-      debug("Plugin: #{self.class.to_s}: " + msg)
+    # empty plugin configuration
+    def is_configured?
+      !configuration.empty?
+    end
+
+    # uniform puts for plugins
+    # dont puts if the runner wants to be silent (stealth mode)
+    def puts(*args)
+      return if runner && runner.capture_stealth
+      super(args)
+    end
+
+    # uniform debug logging for plugins
+    def debug(msg)
+      super("Plugin: #{self.class.to_s}: " + msg)
+    end
+
+    # identifying plugin name (for config, listing)
+    def self.name
+      'plugin'
     end
   end
 end

data/lib/lolcommits/plugins/dot_com.rb

@@ -2,17 +2,17 @@ require 'httmultiparty'
 
 module Lolcommits
   class DotCom < Plugin
+
     def initialize(runner)
       super
-
-      self.name    = 'dot_com'
-      self.default = false
       self.options.concat(['api_key', 'api_secret', 'repo_id'])
     end
 
     def run
+      return unless valid_configuration?
+
       t = Time.now.to_i.to_s
-      resp = HTTMultiParty.post('http://www.lolcommits.com/git_commits.json', 
+      resp = HTTMultiParty.post('http://www.lolcommits.com/git_commits.json',
         :body => {
           :git_commit => {
             :sha              => self.runner.sha,
@@ -28,5 +28,15 @@ module Lolcommits
       )
     end
 
+    def is_configured?
+      !configuration['enabled'].nil? &&
+        configuration['api_key'] &&
+        configuration['api_secret'] &&
+        configuration['repo_id']
+    end
+
+    def self.name
+      'dot_com'
+    end
   end
 end

data/lib/lolcommits/plugins/lol_twitter.rb

@@ -3,101 +3,123 @@ require 'oauth'
 
 # twitter gem currently spams stdout when activated, surpress warnings just during the inital require
 original_verbose, $VERBOSE = $VERBOSE, nil # Supress warning messages.
-  require 'twitter'
-$VERBOSE = original_verbose # Activate warning messages again.
-
-TWITTER_CONSUMER_KEY = 'qc096dJJCxIiqDNUqEsqQ'
-TWITTER_CONSUMER_SECRET = 'rvjNdtwSr1H0TvBvjpk6c4bvrNydHmmbvv7gXZQI'
+require 'twitter'
+$VERBOSE = original_verbose # activate warning messages again.
 
 module Lolcommits
-
   class LolTwitter < Plugin
 
-    def initialize(runner)
-      super
-      self.name    = 'twitter'
-      self.default = false
+    TWITTER_CONSUMER_KEY    = 'qc096dJJCxIiqDNUqEsqQ'
+    TWITTER_CONSUMER_SECRET = 'rvjNdtwSr1H0TvBvjpk6c4bvrNydHmmbvv7gXZQI'
+    TWITTER_RETRIES         = 2
+    TWITTER_PIN_REGEX       = /^\d{4,}$/ # 4 or more digits
+
+    def run
+      return unless valid_configuration?
+
+      attempts = 0
+
+      begin
+        attempts += 1
+        tweet = build_tweet(self.runner.message)
+        puts "Tweeting: #{tweet}"
+        debug "--> Tweeting! (attempt: #{attempts}, tweet size: #{tweet.length} chars)"
+        if client.update_with_media(tweet, File.open(self.runner.main_image, 'r'))
+          puts "\t--> Tweet Sent!"
+        end
+      rescue Twitter::Error::InternalServerError,
+               Twitter::Error::BadRequest,
+               Twitter::Error::ClientError => e
+        debug "Tweet FAILED! #{e.class} - #{e.message}"
+        retry if attempts < TWITTER_RETRIES
+        puts "ERROR: Tweet FAILED! (after #{attempts} attempts) - #{e.message}"
+      end
     end
 
-    def initial_twitter_auth
-      puts "\n--------------------------------------------"
-      puts "Need to grab twitter tokens (first time only)"
-      puts "---------------------------------------------"
+    def build_tweet(commit_message, tag = "#lolcommits")
+      available_commit_msg_size = max_tweet_size - (tag.length + 1)
+      if commit_message.length > available_commit_msg_size
+        commit_message = "#{commit_message[0..(available_commit_msg_size-3)]}..."
+      end
+      "#{commit_message} #{tag}"
+    end
 
-      consumer = OAuth::Consumer.new(TWITTER_CONSUMER_KEY, 
+    def configure_options!
+      options = super
+      # ask user to configure tokens if enabling
+      if options['enabled'] == true
+        if auth_config = configure_auth!
+          options.merge!(auth_config)
+        else
+          # return nil if configure_auth failed
+          return
+        end
+      end
+      return options
+    end
+
+    def configure_auth!
+      puts "---------------------------"
+      puts "Need to grab twitter tokens"
+      puts "---------------------------"
+
+      consumer = OAuth::Consumer.new(TWITTER_CONSUMER_KEY,
                                      TWITTER_CONSUMER_SECRET,
                                      :site => 'http://api.twitter.com',
                                      :request_endpoint => 'http://api.twitter.com',
                                      :sign_in => true)
 
       request_token = consumer.get_request_token
-      rtoken  = request_token.token
-      rsecret = request_token.secret
+      rtoken        = request_token.token
+      rsecret       = request_token.secret
 
-      puts "\n1.) Open the following url in your browser, get the PIN:\n\n"
+      print "\n1) Please open this url in your browser to get a PIN for lolcommits:\n\n"
       puts request_token.authorize_url
-      puts "\n2.) Enter PIN, then press enter:"
+      print "\n2) Enter PIN, then press enter: "
+      twitter_pin = STDIN.gets.strip.downcase.to_s
 
-      begin
-        STDOUT.flush
-        twitter_pin = STDIN.gets.chomp
-      rescue
-      end
-
-      if (twitter_pin.nil?) || (twitter_pin.length == 0)
-        puts "\n\tERROR: Could not read PIN, auth fail"
+      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(consumer, rtoken, rsecret)
         access_token = request_token.get_access_token(:oauth_verifier => twitter_pin)
-      rescue Twitter::Unauthorized
-        puts "> FAIL!"
+      rescue OAuth::Unauthorized
+        puts "\nERROR: Twitter PIN Auth FAILED!"
         return
       end
 
-      # saves the config back to yaml file.
-      self.runner.config.do_configure!('twitter', { 'enabled'      => true,
-                                                    'access_token' => access_token.token,
-                                                    'secret'       => access_token.secret })
-    end
-
-    def run
-      commit_msg = self.runner.message
-      available_commit_msg_size = 128 
-      tweet_msg = commit_msg.length > available_commit_msg_size ? "#{commit_msg[0..(available_commit_msg_size-3)]}..." : commit_msg
-      tweet_text = "#{tweet_msg} #lolcommits"
-      puts "Tweeting: #{tweet_text}"
-
-      if configuration['access_token'].nil? || configuration['secret'].nil?
-        initial_twitter_auth()
-      end
-
-      if configuration['access_token'].nil? || configuration['secret'].nil?
-        puts "Missing Twitter Credentials - Skipping The Tweet"
-        return
+      if access_token.token && access_token.secret
+        print "\n3) Thanks! Twitter Auth Succeeded\n"
+        return { 'access_token' => access_token.token,
+                 'secret'       => access_token.secret }
       end
+    end
 
-      Twitter.configure do |config|
-        config.consumer_key = TWITTER_CONSUMER_KEY
-        config.consumer_secret = TWITTER_CONSUMER_SECRET
-      end
+    def is_configured?
+      !configuration['enabled'].nil? &&
+        configuration['access_token'] &&
+        configuration['secret']
+    end
 
-      client = Twitter::Client.new(
-        :oauth_token => configuration['access_token'],
+    def client
+      @client ||= Twitter::Client.new(
+        :consumer_key       => TWITTER_CONSUMER_KEY,
+        :consumer_secret    => TWITTER_CONSUMER_SECRET,
+        :oauth_token        => configuration['access_token'],
         :oauth_token_secret => configuration['secret']
       )
-      retries = 2
-      begin
-        if client.update_with_media(tweet_text, File.open(self.runner.main_image, 'r'))
-          puts "\t--> Tweet Sent!"
-        end
-      rescue Twitter::Error::InternalServerError
-        retries -= 1
-        retry if retries > 0
-        puts "\t ! --> Tweet 500 Error - Tweet Not Posted"
-      end
+    end
+
+    def max_tweet_size
+      139 - client.configuration.characters_reserved_per_media
+    end
+
+    def self.name
+      'twitter'
     end
   end
 end

data/lib/lolcommits/plugins/lolsrv.rb

@@ -4,42 +4,31 @@ require "json"
 require "logger"
 
 module Lolcommits
-
   class Lolsrv < Plugin
 
-    SERVER = 'server'
-
     def initialize(runner)
       super
-      self.name    = 'lolsrv'
-      self.default = false  
-      self.options << SERVER
-
+      self.options << 'server'
+      if self.runner
+        @logger = Logger.new(File.new(self.runner.config.loldir + "/lolsrv.log", "a+"))
+      end
     end
 
     def run
-      
-      log_file = File.new(self.runner.config.loldir + "/lolsrv.log", "a+")
-      @logger = Logger.new(log_file)
-      
-      if configuration[SERVER].nil?
-        puts "Missing server configuration. Use lolcommits --config -p lolsrv"
-        return
-      end
+      return unless valid_configuration?
+      fork { sync() }
+    end
 
-      fork do
-        sync()
-      end
+    def is_configured?
+      !configuration["enabled"].nil? && configuration["server"]
     end
 
     def sync
       existing = get_existing_lols
       unless existing.nil?
-        Dir.glob(self.runner.config.loldir + "/*.jpg") do |item|
-          next if item == '.' or item == '..'
-          # do work on real items
-          sha = File.basename(item, '.*')
-          unless existing.include?(sha) || sha == 'tmp_snapshot' 
+        Dir[self.runner.config.loldir + "/*.{jpg,gif}"].each do |item|
+          sha = File.basename(item, ".*")
+          unless existing.include?(sha) || sha == "tmp_snapshot"
             upload(item, sha)
           end
         end
@@ -49,11 +38,10 @@ module Lolcommits
     def get_existing_lols
       begin
         lols = JSON.parse(
-        RestClient.get(configuration[SERVER] + '/lols'))
+        RestClient.get(configuration['server'] + "/lols"))
         lols.map { |lol| lol["sha"] }
-      rescue => error
-        @logger.info "Existing lols could not be retrieved with Error " + error.message
-        @logger.info error.backtrace
+      rescue => e
+        log_error(e, "ERROR: existing lols could not be retrieved #{e.class} - #{e.message}")
         return nil
       end
     end
@@ -61,13 +49,24 @@ module Lolcommits
     def upload(file, sha)
       begin
         RestClient.post(
-        configuration[SERVER] + '/uplol', 
-        :lol => File.new(file),
-        :sha => sha) 
-      rescue => error
-        @logger.info "Upload of LOL "+ sha + " failed with Error " + error.message
+          configuration["server"] + "/uplol",
+          :lol => File.new(file),
+          :sha => sha
+        )
+      rescue => e
+        log_error(e,"ERROR: Upload of lol #{sha} FAILED #{e.class} - #{e.message}")
         return
       end
     end
+
+    def log_error(e, message)
+      debug message
+      @logger.info message
+      @logger.info e.backtrace
+    end
+
+    def self.name
+      "lolsrv"
+    end
   end
 end

data/lib/lolcommits/plugins/loltext.rb

@@ -3,22 +3,21 @@ module Lolcommits
 
     def initialize(runner)
       super
-
       @font_location = runner ? runner.font : nil
-
-      self.name    = 'loltext'
-      self.default = true
     end
 
-    def run
-      mm_run
+    # enabled by default (if no configuration exists)
+    def is_enabled?
+      !is_configured? || super
     end
 
-    # use minimagick wrapper
-    def mm_run
-      font_location = @font_location || File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "fonts", "Impact.ttf")
+    def run
+      font_location = @font_location || File.join(Configuration::LOLCOMMITS_ROOT,
+                                                  "vendor",
+                                                  "fonts",
+                                                  "Impact.ttf")
 
-      plugdebug "Annotating image via MiniMagick"
+      debug "Annotating image via MiniMagick"
       image = MiniMagick::Image.open(self.runner.main_image)
       image.combine_options do |c|
         c.gravity 'SouthWest'
@@ -41,34 +40,14 @@ module Lolcommits
         c.annotate '0', self.runner.sha
       end
 
-      plugdebug "Writing changed file to #{self.runner.main_image}"
+      debug "Writing changed file to #{self.runner.main_image}"
       image.write self.runner.main_image
     end
 
-    # use Rmagick wrapper (deprecated, no longer works in IM6.10+)
-    # def rm_run
-    #   canvas = ImageList.new(self.runner.main_image)
-    #   draw = Magick::Draw.new
-    #   draw.font = File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "fonts", "Impact.ttf")
-
-    #   draw.fill   = 'white'
-    #   draw.stroke = 'black'
-
-    #   draw.annotate(canvas, 0, 0, 0, 0, self.runner.sha) do
-    #     self.gravity = NorthEastGravity
-    #     self.pointsize = 32
-    #     self.stroke_width = 2
-    #   end
-
-    #   draw.annotate(canvas, 0, 0, 0, 0, word_wrap(self.runner.message)) do
-    #     self.gravity = SouthWestGravity
-    #     self.pointsize = 48
-    #     self.interline_spacing = -(48 / 5) if self.respond_to?(:interline_spacing)
-    #     self.stroke_width = 2
-    #   end
+    def self.name
+     'loltext'
+    end
 
-    #   canvas.write(runner.main_image)
-    # end
 
     private