spox-mod_spox 0.3.1

data/lib/mod_spox/messages/incoming/Part.rb

@@ -0,0 +1,21 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Part < Message
+                # channel user parted from
+                attr_reader :channel
+                # nick that parted from channel
+                attr_reader :nick
+                # reason for parting
+                attr_reader :reason
+                def initialize(raw, channel, nick, reason)
+                    super(raw)
+                    @channel = channel
+                    @nick = nick
+                    @reason = reason
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Ping.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Ping < Message
+                # server of origin
+                attr_reader :server
+                # string
+                attr_reader :string
+                def initialize(raw, server, string)
+                    super(raw)
+                    @server = server
+                    @string = string
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Pong.rb

@@ -0,0 +1,9 @@
+require 'mod_spox/messages/incoming/Ping'
+module ModSpox
+    module Messages
+        module Incoming
+            class Pong < Ping
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Privmsg.rb

@@ -0,0 +1,90 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Privmsg < Message
+
+                # source of the message
+                attr_reader :source
+                # target of the message
+                attr_reader :target
+                # message is CTCP
+                attr_reader :ctcp
+                # message CTCP type
+                attr_reader :ctcp_type
+                def initialize(raw, source, target, message)
+                    super(raw)
+                    @source = source
+                    @target = target
+                    @ctcp = false
+                    @ctcp_type = nil
+                    @action = false
+                    if(@raw_content =~ /\x01(\S+)\s(.+)\x01/)
+                        @ctcp = true
+                        @ctcp_type = $1
+                        @message = $2
+                        @action = @ctcp_type.downcase == 'action'
+                    else
+                        @message = message
+                    end
+                    botnick = Models::Nick.filter(:botnick => true).first
+                    if(botnick)
+                        @addressed = @message =~ /^#{botnick.nick}/i
+                    else
+                        @addressed = false
+                    end
+                end
+
+                # Is message addressing the bot
+                def addressed?
+                    return @addressed || is_private?
+                end
+
+                # Is this is private message
+                def is_private?
+                    return !is_public?
+                end
+
+                # Is this a DCC message
+                def is_dcc?
+                    return @target.is_a?(String)
+                end
+
+                # Is this a public message
+                def is_public?
+                    return @target.is_a?(Models::Channel)
+                end
+
+                # Does the message contain colors
+                def is_colored?
+                    return @message =~ /\cC\d\d?(?:,\d\d?)?/
+                end
+
+                # Message with coloring stripped
+                def message_nocolor
+                    return @message.gsub(/\cC\d\d?(?:,\d\d?)?/, '').tr("\x00-\x1f", '')
+                end
+
+                # the message sent
+                def message(color=false)
+                    return color ? @message : message_nocolor
+                end
+
+                # Is this message an action message
+                def is_action?
+                    @action
+                end
+
+                def is_ctcp?
+                    @ctcp
+                end
+
+                # Convinence method for replying to the correct place
+                def replyto
+                    return is_public? || is_dcc? ? @target : @source
+                end
+
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Quit.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming    
+            class Quit < Message
+                # nick that quit
+                attr_reader :nick
+                # quit message
+                attr_reader :message
+                def initialize(raw, nick, message)
+                    super(raw)
+                    @nick = nick
+                    @message = message
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Topic.rb

@@ -0,0 +1,21 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Topic < Message
+            
+                # channel topic was set
+                attr_reader :channel
+                # topic messages
+                attr_reader :topic
+                
+                def initialize(raw, channel, topic)
+                    super(raw)
+                    @channel = @channel
+                    @topic = @topic
+                end
+                
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/TopicInfo.rb

@@ -0,0 +1,21 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class TopicInfo < Message
+                # channel topic info is for
+                attr_reader :channel
+                # last nick to set topic
+                attr_reader :nick
+                # time topic was set
+                attr_reader :time
+                def initialize(raw, channel, nick, time)
+                    super(raw)
+                    @channel = channel
+                    @nick = nick
+                    @time = time
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Welcome.rb

