lolcommits 0.9.2 → 0.9.3.pre1

data/lib/lolcommits/plugin/lol_twitter.rb

@@ -0,0 +1,176 @@
+require 'yaml'
+require 'oauth'
+require 'simple_oauth'
+require 'rest_client'
+require 'addressable/uri'
+
+module Lolcommits
+  module Plugin
+    class LolTwitter < Base
+      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            = /^\d{4,}$/ # 4 or more digits
+      DEFAULT_SUFFIX               = '#lolcommits'.freeze
+
+      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
+
+      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
+
+      def post_tweet(status, media)
+        RestClient.post(
+          post_url,
+          {
+            'media[]' => media,
+            'status'  => status
+          }, Authorization: oauth_header
+        )
+      end
+
+      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
+
+      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
+
+      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
+
+      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
+
+      def configured?
+        !configuration['enabled'].nil? &&
+          configuration['access_token'] &&
+          configuration['secret']
+      end
+
+      def oauth_header
+        uri = Addressable::URI.parse(post_url)
+        SimpleOAuth::Header.new(:post, uri, {}, oauth_credentials)
+      end
+
+      def oauth_credentials
+        {
+          consumer_key: TWITTER_CONSUMER_KEY,
+          consumer_secret: TWITTER_CONSUMER_SECRET,
+          token: configuration['access_token'],
+          token_secret: configuration['secret']
+        }
+      end
+
+      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
+
+      def config_with_default(key, default = nil)
+        if configuration[key]
+          configuration[key].strip.empty? ? default : configuration[key]
+        else
+          default
+        end
+      end
+
+      def max_tweet_size
+        139 - TWITTER_RESERVED_MEDIA_CHARS
+      end
+
+      def self.name
+        'twitter'
+      end
+
+      def self.runner_order
+        :postcapture
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin/lol_yammer.rb

@@ -0,0 +1,84 @@
+require 'yammer'
+require 'rest_client'
+
+# https://developer.yammer.com/oauth2-quickstart/
+YAMMER_CLIENT_ID        = 'bgORyeKtnjZJSMwp8oln9g'.freeze
+YAMMER_CLIENT_SECRET    = 'oer2WdGzh74a5QBbW3INUxblHK3yg9KvCZmiBa2r0'.freeze
+YAMMER_ACCESS_TOKEN_URL = 'https://www.yammer.com/oauth2/access_token.json'.freeze
+YAMMER_RETRY_COUNT      = 2
+
+module Lolcommits
+  module Plugin
+    class LolYammer < Base
+      def self.name
+        'yammer'
+      end
+
+      def self.runner_order
+        :postcapture
+      end
+
+      def configured?
+        !configuration['access_token'].nil?
+      end
+
+      def configure_access_token
+        print "Open the URL below and copy the `code` param from query after redirected, enter it as `access_token`:\n"
+        print "https://www.yammer.com/dialog/oauth?client_id=#{YAMMER_CLIENT_ID}&response_type=code\n"
+        print 'Enter code param from the redirected URL, then press enter: '
+        code = gets.to_s.strip
+
+        url = YAMMER_ACCESS_TOKEN_URL
+        debug "access_token url: #{url}"
+        params = {
+          'client_id' => YAMMER_CLIENT_ID,
+          'client_secret' => YAMMER_CLIENT_SECRET,
+          'code' => code
+        }
+        debug "params : #{params.inspect}"
+        result = JSON.parse(RestClient.post(url, params))
+        debug "response : #{result.inspect}"
+        # no need for 'return', last line is always the return value
+        { 'access_token' => result['access_token']['token'] }
+      end
+
+      def configure_options!
+        options = super
+        # ask user to configure tokens if enabling
+        if options['enabled']
+          auth_config = configure_access_token
+          return unless auth_config
+          options.merge!(auth_config)
+        end
+        options
+      end
+
+      def run_postcapture
+        commit_msg = runner.message
+        post = "#{commit_msg} #lolcommits"
+        puts "Yammer post: #{post}" unless runner.capture_stealth
+
+        Yammer.configure do |c|
+          c.client_id = YAMMER_CLIENT_ID
+          c.client_secret = YAMMER_CLIENT_SECRET
+        end
+
+        client = Yammer::Client.new(access_token: configuration['access_token'])
+
+        retries = YAMMER_RETRY_COUNT
+        begin
+          lolimage = File.new(runner.main_image)
+          response = client.create_message(post, attachment1: lolimage)
+          debug response.body.inspect
+          puts "\t--> Status posted!" if response
+        rescue => e
+          retries -= 1
+          retry if retries > 0
+          puts "Status not posted - #{e.message}"
+          puts 'Try running config again:'
+          puts "\tlolcommits --config --plugin yammer"
+        end
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin/lolsrv.rb

