spox-mod_spox 0.3.1

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

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

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

@@ -0,0 +1,10 @@
+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 PluginsReady
+            end
+        end
+    end
+end

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

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

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

@@ -0,0 +1,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class Reconnect
+            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,10 @@
+require 'mod_spox/messages/internal/Request'
+module ModSpox
+    module Messages
+        module Internal
+            # Request current bot status
+            class StatusRequest < Request
+            end
+        end
+    end
+end

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

@@ -0,0 +1,18 @@
+require 'mod_spox/messages/internal/Response'
+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,36 @@
+require 'mod_spox/messages/internal/Request'
+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
+                # message identification
+                attr_reader :ident
+                # 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
+                    @ident = rand(99999999)
+                end
+                
+                # Message ID
+                def id
+                    @ident
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Internal
+            class TimerClear
+                attr_reader :plugin
+                def initialize(plugin=nil)
+                    if(plugin.nil?)
+                        @plugin = nil
+                    else
+                        @plugin = plugin.is_a?(ModSpox::Plugin) ? plugin.name.to_sym : plugin.to_sym
+                    end
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Internal
+            class TimerRemove
+                # action to remove
+                attr_reader :action
+                # message identification
+                attr_reader :ident
+                # action:: action to remove from timer
+                # Remove action from timer
+                def initialize(action)
+                    @action = action
+                    @ident = rand(99999999)
+                end
+                
+                # Message ID
+                def id
+                    @ident
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,34 @@
+require 'mod_spox/messages/internal/Response'
+module ModSpox
+    module Messages
+        module Internal
+            class TimerResponse < Response
+                # action from timer
+                attr_reader :action
+                # response to message with this ID
+                attr_reader :ident
+                # object:: object to send response to
+                # action:: action removed from timer
+                # Notification that action has been removed
+                def initialize(object, action, added, id)
+                    super(object)
+                    @action = action
+                    @added = added
+                    @ident = id
+                end
+                # Action was added to timer
+                def action_added?
+                    return @added
+                end
+                # Action was removed from timer
+                def action_removed?
+                    return !@added
+                end
+                # ID of message this response is for
+                def id
+                    @ident
+                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/internal/UnqueueSocket.rb

@@ -0,0 +1,8 @@
+module ModSpox
+    module Messages
+        module Internal
+            class UnqueueSocket
+            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,11 @@
+require 'mod_spox/messages/outgoing/Simple'
+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

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Invite
+                # nick to invite
+                attr_reader :nick
+                # channel to invite nick to
+                attr_reader :channel
+                # nick:: nick to invite
+                # channel:: channel to invite nick into
+                # Invite user into a channel
+                def initialize(nick, channel)
+                    @nick = nick
+                    @channel = channel
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Ison
+                # nick to check
+                attr_reader :nick
+                # nick:: nick to check
+                # Check if nick is on IRC
+                def initialize(nick)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Join
+                # channel to join
+                attr_reader :channel
+                # key for channel
+                attr_reader :key
+                # channel:: channel to join
+                # key:: channel key if needed
+                # Join the channel. This command only allows single joins.
+                def initialize(channel, key=nil)
+                    @channel = channel
+                    @key = key
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Kick
+                # nick of user to kick
+                attr_reader :nick
+                # channel to kick user out of
+                attr_reader :channel
+                # reason for kick
+                attr_reader :reason
+                # nick:: nick of user to kick
+                # channel:: channel to kick user out of
+                # reason:: reason for kick
+                # Request the forced removal of a user from a channel 
+                def initialize(nick, channel, reason=nil)
+                    @nick = nick
+                    @channel = channel
+                    @reason = reason
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Kill
+                # nick to kill
+                attr_reader :nick
+                # reason for kill
+                attr_reader :comment
+                # nick:: nick to kill
+                # comment:: comment about kill
+                # Kill connection between given nick and server
+                def initialize(nick, comment)
+                    @nick = nick
+                    @comment = comment
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Links
+                # remote server
+                attr_reader :server
+                # server mask
+                attr_reader :mask
+                # server:: remote server
+                # mask:: server mask
+                # List all servernames known by the server answering the query
+                def initialize(server, mask)
+                    @server = server
+                    @mask = mask
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class List
+                # channel to list
+                attr_reader :channel
+                # server to forward request to
+                attr_reader :target
+                # channel:: channel to list
+                # target:: forward to this server to supply response
+                # List channels and their topics
+                def initialize(channel, target='')
+                    @channel = channel
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Lusers
+                # mask for servers to match
+                attr_reader :mask
+                # reply from target server
+                attr_reader :target
+                # mask:: reply formed only by servers matching given mask
+                # target:: reply formed only by target server
+                # Get statistics about size of IRC network
+                def initialize(mask, target='')
+                    @mask = mask
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Motd
+                # server to send request to
+                attr_reader :target
+                # target:: server to send request to
+                # Request MOTD from target server. If no target is given
+                # it requests from the current server
+                def initialize(target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,20 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Names
+                # channel to request names
+                attr_reader :channel
+                # server to forward request to
+                attr_reader :target
+                # channel:: channel to request names from
+                # target:: forward to this server to supply response
+                # List visible nicknames. Supply empty string for channel
+                # to get entire list
+                def initialize(channel, target='')
+                    @channel = channel
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Give or change nickname
+            class Nick
+                # nickname
+                attr_reader :nick
+                # nick:: nickname
+                # Create a new Nick
+                def initialize(nick)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,12 @@
+require 'mod_spox/messages/outgoing/Privmsg'
+module ModSpox
+    module Messages
+        module Outgoing
+            # target:: target for message
+            # message:: message to be sent
+            # Send a notice to user or channel
+            class Notice < Privmsg
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Oper
+                # login name
+                attr_reader :name
+                # user's password
+                attr_reader :password
+                # name:: login name
+                # password:: user's password
+                # Create new Oper message
+                def initialize(name, password)
+                    @name = name
+                    @password = password
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Part
+                # channel to part
+                attr_reader :channel
+                # reason for part
+                attr_reader :reason        
+                # channel:: channel to part
+                # reason:: reason for part
+                # Part from channel. This command only allows single parts.
+                def initialize(channel, reason='')
+                    @channel = channel
+                    @reason = reason
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Send PASS command
+            class Pass
+                # connection password
+                attr_reader :password
+                # password:: connection password
+                # Create new Pass
+                def initialize(password)
+                    @password = @message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,11 @@
+require 'mod_spox/messages/outgoing/Simple'
+module ModSpox
+    module Messages
+        module Outgoing
+            # message:: string
+            # Send a ping        
+            class Ping < Simple
+            end
+        end
+    end
+end