@@ -0,0 +1,27 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Welcome < Message
+                # server bot is connected to
+                attr_reader :server
+                # welcome message from server
+                attr_reader :message
+                # nick of the bot
+                attr_reader :nick
+                # username of the bot
+                attr_reader :username
+                # hostname of the bot
+                attr_reader :hostname
+                def initialize(raw, server, message, nick, username, hostname)
+                    super(raw)
+                    @server = server
+                    @message = message
+                    @nick = nick
+                    @username = username
+                    @hostname = hostname
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Who.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Who < Message
+                # array of nicks
+                attr_reader :nicks
+                # where nicks are from (channel if who'd a channel, nick if who'd a single nick)
+                attr_reader :location
+                def initialize(raw, location, nicks)
+                    super(raw)
+                    @location = location
+                    @nicks = nicks
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/Whois.rb

@@ -0,0 +1,49 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class Whois < Message
+                # Nick of user
+                attr_reader :nick
+                # Channels user is found in
+                attr_accessor :channels
+                # Raw whois string
+                attr_accessor :raw
+                
+                def initialize(nick)
+                    @nick = nick
+                    @channels = Array.new
+                    @raw = Array.new
+                    @locked = false
+                end
+                
+                # channel:: Channel
+                # Adds channel to list
+                def channels_push(channel)
+                    restricted if @locked
+                    @channels << channel
+                end
+                
+                # string:: string
+                # Adds string to raw whois info
+                def raw_push(string)
+                    restricted if @locked
+                    @raw << string
+                end
+                
+                # Locks the object's custom methods
+                def lock
+                    @locked = true
+                    @raw_content = @raw.join("\n")
+                    @nick.refresh
+                end
+                
+                private
+                
+                def restricted
+                    raise Exceptions::LockedObject.new('Whois message can no longer be modified')
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/incoming/YourHost.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/incoming/Message'
+module ModSpox
+    module Messages
+        module Incoming
+            class YourHost < Message
+                # name of server bot is connected to
+                attr_reader :servername
+                # version of server bot is connected to
+                attr_reader :version
+                def initialize(raw, server, version)
+                    super(raw)
+                    @servername = server
+                    @version = version
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/BotInitialized.rb

@@ -0,0 +1,11 @@
+module ModSpox
+    module Messages
+        module Internal
+            # This is a message to let the plugins know the
+            # bot is running and waiting for someone to tell
+            # it to do something
+            class BotInitialized
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/ChangeNick.rb

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Internal
+            class ChangeNick
+                # change bot's nick to this nick
+                attr_reader :new_nick
+                # new_nick: nick to change to
+                # Tells the bot it needs to change its nick
+                def initialize(new_nick)
+                    @new_nick = new_nick
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/Connected.rb

@@ -0,0 +1,20 @@
+module ModSpox
+    module Messages
+        module Internal
+            class Connected
+                # server connected to
+                attr_reader :server
+                # port connected to
+                attr_reader :port
+                # server:: Server bot is connected to
+                # port:: Port bot connected to
+                # Used as notification that the bot has connected
+                # to the given server
+                def initialize(server, port)
+                    @server = server
+                    @port = port
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/ConnectionFailed.rb

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Internal
+            class ConnectionFailed
+                # server attempted 
+                attr_reader :server
+                # port attempted
+                attr_reader :port
+                # reason for failure
+                attr_reader :reason
+                # server:: server attempted to connect
+                # port:: port attempted to connect on
+                # reason: reason for failed connection
+                # Failed connection to the server
+                def initialize(server, port, reason=nil)
+                    @server = server
+                    @port = port
+                    @reason = reason
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/DCCListener.rb

@@ -0,0 +1,12 @@
+module ModSpox
+    module Messages
+        module Internal
+            class DCCListener
+                attr_reader :nick
+                def initialize(nick)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/DCCRequest.rb

@@ -0,0 +1,12 @@
+module ModSpox
+    module Messages
+        module Internal
+            class DCCRequest
+                attr_reader :socket_id
+                def initialize(id)
+                    @socket_id = id
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/DCCSocket.rb

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Internal
+            class DCCSocket
+                # ID of the contained socket
+                attr_reader :socket_id
+                # Models::Nick this socket is connected to
+                attr_reader :nick
+                # socket
+                attr_reader :socket
+                def initialize(id, nick, socket)
+                    @socket_id = id
+                    @nick = nick
+                    @socket = socket
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/Disconnected.rb

