ruben 1.0.1 → 1.0.2

data/README.md

@@ -1,49 +1,63 @@
 Ruben
 =====
 
+[![Build Status](https://travis-ci.org/ericqweinstein/ruben.png)](https://travis-ci.org/ericqweinstein/ruben)
+
 ###Description
 
 Ruben is an IRC chat bot written in Ruby. He is inspired, in part, by [Hubot](http://hubot.github.com/), his CoffeeScript brother from another mother.
 
 ###Dependencies
 
-* Ruby 1.9.3+
-* Rake 10.0.3+
-* RSpec 2.12.2+
+* Ruby 1.9.3 (not tested in Ruby 2.0)
+* Rake 10.0.3 (for running tests)
+* RSpec 2.12.2 (for running tests)
 
 ###Installation
 
-Ruben's a little janky, but he works. Version 1.0.1 is available from RubyGems; you can get your version of Ruben by typing
+Version 1.0.2 is available from RubyGems; you can get your version of Ruben by typing
 
-    $ gem install ruben
+```bash
+$ gem install ruben
+```
 
 ###Getting Started
 
 Ruben comes with a `bin/ruben` executable, so you can run him with
 
-    $ ruben <server> <port> <channel> <nick>
+```bash
+$ ruben <server> <port> <channel> <nick>
+```
 
 Ruben takes a server name, port number, channel name, and nick as command line arguments. For example, if you type: 
 
-    $ ruben irc.freenode.net 6667 test_chan ruben_
+```bash
+$ ruben irc.freenode.net 6667 test_chan ruben_
+```
 
 You should see:
 
-    $ >> USER ruben 0 * :Ruben
-    $ >> NICK ruben_
-    $ >> JOIN #test_chan
+```
+$ >> USER ruben 0 * :Ruben
+$ >> NICK ruben_
+$ >> JOIN #test_chan
+
+...
+```
 
-    ...
+You can get Ruben's usage information by typing `ruben -h` or `ruben --help`.
 
 ###Adding Scripts
 
 You can extend Ruben's functionality by adding scripts to `/scripts`. Each script should be a `.rb` file that instantiates a new `Listener` object, like so:
 
-    thing_to_do lambda do
-      # Arcane magicks go here
-    end
+```ruby
+thing_to_do lambda do
+  # Arcane magicks go here
+end
 
-    Listener.new(/Regexp/, thing_to_do)
+Listener.new(/Regexp/, thing_to_do)
+```
 
 Ruben's listeners hear every incoming IRC message. If a listener's Regexp matches the inbound message, Ruben will call the associated lambda.
 

data/Rakefile

@@ -1,7 +1,6 @@
 require 'rake'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+task :default do
+  sh "rspec"
+end
 

data/bin/ruben

@@ -1,17 +1,43 @@
 #!/usr/bin/env ruby -w
 
+require "optparse"
 require_relative "../lib/robot"
 
+options = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: ruben SERVER PORT CHANNEL NICK"
+  opts.separator ""
+  opts.separator "Running Ruben:"
+  opts.separator "  SERVER is an IRC server (e.g. irc.freenode.net)."
+  opts.separator "  PORT is the IRC port (e.g. 6667)."
+  opts.separator "  CHANNEL is the IRC channel you want to join."
+  opts.separator "  NICK is the nickname you want Ruben to use."
+  opts.separator ""
+
+  opts.on("-h", "--help", "Display this screen") do
+    puts opt_parser
+    exit
+  end
+end
+
+begin opt_parser.parse!
+rescue OptionParser::InvalidOption => e
+  abort("An error occurred: #{e}. Run ruben -h for help.")
+end
+
 begin
-  $ruben = Robot.new(ARGV[0], ARGV[1], ARGV[2], ARGV[3])
-rescue SocketError
-  puts "-- Usage: ruben <server> <port> <channel> <nick>"
-  puts "-- Error: Either \"#{ARGV[0]}\" is not a valid IRC network or \"#{ARGV[1]}\" is not a valid port number."
-  puts "-- You can find help at http://www.irchelp.org/"
+  ruben = Robot.instance
+  ruben.server  = ARGV[0]
+  ruben.port    = ARGV[1]
+  ruben.channel = ARGV[2]
+  ruben.nick    = ARGV[3]
+rescue SocketError => e
+  puts "An error occurred: #{e}. Run ruben -h for help."
 end
 
 # Ensure Ruben leaves politely when ^C-ed
-trap("INT") { $ruben.quit }
+trap("INT") { ruben.quit }
 
-$ruben.run
+ruben.run
 

data/lib/robot.rb

@@ -1,21 +1,27 @@
 require "socket"
+require "singleton"
 require_relative "robot/channel"
 require_relative "robot/listener"
 
 class Robot
+  include Singleton
   include Channel
 
-  attr_reader :channel, :socket, :nick
-  attr_accessor :listeners
+  attr_reader :socket
+  attr_accessor :server, :port, :channel, :nick, :listeners
 
-  def initialize(server, port, channel, nick)
-    @socket    = TCPSocket.open(server, port)
-    @channel   = channel
-    @nick      = nick
+  def initialize
     @listeners = Listener.all_listeners
   end
 
   def run
+    begin
+      @socket = TCPSocket.open(server, port)
+    rescue
+      puts "An error occurred. Make sure to call Ruben with a valid server and port name."
+      exit
+    end
+
     send "USER ruben 0 * :Ruben"
     send "NICK #{@nick}"
     send "JOIN ##{@channel}"

data/lib/robot/scripts/engage.rb

@@ -1,8 +1,8 @@
 # MAXIMUM WARP
 
 warp_factor = lambda do
-  $ruben.say "WARP FACTOR #{rand(9) + 1}"
+  Robot.instance.say "WARP FACTOR #{rand(9) + 1}"
 end
 
-Listener.new(/\bengage\b/i, warp_factor)
+Listener.new(/ :\bengage\b/i, warp_factor)
 

data/lib/robot/scripts/flip_coin.rb

@@ -0,0 +1,11 @@
+# Heads I win, tails you lose
+
+flip_coin = lambda do
+  coin_flip = rand(2)
+  result = coin_flip == 1 ? "heads" : "tails"
+
+  Robot.instance.say "#{result}!"
+end
+
+Listener.new(/ :(?:(?:ruben)?,?\s*flip\s*(?:a)?\s*coin)/i, flip_coin)
+

data/lib/robot/scripts/hello.rb

@@ -2,8 +2,8 @@
 
 say_hello = lambda do
   greetings = ["sup", "hey", "what up", "sup g"]
-  $ruben.say "#{greetings.sample}"
+  Robot.instance.say "#{greetings.sample}"
 end
 
-Listener.new(/:(?:hi|hello|hey)\s*,?\s*(?:ruben)/i, say_hello)
+Listener.new(/ :(?:hi|hello|hey)\s*,?\s*(?:ruben)/i, say_hello)
 

data/lib/robot/scripts/politeness.rb

@@ -2,8 +2,8 @@
 
 youre_welcome = lambda do
   responses = ["no prob", "sure thing", "np boss"]
-  $ruben.say "#{responses.sample}"
+  Robot.instance.say "#{responses.sample}"
 end
   
-Listener.new(/:(?:thanks|ty|thank\s*you),?\s*(?:ruben)/i, youre_welcome)
+Listener.new(/ :(?:thanks|ty|thank\s*you),?\s*(?:ruben)/i, youre_welcome)
 

data/lib/robot/scripts/roll_dice.rb

@@ -0,0 +1,10 @@
+# Ruben's a gamblin' man
+
+roll_dice = lambda do
+  lucky_number = rand(5) + 1
+
+  Robot.instance.say "you rolled a #{lucky_number}!"
+end
+
+Listener.new(/ :(?:(?:ruben)?,?\s*roll\s*(?:the)?\s*dice)/i, roll_dice)
+

data/lib/robot/scripts/tell_time.rb

@@ -4,8 +4,8 @@ what_time = lambda do
   current_hour = Time.now.localtime.strftime("%H").to_i
   current_hour = current_hour > 12 ? current_hour - 12 : current_hour
 
-  $ruben.say "I dunno, around #{Time.now.localtime.strftime("#{current_hour}:%M %p")}"
+  Robot.instance.say "I dunno, around #{Time.now.localtime.strftime("#{current_hour}:%M %p")}"
 end
 
-Listener.new(/(?:what\s*time)/i, what_time)
+Listener.new(/ :(?:what\s*time)/i, what_time)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruben
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies: []
 description: Ruben is an IRC chat bot written in Ruby. He is inspired, in part, by
   Hubot, his CoffeeScript brother from another mother.
@@ -24,8 +24,10 @@ files:
 - lib/robot/channel.rb
 - lib/robot/listener.rb
 - lib/robot/scripts/engage.rb
+- lib/robot/scripts/flip_coin.rb
 - lib/robot/scripts/hello.rb
 - lib/robot/scripts/politeness.rb
+- lib/robot/scripts/roll_dice.rb
 - lib/robot/scripts/tell_time.rb
 - lib/robot.rb
 - LICENSE
@@ -51,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: An extensible IRC chat bot.