jabber-tee 0.1.1 → 0.2.0

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    jabber-tee (0.1.1)
+      choosy (>= 0.4.8)
+      highline (>= 1.5.2)
+      xmpp4r (>= 0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-notification (2.3.1)
+      autotest (~> 4.3)
+    choosy (0.4.8)
+    diff-lcs (1.1.2)
+    highline (1.6.1)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    xmpp4r (0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  autotest-notification
+  choosy (>= 0.4.8)
+  highline (>= 1.5.2)
+  jabber-tee!
+  rspec
+  xmpp4r (>= 0.5)

data/README.markdown

@@ -13,6 +13,14 @@ The command line tool can be installed with:
 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'
+
+or
+
+    echo "I am $(whoami) at $(hostname)" | jabber-tee --to somebody@somewhere.com
+
+Alternatively, you can supply a list of arguments that will be run as a command, which is essentially equivalent:
+
+    jabber-tee --to somebody@somewhere.com -- echo "I am $(whoami) at $(hostname)"
   
 # Configuration
 
@@ -24,12 +32,13 @@ An example configuration file:
     username: my.name@jabber.org
     nick: 'Gabe'
 
-    # Individual profiles that customize global variables    
+    # Individual profiles that customize global variables
     profiles:
         new-hotness:
             # Uses the standard username, above
             nick: 'Mr. Super Cool'
             room: 'HipCentral'
+            password: 'secret'
     
         somebody.else:
             username: supercooldude@gmail.com

data/Rakefile

@@ -4,52 +4,16 @@ $LOAD_PATH.unshift File.expand_path("../spec", __FILE__)
 require 'fileutils'
 require 'rake'
 require 'rubygems'
-require 'spec/rake/spectask'
-require 'jabber-tee/version'
+require 'rspec/core/rake_task'
+require 'choosy/rake'
 
 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-tee' 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
+RSpec::Core::RakeTask.new :spec
 
-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
+task :clean => ['gem:clean']

data/bin/jabber-tee

@@ -2,4 +2,4 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'jabber-tee/cli'
-JabberTee::CLI.new(ARGV).execute!
+JabberTee::CLI.new.execute!(ARGV)

data/lib/VERSION.yml

@@ -0,0 +1,6 @@
+--- 
+version: 
+  major: 0
+  minor: 2
+  tiny: 0
+date: 31/03/2011

data/lib/jabber-tee/cli.rb

@@ -1,164 +1,52 @@
-require 'optparse'
 require 'jabber-tee/errors'
-require 'jabber-tee/version'
-require 'jabber-tee/client'
-require 'jabber-tee/configuration'
+require 'jabber-tee/executor'
+require 'choosy'
 
 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
+    def execute!(args)
+      command.execute!(args)
     end
 
-    def parse!(args)
-      parse_options(args)
-      validate_args(args)
+    def parse!(args, propagate=false)
+      command.parse!(args, propagate)
     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.
+    def command
+      Choosy::Command.new :'jabber-tee' do 
+        printer :standard
+        executor Executor.new
 
-   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",
-                "it must be defined in your",
-                "~/.jabber-tee.yml file.") 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
-=begin
-        opts.on('-a', '--anonymous',
-                "Disregards the username information and",
-                "logs in using anonymous authentication.") do |a|
-          options[:anonymous] = true
-        end
-=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
-=begin
-        opts.on('--sasl',
-                "By default, the connection does not",
-                "use SASL authentication.",
-                "This enables SASL connections") do |s|
-          options[:sasl] = true
+        section 'Description:' do
+          para '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.'
+          para 'The configuration file should live under ~/.jabber-tee.yml. Please see http://github.com/gabemc/jabber-tee for more information.'
         end
-        opts.on('--digest',
-                "When not using SASL, you can use the digest",
-                "authentication mechanism.") do |d|
-          options[:digest] = true
-        end
-=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 
+        section 'Connections:' do
+          string :username, "The user@host.org name used to connect to the jabber server."
+          string :password, "The password for the user to connect with to the jabber server. If not given, it must be defined in your configuration file."
+          string :nick, "The nickname to use when connecting to the server."
+          string :Profile, "The name of the profile defined in the ~/.jabber-tee.yml or /etc/jabber-tee.yml configuration file to connect with."
+          #string :anonymous, "Disregards the username information and logs in using anonymous authentication."
+          #boolean_ :sasl, "By default, the connection does not use SASL authentication. This enables SASL connections."
+          #boolean_ :digest, "When not using SASL, you can use the digest authentication mechanism."
         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
+        section 'Ouput: (One required)' do
+          string :to, "Who to send the message to."
+          string :room, "The room to send the messages to."
         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)
+        section 'Informative:' do
+          help 
+          version Choosy::Version.load_from_parent
+        end
 
-      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)
+        arguments do |builder|
+          metaname '[-- COMMAND]'
+          count :at_least => 0
         end
-      else
-        Configuration.new(options)
       end
     end
-  end # CLI
+  end#CLI
 end

data/lib/jabber-tee/client.rb

@@ -1,6 +1,4 @@
 require 'jabber-tee/errors'
-
-require 'rubygems'
 require 'xmpp4r'
 require 'xmpp4r/muc'
 
@@ -20,20 +18,8 @@ module JabberTee
       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)
+      message.chomp!
       if config.in_room?
         @muc.say(message)
       else

