jabber-tee 0.1.0

data/README.markdown

@@ -0,0 +1,47 @@
+# Jabber TEE
+
+This is a simple command line tool for writing input from the client to a remote jabber server and outputting to the console.
+
+# Installing
+
+The command line tool can be installed with:
+
+    gem install jabber-tee
+
+# Using
+
+The general idea is that you can pipe anything from the console into this, and it will be sent to the remote jabber server:
+
+    cat huge_text_file.txt | jabber-tee -u peon@bigcorp.com --room working-hard@rooms.bigcorp.com --nick 'Worker Drone'
+  
+# Configuration
+
+Because entering the same information on the command line for this thing can be tedious, you can create a ~/.jabber-tee.yml file that fills in all of the basic configuration.  This file also allows you to further customize the output that is sent to the jabber server.
+
+An example configuration file:
+
+    # Global configuration values:
+    username: my.name@jabber.org
+    nick: 'Gabe'
+
+    # Individual profiles that customize global variables    
+    profiles:
+        new-hotness:
+            # Uses the standard username, above
+            nick: 'Mr. Super Cool'
+            room: 'HipCentral'
+    
+        somebody.else:
+            username: supercooldude@gmail.com
+            nick: 'Rocksteady Gabe'
+            to: somebody.else@gmail.com
+
+        work-stuff:
+            username: peon@bigcorp.com
+            nick: 'Worker Drone'
+            room: working-hard@rooms.bigcorp.com
+
+You can then activate these individual profiles from the command line with the '-P' flag.  So, the above command could be replaced with:
+
+    cat huge_text_file.txt | jabber-tee -P work-stuff
+

data/Rakefile

@@ -0,0 +1,55 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../spec", __FILE__)
+
+require 'fileutils'
+require 'rake'
+require 'rubygems'
+require 'spec/rake/spectask'
+require 'jabber-tee/version'
+
+task :default => :spec
+
+desc "Run the RSpec tests"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['-b', '-c', '-f', 'p']
+  t.fail_on_error = false
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name           = 'jabber-tee'
+    gem.version        = JabberTee::Version.to_s
+    gem.executables    = %W{jabber-tee}
+    gem.summary        = 'Simple command line utility for piping the output from one command to both the console and a remote jabber server.'
+    gem.description    = "Installs the 'jabber-pipe' utility for sending messages to a remote jabber server.  Instead of a standard client, it reads from standard in and continues to write to the console."
+    gem.email          = ['madeonamac@gmail.com']
+    gem.authors        = ['Gabe McArthur']
+    gem.homepage       = 'http://github.com/gabemc/jabber-tee'
+    gem.files          = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
+    
+    gem.add_dependency    'highline',   '>=1.5.2'
+    gem.add_dependency    'xmpp4r',     '>=0.5'
+    
+    gem.add_development_dependency 'rspec', '>=1.3.0'
+  end
+rescue LoadError
+  puts "Jeweler or dependencies are not available.  Install it with: sudo gem install jeweler"
+end
+
+desc "Deploys the gem to rubygems.org"
+task :gem => :release do
+  system("gem build jabber-tee.gemspec")
+  system("gem push jabber-tee-#{JabberTee::Version.to_s}.gem")
+end
+
+desc "Does the full release cycle."
+task :deploy => [:gem, :clean] do
+end
+
+desc "Cleans the gem files up."
+task :clean do
+  FileUtils.rm(Dir.glob('*.gemspec'))
+  FileUtils.rm(Dir.glob('*.gem'))
+end

data/bin/jabber-tee

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'jabber-tee/cli'
+JabberTee::CLI.new(ARGV).execute!

data/lib/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/jabber-tee/cli.rb

