lolcommits 0.5.2 → 0.5.3

data/lib/lolcommits/plugins/lol_twitter.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'yaml'
 require 'oauth'
 
@@ -8,7 +9,6 @@ $VERBOSE = original_verbose # activate warning messages again.
 
 module Lolcommits
   class LolTwitter < Plugin
-
     TWITTER_CONSUMER_KEY    = 'qc096dJJCxIiqDNUqEsqQ'
     TWITTER_CONSUMER_SECRET = 'rvjNdtwSr1H0TvBvjpk6c4bvrNydHmmbvv7gXZQI'
     TWITTER_RETRIES         = 2
@@ -28,18 +28,18 @@ module Lolcommits
           puts "\t--> Tweet Sent!"
         end
       rescue Twitter::Error::InternalServerError,
-               Twitter::Error::BadRequest,
-               Twitter::Error::ClientError => e
+             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 build_tweet(commit_message, tag = "#lolcommits")
+    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)]}..."
+        commit_message = "#{commit_message[0..(available_commit_msg_size - 3)]}..."
       end
       "#{commit_message} #{tag}"
     end
@@ -48,25 +48,25 @@ module Lolcommits
       options = super
       # ask user to configure tokens if enabling
       if options['enabled'] == true
-        if auth_config = configure_auth!
+        auth_config = configure_auth!
+        if auth_config
           options.merge!(auth_config)
         else
-          # return nil if configure_auth failed
-          return
+          return # return nil if configure_auth failed
         end
       end
-      return options
+      options
     end
 
     def configure_auth!
-      puts "---------------------------"
-      puts "Need to grab twitter tokens"
-      puts "---------------------------"
+      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',
+                                     :site => 'https://api.twitter.com',
+                                     :request_endpoint => 'https://api.twitter.com',
                                      :sign_in => true)
 
       request_token = consumer.get_request_token
@@ -99,7 +99,7 @@ module Lolcommits
       end
     end
 
-    def is_configured?
+    def configured?
       !configuration['enabled'].nil? &&
         configuration['access_token'] &&
         configuration['secret']

data/lib/lolcommits/plugins/lolsrv.rb

@@ -1,45 +1,45 @@
-require "rest_client"
-require "pp"
-require "json"
-require "logger"
+# -*- encoding : utf-8 -*-
+require 'rest_client'
+require 'pp'
+require 'json'
+require 'logger'
 
 module Lolcommits
   class Lolsrv < Plugin
-
     def initialize(runner)
       super
       self.options << 'server'
       if self.runner
-        @logger = Logger.new(File.new(self.runner.config.loldir + "/lolsrv.log", "a+"))
+        @logger = Logger.new(File.new(self.runner.config.loldir + '/lolsrv.log', 'a+'))
       end
     end
 
     def run
       return unless valid_configuration?
-      fork { sync() }
+      fork { sync }
     end
 
-    def is_configured?
-      !configuration["enabled"].nil? && configuration["server"]
+    def configured?
+      !configuration['enabled'].nil? && configuration['server']
     end
 
     def sync
-      existing = get_existing_lols
+      existing = existing_lols
       unless existing.nil?
-        Dir[self.runner.config.loldir + "/*.{jpg,gif}"].each do |item|
-          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
       end
     end
 
-    def get_existing_lols
+    def existing_lols
       begin
         lols = JSON.parse(
-        RestClient.get(configuration['server'] + "/lols"))
-        lols.map { |lol| lol["sha"] }
+        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
@@ -49,12 +49,14 @@ module Lolcommits
     def upload(file, sha)
       begin
         RestClient.post(
-          configuration["server"] + "/uplol",
+          configuration['server'] + '/uplol',
           :lol => File.new(file),
-          :sha => sha
-        )
+          :url => self.runner.url + sha,
+          :repo => self.runner.repo,
+          :date => File.ctime(file),
+          :sha => sha)
       rescue => e
-        log_error(e,"ERROR: Upload of lol #{sha} FAILED #{e.class} - #{e.message}")
+        log_error(e, "ERROR: Upload of lol #{sha} FAILED #{e.class} - #{e.message}")
         return
       end
     end
