mod_spox 0.0.1

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

@@ -0,0 +1,17 @@
+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,47 @@
+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")
+                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,17 @@
+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/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, port, 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,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class NickRequest < Request
+            end
+        end
+    end
+end

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

@@ -0,0 +1,14 @@
+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,20 @@
+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,16 @@
+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,13 @@
+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,17 @@
+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,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class PluginReload
+            end
+        end
+    end
+end

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

@@ -0,0 +1,17 @@
+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)
+                    @name = name.is_a?(Symbol) ? name : name.to_sym
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,20 @@
+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,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class PluginUnloadRequest < PluginLoadRequest
+            end
+        end
+    end
+end

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

@@ -0,0 +1,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class PluginUnloadResponse < PluginLoadResponse
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Internal
+            class Request
+                # object making request
+                attr_reader :requester
+                # requester:: object making request
+                # Request for information
+                def initialize(requester)
+                    @requester = requester
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Internal
+            class Response
+                # object response is for
+                attr_reader :origin
+                # origin:: object that requested the information
+                # Response of information
+                def initialize(origin)
+                    @origin = origin
+                end
+            end
+        end
+    end
+end

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

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

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

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

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

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Internal
+            # Request current bot status
+            class Status < Request
+            end
+        end
+    end
+end

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

@@ -0,0 +1,17 @@
+module ModSpox
+    module Messages
+        module Internal
+            class StatusResponse < Response
+                # Current status of the bot
+                attr_reader :status
+                # object:: Destination for response
+                # status:: Status of the bot
+                # Send status response to requester
+                def initialize(object, status)
+                    super(object)
+                    @status = status
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,27 @@
+module ModSpox
+    module Messages
+        module Internal
+            class TimerAdd < Request
+                # code block to execute
+                attr_reader :block
+                # data to supply to block
+                attr_reader :data
+                # interval between executions
+                attr_reader :period
+                # only execute block once
+                attr_reader :once
+                # period:: interval between executions
+                # once:: only run block once
+                # block:: code block
+                # Add repeating event to timer
+                def initialize(object, period, data=nil, once=false, &block)
+                    super(object)
+                    @data = data
+                    @period = period
+                    @once = once
+                    @block = block
+                end
+            end
+        end
+    end
+end

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

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

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Internal
+            class TimerRemove
+                # action to remove
+                attr_reader :action
+                # action:: action to remove from timer
+                # Remove action from timer
+                def initialize(action)
+                    @action = action
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,26 @@
+module ModSpox
+    module Messages
+        module Internal
+            class TimerResponse < Response
+                # action from timer
+                attr_reader :action
+                # object:: object to send response to
+                # action:: action removed from timer
+                # Notification that action has been removed
+                def initialize(object, action, added)
+                    super(object)
+                    @action = action
+                    @added = added
+                end
+                # Action was added to timer
+                def action_added?
+                    return @added
+                end
+                # Action was removed from timer
+                def action_removed?
+                    return !@added
+                end
+            end
+        end
+    end
+end

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

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

data/lib/mod_spox/messages/outgoing/Admin.rb

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Admin
+                # target server
+                attr_reader :target
+                # target:: target server
+                # Request administrator info from target serve
+                def initialize(target)
+                    @target = target
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/outgoing/Away.rb

@@ -0,0 +1,10 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # message:: away message
+            # Set away messages
+            class Away < Simple
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/outgoing/ChannelMode.rb

@@ -0,0 +1,25 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class ChannelMode
+                # channel to set mode
+                attr_reader :channel
+                # mode to set/unset
+                attr_reader :mode
+                # target of mode change
+                attr_reader :target
+                # channel:: channel to set mode in
+                # mode:: mode to set/unset
+                # target:: target of mode change
+                # Query/change channel modes. Target can also be used as mode
+                # options for cases like: MODE #chan +l 10 where the target
+                # would hold the limit value.
+                def initialize(channel, mode, target='')
+                    @channel = channel
+                    @mode = mode
+                    @target = target
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/outgoing/Connect.rb

@@ -0,0 +1,24 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Connect
+                # server to connect to
+                attr_reader :target_server
+                # port to connec to
+                attr_reader :port
+                # remote server to connect to target
+                attr_reader :remote_server
+                # target_server:: server to connect to
+                # port:: target server port
+                # remote_server:: remote server to connect to target
+                # Request a server to try to establish a connection to
+                # another server. This is generally an oper command.
+                def initialize(target_server, port, remote_server='')
+                    @target_server = target_server
+                    @port = port
+                    @remote_server = remote_server
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/outgoing/Die.rb

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Shutdown the server (oper command)
+            class Die
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/outgoing/Info.rb

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Info
+                # target server
+                attr_reader :target
+                # target:: target server
+                # Request information about target server
+                def initialize(target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end