@@ -0,0 +1,156 @@
+require 'optparse'
+require 'jabber-tee/errors'
+require 'jabber-tee/version'
+require 'jabber-tee/client'
+require 'jabber-tee/configuration'
+
+module JabberTee
+  class CLI
+    attr_reader :options, :args
+
+    def initialize(args)
+      @args = args
+    end
+
+    def execute!
+      begin
+        parse!(@args.dup)
+        config = load_configuration
+
+        if config.destination_missing?
+          raise JabberTee::ConfigurationError.new("Either the --to or --room flag is required.")
+        end
+
+        client = Client.new(config)
+        client.pump!
+      rescue SystemExit => e
+        raise
+      rescue JabberTee::ConfigurationError => e
+        print_error(e.message)
+      rescue OptionParser::InvalidOption => e
+        print_error(e.message)
+      rescue Exception => e
+        STDERR.puts e.backtrace
+        print_error(e.message)
+      end
+    end
+
+    def parse!(args)
+      parse_options(args)
+      validate_args(args)
+    end
+
+    def parse_options(args)
+      @options ||= {}
+      @parsed_options ||= OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [OPTIONS] "
+        opts.separator <<DESC
+Description:
+   This is a simple tool for reading from STDIN and writing
+   to both STDOUT and a remote jabber server.  It does not handle
+   reading from STDERR, so you will need to re-direct 2>&1 before
+   piping it to this tool.
+
+   The configuration file should live under ~/.jabber-tee.yml.
+   Please see http://github.com/gabemc/jabber-tee for more
+   information.
+
+Options:
+DESC
+        opts.separator "  Connecting:"
+        opts.on('-u', '--username USERNAME',
+                "The user@host.org name to connect to the jabber server.") do |u|
+          options[:username] = u
+        end
+        opts.on('-p', '--password PASSWORD',
+                "The password for the user to connect to the jabber server.",
+                "If not given or defined in the .jabber-tee.yml file,",
+                "it will be asked during runtime.") do |p|
+          options[:password] = p
+        end
+        opts.on('-n', '--nick NICKNAME',
+                "The nickname to use when connecting to the server.") do |n|
+          options[:nick] = n
+        end
+        opts.on('-a', '--anonymous',
+                "Disregards the username information and logs in using anonymous",
+                "authentication.  Either the --username or the --authentication",
+                "flag are required.") do |a|
+          options[:anonymous] = true
+        end
+        opts.on('-P', '--profile PROFILE',
+                "The name of the profile, as defined in the .jabber-tee.yml",
+                "file to use to connect with.") do |p|
+          options[:profile] = p
+        end
+        opts.on('--sasl',
+                "By default, the connection does not use SASL authentication.",
+                "This enables SASL connections") do |s|
+          options[:sasl] = true
+        end
+        opts.on('--digest',
+                "When not using SASL, you can use the digest",
+                "authentication mechanism.") do |d|
+          options[:digest] = true
+        end
+        opts.separator ""
+
+        opts.separator "  Output: (One required)"
+        opts.on('-t', '--to TO',
+                "Who to send the message to.") do |t|
+          options[:to] = t
+        end
+        opts.on('-r', '--room ROOM',
+                "The room to send the messages to.") do |r|
+          options[:room] = r 
+        end
+        opts.separator ""
+
+        opts.separator "  Informative:"
+        opts.on('-v', '--version',
+                "Show the version information") do |v|
+          puts "#{File.basename($0)} version: #{JabberTee::Version.to_s}"
+          exit
+        end
+        opts.on('-h', '--help',
+                "Show this help message") do
+          puts opts
+          exit
+        end
+        opts.separator ""
+
+      end.parse!(args)
+    end
+
+    def validate_args(args)
+      if args.length > 0
+        raise JabberTee::ConfigurationError.new("This command takes no extra arguments: #{args[0]}")
+      end
+    end
+
+    private
+    def print_error(e)
+      STDERR.puts "#{File.basename($0)}: #{e}"
+      STDERR.puts "#{File.basename($0)}: Try '--help' for more information"
+      exit 1
+    end
+
+    JABBER_FILE = '.jabber-tee.yml'
+
+    def load_configuration
+      home = ENV['HOME'] # TODO: Windows users?
+      config_file = File.join(home, JABBER_FILE)
+
+      if File.exists?(config_file)
+        reader = ConfigurationReader.new(config_file)
+        if options.has_key?(:profile)
+          reader.profile(options[:profile]).merge(options)
+        else
+          reader.profile.merge(options)
+        end
+      else
+        Configuration.new(options)
+      end
+    end
+  end # CLI
+end

data/lib/jabber-tee/client.rb

@@ -0,0 +1,46 @@
+require 'jabber-tee/errors'
+
+require 'rubygems'
+require 'xmpp4r'
+require 'xmpp4r/muc'
+
+module JabberTee
+  class Client
+    attr_reader :config, :client
+
+    def initialize(config)
+      @config = config
+      @client = Jabber::Client.new(Jabber::JID.new("#{config.username}/#{config.nick}"))
+      client.connect
+      client.auth(config.password)
+
+      if config.in_room?
+        @muc = Jabber::MUC::SimpleMUCClient.new(client)
+        @muc.join(Jabber::JID.new("#{config.room}/#{config.nick}"))
+      end
+    end
+
+    def pump!
+      if $stdin.tty?
+        $STDERR.puts "Unable to pipe jabber-tee from a TTY"
+        exit(1)
+      else
+        $stdin.each do |line|
+          line.chomp!
+          say(line)
+          puts line
+        end
+      end
+    end
+
+    def say(message)
+      if config.in_room?
+        @muc.say(message)
+      else
+        msg = Jabber::Message.new(config.to, message)
+        msg.type = :chat
+        client.send(msg)
+      end
+    end
+  end
+end

data/lib/jabber-tee/configuration.rb

