campline 0.0.2 → 0.2.0

data/Gemfile

@@ -1,7 +1,8 @@
 source "http://rubygems.org"
 
-gem "tinder"
+gem "tinder", "1.8.0"
 gem "cli-colorize"
+gem "mixlib-cli"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/README.rdoc

@@ -2,9 +2,15 @@
 
 A tiny Campfire client.
 
-Usage: campline <domain> <room> <username>
+Usage: 
 
-The client will prompt for your password and that's it - you're in!
+  campline -d <domain> -r <room> -u <username>
+  
+  OR
+  
+  campline -d <domain> -r <room> -k <api_key>
+
+The client will prompt for your password if you supply your username. And that's it - you're in!
 
 == Contributing to campline
  
@@ -16,6 +22,13 @@ The client will prompt for your password and that's it - you're in!
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== To do/planned list
+
+* Auto-reconnect on timeout
+* Revamp command line in order to support login with api keys
+* Nicer error messages
+* Convert images to ascii art 8-)
+
 == Copyright
 
 Partially based on campfire-cli, by Petyo Ivanov. STDIN/OUT tricks by http://www.rubyquiz.com/quiz45.html (thanks @cfcosta!)

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.2.0

data/bin/campline

@@ -1,14 +1,12 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
+require 'rubygems'
+require "cli_config"
 require "campline"
 
-if ARGV.size != 3
-  puts "Usage: campline <domain> <room> <username>"
-  exit 1
-end
-
 begin
-  domain, room, username = *ARGV
+  config = CliConfig.new
+  config.load!
 
   begin
     %x{stty -echo}
@@ -18,7 +16,9 @@ begin
     %x{stty raw -echo}
   end
 
-  Campline::Client.new(domain, room, username, password).listen!
+  Campline::Client.new(config.data.merge(:password => password)).listen!
+rescue => e
+  puts e.message
 ensure
   %x{stty -raw echo}
 end

data/campline.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "campline"
-  s.version = "0.0.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Herval Freire"]
-  s.date = "2012-07-02"
+  s.date = "2012-09-17"
   s.description = "A tiny Campfire client for command line"
   s.email = "hervalfreire@gmail.com"
   s.executables = ["campline"]
@@ -28,36 +28,40 @@ Gem::Specification.new do |s|
     "bin/campline",
     "campline.gemspec",
     "lib/campline.rb",
+    "lib/cli_config.rb",
     "spec/campline_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/herval/campline"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.15"
   s.summary = "A tiny Campfire client"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<tinder>, [">= 0"])
+      s.add_runtime_dependency(%q<tinder>, ["= 1.8.0"])
       s.add_runtime_dependency(%q<cli-colorize>, [">= 0"])
