ruben 1.0.2 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09c93b25e4f051e816791d7c6d1f56132c8e916e
+  data.tar.gz: a0e138d4f441de54b04d4a35b3be5f866e76498f
+SHA512:
+  metadata.gz: c385cdcbc386cd357aa000a7f75b84a8fbd8bf6d107e5a98f3511cc6a72e605031f1abf7ab11ec505a7c94e15ecf626318963ab2fc80a6957492a49e8ee054cd
+  data.tar.gz: 41131b1132fe46909a129bb2d1495aa0c5a07760f2206d8c46710343a393a4ad66ea63f2bebb38103c2e8779ee19e56c619cd169d189b1b7c57ac65121bc40d7

data/LICENSE

@@ -19,4 +19,3 @@ 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.md

@@ -4,32 +4,28 @@ 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 (not tested in Ruby 2.0)
-* Rake 10.0.3 (for running tests)
-* RSpec 2.12.2 (for running tests)
+* Ruby 1.9.3+
+* Rake 10.0.4 (for running tests, if that's your jam)
+* RSpec 2.13.0 (see above)
 
 ###Installation
-
-Version 1.0.2 is available from RubyGems; you can get your version of Ruben by typing
+Version 1.1.0 is available from RubyGems; you can get your version of Ruben by typing
 
 ```bash
 $ gem install ruben
 ```
 
 ###Getting Started
-
 Ruben comes with a `bin/ruben` executable, so you can run him with
 
 ```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 takes a server name, port number, channel name, and nick as command line arguments. For example, if you type:
 
 ```bash
 $ ruben irc.freenode.net 6667 test_chan ruben_
@@ -48,7 +44,6 @@ $ >> 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:
 
 ```ruby
@@ -60,4 +55,3 @@ 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,6 +1,41 @@
-require 'rake'
+#!/usr/bin/env rake
+# encoding: UTF-8
 
-task :default do
-  sh "rspec"
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+task default: :help
+
+desc 'Display help menu'
+task :help do
+  puts <<-eos
+  Available Rake tasks:
+
+  rake help     # Display help menu
+  rake rubocop  # Lint
+  rake spec     # Run tests
+  rake yard     # Generate documentation
+  eos
+end
+
+desc 'Lint'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = %w(bin/**/* lib/**/*.rb)
+end
+
+desc 'Run tests'
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.rspec_opts = ['--color --format d']
+    task.pattern    = './spec/**/*_spec.rb'
+  end
 end
 
+desc 'Generate documentation'
+task :yard do
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w(bin/* lib/**/*.rb)
+    t.options = ['--protected', '--private']
+  end
+end

data/bin/ruben

@@ -1,21 +1,21 @@
 #!/usr/bin/env ruby -w
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
-require "optparse"
-require_relative "../lib/robot"
-
-options = {}
+require 'optparse'
+require_relative '../lib/robot'
 
 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
+  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
@@ -37,7 +37,6 @@ rescue SocketError => e
 end
 
 # Ensure Ruben leaves politely when ^C-ed
-trap("INT") { ruben.quit }
+trap('INT') { ruben.quit }
 
 ruben.run
-

data/lib/robot.rb

@@ -1,8 +1,20 @@
-require "socket"
-require "singleton"
-require_relative "robot/channel"
-require_relative "robot/listener"
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+require 'socket'
+require 'singleton'
+require_relative 'robot/channel'
+require_relative 'robot/listener'
 
+# Handles connection to the TCP socket and
+# sending credentials as per the IRC protocol.
+# @see http://tools.ietf.org/html/rfc2812
+# @attr_reader [TCPSocket] socket A TCP socket.
+# @attr [String] server An IRC server.
+# @attr [Integer] port The port to connect to.
+# @attr [String] channel The IRC channel to join.
+# @attr [String] nick The robot's nickname.
+# @attr [Array<Listener>] listeners A list
+# of all registered listeners.
 class Robot
   include Singleton
   include Channel
@@ -11,24 +23,22 @@ class Robot
   attr_accessor :server, :port, :channel, :nick, :listeners
 
   def initialize
-    @listeners = Listener.all_listeners
+    @listeners = Listener.listeners
   end
 
+  # The main event loop.
   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
+    rescue => e
+      puts "An error occurred: #{e.message}"
+      exit 1
     end
 
-    send "USER ruben 0 * :Ruben"
+    send 'USER ruben 0 * :Ruben'
     send "NICK #{@nick}"
     send "JOIN ##{@channel}"
 
-    until @socket.eof? do
-      listen
-    end
+    listen until @socket.eof?
   end
 end
-

data/lib/robot/channel.rb

@@ -1,43 +1,51 @@
-require_relative "listener"
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+require_relative 'listener'
 
-# Load scripts
-Dir[File.dirname(__FILE__) + "/scripts/*.rb"].each { |script| require script }
+# Load all our 'bot's scripts.
+Dir[File.dirname(__FILE__) + '/scripts/*.rb'].each { |script| require script }
 
+# Handles communcation with IRC.
 module Channel
+  # Things the robot might say when disconnecting.
+  PARTING_MESSAGES = ['bye', 'peace!', 'later', 'I\'m out']
 
-  PARTING_MESSAGES = ["bye", "peace!", "later", "I'm out"]
-
+  # Sends a message to IRC.
+  # @param [String] msg The message to send.
   def send(msg)
     @socket.puts msg
-    puts "<< " << msg
+    puts '<< ' << msg
   end
 
+  # Sends a message to users in the channel.
+  # @param [String] msg The message to say.
   def say(msg)
     send "PRIVMSG ##{@channel} :#{msg}"
   end
 
+  # Continuously listens to the socket
+  # for messages coming from either IRC
+  # or users in the channel.
   def listen
     @inbound = @socket.gets
-    puts ">> " << @inbound
+    puts '>> ' << @inbound
 
-    # Stay connected to the server
-    if @inbound.match(/^PING (.*)$/)
-      pong = $1
+    # Stay connected to the server.
+    if @inbound.match(/^PING (?<msg>.*)$/)
+      pong = Regexp.last_match[:msg]
       send "PONG #{pong}"
     end
 
-    # Respond to messages in the channel
+    # Respond to messages in the channel.
     @listeners.each do |listener|
-      if @inbound.match(listener.pattern)
-        listener.response.call
-      end
+      listener.response.call if @inbound.match listener.pattern
     end
   end
 
+  # Terminates the IRC connection.
   def quit
     say "#{PARTING_MESSAGES.sample}"
     send "PART ##{@channel} :mic drop"
-    send "QUIT"
+    send 'QUIT'
   end
 end
-

data/lib/robot/listener.rb

@@ -1,16 +1,31 @@
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+# Collects and initalizes
+# listeners from all our scripts.
+# @attr [RegExp] pattern A pattern against
+# which to match incoming messages.
+# @attr [String] response The response to
+# provide if the RegExp matches.
 class Listener
   attr_accessor :pattern, :response
 
-  @@listeners = []
-  
+  @listeners = []
+
   def initialize(pattern, response)
-    @@listeners << self
-    @pattern = pattern
+    self.class.add_listener(self)
+    @pattern  = pattern
     @response = response
   end
 
-  def self.all_listeners
-    @@listeners
+  class << self
+    attr_reader :listeners
+
+    # Adds a listener object to the class'
+    # list of listeners.
+    # @param [Listener] listener A listener to add.
+    def add_listener(listener)
+      @listeners << listener
+    end
   end
 end
-

data/lib/robot/scripts/engage.rb

@@ -1,8 +1,10 @@
-# MAXIMUM WARP
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
+# Provides a random warp factor whenever
+# the robot hears the word 'engage'.
 warp_factor = lambda do
   Robot.instance.say "WARP FACTOR #{rand(9) + 1}"
 end
 
 Listener.new(/ :\bengage\b/i, warp_factor)
-

data/lib/robot/scripts/flip_coin.rb

@@ -1,11 +1,13 @@
-# Heads I win, tails you lose
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
+# The robot flips a coin when
+# it hears 'flip a coin'.
 flip_coin = lambda do
   coin_flip = rand(2)
-  result = coin_flip == 1 ? "heads" : "tails"
+  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

@@ -1,9 +1,11 @@
-# Friendly robots are good robots
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
+# The robot says hello when greeted
+# with any of the greetings.
 say_hello = lambda do
-  greetings = ["sup", "hey", "what up", "sup g"]
+  greetings = ['sup', 'hey', 'what up', 'sup g']
   Robot.instance.say "#{greetings.sample}"
 end
 
 Listener.new(/ :(?:hi|hello|hey)\s*,?\s*(?:ruben)/i, say_hello)
-

data/lib/robot/scripts/politeness.rb

@@ -1,9 +1,11 @@
-# Polite robots are good robots
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
+# The robot tells you you're welcome
+# when it hears 'thanks', 'ty', &c.
 youre_welcome = lambda do
-  responses = ["no prob", "sure thing", "np boss"]
+  responses = ['no prob', 'sure thing', 'np boss']
   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

@@ -1,5 +1,8 @@
-# Ruben's a gamblin' man
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
+# The robot rolls a D6 whenever
+# it hears 'roll the dice'.
 roll_dice = lambda do
   lucky_number = rand(5) + 1
 
@@ -7,4 +10,3 @@ roll_dice = lambda do
 end
 
 Listener.new(/ :(?:(?:ruben)?,?\s*roll\s*(?:the)?\s*dice)/i, roll_dice)
-

data/lib/robot/scripts/tell_time.rb

@@ -1,11 +1,14 @@
-# Teaching Ruben to tell time
+# encoding: UTF-8
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
+# The robot tells you what time it
+# is when it hears 'what time'.
 what_time = lambda do
-  current_hour = Time.now.localtime.strftime("%H").to_i
+  current_hour = Time.now.localtime.strftime('%H').to_i
   current_hour = current_hour > 12 ? current_hour - 12 : current_hour
 
-  Robot.instance.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)
-

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruben
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Weinstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-11 00:00:00.000000000 Z
+date: 2014-06-23 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.
@@ -35,27 +34,26 @@ files:
 - Rakefile
 homepage: http://github.com/ericqweinstein/ruben
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An extensible IRC chat bot.
 test_files: []
 has_rdoc: