history_commander 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+*.swo
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeremy Deininger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,29 @@
+= history_commander
+
+== Quick Start
+
+  'gem install history_commander'
+Installs the history_commander gem.  To run 'hc' you must rubygems bin directory in your path
+
+  'hc_setup_bashrc'
+This installs bash history tweaks to your .bashrc
+
+  'hc configure --help'
+This will setup the .history_commander config file with your selected options
+
+  'hc start'
+Starts history_commander
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeremy Deininger. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "history_commander"
+    gem.summary = %Q{Take command of your shell history!}
+    gem.description = %Q{History Commander is a program designed to keep your shell history in sync across all your nodes. }
+    gem.email = "jeremy@rubyonlinux.org"
+    gem.homepage = "http://github.com/jeremyd/history_commander"
+    gem.authors = ["Jeremy Deininger"]
+    gem.add_dependency "eventmachine"
+    gem.add_dependency "eventmachine-tail"
+    gem.add_dependency "amqp"
+    gem.add_dependency "json"
+    gem.add_dependency "simple-daemon"
+    gem.add_dependency "trollop"
+    gem.add_dependency "highline"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "history_commander #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/hc

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+## Development ENV only
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+###
+
+require 'rubygems'
+require 'history_commander'
+require 'trollop'
+require 'tmpdir'
+
+command = ARGV.shift
+unless ["start", "stop", "configure"].include?(command)
+  puts "Syntax: hc <command> [args] [--help]"
+  puts "  command can be 'start', 'stop', or 'configure'"
+end
+
+@@options = Trollop::options do
+  opt :config, "configuration file to use", :default => File.join(File.expand_path("~"), ".history_commander"), :type => :string
+  opt :foreground, "run in foreground (daemonize is the default)", :default => false
+  opt :amqp_host, "hostname of AMQP server", :type => :string
+  opt :mode, "operate in 'full' read/write (sync) mode -or in 'writeonly' (no sync) mode.  This requires the proper AMQP permissions.", :type => :string
+  opt :user, "AMQP username", :type => :string
+  opt :pass, "AMQP pass", :type => :string
+  opt :vhost, "AMQP vhost", :type => :string
+  opt :amqp_log, "AMQP verbose logging", :default => false, :short => "-l"
+end
+
+def check_options
+  [:user, :pass, :vhost, :amqp_host, :mode].each do |req|
+    unless @@options[req]
+      puts "FATAL: you must specify --#{req} in your history_commander config file or on the command line, see --help"
+      exit 1
+    end
+  end
+end
+
+if command == "configure"
+  check_options  
+  config_file = @@options[:config]
+  @@options.reject! { |k, v| k.to_s.include?("given") || k == :help || k == :save || k == :config }
+  writeme = @@options.dup
+  File.open(config_file, "w") {|f| f.write(writeme.to_json(:indent => "  ", :object_nl => "\n"))}
+  File.chmod 0600, config_file 
+  puts "wrote config to #{config_file}"
+  exit
+end
+
+if File.exists?(@@options[:config])
+  @@options.reject! { |k, v| v == nil } 
+  saved_opts = JSON::parse(IO.read(@@options[:config])).to_mash
+  passed_in_opts = @@options.to_mash
+  @@options = saved_opts.merge passed_in_opts
+end
+
+check_options  
+
+if @@options[:foreground] 
+  puts "History Commander running in foreground mode. CTRL-C to interrupt"
+  EM.run do
+    AMQP.start(:host => @@options[:amqp_host], :user => @@options[:user], :pass => @@options[:pass], :vhost => @@options[:vhost], :logging => @@options[:amqp_log]) do
+      HistWatch.start(@@options[:mode])
+    end
+  end
+else
+  puts "Logging to #{Dir.tmpdir}/HistoryCommanderDaemon.log"
+  require 'simple-daemon'
+  class HistoryCommanderDaemon < SimpleDaemon::Base
+    SimpleDaemon::WORKING_DIRECTORY = Dir.tmpdir
+    def self.start
+      EM.run do
+        AMQP.start(:host => @@options[:amqp_host], :user => @@options[:user], :pass => @@options[:pass], :vhost => @@options[:vhost], :logging => @@options[:amqp_log]) do
+          HistWatch.start(@@options[:mode])
+        end
+      end
+    end
+
+    def self.stop
+      EM.stop
+      puts "Stopping History Commander" 
+    end
+  end
+  HistoryCommanderDaemon.daemonize
+end

data/bin/hc_setup_bashrc

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+## Development ENV only
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+###
+require 'rubygems'
+require 'history_commander/setup_bashrc'
+
+options = Trollop::options do
+  opt :yes, "Do not prompt", :default => false
+end
+
+SetupBashrc.install(options[:yes])

data/history_commander.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{history_commander}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Deininger"]
+  s.date = %q{2010-08-01}
+  s.description = %q{History Commander is a program designed to keep your shell history in sync across all your nodes. }
+  s.email = %q{jeremy@rubyonlinux.org}
+  s.executables = ["hc", "hc_setup_bashrc"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/hc",
+     "bin/hc_setup_bashrc",
+     "history_commander.gemspec",
+     "lib/history_commander.rb",
+     "lib/history_commander/setup_bashrc.rb",
+     "spec/history_commander_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jeremyd/history_commander}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Take command of your shell history!}
+  s.test_files = [
+    "spec/history_commander_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_runtime_dependency(%q<eventmachine-tail>, [">= 0"])
+      s.add_runtime_dependency(%q<amqp>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<simple-daemon>, [">= 0"])
+      s.add_runtime_dependency(%q<trollop>, [">= 0"])
+      s.add_runtime_dependency(%q<highline>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<eventmachine-tail>, [">= 0"])
+      s.add_dependency(%q<amqp>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<simple-daemon>, [">= 0"])
+      s.add_dependency(%q<trollop>, [">= 0"])
+      s.add_dependency(%q<highline>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<eventmachine-tail>, [">= 0"])
+    s.add_dependency(%q<amqp>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<simple-daemon>, [">= 0"])
+    s.add_dependency(%q<trollop>, [">= 0"])
+    s.add_dependency(%q<highline>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/history_commander.rb

@@ -0,0 +1,86 @@
+require 'rubygems'
+require 'json'
+require 'eventmachine'
+require 'eventmachine-tail'
+require 'mq'
+require 'uuidtools'
+require 'mash'
+require 'fileutils'
+
+class HistoryCommander < EventMachine::FileTail
+  attr_accessor :uuid
+  attr_accessor :pause
+
+  def safe_path
+    "#{path}_safe"
+  end
+
+  # path <~String> File path to monitor
+  # mode <~String> Can be set to "full" for read/write mode, and any other value for write only mode.
+  # startpos <~Integer> File position to start tailing the file. Default of -1 starts at the end of the file
+  def initialize(path, startpos=-1, mode="full")
+    super(path, startpos)
+    FileUtils.cp(path, safe_path)
+    @buffer = BufferedTokenizer.new
+    @global_history_fanout = MQ.new.fanout('global_history')
+    @uuid = UUIDTools::UUID.random_create.to_s
+    @host = `hostname`.chomp
+    @user = `whoami`.chomp
+    @pause = false
+    subscribe if mode == "full"
+  end
+
+  # Receive data from the FileTail and submit it
+  # to the MQ
+  def receive_data(data)
+    @buffer.extract(data).each do |line|
+      payload = { :uuid => @uuid, 
+                  :message => line,
+                  :host => @host,
+                  :user => @user }
+      @global_history_fanout.publish(payload.to_json)
+    end
+  end
+
+  def schedule_next_read
+    unless @pause
+      EventMachine::add_timer(@naptime) do
+        read
+      end
+    end
+  end
+
+  def skip_ahead
+    def skip_ahead
+      @pos = @file.sysseek(0, IO::SEEK_END)
+    end
+  end
+
+  # Subscribe to the global history exchange and sync the history file with any new inbound global history.  Pauses FileTail and skips the output when writing to the history file.
+  def subscribe 
+    @subscription = MQ.new
+    @subscription.queue(@uuid).bind(@subscription.fanout('global_history')).subscribe do |result|
+      x = Mash.new(JSON::parse(result))
+      puts "received: #{x[:uuid]} #{x[:user]}@#{x[:host]}$ #{x[:message]}"
+      if x[:uuid] != @uuid
+        @pause = true
+        File.open(path, "a") {|f| f.puts(x[:message])}
+        skip_ahead
+        @pause = false
+        schedule_next_read
+      end
+    end
+  end
+end
+
+# HistWatch is a wrapper class for starting EM and loading configuration information for History Commander
+class HistWatch
+  # starts
+  def self.start(mode="full", file = File.join(File.expand_path('~'), ".bash_history"))
+    @hist_file_watch = EventMachine::file_tail(file, HistoryCommander, -1, mode)
+  end
+
+  def self.stop
+    EM.stop
+  end
+end

data/lib/history_commander/setup_bashrc.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'fileutils'
+require 'trollop'
+require 'highline/import'
+
+class SetupBashrc
+  # Install necessary .bashrc customization for optimal history commander usage.
+  def self.install(force = false)
+    my_home = File.expand_path('~')
+    my_bashrc = File.join(my_home, ".bashrc")
+    unless File.exists?(my_bashrc)
+      if File.exists?("/etc/bashrc")
+        FileUtils.cp("/etc/bashrc", my_bashrc)
+      elsif File.exists?("/usr/etc/bashrc")
+        FileUtils.cp("/usr/etc/bashrc", my_bashrc)
+      else
+        `touch #{my_bashrc}` 
+      end
+    end
+    say "using .bashrc in #{my_bashrc}"
+    self.apply_change(my_bashrc, force)
+  end
+
+  def self.goodies
+    <<eoh
+shopt -s histappend
+export HIST_CONTROL=ignoreboth
+export PROMPT_COMMAND="history -a; history -n"
+export HISTSIZE=1000000 
+export HISTFILESIZE=1000000
+eoh
+  end
+
+  def self.do_warnings(file_contents)
+    if file_contents =~ /#{self.goodies}/
+      say "*** WARNING: modifications already installed!"
+    end
+    if file_contents =~ /PROMPT_COMMAND/
+      say "*** WARNING: your .bashrc already has a PROMPT_COMMAND.  This setting will be overridden!"
+    end
+  end
+
+  # *file <~String>: bashrc file to detect and optionally apply changes to.
+  def self.apply_change(file, force = false)
+    say("Thanks for installing History Commander!\nThe following modifications will be applied to your ~/.bashrc file:")
+    say("+++\n#{self.goodies}")
+    self.do_warnings(IO.read(file))
+    unless force
+      confirm = ask("+++ Apply changes (y/n)?", lambda { |ans| true if (ans =~ /^[y,Y]{1}/) })
+      unless confirm
+        say "Aborting."
+        exit
+      end
+    end
+    backup = "#{file}_hc_backup#{rand(10000)}"
+    say "Creating backup of .bashrc in #{backup}"
+    FileUtils.cp(file, backup)
+    File.open(file, "a") { |f| f.puts(self.goodies)}
+    say "done installing history customization."
+    say "***"
+    say "Now you MUST load your new bash history config:"
+    say "Open a new terminal -or-" 
+    say "'source #{file}'"
+  end
+end

data/spec/history_commander_spec.rb

@@ -0,0 +1,43 @@
+# This Spec requires a running AMQP server.
+# Configure your AMQP server first and enter access information below before running this spec.
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'tmpdir'
+
+describe "HistoryCommander" do
+  before(:all) do
+    @watch_files = []
+    2.times do |x|
+      @watch_files << File.join(Dir.tmpdir, "#{x}unique-history_commander_spec_candelete")
+    end
+    @watch_files.each {|w| `rm #{w}; touch #{w}`}
+  end
+  it "runs multiple history commanders and checks for all files to contain all history" do
+    EM.run do
+      AMQP.start(:host => "ec2-184-72-19-157.us-west-1.compute.amazonaws.com") do
+        EM.next_tick do
+          @watch_files.each do |w|
+            HistWatch.start(w)
+          end
+        end
+        EM.add_timer(2) do
+          @first_value = "first_command: #{rand(10000000)}"
+          File.open(@watch_files.first, "a") {|f| f.puts @first_value }
+        end
+        EM.add_timer(3) do
+          @second_value = "second_command: #{rand(10000000)}"
+          File.open(@watch_files.last, "a") {|f| f.puts @second_value }
+        end
+        EM.add_timer(10) do
+          @watch_files.each do |w|
+            IO.read(w).should =~ /^#{@first_value}/
+            IO.read(w).should =~ /^#{@second_value}/
+          end
+        end
+        EM.add_timer(12) do
+          EM.stop
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'history_commander'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification 
+name: history_commander
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeremy Deininger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine-tail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simple-daemon
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id008
+description: "History Commander is a program designed to keep your shell history in sync across all your nodes. "
+email: jeremy@rubyonlinux.org
+executables: 
+- hc
+- hc_setup_bashrc
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/hc
+- bin/hc_setup_bashrc
+- history_commander.gemspec
+- lib/history_commander.rb
+- lib/history_commander/setup_bashrc.rb
+- spec/history_commander_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jeremyd/history_commander
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Take command of your shell history!
+test_files: 
+- spec/history_commander_spec.rb
+- spec/spec_helper.rb