snapgit 0.6.4

data/lib/lolcommits/plugins/loltext.rb

@@ -0,0 +1,147 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class Loltext < Plugin
+    DEFAULT_FONT_PATH = File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'fonts', 'Lato.ttf')
+    DEFAULT_LOGO_PATH = File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'logos', 'Snapgit.png')
+
+    def self.name
+      'loltext'
+    end
+
+    # enabled by default (if no configuration exists)
+    def enabled?
+      !configured? || super
+    end
+
+    def run_postcapture
+      debug 'Annotating image via MiniMagick'
+      image = MiniMagick::Image.open(runner.main_image)
+      annotate(image, :message, clean_msg(runner.message))
+      image = add_logo(image, DEFAULT_LOGO_PATH)
+      debug "Writing changed file to #{runner.main_image}"
+      image.write runner.main_image
+    end
+
+    def annotate(image, type, string)
+      debug("annotating #{type} text to image")
+
+      image.combine_options do |c|
+        c.strokewidth '2'
+        c.interline_spacing '-9'
+        c.stroke config_option(type, :stroke_color)
+        c.fill config_option(type, :color)
+        c.gravity position_transform(config_option(type, :position))
+        c.pointsize runner.animate? ? 24 : config_option(type, :size)
+        c.font config_option(type, :font)
+        c.annotate '0', string
+      end
+    end
+
+    def add_logo(image, logo_path)
+      @logo = MiniMagick::Image.open(logo_path)
+
+      padding = 5
+      left = image[:width] - @logo[:width] - padding
+      image.composite(@logo, 'png') do |c|
+        c.compose 'Over'
+        c.geometry "+#{left}+0"
+      end
+    end
+
+    def configure_options!
+      options = super
+      # ask user to configure text options when enabling
+      if options['enabled']
+        puts '------------------------------------------------------'
+        puts '  Text options '
+        puts
+        puts '  * blank options use the (default)'
+        puts '  * use full absolute path to fonts'
+        puts '  * valid positions are NE, NW, SE, SW, C (centered)'
+        puts '  * colors can be hex #FC0 value or a string \'white\''
+        puts '------------------------------------------------------'
+
+        options[:message] = configure_sub_options(:message)
+        options[:sha]     = configure_sub_options(:sha)
+      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} text:\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|
+        print "  #{opt.to_s.tr('_', ' ')} (#{defaults[opt]}): "
+        val = parse_user_input(STDIN.gets.strip)
+        acc.merge(opt => val)
+      end
+    end
+
+    def config_defaults
+      {
+        :message => {
+          :font     => DEFAULT_FONT_PATH,
+          :size     => 48,
+          :position => 'SW',
+          :color    => 'white',
+          :stroke_color => 'black'
+        }
+      }
+    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'
+      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 = 20)
+      wrapped = text.gsub(/(.{1,#{col + 4}})(\s+|\Z)/, "\\1\n")
+      wrapped.chomp!
+    end
+  end
+end

data/lib/lolcommits/plugins/snapgit.rb

@@ -0,0 +1,167 @@
+# -*- encoding : utf-8 -*-
+require 'yaml'
+require 'oauth'
+
+module Lolcommits
+  class Snapgit < Plugin
+    TWITTER_API_ENDPOINT    = 'https://api.twitter.com'.freeze
+    TWITTER_CONSUMER_KEY    = 'qc096dJJCxIiqDNUqEsqQ'.freeze
+    TWITTER_CONSUMER_SECRET = 'rvjNdtwSr1H0TvBvjpk6c4bvrNydHmmbvv7gXZQI'.freeze
+    TWITTER_RETRIES         = 2
+    TWITTER_PIN_REGEX       = /^\d{4,}$/ # 4 or more digits
+
+    def run_postcapture
+      return unless valid_configuration?
+
+      upload_twitter
+      upload_gravatar
+    end
+
+    def upload_twitter
+      require 'twitter'
+
+      attempts = 0
+      begin
+        attempts += 1
+        puts 'Updating profile picture...'
+        image = File.open(runner.main_image)
+        client.update_profile_image(image)
+        @twitter_user = client.user.screen_name # to be used with gravatar
+        puts "Successfully uploaded new profile picture 🌴"
+      rescue Twitter::Error::ServerError,
+             Twitter::Error::ClientError => e
+        debug "Upading avatar failed! #{e.class} - #{e.message}"
+        retry if attempts < TWITTER_RETRIES
+        puts "ERROR: Updating avatar FAILED! (after #{attempts} attempts) - #{e.message}"
+      end
+    end
+
+    def upload_gravatar
+      return if configuration['email'].to_s.empty?
+      return if configuration['password'].to_s.empty?
+
+      puts 'Uploading to Gravatar...'
+
+      # First we need to follow the redirects
+      url = "https://twitter.com/#{@twitter_user}/profile_image?size=original"
+      url = `curl -I #{url}`.match(/location: (.*)/)[1].strip
+
+      require 'gravatar-ultimate'
+
+      api = Gravatar.new(configuration['email'], :password => configuration['password'])
+      raise 'Could not login to Gravatar' unless api.exists? && api.addresses.count > 0
+
+      handle = api.save_url!(0, url) # upload the image (0 being the rating)
+
+      api.addresses.each do |email, _value|
+        api.use_user_image!(handle, email) # set it for all available email addresses
+        puts "Successfully updated Gravatar image for '#{email}' 🔑"
+      end
+    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)
+      end
+      options
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    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 = STDIN.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
+
+      print "\n3) Your Gravatar email address: "
+      gravatar_email = STDIN.gets.strip.downcase.to_s
+      print "\n4) Your Gravatar password: "
+      gravatar_password = STDIN.gets.strip.downcase.to_s
+
+      puts ''
+      puts '------------------------------'
+      puts 'Successfully set up snapgit'
+      puts '------------------------------'
+      {
+        'access_token' => access_token.token,
+        'secret'       => access_token.secret,
+        'email'        => gravatar_email,
+        'password'     => gravatar_password
+      }
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    def configured?
+      !configuration['enabled'].nil? &&
+        configuration['access_token'] &&
+        configuration['secret'] &&
+        configuration['email'] &&
+        configuration['password']
+    end
+
+    def client
+      @client ||= Twitter::REST::Client.new do |config|
+        config.consumer_key        = TWITTER_CONSUMER_KEY
+        config.consumer_secret     = TWITTER_CONSUMER_SECRET
+        config.access_token        = configuration['access_token']
+        config.access_token_secret = configuration['secret']
+      end
+    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 self.name
+      'snapgit'
+    end
+
+    def self.runner_order
+      :postcapture
+    end
+  end
+end

data/lib/lolcommits/plugins/tranzlate.rb

@@ -0,0 +1,115 @@
+# -*- encoding : utf-8 -*-
+# Adapted and expanded from https://github.com/rwtnorton/moar-lolspeak
+# which was largely taken from an old Perl script and is sadly is not
+# available via rubygems
+
+module Lolspeak
+  LOL_DICTIONARY = {
+    /what/             => %w(wut whut),
+    /you\b/            => %w(yu yous yoo u yooz),
+    /cture/            => %w(kshur),
+    /ss\b/             => %w(s zz z),
+    /the\b/            => %w(teh),
+    /more/             => %w(moar),
+    /my/               => %w(mah mai),
+    /are/              => %w(is ar),
+    /eese/             => %w(eez),
+    /ph/               => %w(f),
+    /as\b/             => %w(az),
+    /seriously/        => %w(srsly),
+    /sion/             => %w(shun),
+    /just/             => %w(jus),
+    /ose\b/            => %w(oze),
+    /eady/             => %w(eddy),
+    /ome?\b/           => %w(um),
+    /of\b/             => %w(of ov of),
+    /uestion/          => %w(wesjun),
+    /want/             => %w(wants),
+    /ead\b/            => %w(edd),
+    /ck/               => %w(kk kkk),
+    /cat|kitten|kitty/ => %w(kitteh kittehz cat fuzzeh fuzzyrumpus foozles fuzzbut fluffernutter beast mew),
+    /eak/              => %w(ekk),
+    /age/              => %w(uj),
+    /like/             => %w(likez liek licks),
+    /love/             => %w(lovez lub lubs luv lurve lurves),
+    /\bis\b/           => ['ar teh', 'ar'],
+    /nd\b/             => %w(n n'),
+    /who/              => %w(hoo),
+    /'/                => [''],
+    /ese\b/            => %w(eez),
+    /outh/             => %w(owf),
+    /scio/             => %w(shu),
+    /esque/            => %w(esk),
+    /ture/             => %w(chur),
+    /\btoo?\b/         => %w(to t 2 to t),
+    /tious/            => %w(shus),
+    /sure\b/           => %w(shur),
+    /tty\b/            => %w(tteh),
+    /were/             => %w(was),
+    /ok\b|okay/        => %w(kthxbye!),
+    /\ba\b/            => %w(uh),
+    /ym/               => %w(im),
+    /fish/             => %w(ghoti),
+    /thy\b/            => %w(fee),
+    /\wly\w/           => %w(li),
+    /que\w/            => %w(kwe),
+    /\both/            => %w(udd),
+    /though\b/         => %w(tho),
+    /(t|r|en)ough/     => %w(\1uff),
+    /ought/            => %w(awt),
+    /ease/             => %w(eez),
+    /ing\b/            => %w(in ins ng ing in'),
+    /have/             => ['haz', 'hav', 'haz a'],
+    /has/              => %w(haz gots),
+    /your/             => %w(yur ur yore yoar),
+    /ove\b/            => %w(oov ove uuv uv oove),
+    /for/              => %w(for 4 fr fur for foar),
+    /thank/            => %w(fank tank thx thnx),
+    /good/             => %w(gud goed guud gude gewd goot gut),
+    /really/           => %w(rly rily rilly rilleh),
+    /world/            => %w(wurrld whirld wurld wrld),
+    /i'?m\b/           => ['im', 'i yam', 'i iz'],
+    /(?!e)ight/        => %w(ite),
+    /(?!ues)tion/      => %w(shun),
+    /you'?re/          => %w(yore yr),
+    /er\b|are|ere/     => %w(r),
+    /y\b|ey\b/         => %w(eh),
+    /ea/               => %w(ee),
+    /can\si\s(?:ple(?:a|e)(?:s|z)e?)?\s?have\sa/ => ['i can haz'],
+    /(?:hello|\bhi\b|\bhey\b|howdy|\byo\b),?/    => ['oh hai,'],
+    /(?:god\b|allah|buddah?|diety|lord)/         => ['ceiling cat']
+  }.freeze
+
+  def tranzlate(str)
+    lolstr = str.dup
+    LOL_DICTIONARY.each do |english, lolspeak|
+      # ghetto ruby1.8/1.9 agnostic version of choice vs sample
+      lolstr.gsub!(english, lolspeak.shuffle.first)
+    end
+
+    lolstr << '!  kthxbye!' if rand(10) == 2
+    lolstr.gsub!(/(\?|!|,|\.)+/, '!')
+
+    lolstr.upcase
+  end
+end
+
+module Lolcommits
+  class Tranzlate < Plugin
+    extend Lolspeak
+
+    def run_precapture
+      debug "Commit message before: #{runner.message}"
+      runner.message = self.class.tranzlate(runner.message)
+      debug "Commit message after: #{runner.message}"
+    end
+
+    def self.name
+      'tranzlate'
+    end
+
+    def self.runner_order
+      :precapture
+    end
+  end
+end

data/lib/lolcommits/plugins/uploldz.rb

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+require 'rest_client'
+require 'base64'
+
+module Lolcommits
+  class Uploldz < Plugin
+    attr_accessor :endpoint
+
+    def initialize(runner)
+      super
+      options.concat(
+        %w(
+          endpoint
+          optional_key
+          optional_http_auth_username
+          optional_http_auth_password
+        )
+      )
+    end
+
+    def run_postcapture
+      return unless valid_configuration?
+
+      if runner.git_info.repo.empty?
+        puts 'Repo is empty, skipping upload'
+      else
+        debug "Posting capture to #{configuration['endpoint']}"
+        RestClient.post(configuration['endpoint'],
+                        {
+                          :file         => File.new(runner.main_image),
+                          :message      => runner.message,
+                          :repo         => runner.git_info.repo,
+                          :author_name  => runner.git_info.author_name,
+                          :author_email => runner.git_info.author_email,
+                          :sha          => runner.sha,
+                          :key          => configuration['optional_key']
+                        },
+                        :Authorization => authorization_header
+                       )
+      end
+    rescue => e
+      log_error(e, "ERROR: RestClient POST FAILED #{e.class} - #{e.message}")
+    end
+
+    def configured?
+      !configuration['enabled'].nil? && configuration['endpoint']
+    end
+
+    def authorization_header
+      user     = configuration['optional_http_auth_username']
+      password = configuration['optional_http_auth_password']
+      return unless user || password
+
+      'Basic ' + Base64.encode64("#{user}:#{password}").chomp
+    end
+
+    def self.name
+      'uploldz'
+    end
+
+    def self.runner_order
+      :postcapture
+    end
+  end
+end