hubeye 0.0.3 → 0.0.4

data/README.md.html

@@ -0,0 +1,212 @@
+<h1>Hubeye</h1>
+
+<p><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 />
+<br /></p>
+
+<p>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.</p>
+
+<p>Example: (what the user enters is preceded by the prompt)</p>
+
+<pre><code>&gt;hubeye
+commit  77b82b54044c16751228
+tree    8ce18af1461b5c741003
+parent  ea63fe317fe58dff1c95
+log tracking info for repos on client quit  =&gt; luke-gru
+</code></pre>
+
+<p>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.</p>
+
+<h2>Starting Hubeye</h2>
+
+<p>To start the server:</p>
+
+<pre><code>&gt;hubeye -s
+</code></pre>
+
+<p>or just</p>
+
+<pre><code>&gt;hubeye
+</code></pre>
+
+<p>This starts the server as a daemonized process. To run the server in<br />
+your terminal (on <b>t</b>op):</p>
+
+<pre><code>&gt;hubeye -st
+</code></pre>
+
+<p>Hubeye runs on port 2000 be default. Change the port like this:</p>
+
+<pre><code>&gt;hubeye -sp 9001
+</code></pre>
+
+<p>To connect with the client:</p>
+
+<pre><code>&gt;hubeye -c
+</code></pre>
+
+<p>For more options:</p>
+
+<pre><code>&gt;hubeye -h
+</code></pre>
+
+<h3>~/.hubeye/hubeyerc</h3>
+
+<pre><code>username: luke-gru
+</code></pre>
+
+<p>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.</p>
+
+<h3>Keeping track of repositories</h3>
+
+<p>Hubeye doesn't actually track any repositories unless you disconnect<br />
+from the server and leave the server running. This can be done by:</p>
+
+<pre><code>&gt;quit
+Bye!
+</code></pre>
+
+<p>If Hubeye has any repos to watch (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
+/></p>
+
+<p>To track your own repository, start the client in the root directory<br />
+of your local git repo:</p>
+
+<pre><code>&gt;.
+</code></pre>
+
+<p>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 /></p>
+
+<p>You can add another user's repo like this:</p>
+
+<pre><code>&gt;rails/rails
+</code></pre>
+
+<p>This adds https://github.com/rails/rails to the watch list.<br />
+Hubeye does not remove a repo from the watch list unless explicitly<br />
+told to do so:</p>
+
+<pre><code>&gt;rm luke-gru/hubeye
+</code></pre>
+
+<p>To see a list of all repos (with recent commit messages) in the watch (track) list:</p>
+
+<pre><code>&gt;tracking
+</code></pre>
+
+<h3>Desktop Notification</h3>
+
+<p><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 /></p>
+
+<h3>Shutting down and persistence between sessions</h3>
+
+<pre><code>&gt;shutdown
+</code></pre>
+
+<p>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:</p>
+
+<p><i>~/.hubeye/hubeyerc</i></p>
+
+<pre><code>track: rails/rails, dchelimsky/rspec
+</code></pre>
+
+<p>These will be watched automatically when starting up the server.<br /></p>
+
+<p>A way to interactively save all currently tracked repositories:</p>
+
+<pre><code>&gt;save repos as my_work_repos
+</code></pre>
+
+<p>And then load any time (even after a shutdown; next session, next week, etc...)</p>
+
+<pre><code>&gt;load repos my_work_repos
+</code></pre>
+
+<h3>Working with hooks</h3>
+
+<pre><code>&gt;hook add rails/rails dir: /path/to/local/rails cmd: git pull origin master
+</code></pre>
+
+<p>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 /></p>
+
+<p>To see all currently loaded hooks:</p>
+
+<pre><code>&gt;hook list
+</code></pre>
+
+<p>To save all hooks for next sessions (after a server shutdown)</p>
+
+<pre><code>&gt;save hooks as weekend_projects_hooks
+</code></pre>
+
+<p>Then, next weekend:</p>
+
+<pre><code>&gt;load hooks weekend_projects_hooks
+</code></pre>
+
+<p>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.</p>
+
+<h3>All ~/.hubeyerc configurations</h3>
+
+<p>When the server is started, the options are set here.</p>
+
+<pre><code>username: luke-gru
+track: username/reponame, username2/reponame2, myreponame
+oncearound = 90
+load hooks: myhook1, myworkhooks
+load repos: workprojects, funprojects
+desktop notification: on/off
+</code></pre>
+
+<p><i>username</i>: username used for Github URLS when the full path is not
+given<br />
+inside of the client.<br /></p>
+
+<p><i>track</i>: default repositories to watch for changes upon server start<br /></p>
+
+<p><i>oncearound</i>: number of seconds before completing a check of every repo in<br />
+the watch list for changes<br /></p>
+
+<p><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 /></p>
+
+<p><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 /></p>
+
+<p><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.</p>

data/VERSION.rb

@@ -1,5 +1,5 @@
 class Hubeye
-  # 0.0.3 since sept.4 2011
-  VERSION = [0,0,3]
+  # 0.0.4 since sept.5 2011
+  VERSION = [0,0,4]
 end
 

data/tasks/install.rb

@@ -0,0 +1,36 @@
+task :install => :chmod do
+  puts "Done"
+end
+
+task :chmod => :config_file do
+  binfile = File.join(File.expand_path(File.dirname(__FILE__) + '/..'), "/bin/hubeye")
+  chmod 0777, binfile unless File.executable?(binfile)
+end
+
+task :config_file do
+  config_file = File.join(ENV['HOME'], "/.hubeye/hubeyerc")
+  touch config_file unless File.exists? config_file
+end
+
+task :config_file => :makelog
+
+task :makelog => :message do
+  hubeye_dir  =  ENV['HOME'] + "/.hubeye"
+  mkdir(hubeye_dir) unless File.exists?(hubeye_dir)
+
+  hooks_dir = hubeye_dir + "/hooks"
+  mkdir(hooks_dir) unless File.exists?(hooks_dir)
+
+  repos_dir = hubeye_dir + "/repos"
+  mkdir(repos_dir) unless File.exists?(repos_dir)
+
+  hubeye_log_file =  File.join(ENV['HOME'], "/.hubeye/log")
+  touch hubeye_log_file unless File.exists?(hubeye_log_file)
+end
+
+
+
+task :message do
+  puts "Installing Hubeye..."
+end
+

metadata

@@ -1,82 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hubeye
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.4
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Luke Gruber
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &71785010 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: Github repository commit watcher -- keep your eye on new commits from multiple repos through an interactive CLI
+  prerelease: false
+  version_requirements: *71785010
+description: Github repository commit watcher -- keep your eye on new commits from
+  multiple repos through an interactive CLI
 email: luke.gru@gmail.com
-executables: 
+executables:
 - hubeye
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- lib/config/parser.rb
+- lib/client/hubeye_client.rb
+- lib/notification/growl.rb
 - lib/notification/gnomenotify.rb
 - lib/notification/notification.rb
-- lib/notification/growl.rb
-- lib/config/parser.rb
-- lib/helpers/time.rb
-- lib/hooks/git_hooks.rb
-- lib/hooks/executer.rb
 - lib/server/hubeye_server.rb
+- lib/hooks/executer.rb
+- lib/hooks/git_hooks.rb
 - lib/log/logger.rb
 - lib/environment.rb
-- lib/client/hubeye_client.rb
+- lib/helpers/time.rb
 - bin/hubeye
-- LICENSE
+- README.md.html
 - README.md
 - VERSION.rb
-- test/notification.rb
-- test/runner.rb
+- LICENSE
 - test/config_parser.rb
+- test/runner.rb
 - test/environment.rb
+- test/notification.rb
+- images/change_icon.jpg
+- tasks/install.rb
 homepage: 
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Github repository commit watcher -- keep your eye on new commits from multiple repos through an interactive CLI
+summary: Github repository commit watcher -- keep your eye on new commits from multiple
+  repos through an interactive CLI
 test_files: []
-