hubeye 0.3.3 → 0.3.5

data/README.md

@@ -1,4 +1,5 @@
 #Hubeye
+
 <br />
 Keep track of repositories on Github, get notified when they change and<br />
 (optionally) run local system commands when new commits get pushed to certain
@@ -7,56 +8,56 @@ repositories.<br />
 
 Hubeye is composed of a client and server. Once the server is run,<br />
 you can connect to it via the client. Once connected, you'll be<br />
-prompted by a '>'. Type the name of a Github repository.
+prompted by a '>'. Type in the name of a Github repository.
 
 Example: (what the user enters is preceded by the prompt)
 
-    >hubeye
+    > hubeye
     log tracking info for repos on client quit
     => luke-gru
 
-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.
+What you see is the latest commit message and committer for that repository.<br />
+Note that we did not type a username. This is because we defined <br />
+a username in our ~/.hubeye/hubeyerc file.
 
 Once a repo is in the watch list, typing it again will go and see if it has
 changed.
 
-    >hubeye
+    > 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 />
+If, however, luke-gru/hubeye was pushed to since we last typed it in, <br />
+it'll tell us that there have been changes, and what the new commit <br />
 message is.
 
 ##Starting Hubeye
 
 To start the server:
 
-    >hubeye -s
+    > hubeye -s
 or just
 
-    >hubeye
+    > hubeye
 
 This starts the server as a daemonized process. To run the server in<br />
-your terminal (on <b>t</b>op):
+your <b>t</b>erminal:
 
-    >hubeye -st
+    > hubeye -st
 
 Hubeye runs on port 4545 by default. Change the port like this:
 
-    >hubeye -sp 9001
+    > hubeye -sp 9001
 
 To connect using the client:
 
-    >hubeye -c
+    > hubeye -c
 
 For more options:
 
-    >hubeye -h
+    > hubeye -h
 
 
-###~/.hubeye/hubeyerc
+##Basic ~/.hubeye/hubeyerc Configuration
 
     username: luke-gru
 
@@ -64,20 +65,29 @@ This allows the user to type a repository name only, and to receive<br />
 information regarding that <i>username</i>'s repository. The username<br />
 should be a valid Github username.
 
-###Keeping track of repositories
+##Keeping Track of Repositories
+
+You can add another user's repo like this:
+
+    > rails/rails
+or
+    > add rails/rails
+
+If you want to add multiple repos at once, separated by spaces, use the<br />
+<i>'add repo1 repo2'</i> syntax
 
 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
+    > quit
     Bye!
 
-If Hubeye has any repos to watch (track), it will watch Github for changes.<br />
+If Hubeye has any repos to track, it will watch Github for changes.<br />
 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 there.<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.
@@ -85,30 +95,31 @@ 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 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 <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
+    > rm luke-gru/hubeye
+
+To remove all tracked repos, simply:
+
+    > rm -a
 
 To see a list of all repos that Hubeye is tracking:
 
-    >tracking
+    > tracking
 
 To see a more detailed list, including commit messages:
 
-    >tracking -d
+    > tracking -d
 
 ###Desktop Notification
 <i>On Linux: install libnotify-bin. On Mac: install growl (if not already installed).<br />
@@ -116,9 +127,9 @@ 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
+###Shutting Down and Persistence Between Sessions
 
-    >shutdown
+    > shutdown
 
 Next time you start up the server, the watch list will be empty<br />
 (and so will the log file). In order to have a default watch list:
@@ -131,18 +142,18 @@ These will be watched automatically when starting up the server.<br />
 
 A way to interactively save all currently tracked repositories:
 
-    >save repos as my_work_repos
+    > save repos as my_work_repos
 
 And then load them any time (even after a shutdown, next session, next week, etc...)
 
-    >load repos my_work_repos
+    > 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
+###Working with Hooks
 
-    >hook add rails/rails dir: /path/to/local/rails cmd: git pull origin master
+    > 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)</i><br />
@@ -150,22 +161,30 @@ 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 />
 
