mod_spox 0.0.1

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Names
+                # 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,11 @@
+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,10 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # message:: string
+            # Send a ping        
+            class Ping < Simple
+            end
+        end
+    end
+end

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

@@ -0,0 +1,17 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Pong
+                # server:: server to send to
+                attr_reader :server
+                # string:: string
+                attr_reader :string
+                # Send a pong
+                def initialize(server, string)
+                    @server = server
+                    @string = string
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Privmsg
+                # target for the message
+                attr_reader :target
+                # the message
+                attr_reader :message
+                # target:: target for the message
+                # message:: message to be sent
+                # Send a message to user or channel
+                def initialize(target, message)
+                    @target = target
+                    @message = message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,10 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # message:: quit messages
+            # Disconnects the bot from the IRC server
+            class Quit < Simple
+            end
+        end
+    end
+end

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

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Force server to re-read config file (oper command)
+            class Rehash
+            end
+        end
+    end
+end

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

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

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class ServList
+                # mask
+                attr_reader :mask
+                # type
+                attr_reader :type
+                # mask:: mask
+                # type:: type
+                # List services currently connected to network
+                def initialize(mask, type)
+                    @mask = mask
+                    @type = type
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,12 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Simple
+                attr_reader :message
+                def initialize(message)
+                    @message = message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Squery
+                # service to query
+                attr_reader :service_name
+                # message to send to service
+                attr_reader :message
+                # service_name:: name of the service to query
+                # message:: message to send to service
+                # Send message to a service
+                def initialize(service_name, message)
+                    @service_name = service_name
+                    @message = message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Squit
+                # server to disconnect
+                attr_reader :server
+                # reasone for disconnection
+                attr_reader :comment
+                # server:: server to disconnect
+                # comment:: reason for disconnection
+                # Disconnect server link. Only available if bot is oper.
+                def initialize(server, comment)
+                    @comment = comment
+                    @server = server
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,18 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Stats
+                # the query
+                attr_reader :query
+                # target server
+                attr_reader :target
+                # query:: single character for query
+                # target:: target server to query (or connected server if unset)
+                def initialize(query, target='')
+                    @query = query
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Summon
+                # nick to summon
+                attr_reader :nick
+                # server nick is on
+                attr_reader :target
+                # channel to summon to
+                attr_reader :channel
+                # nick:: nick to summon
+                # target:: server which nick is on
+                # channel:: channel to summon to
+                # Summon a user
+                def initialize(nick, target='', channel='')
+                    @nick = nick
+                    @channel = channel
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Time
+                # target server
+                attr_reader :target
+                # target:: target server
+                # Request time on server
+                def initialize(channel, target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Topic
+                # channel to set topic
+                attr_reader :channel
+                # the topic
+                attr_reader :topic
+                # channel:: channel to set topic in
+                # topic:: the topic
+                # Set the topic for the channel
+                def initialize(channel, topic)
+                    @channel = channel
+                    @topic = topic
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Trace
+                # target to trace to
+                attr_reader :target
+                # target:: target to trace to
+                # Find route to specifc server
+                def initialize(target)
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Set status as not away
+            class Unaway
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class User
+                # username of user
+                attr_reader :username
+                # real name of user
+                attr_reader :real_name
+                # mode of user
+                attr_reader :mode
+                # username:: username of user
+                # real_name:: real name of user
+                # mode:: default mode (see RFC 2812 for proper mode values)
+                # Create new User message
+                def initialize(username, real_name, mode=0)
+                    @username = username
+                    @real_name = real_name
+                    @mode = mode
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class UserHost
+                # nick to query
+                attr_reader :nick
+                # nick:: nick to query
+                # Request host of nick
+                def initialize(nick)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class UserMode
+                # The bot's nick
+                attr_reader :nick
+                # mode to set/unset
+                attr_reader :mode
+                # nick:: The bot's nick
+                # mode:: mode to set/unset
+                # Create UserMode message
+                def initialize(nick, mode)
+                    @nick = nick
+                    @mode = mode
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Users
+                # target server
+                attr_reader :target
+                # target:: target server
+                # List users on server
+                def initialize(target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Version
+                # target server to query
+                attr_reader :target
+                # target:: target server to query
+                # Query version of server. Connected server is queried
+                # if target is not defined
+                def initialize(target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Who
+                # mask to match
+                attr_reader :mask
+                # return only ops
+                attr_reader :op_only
+                # mask:: mask of clients to match
+                # only_ops:: only return operators
+                # Query for information matching given mask
+                def initialize(mask, op_only=false)
+                    @mask = mask
+                    @op_only = op_only
+                end
+            end
+        end
+    end
+end