@@ -0,0 +1,58 @@
+require 'rest_client'
+require 'pp'
+require 'json'
+
+module Lolcommits
+  module Plugin
+    class Lolsrv < Base
+      def initialize(runner)
+        super
+        options << 'server'
+      end
+
+      def run_postcapture
+        fork { sync }
+      end
+
+      def configured?
+        !configuration['enabled'].nil? && configuration['server']
+      end
+
+      def sync
+        existing = existing_lols
+        return unless existing.nil?
+        Dir[runner.config.loldir + '/*.{jpg,gif}'].each do |item|
+          sha = File.basename(item, '.*')
+          upload(item, sha) unless existing.include?(sha) || sha == 'tmp_snapshot'
+        end
+      end
+
+      def existing_lols
+        lols = JSON.parse(RestClient.get(configuration['server'] + '/lols'))
+        lols.map { |lol| lol['sha'] }
+      rescue => e
+        log_error(e, "ERROR: existing lols could not be retrieved #{e.class} - #{e.message}")
+        return nil
+      end
+
+      def upload(file, sha)
+        RestClient.post(configuration['server'] + '/uplol',
+                        lol: File.new(file),
+                        url: runner.vcs_info.url + sha,
+                        repo: runner.vcs_info.repo,
+                        date: File.ctime(file),
+                        sha: sha)
+      rescue => e
+        log_error(e, "ERROR: Upload of lol #{sha} FAILED #{e.class} - #{e.message}")
+      end
+
+      def self.name
+        'lolsrv'
+      end
+
+      def self.runner_order
+        :postcapture
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin/loltext.rb