+      s.add_runtime_dependency(%q<mixlib-cli>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
     else
-      s.add_dependency(%q<tinder>, [">= 0"])
+      s.add_dependency(%q<tinder>, ["= 1.8.0"])
       s.add_dependency(%q<cli-colorize>, [">= 0"])
+      s.add_dependency(%q<mixlib-cli>, [">= 0"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
   else
-    s.add_dependency(%q<tinder>, [">= 0"])
+    s.add_dependency(%q<tinder>, ["= 1.8.0"])
     s.add_dependency(%q<cli-colorize>, [">= 0"])
+    s.add_dependency(%q<mixlib-cli>, [">= 0"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<bundler>, [">= 0"])

data/lib/campline.rb

@@ -1,75 +1,123 @@
-require 'rubygems'
+# encoding: utf-8
+
+require 'time'
 require 'thread'
 require 'tinder'
 require 'io/wait'
 require 'yaml'
 require 'cli-colorize'
 
+unless Gem::Specification::find_all_by_name('ruby-growl').empty?
+  require 'ruby-growl'
+  $growl = Growl.new "localhost", "ruby-growl", "UDP"
+else
+  print "Install the ruby-growl to enable Growl notification support\r\n"
+end
+
 module Campline
   
+  GO_BACK = "\r\e[0K" # return to beginning of line and use the ANSI clear command "\e" or "\003"
+
   class Client
     include Tinder
     include CLIColorize
 
-    def initialize(domain, room, username, password)
-      @domain = domain
-      @room = room
-      @username = username
-      @password = password
-      @user_id = nil
+    def initialize(options)
+      @config = options
+      @me = nil
       @room_users = []
       @output_buffer = ""
       @input_buffer = Queue.new
     end
 
-    def print_message(msg)
-      return if (msg[:user] && msg[:user][:id] == @user_id)
-      case msg[:type]
-        when "SoundMessage" then
-          @input_buffer << "#{green(msg[:user][:name])} played some annoying sound" 
-        when "PasteMessage" then
-          @input_buffer << "#{green(msg[:user][:name])}: #{msg[:body]}"
-        when "TextMessage" then
-          @input_buffer << "#{green(msg[:user][:name])}: #{msg[:body]}"
+    def print_message(msg, flush = true, ignore_current_user = true)
+      return if msg[:user].nil?
+
+      return if (msg[:user] && msg[:user][:id] == @me[:id] && ignore_current_user)
+      @input_buffer << case msg[:type]
+        when "KickMessage","LeaveMessage"
+          white("#{msg[:user][:name]} left the room")
+        when "EnterMessage"
+          white("#{msg[:user][:name]} joined the room")
+        when "SoundMessage"
+          "#{green(msg[:user][:name])} #{white('played some sound. Sound is for dummies.')}" 
+        when "PasteMessage", "TextMessage", "TweetMessage"
+          "#{green(msg[:user][:name])}: #{msg[:body]}"
+        else
+          msg
       end
+      flush_input_buffer! if flush
+    end
+
+    def print_inline(msg)
+      print "#{GO_BACK}#{msg}\r\n"
+      show_prompt
     end
 
     def commands
       {
-        "/help" => lambda { print "\r\nAvailable commands: /users (list users on the room), /exit (quit!)"},
-        "/exit" => lambda { @campfire_room.leave; exit; },
-        "/users" => lambda { list_users }
+        "/help" => lambda { print_inline(white("Available commands: /users (list users on the room), /exit (quit!), /log (show latest messages)")) },
+        "/exit" => lambda { exit! },
+        "/users" => lambda { list_users },
+        "/log" => lambda { print_transcript }
       }
     end
 
     def list_users
-      print white("\r\nIn the room right now: #{@room_users.join(', ')}")
+      update_user_list
+      print_inline(white("In the room right now: #{@room_users.collect(&:name).join(', ')}"))
     end
 
-    def update_user_list
-      new_list = @campfire_room.users.collect(&:name)
-      @room_users = new_list if @room_users.empty?
+    def print_transcript
+      update_user_list
+      transcript = @campfire_room.transcript(Date.today) || []
+      
+      # load user names, as these don't come on the transcript...
+      talking_users = {}
+      @room_users.each do |user|
+        talking_users[user.id] = user
+      end
 
-      new_guys = new_list - @room_users
-      new_guys.each { |n| @input_buffer << "#{n} joined the room" }
+      transcript.reverse[0..15].reverse.each do |m| 
+        print_message(m.merge(:user => talking_users[m[:user_id]], :type => "TextMessage", :body => m[:message]), false, false)
+      end
+      flush_input_buffer!
+      print_inline(white("Last message received at #{transcript[-1][:timestamp]}"))
+    end
 
-      dead_guys = @room_users - new_list
-      dead_guys.each { |n| @input_buffer << "#{n} left the room" }
-      @room_users = new_list
+    def update_user_list
+      @room_users = @campfire_room.users
     end
 
     def backspace!
       @output_buffer.chop!
-      go_back = "\r\e[0K" # return to beginning of line and use the ANSI clear command "\e" or "\003"
-      print "#{go_back}> #{@output_buffer}"
+      print "#{GO_BACK}> #{@output_buffer}"
     end
 
     def show_prompt
-      puts "\r\n"
-      print "> #{@output_buffer}"
+      print "#{GO_BACK}> #{@output_buffer}"
       $stdout.flush
     end
 
+    def exit!
+      @campfire_room.leave
+      print "\r\nGoodbye..."
+      exit    
+    end
+
+    def flush_input_buffer!
+      unless @input_buffer.empty? # read from server
+        notify_growl!
+        print GO_BACK
+        print "#{@input_buffer.shift}\r\n" until @input_buffer.empty?
+        show_prompt
+      end      
+    end
+
+    def notify_growl!
+      $growl.notify("ruby-growl", "ruby-growl", "Greetings!") if $growl
+    end
+
     def blue(str)
       colorize(str, :foreground => :blue)
     end
@@ -87,74 +135,87 @@ module Campline
     end
 
     def send_line!
-      if commands[@output_buffer]
-        commands[@output_buffer].call
-      else
-        @campfire_room.speak @output_buffer
-      end
+      buffer = @output_buffer
       @output_buffer = ""
+      if commands[buffer]
+        commands[buffer].call
+      else
+        return if buffer.blank?
+        Thread.new do
+          begin
+            print_message({ :user => @me, :type => "TextMessage", :body => buffer }, true, false)
+            @campfire_room.speak(buffer)
+          rescue => e
+            print_inline(white("A message could not be sent: #{buffer}"))
+          end
+        end
+      end        
     end
 
-    def listen!
-      puts "Logging in...\r\n"
-      begin
-        campfire = Campfire.new @domain, :username => @username, :password => @password, :ssl => true
-      rescue Tinder::AuthenticationFailed
-        raise "There was an authentication error - check your username and password\r\n"
-      end
-      @user_id = campfire.me.id
-
-      puts "Joining #{@room}...\r\n"
-      @campfire_room = campfire.find_room_by_name @room
-      raise "Can't find room named #{@room}!\r\n" if @campfire_room.nil?
-      
-      @campfire_room.join
-      update_user_list
-      
-      puts "You're up! For a list of available commands, type #{highlight('/help')}\r\n"
-
-      Thread.new(@campfire_room) do |listener|
+    def start_message_listener!(room)
+      Thread.new do
         while true
-          listener.listen do |msg|
-            print_message msg
+          begin
+            room.listen do |msg|
+              print_message(msg)
+            end
+          rescue => e
+            # ignore errors!
+            #  puts e
           end
         end
       end
+    end
 
+    def start_typing_agent!
       Thread.new do
-        while true
-          sleep(10)
-          update_user_list
+        while character = $stdin.getc
+          case character
+            when ?\C-c
+              exit!
+            when ?\r, ?\n
+              send_line!
+              show_prompt
+            when ?\e # arrow keys & fn keys
+              # do nothing
+            when ?\u007F, ?\b
+              backspace!
+            else
+              @output_buffer << character
+              print character.chr
+              $stdout.flush
+          end
         end
       end
+    end
 
-      Thread.new do
-        while true #msg = Readline.readline('> ', true)
-          if $stdin.ready?
-            character = $stdin.getc
-            case character
-              when ?\C-c
-                break
-              when ?\r, ?\n
-                send_line!
-                show_prompt
-              when ?\u007F, ?\b
-                backspace!
-              else
-                @output_buffer << character
-                print character.chr
-                $stdout.flush
-            end
-          end
+    def listen!
+      print "Logging in...\r\n"
+      begin
+        params = { :ssl => true }
+        if @config[:api_key]
+          params[:token] = @config[:api_key]
+        else
+          params.merge!(:username => @config[:username], :password => @config[:password])
+        end
+        campfire = Campfire.new(@config[:domain], params)
+      rescue Tinder::AuthenticationFailed
+        raise "There was an authentication error - check your login information\r\n"
+      end
+      @me = campfire.me
 
-          unless @input_buffer.empty?   # read from server
-            puts "\r\n"
-            puts "#{@input_buffer.shift}\r\n" until @input_buffer.empty?
-            show_prompt
-          end
+      print "Joining #{@config[:room]}...\r\n"
+      @campfire_room = campfire.find_room_by_name(@config[:room])
+      raise "Can't find room named #{@config[:room]}!\r\n" if @campfire_room.nil?
+      
+      @campfire_room.join
+      update_user_list
+      
+      print_transcript
+      print_inline("You're up! For a list of available commands, type #{highlight('/help')}\r\n")
 
-        end
-      end.join
+      start_message_listener!(@campfire_room)
+      start_typing_agent!.join
     end
   end
 

data/lib/cli_config.rb

@@ -0,0 +1,52 @@
+require "mixlib/cli"
+
+class CliConfig
+  include Mixlib::CLI
+
+  option :room,
+    :short => "-r ROOM_NAME",
+    :long => "--room ROOM_NAME",
+    :description => "Use quotes if there are spaces on the room name"
+
+  option :domain,
+    :short => "-d DOMAIN_NAME",
+    :long => "--domain DOMAIN_NAME",
+    :description => "The subdomain of your campfire room - <domain>.campfirenow.com"
+
+
+  option :username,
+    :short => "-u USERNAME",
+    :long => "--user USERNAME"
+
+  option :api_key,
+    :short => "-k API_KEY",
+    :long => "--key API_KEY",
+    :description => "Use this to log without a username/password prompt. You can skip the -u option if you use that"
+
+  option :help,
+    :short => "-h",
+    :long => "--help",
+    :on => :tail,
+    :description => "This handy guide you're reading right now",
+    :boolean => true,
+    :show_options => true,
+    :exit => 0
+
+  option :version,
+    :short => "-v",
+    :long => "--version",
+    :proc => Proc.new { puts "Campline version #{File.open('VERSION').read}" },
+    :boolean => true,
+    :exit => 0
+
+  def load!
+    self.parse_options
+    unless self.config[:domain] && self.config[:room] && (self.config[:username] || self.config[:api_key])
+      raise "Missing parameters - please run 'campline --help' for help" 
+    end
+  end
+
+  def data
+    config
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: campline
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,27 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-02 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinder
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152712180 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - =
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2152712180
 - !ruby/object:Gem::Dependency
   name: cli-colorize
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2152711540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *2152711540
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: &2152710400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152710400
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156559220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156559220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156558600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -69,15 +65,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.8.0
+  version_requirements: *2156558600
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156557060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2156557060
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2156555320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,12 +87,7 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.4
+  version_requirements: *2156555320
 description: A tiny Campfire client for command line
 email: hervalfreire@gmail.com
 executables:
@@ -126,6 +107,7 @@ files:
 - bin/campline
 - campline.gemspec
 - lib/campline.rb
+- lib/cli_config.rb
 - spec/campline_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/herval/campline
@@ -143,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3789922764660391293
+      hash: -2165468162116161805
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A tiny Campfire client