+If you want to call your own script with a hook and pass it the changed repo<br />
+name, you can find the changed repo name by accessing <b>ENV['HUBEYE_CHANGED_REPO']</b><br />
+in your script. Example:
+
+    > hook add rails/rails dir: /path/to/email/script cmd: ./email_me.rb
+
+In <i>email_me.rb</i>, <b>ENV['HUBEYE_CHANGED_REPO']</b> will be <i>rails/rails</i>.
+
 To see all currently loaded hooks:
 
-    >hook list
+    > hook list
 
 To save all hooks for next sessions (after a server shutdown)
 
-    >save hooks as weekend_projects_hooks
+    > save hooks as weekend_projects_hooks
 
 Then, next weekend:
 
-    >load hooks weekend_projects_hooks
+    > load hooks weekend_projects_hooks
 
 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
+###All ~/.hubeye/hubeyerc Configurations
 
 When the server is started, the options are set here.
 
@@ -184,14 +203,14 @@ given inside of the client <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 />
+<i>load hooks</i>: hooks to load 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>: repos to load 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 />
 or growl. This is set to <i>on</i> by default. However, if no notification<br />
-system is found, it is ignored. Set it to <i>off</i> if you don't want it.
+system is found, it is ignored.
 

data/VERSION.rb

@@ -1,5 +1,5 @@
 module Hubeye
-  # 0.3.3 since Jan. 28, 2012
-  VERSION = [0,3,3]
+  # 0.3.5 since 10 Feb. 2012
+  VERSION = [0,3,5]
 end
 

data/bin/hubeye

@@ -1,13 +1,11 @@
 #!/usr/bin/env ruby
 
-module Hubeye
+require File.join(File.expand_path(File.dirname(__FILE__) + "/../"), "lib/hubeye/config/environment")
 
-  # require environment and VERSION files
-  require File.join(File.expand_path(File.dirname(__FILE__) + "/../"), "lib/hubeye/config/environment")
+module Hubeye
   include Environment
   require File.join(ROOTDIR, 'VERSION')
 
-  # standard lib
   require 'optparse'
   require 'ostruct'
 
@@ -83,19 +81,17 @@ module Hubeye
       options = Options.parse(ARGV)
       host = options.host
       port = options.port
-      daemonized = options.server_daemonized
       if options.server_wanted
         unless port_open?(port)
           puts "A service is already running on this port"
           exit 1
         end
         require File.join('hubeye', 'server', 'server')
-        options.server_daemonized ?
-          start_server(port, :daemon => true) :
-          start_server(port, :daemon => false)
+        start_server(port, :daemon => options.server_daemonized)
       else
+        # move this to client script
         ['INT', 'KILL'].each do |sig|
-          trap(sig) { STDOUT.puts; exit 1 }
+          trap(sig) { STDOUT.print("\n"); exit 1 }
         end
         require File.join('hubeye', 'client', 'client')
         start_client(host, port)
@@ -112,7 +108,7 @@ module Hubeye
       true
     end
 
-    def start_server(port, options={}, *)
+    def start_server(port, options={})
       server = Server::Server.new(true) # debug
       if options[:daemon]
         Process.daemon(true) # don't change dir to '/'
@@ -120,7 +116,7 @@ module Hubeye
       server.start(port, options)
     end
 
-    def start_client(host, port, *)
+    def start_client(host, port)
       client = Client::Client.new(false) # debug
       client.start(host, port)
     end
@@ -129,4 +125,3 @@ module Hubeye
 end
 
 Hubeye.start
-

data/lib/hubeye/client/client.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
+require File.expand_path('../connection', __FILE__)
 require 'readline'
-require_relative 'connection'
 
 module Hubeye
   module Client
@@ -35,14 +35,12 @@ module Hubeye
       end
 
       private
-
-      # Now begin a loop of client/server interaction.
       def interact
         loop do
           get_input_from_readline
           begin
