erasmus 0.0.1

data/LICENSE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar
+  14 rue de Plaisance, 75014 Paris, France
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.rdoc

@@ -0,0 +1,18 @@
+= erasmus
+
+A simple, modular irc bot/framework.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 xiongchiamiov. See LICENSE for details.

data/lib/bots.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'erasmus'
+require 'utils'
+
+Erasmus::Bot.new("irc.freenode.net").join([
+	Erasmus::Channel.new('erasmus-testing') \
+		.extend(Utils::Foo) \
+		.extend(Utils::Changelog) \
+		.extend(Utils::FlagFloodProtection), \
+	Erasmus::Channel.new('erasmus-testing2'),
+]).run

data/lib/erasmus.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/env ruby
+
+require 'socket'
+
+module Erasmus
+	class Bot
+		attr_reader :nick
+		
+		def initialize(server, port=6667)
+			@nick = 'mpu_test'
+			@channels = {}
+			@socket = TCPSocket.open(server, port)
+			say "NICK #{@nick}"
+			say "USER #{@nick} 0 * #{@nick}"
+		end
+		
+		def join(channels)
+			channels.each do |channel|
+				channel.server = self
+				channel.join
+				@channels[channel.name] = channel
+			end
+			
+			#return self so we can chain methods
+			self
+		end
+	
+		def say(msg)
+			puts msg
+			@socket.puts msg
+		end
+	
+		def say_to_channel(channel, message)
+			say "PRIVMSG ##{channel} :#{message}"
+		end
+	
+		def pm_user(user, message)
+			say "PRIVMSG #{user} :#{message}"
+		end
+		
+		def notice_user(user, message)
+			say "NOTICE #{user} :#{message}"
+		end
+		
+		def notice_channel(channel, message)
+			say "NOTICE ##{channel} :#{message}"
+		end
+		
+		def run
+			until @socket.eof? do
+				msg = @socket.gets
+				puts msg
+				
+				case msg
+				when /^PING :(.*)$/
+					say "PONG #{$1}"
+				# channel messages
+				when /^:(.*)!(.*) PRIVMSG #(\S+) :(.*)$/
+					user = $1
+					host = $2
+					channel = $3
+					content = $4
+					@channels[channel].handle_public_message(user, host, content)
+				# actual private messages
+				when /^:(.*)!(.*) PRIVMSG \S+ :(.*)$/
+					user = $1
+					host = $2
+					content = $3
+					handle_private_message(user, host, content)
+				end
+			end
+		end
+		
+		def handle_private_message(user, host, message)
+			pm_user(user, 'hey!')
+		end
+	
+		def quit
+			@channels.each do |name, channel|
+				channel.part
+			end
+			say 'QUIT'
+		end
+	end
+	
+	class Channel
+		attr_accessor :server
+		attr_reader :name
+		
+		def initialize(channel, flag='!')
+			@name = channel
+			@flag = flag
+			
+			@flags = {}
+			@blacklists = []
+		end
+		
+		def join
+			@server.say "JOIN ##{@name}"
+		end
+		
+		def part(message='Bai~')
+			@server.say "PART ##{@name} :#{message}"
+		end
+		
+		def say(message)
+			@server.say_to_channel(@name, message)
+		end
+		
+		def hilight_user(user, message)
+			@server.say_to_channel(@name, "#{user}: #{message}")
+		end
+		
+		def notice_user(user, message)
+			@server.notice_user(user, message)
+		end
+		
+		def notice_channel(message)
+			@server.notice_channel(@name, message)
+		end
+		
+		def handle_public_message(user, host, message)
+			if message =~ /^#{@server.nick}: (.*)$/
+				handle_hilight(user, host, $1)
+			elsif message =~ /^#{@flag}(\S+)\s(.*)$/
+				command = $1
+				arguments = $2.split(/\s/)
+				handle_flag(user, host, command, arguments)
+			end
+		end
+		
+		def handle_hilight(user, host, message)
+		end
+		def handle_flag(user, host, flag, arguments)
+			if allowed? user
+				begin
+					@flags[flag].call(user, host, arguments)
+				rescue NoMethodError
+					#say("Sorry, there's no action associated with the flag #{flag}.")
+				end
+			end
+		end
+		
+		def allowed?(user)
+			begin
+				@blacklists.each do |blacklist|
+					blacklist.call(user)
+				end
+			rescue NotAllowedException
+				return false
+			rescue => detail
+				say("Uh oh: #{detail}")
+				return false
+			else
+				return true
+			end
+		end
+	end
+	
+	class NotAllowedException < StandardError
+	end
+end

data/lib/utils.rb

@@ -0,0 +1,69 @@
+module Utils
+	module Foo
+		def handle_hilight(user, host, message)
+			hilight_user(user, 'whatcha want?')
+		end
+		
+		def self.extended(obj)
+			obj.instance_eval {
+				@flags['foo'] = lambda { |user, host, arguments|
+					say('bar')
+				}
+				@flags['bar'] = lambda { |user, host, arguments|
+					notice_user(user, 'baz')
+				}
+				@flags['baz'] = lambda { |user, host, arguments|
+					notice_channel('not baz!')
+				}
+			}
+		end
+		
+		def join
+			@server.say "JOIN ##{@name}"
+			say "#{1.chr}ACTION is here to help#{1.chr}"
+		end
+	end
+	
+	module Changelog
+		def self.extended(obj)
+			obj.instance_eval {
+				@flags['changelog'] = lambda { |user, host, arguments|
+					if arguments[0] and arguments[0] =~ /^[\w\d "]+$/
+						output = `git --no-pager log --pretty=format:%s --since=#{arguments[0]}`
+					else
+						output = `git --no-pager log --pretty=format:%s -1`
+					end
+					if output.empty?
+						say "No changes found for specified period of time."
+					else
+						for summary in output.split("\n")
+							say summary
+						end
+					end
+				}
+			}
+		end
+	end
+	
+	module FlagFloodProtection
+		require 'erasmus'
+		require 'thread' # for Queue
+		
+		def self.extended(obj)
+			obj.instance_eval {
+				@userMessages = Hash.new(Queue.new)
+				@blacklists << lambda { |user|
+					@userMessages[user] << Time.now
+					
+					# don't allow messages from users who have sent
+					# 5 messages in 15 seconds
+					if @userMessages[user].length > 4 \
+					and Time.now - @userMessages[user].pop < 15
+						say("#{user} is flooding!")
+						raise Erasmus::NotAllowedException
+					end
+				}
+			}
+		end
+	end
+end

data/test/erasmus_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ErasmusTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'erasmus'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: erasmus
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- xiongchiamiov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "TODO: longer description of your gem"
+email: xiong.chiamiov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/bots.rb
+- lib/erasmus.rb
+- lib/utils.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/xiongchiamiov/erasmus
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A simple, modular irc bot/framework
+test_files: 
+- test/erasmus_test.rb
+- test/test_helper.rb