snapgit 0.6.4

data/lib/lolcommits/installation.rb

@@ -0,0 +1,128 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  #
+  # Methods to handle enabling and disabling of lolcommits
+  #
+  class Installation
+    HOOK_PATH = File.join '.git', 'hooks', 'post-commit'
+    HOOK_DIR = File.join '.git', 'hooks'
+
+    #
+    # IF --ENABLE, DO ENABLE
+    #
+    def self.do_enable
+      unless File.directory?('.git')
+        fatal "You don't appear to be in the base directory of a git project."
+        exit 1
+      end
+
+      # its possible a hooks dir doesnt exist, so create it if so
+      Dir.mkdir(HOOK_DIR) unless File.directory?(HOOK_DIR)
+
+      # should add a shebang (or not) adding will rewrite hook file
+      add_shebang = false
+      if hook_file_exists?
+        # clear away any existing lolcommits hook
+        remove_existing_hook! if lolcommits_hook_exists?
+
+        # if file is empty we should add a shebang (and rewrite hook)
+        if File.read(HOOK_PATH).strip.empty?
+          add_shebang = true
+        elsif !good_shebang?
+          # look for good shebang in existing hook, abort if none found
+          warn "the existing hook (at #{HOOK_PATH}) doesn't start with a good shebang; like #!/bin/sh"
+          exit 1
+        end
+      else
+        add_shebang = true
+      end
+
+      File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
+        f.write("#!/bin/sh\n") if add_shebang
+        f.write(hook_script)
+      end
+
+      FileUtils.chmod 0755, HOOK_PATH
+
+      info 'installed lolcommit hook to:'
+      info "  -> #{File.expand_path(HOOK_PATH)}"
+      info '(to remove later, you can use: lolcommits --disable)'
+      # we dont symlink, but rather install a small stub that calls the one from path
+      # that way, as gem version changes, script updates even if new file thus breaking symlink
+    end
+
+    #
+    # IF --DISABLE, DO DISABLE
+    #
+    def self.do_disable
+      if lolcommits_hook_exists?
+        remove_existing_hook!
+        info "uninstalled lolcommits hook (from #{HOOK_PATH})"
+      elsif File.exist?(HOOK_PATH)
+        info "couldn't find an lolcommits hook (at #{HOOK_PATH})"
+        if File.read(HOOK_PATH) =~ /lolcommit/
+          info "warning: an older-style lolcommit hook may still exist, edit #{HOOK_PATH} to remove it manually"
+        end
+      else
+        info "no post commit hook found (at #{HOOK_PATH}), so there is nothing to uninstall"
+      end
+    end
+
+    def self.hook_script
+      ruby_path     = Lolcommits::Platform.command_which('ruby', true)
+      imagick_path  = Lolcommits::Platform.command_which('identify', true)
+
+      if Lolcommits::Platform.platform_windows?
+        hook_export = "set path \"#{ruby_path};#{imagick_path};%PATH%\"\n"
+      else
+        locale_export = "export LANG=\"#{ENV['LANG']}\"\n"
+        hook_export   = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
+      end
+
+      capture_cmd   = 'lolcommits --capture'
+      capture_args  = ' '
+      capture_args  += "#{ARGV[1..-1].join(' ')} " if ARGV.length > 1
+      capture_args  += ENV['LOLCOMMITS_INIT_PARAMS'].to_s
+
+      <<-EOS
+### lolcommits hook (begin) ###
+if [ ! -d "$GIT_DIR/rebase-merge" ]; then
+#{locale_export}#{hook_export}#{capture_cmd}#{capture_args}
+fi
+###  lolcommits hook (end)  ###
+EOS
+    end
+
+    # does a git hook exist at all?
+    def self.hook_file_exists?
+      File.exist?(HOOK_PATH)
+    end
+
+    # does a git hook exist with lolcommits commands?
+    def self.lolcommits_hook_exists?
+      hook_file_exists? &&
+        File.read(HOOK_PATH).to_s =~ /lolcommits.*\(begin\)(.*\n)*.*lolcommits.*\(end\)/
+    end
+
+    # does the git hook file have a good shebang?
+    def self.good_shebang?
+      File.read(HOOK_PATH).lines.first =~ %r{^\#\!\/bin\/.*sh}
+    end
+
+    def self.remove_existing_hook!
+      hook = File.read(HOOK_PATH)
+      out  = File.open(HOOK_PATH, 'w')
+      skip = false
+
+      hook.lines.each do |line|
+        skip = true if !skip && (line =~ /lolcommits.*\(begin\)/)
+
+        out << line unless skip
+
+        skip = false if skip && (line =~ /lolcommits.*\(end\)/)
+      end
+
+      out.close
+    end
+  end
+end

data/lib/lolcommits/platform.rb

@@ -0,0 +1,127 @@
+# -*- encoding : utf-8 -*-
+require 'mini_magick'
+require 'rbconfig'
+
+module Lolcommits
+  class Platform
+    # The capturer class constant to use
+    # @return Class
+    def self.capturer_class(animate = false)
+      if ENV['LOLCOMMITS_CAPTURER']
+        const_get(ENV['LOLCOMMITS_CAPTURER'])
+      elsif platform_mac?
+        animate ? CaptureMacAnimated : CaptureMac
+      elsif platform_linux?
+        animate ? CaptureLinuxAnimated : CaptureLinux
+      elsif platform_windows?
+        CaptureWindows
+      elsif platform_cygwin?
+        CaptureCygwin
+      else
+        raise 'Unknown / Unsupported Platform.'
+      end
+    end
+
+    # Are we on a Mac platform?
+    # @return Boolean
+    def self.platform_mac?
+      host_os.include?('darwin')
+    end
+
+    # Are we on a Linux platform?
+    # @return Boolean
+    def self.platform_linux?
+      host_os.include?('linux')
+    end
+
+    # Are we on a Windows platform?
+    # @return Boolean
+    def self.platform_windows?
+      !host_os.match(/(win|w)32/).nil?
+    end
+
+    # Are we on a Cygwin platform?
+    # @return Boolean
+    def self.platform_cygwin?
+      host_os.include?('cygwin')
+    end
+
+    # return host_os identifier from the RbConfig::CONFIG constant
+    # @return String
+    def self.host_os
+      ENV['LOLCOMMITS_FAKE_HOST_OS'] || RbConfig::CONFIG['host_os'].downcase
+    end
+
+    # Is the platform capable of capturing animated GIFs from webcam?
+    # @return Boolean
+    def self.can_animate?
+      platform_linux? || platform_mac?
+    end
+
+    # Is a valid install of imagemagick present on the system?
+    # @return Boolean
+    def self.valid_imagemagick_installed?
+      return false unless command_which('identify')
+      return false unless command_which('mogrify')
+      # you'd expect the below to work on its own, but it only handles old versions
+      # and will throw an exception if IM is not installed in PATH
+      MiniMagick.valid_version_installed?
+    rescue
+      return false
+    end
+
+    # Is a valid install of ffmpeg present on the system?
+    #
+    # @note For now, this just checks for presence, any version should work.
+    # @return Boolean
+    def self.valid_ffmpeg_installed?
+      command_which('ffmpeg')
+    end
+
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    # Idea taken from http://bit.ly/qDaTbY, if only_path is true, only the path
+    # is returned (not the path and command)
+    #
+    # @example
+    #   command_which('ruby') #=> /usr/bin/ruby
+    #
+    # @return Boolean
+    def self.command_which(cmd, only_path = false)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = "#{path}/#{cmd}#{ext}"
+          return only_path ? path : exe if File.executable? exe
+        end
+      end
+      nil
+    end
+
+    # Is `git config color.ui` set to 'always'?
+    #
+    # Due to a bug in the ruby-git library, git config for color.ui cannot be
+    # set to 'always' or it won't read properly.
+    #
+    # This helper method let's us check for that error condition so we can
+    # alert the user in the CLI tool.
+    #
+    # @return Boolean
+    def self.git_config_color_always?
+      `git config color.ui`.chomp =~ /always/
+    end
+
+    # Returns a list of system camera devices in a format suitable to display
+    # to the user.
+    #
+    # @note Currently only functions on Mac.
+    # @return String
+    def self.device_list
+      # TODO: handle other platforms here (linux/windows)
+      if Platform.platform_mac?
+        capturer = Lolcommits::CaptureMacAnimated.new
+        `#{capturer.executable_path} -l`
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin.rb

@@ -0,0 +1,130 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class Plugin
+    include Methadone::CLILogging
+
+    attr_accessor :runner, :options
+
+    def initialize(runner)
+      debug 'Initializing'
+      self.runner = runner
+      self.options = ['enabled']
+    end
+
+    def execute_precapture
+      if enabled?
+        debug 'I am enabled, about to run precapture'
+        run_precapture
+      else
+        debug 'Disabled, doing nothing for precapture execution'
+      end
+    end
+
+    def execute_postcapture
+      if enabled?
+        debug 'I am enabled, about to run postcapture'
+        run_postcapture
+      else
+        debug 'Disabled, doing nothing for postcapture execution'
+      end
+    end
+
+    def run_precapture
+      debug 'base plugin, does nothing to anything'
+    end
+
+    def run_postcapture
+      debug 'base plugin, does nothing to anything'
+    end
+
+    def configuration
+      config = runner.config.read_configuration if runner
+      return {} unless config
+      config[self.class.name] || {}
+    end
+
+    # ask for plugin options
+    def configure_options!
+      puts "Configuring plugin: #{self.class.name}\n"
+      options.reduce({}) do |acc, option|
+        if option != 'enabled'
+          print "#{option}: "
+          val = parse_user_input(STDIN.gets.strip)
+        else
+          val = true
+        end
+
+        # check enabled option isn't a String
+        if (option == 'enabled') && ![true, false].include?(val)
+          puts "Aborting - please respond with 'true' or 'false'"
+          exit 1
+        else
+          acc.merge(option => val)
+        end
+      end
+    end
+
+    def parse_user_input(str)
+      # cater for bools, strings, ints and blanks
+      if 'true'.casecmp(str) == 0
+        true
+      elsif 'false'.casecmp(str) == 0
+        false
+      elsif str =~ /^[0-9]+$/
+        str.to_i
+      elsif str.strip.empty?
+        nil
+      else
+        str
+      end
+    end
+
+    def enabled?
+      configuration['enabled'] == true
+    end
+
+    # check config is valid
+    def valid_configuration?
+      if configured?
+        true
+      else
+        puts "Missing #{self.class.name} config - configure with: lolcommits --config -p #{self.class.name}"
+        false
+      end
+    end
+
+    # empty plugin configuration
+    def 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
+
+    # helper to log errors with a message via debug
+    def log_error(e, message)
+      debug message
+      debug e.backtrace.join("\n")
+    end
+
+    # uniform debug logging for plugins
+    def debug(msg)
+      super("Plugin: #{self.class}: " + msg)
+    end
+
+    # identifying plugin name (for config, listing)
+    def self.name
+      'plugin'
+    end
+
+    # a plugin requests to be run by the runner in one of the possible positions.
+    # valid options are [:precapture, :postcapture]
+    def self.runner_order
+      nil
+    end
+  end
+end

data/lib/lolcommits/plugins/dot_com.rb

@@ -0,0 +1,50 @@
+# -*- encoding : utf-8 -*-
+require 'httmultiparty'
+
+module Lolcommits
+  class DotCom < Plugin
+    BASE_URL = 'http://lolcommits-dot-com.herokuapp.com'.freeze
+
+    def initialize(runner)
+      super
+      options.concat(%w(api_key api_secret repo_id))
+    end
+
+    def run_postcapture
+      return unless valid_configuration?
+
+      t = Time.now.to_i.to_s
+      HTTMultiParty.post(
+        "#{BASE_URL}/git_commits.json",
+        :body => {
+          :git_commit => {
+            :sha              => runner.sha,
+            :repo_external_id => configuration['repo_id'],
+            :image            => File.open(runner.main_image),
+            :raw              => File.open(runner.snapshot_loc)
+          },
+
+          :key   => configuration['api_key'],
+          :t     => t,
+          :token => Digest::SHA1.hexdigest(configuration['api_secret'] + t)
+        })
+    rescue => e
+      log_error(e, "ERROR: HTTMultiParty POST FAILED #{e.class} - #{e.message}")
+    end
+
+    def configured?
+      !configuration['enabled'].nil? &&
+        configuration['api_key'] &&
+        configuration['api_secret'] &&
+        configuration['repo_id']
+    end
+
+    def self.name
+      'dot_com'
+    end
+
+    def self.runner_order
+      :postcapture
+    end
+  end
+end

data/lib/lolcommits/plugins/lol_protonet.rb

@@ -0,0 +1,68 @@
+# -*- encoding : utf-8 -*-
+require 'rest_client'
+
+module Lolcommits
+  class LolProtonet < Plugin
+    def initialize(runner)
+      super
+      options.concat(%w(api_token api_endpoint))
+    end
+
+    def run_postcapture
+      return unless valid_configuration?
+
+      debug "Posting capture to #{configuration['endpoint']}"
+      RestClient.post(
+        api_url,
+        {
+          :files        => [File.new(runner.main_image)],
+          :message      => message
+        },
+        'X-Protonet-Token' => configuration['api_token']
+      )
+    end
+
+    def api_url
+      configuration['api_endpoint']
+    end
+
+    def message
+      "commited some #{random_adjective} #{random_object} to #{runner.git_info.repo}@#{runner.sha} (#{runner.git_info.branch}) "
+    end
+
+    def random_object
+      objects = %w(screws bolts exceptions errors cookies)
+
+      objects.sample
+    end
+
+    def random_adjective
+      adjectives = ['awesome', 'great', 'interesting', 'cool', 'EPIC', 'gut', 'good', 'pansy',
+                    'powerful', 'boring', 'quirky', 'untested', 'german', 'iranian', 'neutral', 'crazy', 'well tested',
+                    'jimmy style', 'nasty', 'bibliographical (we received complaints about the original wording)',
+                    'bombdiggidy', 'narly', 'spiffy', 'smashing', 'xing style',
+                    'leo apotheker style', 'black', 'white', 'yellow', 'shaggy', 'tasty', 'mind bending', 'JAY-Z',
+                    'Kanye (the best ever)', '* Toby Keith was here *', 'splendid', 'stupendulous',
+                    '(freedom fries!)', '[vote RON PAUL]', '- these are not my glasses -', 'typical pansy',
+                    '- ze goggles zey do nothing! -', 'almost working', 'legen- wait for it -', '-dairy!',
+                    ' - Tavonius would be proud of this - ', 'Meg FAILMAN!', '- very brofessional of you -',
+                    'heartbleeding', 'juciy', 'supercalifragilisticexpialidocious', 'failing', 'loving'
+                   ]
+      adjectives.sample
+    end
+
+    def configured?
+      !configuration['enabled'].nil? &&
+        configuration['api_token'] &&
+        configuration['api_endpoint']
+    end
+
+    def self.name
+      'lolprotonet'
+    end
+
+    def self.runner_order
+      :postcapture
+    end
+  end
+end