@@ -0,0 +1,90 @@
+require 'jabber-tee/errors'
+
+require 'rubygems'
+require 'highline/import'
+require 'yaml'
+
+module JabberTee
+
+  class ConfigurationReader
+    def initialize(yaml_file)
+      if !File.exists?(yaml_file)
+        raise JabberTee::ConfigurationError.new("Unable to locate the configuration file.")
+      end
+
+      yaml = nil
+      file = File.open(yaml_file) {|f| yaml = f.read }
+      @config = YAML::load(yaml)
+    end
+    
+    def profile(name=nil)
+      if name.nil?
+        Configuration.new(@config)
+      else
+        config = Configuration.new(@config)
+        profiles = @config['profiles']
+        if profiles.nil?
+          raise JabberTee::ConfigurationError.new("Unable to load an profiles from your home configuration.")
+        end
+        profile = profiles[name]
+        if config.nil?
+          raise JabberTee::ConfigurationError.new("Unable to load the #{name} profile from your home configuration.")
+        end
+        config.merge(profile)
+      end
+    end
+  end
+
+  class Configuration
+    ATTRIBUTES = ['username', 'nick', 'password', 'anonymous', 'sasl', 'digest', 'room', 'to']
+
+    attr_reader :username, :nick, :to, :room
+
+    def initialize(options=nil)
+      if !options.nil?
+        merge(options)
+      end
+    end
+
+    def merge(options)
+      ATTRIBUTES.each do |attr|
+        if options.has_key?(attr.to_sym) || options.has_key?(attr)
+          value = options[attr.to_sym] || options[attr]
+          instance_variable_set("@#{attr}", value)
+        end
+      end
+      self
+    end
+
+    def password
+      if @password.nil?
+        @password = ask("#{username}: password: ") {|q| q.echo = false }
+      end
+      @password
+    end
+
+    def anonymous?
+      !@anonymous.nil? && username.nil?
+    end
+
+    def sasl?
+      !@sasl.nil?
+    end
+
+    def digest?
+      !@digest.nil?
+    end
+
+    def in_room?
+      !@room.nil?
+    end
+
+    def destination_missing?
+      @room.nil? && @to.nil?
+    end
+
+    def to_s
+      "<JabberTee::Configuration{:username => '#{username}', :room => '#{room}', :to => '#{to}', :anonymous => #{anonymous?}, :sasl => #{sasl?}}>"
+    end
+  end
+end

data/lib/jabber-tee/errors.rb

@@ -0,0 +1,6 @@
+
+module JabberTee
+  Error = Class.new(RuntimeError)
+
+  ConfigurationError = Class.new(JabberTee::Error)
+end

data/lib/jabber-tee/version.rb

