moonbot 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in MoonBot.gemspec
+gemspec

data/MoonBot.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "MoonBot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "moonbot"
+  s.version     = MoonBot::VERSION
+  s.authors     = ["Blake Williams"]
+  s.email       = ["blake@baristadesign.com"]
+  s.homepage    = "https://github.com/BlakeWilliams/MoonBot"
+  s.summary     = %q{Amazingly simple IRC bot.}
+  s.description = %q{Amazingly simple IRC bot that handles everything via plugins with the exception of connecting.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "eventmachine"
+end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/MoonBot/bot.rb

@@ -0,0 +1,31 @@
+module MoonBot
+  class Bot
+    attr_reader :host, :port, :plugins, :client
+    
+    def initialize host, port
+      @host = host
+      @port = port
+      
+      @plugins = {}
+    end
+    
+    def start
+      EventMachine.run do
+        @client = EventMachine.connect @host, @port, Client, Proc.new { |m| self.handle m }
+      end
+    end
+    
+    def handle message
+      @plugins.each do |name, instance|
+        instance.send('on_' + message[:command].downcase, message) rescue nil
+        instance.send('any', message) if instance.respond_to? 'any'          
+      end
+    end
+    
+    def register plugin
+      @plugins[plugin.to_s] = plugin.new(self)
+      puts "Loading #{plugin.to_s}"
+    end
+  
+  end
+end

data/lib/MoonBot/client.rb

@@ -0,0 +1,21 @@
+module MoonBot
+  class Client < EventMachine::Connection
+
+    def initialize on_message
+      @on_message = on_message
+    end
+
+    def receive_data(data)
+      data = data.split "\r\n"
+      data.each do |d|
+        message = Parser::parse(d)
+        @on_message.call(message) if @on_message
+      end
+    end
+    
+    def derp x
+      puts "herp"
+    end
+
+  end
+end

data/lib/MoonBot/parser.rb

@@ -0,0 +1,23 @@
+module MoonBot
+  class Parser
+    def self.parse data
+      message = {}
+      # if not empty
+      if !data.scan(/^:/).empty?
+        separated = data.split ':'
+        body  = separated[1].split ' '
+        message[:prefix]  = body.shift
+        message[:command] = body.shift
+        message[:params]  = body.shift
+        2.times { separated.shift }
+        message[:trailing] = separated.join(":")
+      else
+        body = data.split ' '
+        message[:command] = body.shift
+        message[:args]    = body
+      end
+      message
+    end
+    
+  end
+end

data/lib/MoonBot/plugin.rb

@@ -0,0 +1,2 @@
+# Require all files from plugins directory
+Dir[File.join(File.dirname(__FILE__), 'plugins', '*.rb')].map {|f| require f }

data/lib/MoonBot/plugins/auth.rb

@@ -0,0 +1,24 @@
+module MoonBot::Plugin
+  class Auth
+    def initialize bot
+      @bot = bot
+    end
+    
+    def on_notice message
+      send_auth if message[:trailing] == '*** No Ident response'
+    end
+    
+    def set_user nick, login, name = nil
+      @nick  = nick
+      @login = login
+      @name  = name || login
+    end
+    
+    def send_auth
+      puts "Sending User Data"
+      auth  = "NICK #{@nick}\r\n"
+      auth += "USER #{@login} 8 * : #{@name}\r\n"
+      @bot.client.send_data auth
+    end
+  end
+end

data/lib/MoonBot/plugins/ping.rb

@@ -0,0 +1,12 @@
+module MoonBot::Plugin
+  class Ping
+    def initialize bot
+      @bot = bot
+    end
+    
+    def on_ping message
+      pong = "PONG #{message[:args]}"
+      @bot.client.send_data pong
+    end
+  end
+end

data/lib/MoonBot/plugins/verbose.rb

@@ -0,0 +1,10 @@
+module MoonBot::Plugin
+  class Verbose
+    def initialize bot
+    end
+    
+    def any message
+      puts message
+    end
+  end
+end

data/lib/MoonBot/version.rb

@@ -0,0 +1,3 @@
+module MoonBot
+  VERSION = "0.0.2"
+end

data/lib/MoonBot.rb

@@ -0,0 +1,8 @@
+require 'eventmachine'
+require "fileutils"
+require 'yaml'
+
+require "MoonBot/version"
+require 'MoonBot/parser'
+require 'MoonBot/client'
+require 'MoonBot/bot'

data/readme.md

@@ -0,0 +1,57 @@
+# MoonBot: The stupid modular bot
+MoonBot is my bot "framework" where the bot does nothing but connect to the server, not even play ping pong.
+
+## What does it do?
+Nothing with the exception of the default plugins that you can choose to use. To do anything with the bot you have to write a plugin that responds to the proper command. Right now the built in plugins are Ping, Auth, and Verbose.
+
+## How do I write a plugin?
+Plugins are incredibly simple, all you do is make a class, add an initializer that takes one parameter (bot), and then define methods that respond to the command the server sends. All methods are the command the server sends with "on_" prefixed. So if you want to check every PRIVMSG and respond accordingly you would define a method called "on_privmsg".
+
+```ruby
+class Ping
+  def initialize bot
+    @bot = bot
+  end
+    
+  def on_ping message
+    pong = "PONG #{message[:args]}"
+    @bot.client.send_data pong
+  end
+end
+```
+
+The initializer takes the bot as a paramater so you can access the client to send data as well as access plugins so you can call methods from them (for example you have an authorization plugin that you want to use on the user). There is also the "any" method, if your plugin has this method it will be called every time the server sends back data.
+
+## How do I get started?
+First, Add moonbot to your Gemfile.
+
+```ruby
+source "http://rubygems.org"
+gem 'moonbot'
+```
+
+Second, create a file and start hacking. Here is a simple bot to get you started. If you're making your own plugins in the same directory as your bot, I suggest making a plugins directory and putting them there because in the future MoonBot might have helper commands for loading plugins. Plugins as gems are also a nice decision if you want to share them easily.
+
+```ruby
+require 'moonbot'
+require 'moonbot/plugin'
+
+@bot = MoonBot::Bot.new 'irc.server.tld', 6667
+@bot.register MoonBot::Plugin::Ping
+@bot.register MoonBot::Plugin::Verbose
+@bot.register MoonBot::Plugin::Auth
+@bot.plugins["MoonBot::Plugin::Auth"].set_user "Nick", "Name"
+@bot.start
+```
+    
+## Why?
+It was just a stupid idea that I wanted to play with and it turned out not being as stupid as I thought (but is still pretty dumb).
+
+## License
+Copyright (c) 2012 Blake Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 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.

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: moonbot
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Blake Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70302262152900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70302262152900
+description: Amazingly simple IRC bot that handles everything via plugins with the
+  exception of connecting.
+email:
+- blake@baristadesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MoonBot.gemspec
+- Rakefile
+- lib/MoonBot.rb
+- lib/MoonBot/bot.rb
+- lib/MoonBot/client.rb
+- lib/MoonBot/parser.rb
+- lib/MoonBot/plugin.rb
+- lib/MoonBot/plugins/auth.rb
+- lib/MoonBot/plugins/ping.rb
+- lib/MoonBot/plugins/verbose.rb
+- lib/MoonBot/version.rb
+- readme.md
+homepage: https://github.com/BlakeWilliams/MoonBot
+licenses: []
+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.12
+signing_key: 
+specification_version: 3
+summary: Amazingly simple IRC bot.
+test_files: []