@@ -0,0 +1,190 @@
+module Lolcommits
+  module Plugin
+    class Loltext < Base
+      DEFAULT_FONT_PATH = File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'fonts', 'Impact.ttf')
+
+      def self.name
+        'loltext'
+      end
+
+      # enabled by default (if no configuration exists)
+      def enabled?
+        !configured? || super
+      end
+
+      # valid by default (if no config exists)
+      def valid_configuration?
+        !configured? || super
+      end
+
+      def run_postcapture
+        debug 'Annotating image via MiniMagick'
+        image = MiniMagick::Image.open(runner.main_image)
+        if config_option(:overlay, :enabled)
+          image.combine_options do |c|
+            c.fill config_option(:overlay, :overlay_colors).sample
+            c.colorize config_option(:overlay, :overlay_percent)
+          end
+        end
+
+        annotate(image, :message, clean_msg(runner.message))
+        annotate(image, :sha, runner.sha)
+        debug "Writing changed file to #{runner.main_image}"
+        image.write runner.main_image
+      end
+
+      def annotate(image, type, string)
+        debug("annotating #{type} to image with #{string}")
+
+        transformed_position = position_transform(config_option(type, :position))
+        annotate_location = '0'
+        if transformed_position == 'South'
+          annotate_location = '+0+20' # Move South gravity off the edge of the image.
+        end
+
+        string.upcase! if config_option(type, :uppercase)
+
+        image.combine_options do |c|
+          c.strokewidth runner.capture_animated? ? '1' : '2'
+          c.interline_spacing(-(config_option(type, :size) / 5))
+          c.stroke config_option(type, :stroke_color)
+          c.fill config_option(type, :color)
+          c.gravity transformed_position
+          c.pointsize runner.capture_animated? ? (config_option(type, :size) / 2) : config_option(type, :size)
+          c.font config_option(type, :font)
+          c.annotate annotate_location, string
+        end
+      end
+
+      def configure_options!
+        options = super
+        # ask user to configure text options when enabling
+        if options['enabled']
+          puts '---------------------------------------------------------------'
+          puts '  LolText options '
+          puts ''
+          puts '  * any blank options will use the (default)'
+          puts '  * always use the full absolute path to fonts'
+          puts '  * valid text positions are NE, NW, SE, SW, S, C (centered)'
+          puts '  * colors can be hex #FC0 value or a string \'white\''
+          puts '      - use `none` for no stroke color'
+          puts '  * overlay fills your image with a random color'
+          puts '      - set one or more overlay_colors with a comma seperator'
+          puts '      - overlay_percent (0-100) sets the fill colorize strength'
+          puts '---------------------------------------------------------------'
+
+          options[:message] = configure_sub_options(:message)
+          options[:sha]     = configure_sub_options(:sha)
+          options[:overlay] = configure_sub_options(:overlay)
+        end
+        options
+      end
+
+      # TODO: consider this type of configuration prompting in the base Plugin
+      # class, working with hash of defaults
+      def configure_sub_options(type)
+        print "#{type}:\n"
+        defaults = config_defaults[type]
+
+        # sort option keys since different `Hash#keys` varys across Ruby versions
+        defaults.keys.sort_by(&:to_s).reduce({}) do |acc, opt|
+          # if we have an enabled key set to false, abort asking for any more options
+          if acc.key?(:enabled) && acc[:enabled] != true
+            acc
+          else
+            print "  #{opt.to_s.tr('_', ' ')} (#{defaults[opt]}): "
+            val = parse_user_input(gets.chomp.strip)
+            # handle array options (comma seperated string)
+            if defaults[opt].is_a?(Array) && !val.nil?
+              val = val.split(',').map(&:strip).delete_if(&:empty?)
+            end
+            acc.merge(opt => val)
+          end
+        end
+      end
+
+      def config_defaults
+        {
+          message: {
+            color: 'white',
+            font: DEFAULT_FONT_PATH,
+            position: 'SW',
+            size: 48,
+            stroke_color: 'black',
+            uppercase: false
+          },
+          sha: {
+            color: 'white',
+            font: DEFAULT_FONT_PATH,
+            position: 'NE',
+            size: 32,
+            stroke_color: 'black',
+            uppercase: false
+          },
+          overlay: {
+            enabled: false,
+            overlay_colors: [
+              '#2e4970', '#674685', '#ca242f', '#1e7882', '#2884ae', '#4ba000',
+              '#187296', '#7e231f', '#017d9f', '#e52d7b', '#0f5eaa', '#e40087',
+              '#5566ac', '#ed8833', '#f8991c', '#408c93', '#ba9109'
+            ],
+            overlay_percent: 50
+          }
+        }
+      end
+
+      def config_option(type, option)
+        default_option = config_defaults[type][option]
+        if configuration[type]
+          configuration[type][option] || default_option
+        else
+          default_option
+        end
+      end
+
+      private
+
+      # explode psuedo-names for text position
+      def position_transform(position)
+        case position
+        when 'NE'
+          'NorthEast'
+        when 'NW'
+          'NorthWest'
+        when 'SE'
+          'SouthEast'
+        when 'SW'
+          'SouthWest'
+        when 'C'
+          'Center'
+        when 'S'
+          'South'
+        end
+      end
+
+      # do whatever is required to commit message to get it clean and ready for imagemagick
+      def clean_msg(text)
+        wrapped_text = word_wrap text
+        escape_quotes wrapped_text
+        escape_ats wrapped_text
+      end
+
+      # conversion for quotation marks to avoid shell interpretation
+      # does not seem to be a safe way to escape cross-platform?
+      def escape_quotes(text)
+        text.gsub(/"/, "''")
+      end
+
+      def escape_ats(text)
+        text.gsub(/@/, '\@')
+      end
+
+      # convenience method for word wrapping
+      # based on https://github.com/cmdrkeene/memegen/blob/master/lib/meme_generator.rb
+      def word_wrap(text, col = 27)
+        wrapped = text.gsub(/(.{1,#{col + 4}})(\s+|\Z)/, "\\1\n")
+        wrapped.chomp!
+      end
+    end
+  end
+end