hubeye 0.2.5 → 0.2.7

data/README.md

@@ -1,7 +1,8 @@
 #Hubeye
 <br />
 Keep track of repositories on Github, get notified when they change and<br />
-(optionally) run local system commands when new commits come in to Github.<br />
+(optionally) run local system commands when new commits get pushed to certain
+repositories.<br />
 <br />
 
 Hubeye is composed of a client and server. Once the server is run,<br />
@@ -11,15 +12,22 @@ prompted by a '>'. Type the name of a Github repository.
 Example: (what the user enters is preceded by the prompt)
 
     >hubeye
-    commit  77b82b54044c16751228
-    tree    8ce18af1461b5c741003
-    parent  ea63fe317fe58dff1c95
-    log tracking info for repos on client quit  => luke-gru
+    log tracking info for repos on client quit
+    => luke-gru
 
-What you see is the latest commit reference, tree reference and parent<br />
-commit reference on Github for that repository. Note that the user did<br />
-not type a username. This is because the user defined a username in his<br />
-~/.hubeye/hubeyerc file.
+What you see is the latest commit msg and committer for that repository.<br />
+Note that the user did not type a username. This is because she defined <br />
+a username in her ~/.hubeye/hubeyerc file.
+
+Once a repo is in the watch list, typing it again will go and see if it has
+changed.
+
+    >hubeye
+    Repository luke-gru/hubeye has not changed.
+
+If, however, luke-gru/hubeye was pushed to since she last typed it in, <br />
+it will tell her that there have been changes, and what the new commit <br />
+message is.
 
 ##Starting Hubeye
 
@@ -35,11 +43,11 @@ your terminal (on <b>t</b>op):
 
     >hubeye -st
 
-Hubeye runs on port 2000 be default. Change the port like this:
+Hubeye runs on port 4545 by default. Change the port like this:
 
     >hubeye -sp 9001
 
-To connect with the client:
+To connect using the client:
 
     >hubeye -c
 
@@ -58,7 +66,7 @@ should be a valid Github username.
 
 ###Keeping track of repositories
 
-Hubeye doesn't actually track any repositories unless you disconnect<br />
+Hubeye doesn't actually enter its tracking loop unless you disconnect<br />
 from the server and leave the server running. This can be done by:
 
     >quit
@@ -69,38 +77,44 @@ It can keep track of as many repos as you want; just keep typing<br />
 them in. If Hubeye finds a change to a repo, it will notify you of the<br />
 changes using your Desktop notification system (libnotify, growl). It will<br />
 also log the changes to your $HOME/.hubeye/log file. If the server is run<br />
-in a terminal (-t option), the changes will also be logged to the terminal.<br
-/>
+in a terminal (-t option), the changes will also be logged to the terminal.<br />
 
-To track your own repository, start the client in the root directory<br />
+Note that since the server is still running, you can connect to it using the<br />
+client any time to add more repos to track, or to check the current commits.
+
+To track your own repository, start the <i>client</i> in the root directory<br />
 of your local git repo:
 
     >.
 
 This only works if a <i>username</i> is added to the hubeyerc, and if the<br />
-Github repository name is the same as the local root directory name.<br />
-ie: '.' put in '/home/luke/code/hubeye' would track https://www.github.com/
-luke-gru/hubeye<br />
-if <i>username</i> was set to luke-gru.<br />
+Github repository name is the same as the basename of $PWD<br />
+ie: '.' put in '/home/luke/code/hubeye' would track https://www.github.com/luke-gru/hubeye
+if <i>username</i> were set to luke-gru.<br />
 
 You can add another user's repo like this:
 
     >rails/rails
 
-This adds https://github.com/rails/rails to the watch list.<br />
+This adds <b>https://github.com/rails/rails</b> to the watch list.<br />
 Hubeye does not remove a repo from the watch list unless explicitly<br />
 told to do so:
 
     >rm luke-gru/hubeye
 
-To see a list of all repos (with recent commit messages) in the watch (track) list:
+To see a list of all repos that Hubeye is tracking:
 
     >tracking
 
+To see a more detailed list, including commit messages:
+
+    >tracking -d
+
 ###Desktop Notification
 <i>On Linux: install libnotify-bin. On Mac: install growl (if not already installed).<br />
-The autotest gem is needed for Desktop notification to work in both
-cases.</i><br />
+The autotest gem is needed for Desktop notification to work with growl.<br />
+Desktop notification is currently untested with growl, so please send error reports if<br />
+you have any problems, or fork Hubeye and help out!</i>
 
 ###Shutting down and persistence between sessions
 
@@ -119,23 +133,22 @@ A way to interactively save all currently tracked repositories:
 
     >save repos as my_work_repos
 