data/lib/jabber-tee/configuration.rb

@@ -1,20 +1,15 @@
 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)
+      @config = YAML::load_file(yaml_file)
     end
     
     def profile(name=nil)
@@ -28,7 +23,7 @@ module JabberTee
         end
         profile = profiles[name]
         if profile.nil?
-          raise JabberTee::ConfigurationError.new("Unable to load the #{name} profile from your home configuration.")
+          raise JabberTee::ConfigurationError.new("Unable to load the '#{name}' profile from your home configuration.")
         end
         config.merge(profile)
       end
@@ -36,46 +31,34 @@ module JabberTee
   end
 
   class Configuration
-    ATTRIBUTES = ['username', 'nick', 'password', 'anonymous', 'sasl', 'digest', 'room', 'to']
+    ATTRIBUTES = [:username, :nick, :password, :anonymous, :room, :to]
 
     attr_reader :username, :nick, :to, :room
 
     def initialize(options=nil)
+      @username = @nick = @to = @room = @anonymous = @password = nil
       if !options.nil?
         merge(options)
       end
     end
 
-    def merge(options)
-      #self if options.nil?
+    def merge(options=nil)
+      return self if options.nil?
       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
+        value = options[attr] || options[attr.to_s]
+        instance_variable_set("@#{attr}", value) if value
       end
       self
     end
 
     def password
-      if @password.nil?
-        @password = ask("#{username}: password: ") {|q| q.echo = false }
-      end
-      @password
+      @password ||= ask("#{username}: password: ") {|q| q.echo = false }
     end
 
     def anonymous?
       !@anonymous.nil? && username.nil?
     end
 
-    def sasl?
-      !@sasl.nil?
-    end
-
-    def digest?
-      !@digest.nil?
-    end
-
     def in_room?
       !@room.nil?
     end
@@ -83,9 +66,5 @@ module JabberTee
     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/executor.rb

@@ -0,0 +1,69 @@
+require 'jabber-tee/errors'
+require 'jabber-tee/client'
+require 'jabber-tee/configuration'
+require 'choosy/terminal'
+
+module JabberTee
+  class Executor
+    include Choosy::Terminal
+
+    JABBER_FILE_LOCATIONS = [
+      File.join(ENV['HOME'], '.jabber-tee.yml'),
+      '/etc/jabber-tee.yml'
+    ]
+
+    def execute!(args, options)
+      command = format_command(args)
+      if command && stdin?
+        die "Cannot both execute command and read from STDIN"
+      elsif command.nil? && !stdin?
+        die "Unable to read from STDIN"
+      end
+
+      client = create_client(options)
+      code = pipe_in(command) do |line|
+        client.say(line)
+        puts line
+      end
+
+      exit code.to_i
+    end
+
+    private
+    def create_client(options)
+      config = load_configuration(options)
+      if config.destination_missing?
+        die "Either the --to or --room flag is required."
+      end
+
+      Client.new(config)
+    end
+
+    def format_command(args)
+      if args.length > 0 
+        if !command_exists?(args[0])
+          die "Not a recognized command: #{args[0]}"
+        else
+          args.join(' ')
+        end
+      else
+        nil
+      end
+    end
+
+    def load_configuration(options)
+      begin
+        config_file = JABBER_FILE_LOCATIONS.select {|l| File.exists?(l)}
+
+        if !config_file.nil? && File.exists?(config_file[0])
+          reader = ConfigurationReader.new(config_file[0])
+          reader.profile(options[:Profile]).merge(options)
+        else
+          Configuration.new(options)
+        end
+      rescue JabberTee::ConfigurationError => e
+        die e.message
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -44,16 +44,6 @@ module JabberTee
       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)

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jabber-tee
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gabe McArthur
@@ -15,8 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -07:00
-default_executable: jabber-tee
+date: 2011-03-31 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: highline
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 5
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
         segments: 
         - 0
         - 5
@@ -50,21 +47,59 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: choosy
   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
+        - 4
+        - 8
+        version: 0.4.8
+  type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: autotest-notification
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: Installs the 'jabber-tee' 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
@@ -72,30 +107,31 @@ executables:
 - jabber-tee
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
+- Gemfile
 - README.markdown
+- Gemfile.lock
 - Rakefile
 - bin/jabber-tee
-- lib/VERSION
+- lib/jabber-tee/errors.rb
 - lib/jabber-tee/cli.rb
 - lib/jabber-tee/client.rb
+- lib/jabber-tee/executor.rb
 - lib/jabber-tee/configuration.rb
-- lib/jabber-tee/errors.rb
-- lib/jabber-tee/version.rb
-- spec/cli_spec.rb
-- spec/configuration_spec.rb
+- lib/VERSION.yml
 - spec/helpers.rb
-- spec/test-config-1.yaml
+- spec/configuration_spec.rb
 - spec/test-config-2.yaml
+- spec/test-config-1.yaml
 has_rdoc: true
 homepage: http://github.com/gabemc/jabber-tee
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -103,7 +139,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -112,7 +147,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -123,7 +157,5 @@ 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
+test_files: []
+

data/lib/VERSION

@@ -1 +0,0 @@
-0.1.1

data/lib/jabber-tee/version.rb

@@ -1,12 +0,0 @@
-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

@@ -1,72 +0,0 @@
-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
-=begin
-      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
-=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