@@ -0,0 +1,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class Disconnected
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/Disconnecting.rb

@@ -0,0 +1,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class Disconnecting
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/EstablishConnection.rb

@@ -0,0 +1,22 @@
+module ModSpox
+    module Messages
+        module Internal
+            class EstablishConnection
+                # server to connect to
+                attr_reader :server
+                # port to connect to
+                attr_reader :port
+                # password for connection to server
+                attr_reader :password
+                # server:: Server to connect to
+                # port:: Port to connect to
+                # password:: password to connect
+                def initialize(server=nil, port=nil, password=nil)
+                    @server = server
+                    @port = port
+                    @password = password
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/HaltBot.rb

@@ -0,0 +1,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class HaltBot
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/NickRequest.rb

@@ -0,0 +1,9 @@
+require 'mod_spox/messages/internal/Request'
+module ModSpox
+    module Messages
+        module Internal
+            class NickRequest < Request
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/NickResponse.rb

@@ -0,0 +1,15 @@
+require 'mod_spox/messages/internal/Response'
+module ModSpox
+    module Messages
+        module Internal
+            class NickResponse < Response
+                # nick of the bot (model)
+                attr_reader :nick
+                def initialize(origin, nick)
+                    super(origin)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginLoadRequest.rb

@@ -0,0 +1,21 @@
+require 'mod_spox/messages/internal/Request'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginLoadRequest < Request
+                # path to plugin file
+                attr_reader :path
+                # file name for plugin
+                attr_reader :name
+                # object:: object requesting the load
+                # path:: path to plugin file to be loaded
+                # Loads a plugin located at the given path
+                def initialize(object, path, name=nil)
+                    super(object)
+                    @path = path
+                    @name = name
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginLoadResponse.rb

@@ -0,0 +1,17 @@
+require 'mod_spox/messages/internal/Response'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginLoadResponse < Response
+                # success of loading
+                attr_reader :success
+                # successful:: load was successful
+                # Notifies requesting object if load was successful
+                def initialize(object, successful)
+                    super(object)
+                    @success = successful
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginModuleRequest.rb

@@ -0,0 +1,14 @@
+require 'mod_spox/messages/internal/Request'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginModuleRequest < Request
+                # object:: object requesting the load
+                # Requests the plugin module
+                def initialize(object)
+                    super(object)
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginModuleResponse.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/internal/Response'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginModuleResponse < Response
+                # plugins module
+                attr_reader :module
+                # plugin:: Plugin to send to requester
+                # Sends the plugins module to the requester
+                def initialize(object, mod)
+                    super(object)
+                    @module = mod
+                end
+
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginReload.rb

@@ -0,0 +1,18 @@
+module ModSpox
+    module Messages
+        module Internal
+            # Sends message to reload plugin. If new and stale
+            # attributes are set, only that plugin will be reloaded
+            class PluginReload
+                # Path to new plugin to load
+                attr_reader :fresh
+                # Path to stale plugin to remove
+                attr_reader :stale
+                def initialize(fresh=nil, stale=nil)
+                    @fresh = fresh
+                    @stale = stale
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginRequest.rb

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/internal/Request'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginRequest  < Request
+                # plugin requested
+                attr_reader :plugin
+                # object:: object requesting
+                # name:: Name of plugin
+                # Request plugin from bot
+                def initialize(object, name)
+                    super(object)
+                    @plugin = name.is_a?(Symbol) ? name : name.to_sym
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginResponse.rb

@@ -0,0 +1,21 @@
+require 'mod_spox/messages/internal/Response'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginResponse < Response
+                # plugin object
+                attr_reader :plugin
+                # plugin:: Plugin to send to requester
+                # Sends a plugin to requesting object
+                def initialize(object, plugin)
+                    super(object)
+                    @plugin = plugin
+                end
+                
+                def found?
+                    return !@plugin.nil?
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/internal/PluginUnloadRequest.rb

@@ -0,0 +1,9 @@
+require 'mod_spox/messages/internal/PluginLoadRequest'
+module ModSpox
+    module Messages
+        module Internal
+            class PluginUnloadRequest < PluginLoadRequest
+            end
+        end
+    end
+end