summer 1.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Bigg
+
+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.

data/README.markdown

@@ -0,0 +1,96 @@
+# Summer
+
+Summer is an IRC Bot "framework" "inspired" by [http://github.com/RISCFuture/autumn](Autumn). Its goal is to be tiny.
+
+## Installation
+
+The project is currently in "preview" state 'cause that's all the rage nowadays. No there's no invites, BUT everybody gets access to it.
+Sorry to inform you that you'll have to clone it and then run `rake install` if you want to use it.
+
+## Usage
+
+To use summer, create a file like this:
+
+    require 'rubygems'
+    require 'summer'
+
+    class Bot < Summer::Connection
+
+    end
+
+    Bot.new("localhost")
+    
+Running it will make your bot attempt to connect to the server on localhost. For those of you who do not have an IRC server running locally, I would suggest trying irc.freenode.net instead. 
+    
+## Configuration
+
+In the same directory create a directory called _config_ and in that put _summer.yml_ which can have the following keys:
+
+* nick: The nickname of the bot.
+* channel: A channel to join on startup.
+* channels: Channels to join on startup.
+* auto_rejoin: Set this to true if you want the bot to re-join any channel it's kicked from.
+
+## `did_start_up`
+
+Called when the bot has received the final MOTD line (376 or 422) and has finished joining all the channels.
+
+## `channel_message(sender, channel, message)`
+
+Called when the bot receives a channel message.
+
+sender (`Hash`): Contains `nick` and `hostname`
+channel (`String`): The channel name: e.g. "#logga"
+message (`String`): The message that was received
+
+## `private_message(sender, bot, message)`
+
+Called when the bot receives a private message.
+
+sender (`Hash`): Contains `nick` and `hostname`
+bot (`String`): The bot's name.
+message (`String`): The message that was received
+
+## `join(sender, channel)`
+
+Called when the bot sees someone join a channel.
+
+sender (`Hash`): Contains `nick` and `hostname`
+channel (`String`): The channel name: e.g. "#logga"
+
+## `part(sender, channel, message)`
+
+Called when someone parts a channel:
+
+sender (`Hash`): Contains `nick` and `hostname`
+channel (`String`): The channel name: e.g. "#logga"
+message (`String`): The message that was received
+
+## `quit(sender, message)`
+
+Called when someone quits the server:
+
+sender (`Hash`): Contains `nick` and `hostname`
+message (`String`): The message that was received.
+
+
+## `kick(kicker, channel, victim, message)`
+
+Called when someone quits the server:
+
+kicker (`Hash`): Contains `nick` and `hostname`
+channel (`String`): The channel name: e.g. "#logga"
+victim (`String`): Just the nick of whoever was kicked.
+message (`String`): The message that was received.
+
+
+## Handling raw messages
+
+If you wish to handle raw messages that come into your bot you can define a `handle_xxx` method for that where `xxx` is the three-digit representation of the raw you wish to handle.
+
+
+### Upcoming
+
+`mode` method to detect mode changes
+Auto-rejoin after kick (configuration options)
+

data/lib/ext/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def clean
+    join(" ").clean
+  end
+end

data/lib/ext/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def really_try(method, *args)
+    try(method, *args) if respond_to?(method)
+  end
+end

data/lib/ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def clean
+    gsub(/^:/, '')
+  end
+end

data/lib/summer.rb

@@ -0,0 +1,149 @@
+require 'socket'
+require 'yaml'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/object/try'
+
+Dir[File.dirname(__FILE__) + '/ext/*.rb'].each { |f| require f }
+
+require File.dirname(__FILE__) + "/summer/handlers"
+
+module Summer
+  class Connection
+    include Handlers
+    attr_accessor :connection, :ready, :started, :config, :server, :port
+    def initialize(server, port=6667, dry=false)
+      @ready = false
+      @started = false
+
+      @server = server
+      @port = port
+
+      load_config
+      connect!
+
+      unless dry
+        loop do
+          startup! if @ready && !@started
+          message = @connection.gets
+          if message
+            parse(message)
+          else
+            break
+          end
+        end
+      end
+    end
+
+    private
+
+    def load_config
+      @config = HashWithIndifferentAccess.new(YAML::load_file(File.dirname($0) + "/config/summer.yml"))
+      @config[:channels] ||= []
+      @config[:channels] << @config.delete(:channel) if @config[:channel]
+    end
+
+    def connect!
+      @connection = TCPSocket.open(server, port)
+      response("USER #{config[:nick]} #{config[:nick]} #{config[:nick]} #{config[:nick]}")
+      response("NICK #{config[:nick]}")
+    end
+
+
+    # Will join channels specified in configuration.
+    def startup!
+      nickserv_identify if @config[:nickserv_password]
+      config[:channels].each do |channel|
+        join(channel)
+      end
+      @started = true
+      really_try(:did_start_up) if respond_to?(:did_start_up)
+    end
+
+    def nickserv_identify
+      privmsg("nickserv", "register #{@config[:nickserv_password]} #{@config[:nickserv_email]}")
+      privmsg("nickserv", "identify #{@config[:nickserv_password]}")
+    end
+    # Go somewhere.
+    def join(channel)
+      response("JOIN #{channel}")
+    end
+
+    # Leave somewhere
+    def part(channel)
+      response("PART #{channel}")
+    end
+
+    # What did they say?
+    def parse(message)
+      puts "<< #{message.to_s.strip}"
+      words = message.split(" ")
+      sender = words[0]
+      raw = words[1]
+      channel = words[2]
+      # Handling pings
+      if /^PING (.*?)\s$/.match(message)
+        response("PONG #{$1}")
+      # Handling raws
+      elsif /\d+/.match(raw)
+        send("handle_#{raw}", message) if raws_to_handle.include?(raw)
+      # Privmsgs
+      elsif raw == "PRIVMSG"
+        message = words[3..-1].clean
+        # Parse commands
+        if /^!(\w+)\s*(.*)/.match(message) && respond_to?("#{$1}_command")
+          really_try("#{$1}_command", parse_sender(sender), channel, $2)
+        # Plain and boring message
+        else
+          sender = parse_sender(sender)
+          method, channel = channel == me ? [:private_message, sender[:nick]]  : [:channel_message, channel]
+          really_try(method, sender, channel, message)
+        end
+      # Joins
+      elsif raw == "JOIN"
+        really_try(:join, parse_sender(sender), channel)
+      elsif raw == "PART"
+        really_try(:part, parse_sender(sender), channel, words[3..-1].clean)
+      elsif raw == "QUIT"
+        really_try(:quit, parse_sender(sender), words[2..-1].clean)
+      elsif raw == "KICK"
+        really_try(:kick, parse_sender(sender), channel, words[3], words[4..-1].clean)
+        join(channel) if words[3] == me && config[:auto_rejoin]
+      elsif raw == "MODE"
+        really_try(:mode, parse_sender(sender), channel, words[3], words[4..-1].clean)
+      elsif raw == "TOPIC"
+        really_try(:topic, parse_sender(sender), channel, words[3..-1].clean)
+      end
+
+    end
+
+    def parse_sender(sender)
+      nick, hostname = sender.split("!")
+      { :nick => nick.clean, :hostname => hostname }
+    end
+
+    # These are the raws we care about.
+    def raws_to_handle
+      ["422", "376"]
+    end
+
+    def privmsg(message, to)
+      response("PRIVMSG #{to} :#{message}")
+    end
+
+    # Output something to the console and to the socket.
+    def response(message)
+      puts ">> #{message.strip}"
+      @connection.puts(message)
+    end
+
+    def me
+      config[:nick]
+    end
+
+    def log(message)
+      File.open(config[:log_file]) { |file| file.write(message) } if config[:log_file]
+    end
+
+  end
+
+end

data/lib/summer/handlers.rb

@@ -0,0 +1,10 @@
+module Summer
+  module Handlers
+    def handle_422(message)
+      self.ready = true
+    end
+
+    alias_method :handle_376, :handle_422
+
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: summer
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Bigg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2153293060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153293060
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2153292580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2153292580
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153292100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153292100
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2153291620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *2153291620
+description: Tiny IRC Bot Frameowkr
+email: radarlistener@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- lib/ext/array.rb
+- lib/ext/object.rb
+- lib/ext/string.rb
+- lib/summer.rb
+- lib/summer/handlers.rb
+- LICENSE
+- README.markdown
+homepage: http://github.com/radar/summer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3637726515248804584
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Tiny IRC Bot Framework
+test_files: []