-And then load any time (even after a shutdown; next session, next week, etc...)
+And then load them any time (even after a shutdown, next session, next week, etc...)
 
     >load repos my_work_repos
 
+This puts the repository names in the watch list with their most recent commits,
+not the commits that were being tracked when you saved the repos.
+
 ###Working with hooks
 
     >hook add rails/rails dir: /path/to/local/rails cmd: git pull origin master
 
-When <b>https://www.github.com/rails/rails</b> changes, a process will start,
-<br />
-change to the selected directory and execute the command. The <i>(dir: /my/dir)
-<br />
-</i> part is optional, and when ignored won't change directories. In this
-case,
-<br />
-the directory will be where the hubeye server was originally
-started from.<br />
+When <b>https://www.github.com/rails/rails</b> changes, a process will start, <br />
+change to the selected directory and execute the command. The <i>(dir: /my/dir)</i><br />
+part is optional, and when ignored won't change directories. In that case,<br />
+the directory in which the command is executed will be where the Hubeye server<br />
+was originally started.<br />
 
 To see all currently loaded hooks:
 
@@ -149,8 +162,7 @@ Then, next weekend:
 
     >load hooks weekend_projects_hooks
 
-These hooks, of course, will only really do anything if the repositories they
-<br />
+These hooks, of course, will only really do anything if the repositories they <br />
 are hooked to are currently being watched. This is not done automatically.
 
 ###All ~/.hubeyerc configurations
@@ -159,31 +171,27 @@ When the server is started, the options are set here.
 
     username: luke-gru
     track: username/reponame, username2/reponame2, myreponame
-    oncearound = 90
+    oncearound: 90
     load hooks: myhook1, myworkhooks
     load repos: workprojects, funprojects
-    desktop notification: on/off
+    desktop notification: on
 
-<i>username</i>: username used for Github URLS when the full path is not
-given<br />
-inside of the client.<br />
+<i>username</i>: username used for Github URLS when the full path is not <br />
+given inside of the client <br />
 
 <i>track</i>: default repositories to watch for changes upon server start<br />
 
-<i>oncearound</i>: number of seconds before completing a check of every repo in<br />
-the watch list for changes<br />
+<i>oncearound</i>: number of seconds before completing a check of every repo in <br />
+the watch list for changes <br />
 
-<i>load hooks</i>: load hooks on server start. To see how to save hooks in the
-<br />
-client, see the <i>Working with hooks</i> section<br />
+<i>load hooks</i>: load hooks on server start. To see how to save hooks in the <br />
+client, see the <i>Working with hooks</i> section <br />
 
-<i>load repos</i>: load repos on server start. To see how to save repos in the
-<br />
+<i>load repos</i>: load repos on server start. To see how to save repos in the <br />
 client, see the <i>Shutting down and persistence between sessions</i> section.
 <br />
 
-<i>desktop notification</i>: whether to notify of repo changes using libnotify
-<br />
+<i>desktop notification</i>: whether to notify of repo changes using libnotify <br />
 or growl. This is set to <i>on</i> by default. However, if no notification<br />
-system is found, it is ignored.
+system is found, it is ignored. Set it to <i>off</i> if you don't want it.
 

data/VERSION.rb

@@ -1,5 +1,5 @@
 class Hubeye
-  # 0.2.5 since Dec. 4, 2011
-  VERSION = [0,2,5]
+  # 0.2.7 since Dec. 4, 2011
+  VERSION = [0,2,7]
 end
 

data/bin/hubeye

@@ -12,7 +12,7 @@ require 'ostruct'
 unless File.exists?(File.join(ENV['HOME'],'.hubeye'))
   require 'rake'
 
-  require File.join(ROOTDIR, 'tasks/install')
+  require File.join(ROOTDIR, 'tasks', 'install')
   Rake.application['install'].invoke
 end
 
@@ -83,7 +83,7 @@ class Hubeye
       daemonized = options.server_daemonized
       if options.server_wanted
         unless port_open?(port)
-          puts "Other instances are running"
+          puts "A service is already running on this port"
           exit 1
         end
         require File.join(LIBDIR, 'server', 'hubeye_server')
@@ -91,15 +91,17 @@ class Hubeye
           start_server(port, :daemon => true) :
           start_server(port, :daemon => false)
       else
+        ['INT', 'KILL'].each do |sig|
+          trap(sig) { STDOUT.puts; exit 1 }
+        end
         require File.join(LIBDIR, 'client', 'hubeye_client')
         start_client(host, port)
       end
     end
 
-
     def port_open?(port)
-      # this is the solution until multi-threading or forking is implemented
-      # on the TCP server
+      # will change this to a more platform-agnostic method, like
+      # rescuing busy port exceptions.
       listening_tcps = `netstat -l --tcp --numeric`
       if /#{port}/ =~ listening_tcps
         return false