-            if @input.match(/^\.$/) # '.' = pwd (of client process)
-              @input.gsub!(/\A\.\Z/, File.split(File.expand_path('.')).last)
+            if @input.match(/^(add)?\s*\.$/) # '.' = pwd (of client process)
+              @input.gsub!(/\./, File.split(File.expand_path('.')).last)
             else
               @input.gsub!(/\//, 'diiv')
             end

data/lib/hubeye/config/environment.rb

@@ -10,4 +10,3 @@ module Hubeye
 
   end
 end
-

data/lib/hubeye/hooks/{executer.rb → command.rb}

@@ -4,8 +4,8 @@ module Hubeye
 
       class NoHookError < ArgumentError; end
 
-      #options include the directory to execute the command
-      #(that's it for now, will add more functionality later)
+      # options include the directory to execute the command and
+      # the full repo name of the changed repository
       def self.execute(commands, options={})
         opts = {:directory => nil, :repo => nil}.merge(options)
         dir  = opts[:directory]
@@ -14,14 +14,18 @@ module Hubeye
           commands.each do |cmd|
             if dir
               Dir.chdir(File.expand_path(dir)) do
-                ::Kernel.system cmd
+                if repo
+                  ::Kernel.system "HUBEYE_CHANGED_REPO=#{repo} #{cmd}"
+                else
+                  ::Kernel.system cmd
+                end
               end
             else
               ::Kernel.system cmd
             end
           end
         rescue ArgumentError
-          raise NoHookError "There aren't any hook commands for the repository #{repo}"
+          raise NoHookError.new "There aren't any hook commands for the repository #{repo}"
         end
       end
 

data/lib/hubeye/hooks/git.rb

@@ -0,0 +1,19 @@
+module Hubeye
+  module Hooks
+    class Git
+
+      def self.fetch(local_repo_name, remote_name, branch_name)
+        Dir.chdir(File.expand_path(local_repo_name)) do
+          system "git fetch #{remote_name} #{branch_name}"
+        end
+      end
+
+      def self.pull(local_repo_name, remote_name, branch_name)
+        Dir.chdir(File.expand_path(local_repo_name)) do
+          system "git pull #{remote_name} #{branch_name}"
+        end
+      end
+
+    end
+  end
+end

data/lib/hubeye/log/logger.rb

@@ -27,6 +27,7 @@ Repository: #{repo_name.downcase.strip} has changed (#{Time.now.strftime("%m/%d/
 Commit msg: #{commit_msg}
 Committer : #{committer}
 ===============================
+
 MSG
         if opts[:include_terminal]
           STDOUT.puts change_msg

data/lib/hubeye/server/commit.rb

@@ -1,51 +1,29 @@
 module Hubeye
   module Server
 
-  # simple interface to Github's api v3 for commits
+    # simple interface to Github's api v3 for commits
     class Commit
-      attr_reader :raw_input, :repo, :only_sha, :latest
+      attr_reader :repo_name, :sha, :message, :committer_name
 
-      def initialize(input)
-        @raw_input = input
-        @repo = input.keys.first
-        if Hash === input
-          if input[@repo].keys == ["sha"]
-            @only_sha = true
-          else
-            @latest = true
-          end
-        else
-          raise ArgumentError.new "input must be a kind of hash"
-        end
+      def initialize(repo_name, raw_commit_ary)
+        commit_hash = parse_raw_commit_ary(raw_commit_ary)
+        @repo_name = repo_name
+        @sha = commit_hash['sha']
+        @message = commit_hash['commit']['message']
+        @committer_name = commit_hash['commit']['committer']['name']
       end
 
-      def sha
-        @sha ||= @raw_input[@repo]['sha']
-      end
-
-      def commit_message
-        if @only_sha
-          return
-        elsif @latest
-          @commit_message ||=
-            @raw_input[@repo]['commit']['message']
-        else
-          raise
-        end
-      end
-
-      def committer_name
-        if @only_sha
-          return
-        elsif @latest
-          @committer_name ||=
-            @raw_input[@repo]['commit']['committer']['name']
-        else
-          raise
-        end
+      private
+      def parse_raw_commit_ary(raw_commit_ary)
+        {'sha' => raw_commit_ary.first['sha'],
+         'commit' =>
+           {'message' => raw_commit_ary.first['commit']['message'],
+            'committer' =>
+              {'name' => raw_commit_ary.first['commit']['committer']['name']}
+           }
+        }
       end
 
     end
   end
 end
-