@@ -0,0 +1,12 @@
+require 'scanf'
+
+module JabberTee
+  class Version
+    CURRENT = File.read(File.dirname(__FILE__) + '/../VERSION')
+    MAJOR, MINOR, TINY = CURRENT.scanf('%d.%d.%d')
+
+    def self.to_s
+      CURRENT
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,72 @@
+require 'helpers'
+require 'jabber-tee/cli'
+
+module JabberTee
+
+  module CLIHelper
+    def parse(*args)
+      cli = CLI.new(args)
+      cli.parse_options(args)
+      cli
+    end
+
+    def validate(*args)
+      cli = CLI.new(args)
+      cli.parse_options(args)
+      cli.validate_args(args)
+      cli
+    end
+
+    def check(sym, flags, value)
+      flags.each do |flag|
+        if value.is_a?(String)
+          parse(flag, value).options[sym].should eql(value)
+        else
+          parse(flag).options[sym].should eql(value)
+        end
+      end
+    end
+  end
+  
+  describe "Jabber Tee CLI interface" do
+    include CLIHelper
+
+    describe "when just checking arguments" do
+      it "should parse the username correctly" do
+        check(:username, ['-u', '--username'], 'someuser')
+      end
+
+      it "should parse the password correctly" do
+        check(:password, ['-p', '--password'], 'super_!!_secret')
+      end
+
+      it "should parse the sasl flag correctly" do
+        check(:sasl, ['--sasl'], true)
+      end
+      
+      it "should parse the digest flag correctly" do
+        check(:digest, ['--digest'], true)
+      end
+
+      it "should parse the anonymous flag correctly" do
+        check(:anonymous, ['-a', '--anonymous'], true)
+      end
+
+      it "should parse the room flag correctly" do
+        check(:room, ['-r', '--room'], 'ROOM')
+      end
+     
+      it "should parse the nickname flag correctly" do
+        check(:nick, ['-n', '--nick'], 'nickname!')
+      end
+    end
+
+    describe "while validating the arguments" do
+      CE = JabberTee::ConfigurationError
+
+      it "should fail when there are extra arguments" do
+        attempting_to { validate('extra-arg') }.should raise_error(CE, /extra/)
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,91 @@
+require 'jabber-tee/configuration'
+require 'helpers'
+
+module JabberTee
+  describe "ConfigurationReader" do
+    it "should fail when the yaml file doesn't exist" do
+      attempting_to { ConfigurationReader.new('doesnt-exist.yml') }.should raise_error(ConfigurationError, /locate/)
+    end
+
+    it "should load a yaml file and pull the default profile" do
+      r = ConfigurationReader.new('spec/test-config-1.yaml')
+      c = r.profile
+
+      c.username.should eql('gabe@someplace.org')
+      c.room.should be(nil)
+    end
+
+    it "should be able to load sub-profiles" do
+      r = ConfigurationReader.new('spec/test-config-1.yaml')
+      c = r.profile('standard')
+
+      c.room.should eql('cudos@rooms.someplace.org')
+    end
+
+    it "should fail when the profiles section doesn't exist" do
+      r = ConfigurationReader.new('spec/test-config-2.yaml')
+      attempting_to { r.profile('standard') }.should raise_error(ConfigurationError, /profiles/)
+    end
+
+    it "should fail when the profile doesn't exist" do
+      r = ConfigurationReader.new('spec/test-config-1.yaml')
+      attempting_to { r.profile('non-existant') }.should raise_error(ConfigurationError, /non-existant/)
+    end
+  end
+
+  describe "The Configuration" do
+    it "should initialize default values to nil" do
+      c = Configuration.new
+      c.username.should be(nil)
+    end
+
+    it "should set anonymous to false by default" do
+      c = Configuration.new
+      c.anonymous?.should be(false)
+    end
+
+    it "should set SASL mode to false by default" do
+      c = Configuration.new
+      c.sasl?.should be(false)
+    end
+
+    it "should set the digest mode to false by default" do
+      c = Configuration.new
+      c.digest?.should be(false)
+    end
+
+    it "should se the 'in_room?' attribute to false by default" do
+      c = Configuration.new
+      c.in_room?.should be(false)
+    end
+
+    it "should merge options correctly" do
+      options = {:username => 'gabe', :password => 'supersecret'}
+      c = Configuration.new(options)
+      c.username.should eql('gabe')
+      c.password.should eql('supersecret')
+    end
+
+    it "should set 'anonymous' to false when a username is provided" do
+      options = {:username => 'gabe' }
+      c = Configuration.new(options)
+      c.anonymous?.should be(false)
+    end
+
+    it "should merge options correctly more than once" do
+      init = {:username => 'gabe', :password => 'supersecret'}
+      options = {:room => 'rc@someplace'}
+      c = Configuration.new(init)
+      c.merge(options)
+      c.in_room?.should be(true)
+      c.room.should eql('rc@someplace')
+    end
+
+    it "should set the 'to' field correctly" do
+      c = Configuration.new
+      c.merge({:to => 'to-me'})
+      c.in_room?.should be(false)
+      c.to.should eql('to-me')
+    end
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,9 @@
+
+
+def attempting(&block)
+  lambda &block
+end
+
+def attempting_to(&block)
+  lambda &block
+end

data/spec/test-config-1.yaml

@@ -0,0 +1,13 @@
+username: 'gabe@someplace.org'
+password: 'pinchme!Imsecret!'
+nick: 'Gabe'
+
+profiles:
+  standard:
+    room: 'cudos@rooms.someplace.org'
+    sasl: true
+  weird:
+    username: 'weirdo@someplaceelse.org'
+    password: 'notsosecret'
+    nick: 'Jabberwocky Slayer'
+    to: 'jabber-monster@someplaceelse.org'

data/spec/test-config-2.yaml

@@ -0,0 +1,5 @@
+
+username: 'gabe@someplace.org'
+password: 'pinchme!Imsecret!'
+nick: 'Gabe'
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: jabber-tee
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabe McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 -07:00
+default_executable: jabber-tee
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Installs the 'jabber-pipe' utility for sending messages to a remote jabber server.  Instead of a standard client, it reads from standard in and continues to write to the console.
+email: 
+- madeonamac@gmail.com
+executables: 
+- jabber-tee
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- bin/jabber-tee
+- lib/VERSION
+- lib/jabber-tee/cli.rb
+- lib/jabber-tee/client.rb
+- lib/jabber-tee/configuration.rb
+- lib/jabber-tee/errors.rb
+- lib/jabber-tee/version.rb
+- spec/cli_spec.rb
+- spec/configuration_spec.rb
+- spec/helpers.rb
+- spec/test-config-1.yaml
+- spec/test-config-2.yaml
+has_rdoc: true
+homepage: http://github.com/gabemc/jabber-tee
+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: Simple command line utility for piping the output from one command to both the console and a remote jabber server.
+test_files: 
+- spec/helpers.rb
+- spec/configuration_spec.rb
+- spec/cli_spec.rb