@@ -66,7 +68,7 @@ module Lolcommits
     end
 
     def self.name
-      "lolsrv"
+      'lolsrv'
     end
   end
 end

data/lib/lolcommits/plugins/loltext.rb

@@ -1,23 +1,23 @@
+# -*- encoding : utf-8 -*-
 module Lolcommits
   class Loltext < Plugin
-
     def initialize(runner)
       super
       @font_location = runner ? runner.font : nil
     end
 
     # enabled by default (if no configuration exists)
-    def is_enabled?
-      !is_configured? || super
+    def enabled?
+      !configured? || super
     end
 
     def run
       font_location = @font_location || File.join(Configuration::LOLCOMMITS_ROOT,
-                                                  "vendor",
-                                                  "fonts",
-                                                  "Impact.ttf")
+                                                  'vendor',
+                                                  'fonts',
+                                                  'Impact.ttf')
 
-      debug "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'
@@ -45,10 +45,9 @@ module Lolcommits
     end
 
     def self.name
-     'loltext'
+      'loltext'
     end
 
-
     private
 
     # do whatever is required to commit message to get it clean and ready for imagemagick

data/lib/lolcommits/plugins/tranzlate.rb

@@ -1,9 +1,9 @@
+# -*- 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},
@@ -33,7 +33,7 @@ module Lolspeak
     /age/              => %w{uj},
     /like/             => %w{likez liek licks},
     /love/             => %w{lovez lub lubs luv lurve lurves},
-    /\bis\b/           => ['ar teh','ar'],
+    /\bis\b/           => ['ar teh', 'ar'],
     /nd\b/             => %w{n n'},
     /who/              => %w{hoo},
     /'/                => [''],
@@ -78,13 +78,13 @@ module Lolspeak
     /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'],
+    /(?:god\b|allah|buddah?|diety|lord)/         => ['ceiling cat']
   }
 
   def tranzlate(str)
     lolstr = str.dup
     LOL_DICTIONARY.each do |english, lolspeak|
-      #ghetto ruby1.8/1.9 agnostic version of choice vs sample
+      # ghetto ruby1.8/1.9 agnostic version of choice vs sample
       lolstr.gsub!(english, lolspeak.shuffle.first)
     end
 
@@ -97,7 +97,6 @@ end
 
 module Lolcommits
   class Tranzlate < Plugin
-
     extend Lolspeak
 
     def run

data/lib/lolcommits/plugins/uploldz.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'rest_client'
 
 module Lolcommits
@@ -6,7 +7,7 @@ module Lolcommits
 
     def initialize(runner)
       super
-      self.options << 'endpoint'
+      self.options.concat(['endpoint', 'optional_key'])
     end
 
     def run
@@ -14,17 +15,18 @@ module Lolcommits
 
       repo = self.runner.repo.to_s
       if repo.empty?
-        puts "Repo is empty, skipping upload"
+        puts 'Repo is empty, skipping upload'
       else
-        debug "Calling " + configuration['endpoint'] + " with repo " + repo
+        debug 'Calling ' + configuration['endpoint'] + ' with repo ' + repo
         RestClient.post(configuration['endpoint'],
-          :file => File.new(self.runner.main_image),
-          :repo => repo)
+                        :file => File.new(self.runner.main_image),
+                        :repo => repo,
+                        :key => configuration['optional_key'])
       end
     end
 
-    def is_configured?
-      !configuration["enabled"].nil? && configuration["endpoint"]
+    def configured?
+      !configuration['enabled'].nil? && configuration['endpoint']
     end
 
     def self.name

data/lib/lolcommits/runner.rb

@@ -1,10 +1,11 @@
+# -*- encoding : utf-8 -*-
 module Lolcommits
   PLUGINS = Lolcommits::Plugin.subclasses
 
   class Runner
     attr_accessor :capture_delay, :capture_stealth, :capture_device, :message, :sha,
-      :snapshot_loc, :main_image, :repo, :config, :repo_internal_path,
-      :font, :capture_animate
+                  :snapshot_loc, :main_image, :repo, :config, :repo_internal_path,
+                  :font, :capture_animate, :url
 
     include Methadone::CLILogging
     include ActiveSupport::Callbacks