@@ -107,7 +109,6 @@ class Hubeye
       true
     end
 
-
     def start_server(port, options={})
       server = HubeyeServer.new(true) # debug: true
       if options[:daemon]

data/lib/client/hubeye_client.rb

@@ -62,11 +62,15 @@ class HubeyeClient
         STDOUT.print '> '
         STDOUT.flush
         local = STDIN.gets
-        if local.match(/^\.$/) # '.' = pwd
-          # Send the line to the server, daemons gem strips some special chars (/, :)
-          @s.puts(local.gsub(/\A\.\Z/, "pwd" + Dir.pwd.split('/').last))
-        else
-          @s.puts(local.gsub(/\//, 'diiv'))
+        begin
+          if local.match(/^\.$/) # '.' = pwd
+            # Send the line to the server, daemons gem strips some special chars (/, :)
+            @s.puts(local.gsub(/\A\.\Z/, "pwd" + Dir.pwd.split('/').last))
+          else
+            @s.puts(local.gsub(/\//, 'diiv'))
+          end
+        rescue Errno::EPIPE
+          exit 1
         end
         @s.flush
         if local =~ /load repo/
@@ -80,7 +84,6 @@ class HubeyeClient
         rescue EOFError
           response = "Bye!"
         end
-
         if response.chop.strip == "Bye!"
           puts response.chop
           @s.close

data/lib/log/logger.rb

@@ -1,35 +1,37 @@
-class Logger
-  LOG_DIR = File.join(ENV['HOME'], '.hubeye', 'log')
+module Log
+  class Logger
+    LOG_DIR = File.join(ENV['HOME'], '.hubeye', 'log')
 
-  def self.log(msg)
-    File.open(LOG_DIR, "a") do |f|
-      f.puts(msg)
+    def self.log(msg)
+      File.open(LOG_DIR, "a") do |f|
+        f.puts(msg)
+      end
     end
-  end
 
-  def self.relog(msg)
-    #wipe the file and start anew
-    File.open(LOG_DIR, "w") do |f|
-      f.puts(msg)
+    def self.relog(msg)
+      #wipe the file and start anew
+      File.open(LOG_DIR, "w") do |f|
+        f.puts(msg)
+      end
     end
-  end
 
-  # If {include_terminal: true}, log to the terminal too (make sure that the
-  # process is not daemonized). Always log to the logfile.
+    # If {include_terminal: true}, log to the terminal too (make sure that the
+    # process is not daemonized). Always log to the logfile.
 
-  def self.log_change(repo_name, commit_msg, committer, options={})
-    opts = {:include_terminal => false}.merge options
-    change_msg = <<-MSG
-    ===============================
-    Repository: #{repo_name.downcase.strip} has changed (#{Time.now.strftime("%m/%d/%Y at %I:%M%p")})
-    Commit msg: #{commit_msg}
-    Committer : #{committer}
-    ===============================
-    MSG
-    if opts[:include_terminal]
-      STDOUT.puts change_msg
+    def self.log_change(repo_name, commit_msg, committer, options={})
+      opts = {:include_terminal => false}.merge options
+      change_msg = <<-MSG
+      ===============================
+      Repository: #{repo_name.downcase.strip} has changed (#{Time.now.strftime("%m/%d/%Y at %I:%M%p")})
+      Commit msg: #{commit_msg}
+      Committer : #{committer}
+      ===============================
+      MSG
+      if opts[:include_terminal]
+        STDOUT.puts change_msg
+      end
+      log(change_msg)
     end
-    log(change_msg)
-  end
 
+  end
 end

data/lib/notification/{notification.rb → finder.rb}

@@ -1,5 +1,9 @@
 module Notification
 
+  dir =  File.dirname(__FILE__)
+  CHANGE_ICON      = "change_icon.jpg"
+  CHANGE_ICON_PATH = File.expand_path(File.join(dir, "..", "images", CHANGE_ICON))
+
   class Finder
 
     def self.find_notify
@@ -46,7 +50,7 @@ module Notification
           end
         end
         if defined? Autotest
-          return true
+          true
         end
       end
 
@@ -62,7 +66,7 @@ module Notification
           end
         end
         if defined? Autotest
-          return true
+          true
         end
       end
     end

data/lib/notification/gnomenotify.rb

@@ -1,11 +1,12 @@
-module Autotest::GnomeNotify
+module Notification
+  module GnomeNotify
 
-  EXPIRATION_IN_SECONDS = 2
-  CHANGE_ICON = File.join(File.expand_path("images", ::Environment::ROOTDIR), "change_icon.jpg")
+    EXPIRATION_IN_SECONDS = 2
 
-  def self.notify(title, msg, img=CHANGE_ICON)
-    options = "-t #{EXPIRATION_IN_SECONDS * 1000} -i #{img}"
-    system "notify-send #{options} '#{title}' '#{msg}'"
-  end
+    def self.notify(title, msg, img=CHANGE_ICON_PATH)
+      options = "-t #{EXPIRATION_IN_SECONDS * 1000} -i #{img}"
+      system "notify-send #{options} '#{title}' '#{msg}'"
+    end
 
+  end
 end

data/lib/notification/growl.rb

@@ -1,11 +1,12 @@
-module Autotest::Growl
+module Autotest
+  module Growl
 
-  EXPIRATION_IN_SECONDS = 2
-  dir =  File.dirname(__FILE__)
-  CHANGE_ICON = File.expand_path(dir + "/../images/change_icon.jpg")
+    EXPIRATION_IN_SECONDS = 2
+    IMG = ::Notification::CHANGE_ICON_PATH
 
-  def self.growl(title, msg, img=CHANGE_ICON, pri=0, stick="")
-    system "growlnotify  -n autotest --image #{img} -p #{pri} -m #{msg.inspect} #{title} #{stick}"
-  end
+    def self.growl(title, msg, img=IMG, pri=0, stick="")
+      system "growlnotify  -n autotest --image #{img} -p #{pri} -m #{msg.inspect} #{title} #{stick}"
+    end
 
+  end
 end

data/lib/server/hubeye_server.rb

@@ -1,3 +1,6 @@
+require "log/logger"
+include Log
+
 class Hubeye
 
   # simple interface to Github's api v3 for commits
@@ -53,8 +56,7 @@ class Hubeye
     require 'open-uri'
     # hubeye
     require "config/parser"
-    require "log/logger"
-    require "notification/notification"
+    require "notification/finder"
     require "hooks/git_hooks"
     require "hooks/executer"
     require "helpers/time"
@@ -110,6 +112,11 @@ class Hubeye
         opts = {:internal_input => nil}.merge options
         if !opts[:internal_input]
           @input = server.socket.gets
+          # check if the client pressed ^C or ^D
+          if @input.nil?
+            @server.remote_connection = false
+            throw(:invalid_input)
+          end
           @input.chop!
         else
           @input = opts[:internal_input]
@@ -174,7 +181,7 @@ class Hubeye
           @sockets.delete(@socket)
           @socket.close
           unless @server.daemonized
-            STDOUT.puts "Shutdown gracefully."
+            STDOUT.puts "Shutting down gracefully."
           end
           exit 0
         end
@@ -534,8 +541,10 @@ EOS
           look_for_changes unless @remote_connection
         end
         client_connect(@sockets) if waiting
-        strategy = Strategy.new(self)
-        strategy.call
+        catch(:invalid_input) do
+          strategy = Strategy.new(self)
+          strategy.call
+        end
         @session.cleanup
       end
     end
@@ -564,7 +573,7 @@ EOS
           end
         rescue
           @socket.puts "Not a Github repository name"
-          return
+          throw(:invalid_input)
         end
         new_info =
           {full_repo_name =>
@@ -602,6 +611,13 @@ EOS
     def setup_env(options={})
       @daemonized = options[:daemon]
       @sockets = [@server]  # An array of sockets we'll monitor
+      ['INT', 'KILL'].each do |sig|
+        trap(sig) do
+          @sockets.each {|s| s.close}
+          STDOUT.puts
+          exit 1
+        end
+      end
       @session = Session.new
       unless CONFIG[:default_track].nil?
         CONFIG[:default_track].each do |repo|
@@ -665,7 +681,7 @@ EOS
                 "#{commit_msg}\n=> #{committer}"
               case CONFIG[:desktop_notification]
               when "libnotify"
-                Autotest::GnomeNotify.notify("Hubeye", change_msg)
+                Notification::GnomeNotify.notify("Hubeye", change_msg)
                 Logger.log_change(full_repo_name, commit_msg, committer)
               when "growl"
                 Autotest::Growl.growl("Hubeye", change_msg)
@@ -680,7 +696,6 @@ EOS
               # execute any hooks for that repository
               unless @session.hooks.nil? || @session.hooks.empty?
                 if hooks = @session.hooks[full_repo_name]
-                  hooks = hooks.dup
                   hooks.each do |dir,cmds|
                     # execute() takes [commands], {options} where
                     # options = :directory and :repo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubeye
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -32,7 +32,7 @@ files:
 - lib/client/hubeye_client.rb
 - lib/notification/growl.rb
 - lib/notification/gnomenotify.rb
-- lib/notification/notification.rb
+- lib/notification/finder.rb
 - lib/server/hubeye_server.rb
 - lib/hooks/executer.rb
 - lib/hooks/git_hooks.rb