@@ -20,7 +21,7 @@ module Lolcommits
     set_callback :run, :after,  :execute_lolcommits_loltext
     # Executed First
 
-    def initialize(attributes={})
+    def initialize(attributes = {})
       attributes.each do |attr, val|
         self.send("#{attr}=", val)
       end
@@ -31,6 +32,7 @@ module Lolcommits
         self.message = git_info.message if self.message.nil?
         self.repo_internal_path = git_info.repo_internal_path
         self.repo = git_info.repo
+        self.url  = git_info.url
       end
     end
 
@@ -38,7 +40,7 @@ module Lolcommits
       die_if_rebasing!
 
       run_callbacks :run do
-        puts "*** Preserving this moment in history." unless capture_stealth
+        puts '*** Preserving this moment in history.' unless capture_stealth
         self.snapshot_loc = self.config.raw_image(image_file_type)
         self.main_image   = self.config.main_image(self.sha, image_file_type)
         capturer = capturer_class.new(
@@ -60,6 +62,7 @@ module Lolcommits
     end
 
     private
+
     def capturer_class
       "Lolcommits::Capture#{Configuration.platform}#{animate? ? 'Animated' : nil}".constantize
     end
@@ -70,22 +73,23 @@ module Lolcommits
   end
 
   protected
+
   def die_if_rebasing!
     debug "Runner: Making sure user isn't rebasing"
     if not self.repo_internal_path.nil?
-      mergeclue = File.join self.repo_internal_path, "rebase-merge"
+      mergeclue = File.join self.repo_internal_path, 'rebase-merge'
       if File.directory? mergeclue
-        debug "Runner: Rebase detected, silently exiting!"
+        debug 'Runner: Rebase detected, silently exiting!'
         exit 0
       end
     end
   end
 
   def resize_snapshot!
-    debug "Runner: resizing snapshot"
+    debug 'Runner: resizing snapshot'
     image = MiniMagick::Image.open(self.snapshot_loc)
-    if (image[:width] > 640 || image[:height] > 480)
-      #this is ghetto resize-to-fill
+    if image[:width] > 640 || image[:height] > 480
+      # this is ghetto resize-to-fill
       image.combine_options do |c|
         c.resize '640x480^'
         c.gravity 'center'
@@ -99,7 +103,7 @@ module Lolcommits
   end
 
   def cleanup!
-    debug "Runner: running cleanup"
+    debug 'Runner: running cleanup'
     # clean up the captured image and any other raw assets
     FileUtils.rm(self.snapshot_loc)
     FileUtils.rm_f(self.config.video_loc)

data/lib/lolcommits/version.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Lolcommits
-  VERSION = "0.5.2"
+  VERSION = '0.5.3'
 end

data/lolcommits.gemspec

@@ -30,11 +30,15 @@ Gem::Specification.new do |s|
   # development dependencies
   s.add_development_dependency('rdoc')
   s.add_development_dependency('aruba', '~> 0.5.1')
-  s.add_development_dependency('rake',' ~> 10.0.2')
+  s.add_development_dependency('rake', '~> 10.0.2')
   s.add_development_dependency('fivemat')
   s.add_development_dependency('faker')
   s.add_development_dependency('travis')
   s.add_development_dependency('coveralls')
+  s.add_development_dependency('magic_encoding')
+  if RUBY_VERSION >= '1.9.2'
+    s.add_development_dependency('rubocop', '~> 0.18.1')
+  end
 
   # plugin dependencies
   s.add_runtime_dependency('twitter', '~> 4.8.1')     #twitter

data/rubocop-todo.yml

@@ -0,0 +1,249 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-02-10 12:40:38 -0500 using RuboCop version 0.18.1.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offence count: 22
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+# Offence count: 1
+CaseEquality:
+  Enabled: false
+
+# Offence count: 1
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+# NOTE: Not sure I agree with this one. -mroth
+CaseIndentation:
+  Enabled: false
+
+# Offence count: 2
+FavorSprintf:
+  Enabled: false
+
+# Offence count: 8
+FavorUnlessOverNegatedIf:
+  Enabled: false
+
+# Offence count: 7
+IfUnlessModifier:
+  Enabled: false
+
+# Offence count: 8
+Not:
+  Enabled: false
+
+# Offence count: 1
+# Cop supports --auto-correct.
+Proc:
+  Enabled: false
+
+# Offence count: 3
+RedundantBegin:
+  Enabled: false
+
+# Offence count: 67
+# Cop supports --auto-correct.
+# NOTE: I want to understand this one better before auto it -mroth
+RedundantSelf:
+  Enabled: false
+
+# Offence count: 1
+# NOTE: Eh, I don't like this one, I think they are more readable? -mroth
+OneLineConditional:
+  Enabled: false
+
+# Offence count: 2
+UselessAssignment:
+  Enabled: false
+
+# Offence count: 23
+Documentation:
+  Enabled: false
+
+# Offence count: 1
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 169
+
+# Offence count: 73
+LineLength:
+  Max: 179
+
+# Offence count: 19
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 32
+
+# Offence count: 2
+# Cop supports --auto-correct.
+WordArray:
+  MinSize: 3
+
+# Offence count: 1
+RegexpLiteral:
+  MaxSlashes: 2
+
+# Offence count: 3
+CyclomaticComplexity:
+  Max: 10
+
+# Offence count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+# RedundantReturn:
+#   Enabled: true
+
+# Offence count: 1
+# AccessorMethodName:
+#   Enabled: true
+
+# Offence count: 2
+# Cop supports --auto-correct.
+# AlignArray:
+#   Enabled: true
+
+# Offence count: 7
+# Cop supports --auto-correct.
+# AlignParameters:
+#   Enabled: true
+
+# Offence count: 3
+# Configuration parameters: AllowSafeAssignment.
+# AssignmentInCondition:
+#   Enabled: true
+
+# Offence count: 2
+# Cop supports --auto-correct.
+# Blocks:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredMethods.
+# CollectionMethods:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# ColonMethodCall:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# EmptyLines:
+#   Enabled: true
+
+# Offence count: 3
+# EmptyLinesAroundAccessModifier:
+#   Enabled: true
+
+# Offence count: 19
+# Cop supports --auto-correct.
+# EmptyLinesAroundBody:
+#   Enabled: true
+
+# Offence count: 4
+# Cop supports --auto-correct.
+# EmptyLiteral:
+#   Enabled: true
+
+# Offence count: 2
+# IndentationWidth:
+#   Enabled: true
+
+# Offence count: 8
+# Cop supports --auto-correct.
+# LeadingCommentSpace:
+#   Enabled: true
+
+# Offence count: 7
+# Cop supports --auto-correct.
+# MethodCallParentheses:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowSafeAssignment.
+# ParenthesesAroundCondition:
+#   Enabled: true
+
+# Offence count: 13
+# Configuration parameters: NamePrefixBlacklist.
+# PredicateName:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SignalException:
+#   Enabled: true
+
+# Offence count: 7
+# Cop supports --auto-correct.
+# SpaceAfterComma:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# SpaceAfterControlKeyword:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# SpaceAfterNot:
+#   Enabled: true
+
+# Offence count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SpaceAroundBlockBraces:
+#   Enabled: true
+
+# Offence count: 2
+# Cop supports --auto-correct.
+# SpaceAroundEqualsInParameterDefault:
+#   Enabled: true
+
+# Offence count: 4
+# Cop supports --auto-correct.
+# SpaceAroundOperators:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# SpaceInsideBrackets:
+#   Enabled: true
+
+# Offence count: 5
+# Cop supports --auto-correct.
+# SpaceInsideParens:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# SpecialGlobalVars:
+#   Enabled: true
+
+# Offence count: 178
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# StringLiterals:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# TrailingBlankLines:
+#   Enabled: true
+
+# Offence count: 1
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+# TrailingComma:
+#   Enabled: true
+
+# Offence count: 1
+# Cop supports --auto-correct.
+# TrailingWhitespace:
+#   Enabled: true