ril 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/COPYING +339 -0
- data/README +32 -0
- data/examples/vbot.rb +43 -0
- data/lib/ril.rb +365 -0
- metadata +56 -0
data/COPYING
ADDED
@@ -0,0 +1,339 @@
|
|
1
|
+
GNU GENERAL PUBLIC LICENSE
|
2
|
+
Version 2, June 1991
|
3
|
+
|
4
|
+
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
5
|
+
675 Mass Ave, Cambridge, MA 02139, USA
|
6
|
+
Everyone is permitted to copy and distribute verbatim copies
|
7
|
+
of this license document, but changing it is not allowed.
|
8
|
+
|
9
|
+
Preamble
|
10
|
+
|
11
|
+
The licenses for most software are designed to take away your
|
12
|
+
freedom to share and change it. By contrast, the GNU General Public
|
13
|
+
License is intended to guarantee your freedom to share and change free
|
14
|
+
software--to make sure the software is free for all its users. This
|
15
|
+
General Public License applies to most of the Free Software
|
16
|
+
Foundation's software and to any other program whose authors commit to
|
17
|
+
using it. (Some other Free Software Foundation software is covered by
|
18
|
+
the GNU Library General Public License instead.) You can apply it to
|
19
|
+
your programs, too.
|
20
|
+
|
21
|
+
When we speak of free software, we are referring to freedom, not
|
22
|
+
price. Our General Public Licenses are designed to make sure that you
|
23
|
+
have the freedom to distribute copies of free software (and charge for
|
24
|
+
this service if you wish), that you receive source code or can get it
|
25
|
+
if you want it, that you can change the software or use pieces of it
|
26
|
+
in new free programs; and that you know you can do these things.
|
27
|
+
|
28
|
+
To protect your rights, we need to make restrictions that forbid
|
29
|
+
anyone to deny you these rights or to ask you to surrender the rights.
|
30
|
+
These restrictions translate to certain responsibilities for you if you
|
31
|
+
distribute copies of the software, or if you modify it.
|
32
|
+
|
33
|
+
For example, if you distribute copies of such a program, whether
|
34
|
+
gratis or for a fee, you must give the recipients all the rights that
|
35
|
+
you have. You must make sure that they, too, receive or can get the
|
36
|
+
source code. And you must show them these terms so they know their
|
37
|
+
rights.
|
38
|
+
|
39
|
+
We protect your rights with two steps: (1) copyright the software, and
|
40
|
+
(2) offer you this license which gives you legal permission to copy,
|
41
|
+
distribute and/or modify the software.
|
42
|
+
|
43
|
+
Also, for each author's protection and ours, we want to make certain
|
44
|
+
that everyone understands that there is no warranty for this free
|
45
|
+
software. If the software is modified by someone else and passed on, we
|
46
|
+
want its recipients to know that what they have is not the original, so
|
47
|
+
that any problems introduced by others will not reflect on the original
|
48
|
+
authors' reputations.
|
49
|
+
|
50
|
+
Finally, any free program is threatened constantly by software
|
51
|
+
patents. We wish to avoid the danger that redistributors of a free
|
52
|
+
program will individually obtain patent licenses, in effect making the
|
53
|
+
program proprietary. To prevent this, we have made it clear that any
|
54
|
+
patent must be licensed for everyone's free use or not licensed at all.
|
55
|
+
|
56
|
+
The precise terms and conditions for copying, distribution and
|
57
|
+
modification follow.
|
58
|
+
|
59
|
+
GNU GENERAL PUBLIC LICENSE
|
60
|
+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
61
|
+
|
62
|
+
0. This License applies to any program or other work which contains
|
63
|
+
a notice placed by the copyright holder saying it may be distributed
|
64
|
+
under the terms of this General Public License. The "Program", below,
|
65
|
+
refers to any such program or work, and a "work based on the Program"
|
66
|
+
means either the Program or any derivative work under copyright law:
|
67
|
+
that is to say, a work containing the Program or a portion of it,
|
68
|
+
either verbatim or with modifications and/or translated into another
|
69
|
+
language. (Hereinafter, translation is included without limitation in
|
70
|
+
the term "modification".) Each licensee is addressed as "you".
|
71
|
+
|
72
|
+
Activities other than copying, distribution and modification are not
|
73
|
+
covered by this License; they are outside its scope. The act of
|
74
|
+
running the Program is not restricted, and the output from the Program
|
75
|
+
is covered only if its contents constitute a work based on the
|
76
|
+
Program (independent of having been made by running the Program).
|
77
|
+
Whether that is true depends on what the Program does.
|
78
|
+
|
79
|
+
1. You may copy and distribute verbatim copies of the Program's
|
80
|
+
source code as you receive it, in any medium, provided that you
|
81
|
+
conspicuously and appropriately publish on each copy an appropriate
|
82
|
+
copyright notice and disclaimer of warranty; keep intact all the
|
83
|
+
notices that refer to this License and to the absence of any warranty;
|
84
|
+
and give any other recipients of the Program a copy of this License
|
85
|
+
along with the Program.
|
86
|
+
|
87
|
+
You may charge a fee for the physical act of transferring a copy, and
|
88
|
+
you may at your option offer warranty protection in exchange for a fee.
|
89
|
+
|
90
|
+
2. You may modify your copy or copies of the Program or any portion
|
91
|
+
of it, thus forming a work based on the Program, and copy and
|
92
|
+
distribute such modifications or work under the terms of Section 1
|
93
|
+
above, provided that you also meet all of these conditions:
|
94
|
+
|
95
|
+
a) You must cause the modified files to carry prominent notices
|
96
|
+
stating that you changed the files and the date of any change.
|
97
|
+
|
98
|
+
b) You must cause any work that you distribute or publish, that in
|
99
|
+
whole or in part contains or is derived from the Program or any
|
100
|
+
part thereof, to be licensed as a whole at no charge to all third
|
101
|
+
parties under the terms of this License.
|
102
|
+
|
103
|
+
c) If the modified program normally reads commands interactively
|
104
|
+
when run, you must cause it, when started running for such
|
105
|
+
interactive use in the most ordinary way, to print or display an
|
106
|
+
announcement including an appropriate copyright notice and a
|
107
|
+
notice that there is no warranty (or else, saying that you provide
|
108
|
+
a warranty) and that users may redistribute the program under
|
109
|
+
these conditions, and telling the user how to view a copy of this
|
110
|
+
License. (Exception: if the Program itself is interactive but
|
111
|
+
does not normally print such an announcement, your work based on
|
112
|
+
the Program is not required to print an announcement.)
|
113
|
+
|
114
|
+
These requirements apply to the modified work as a whole. If
|
115
|
+
identifiable sections of that work are not derived from the Program,
|
116
|
+
and can be reasonably considered independent and separate works in
|
117
|
+
themselves, then this License, and its terms, do not apply to those
|
118
|
+
sections when you distribute them as separate works. But when you
|
119
|
+
distribute the same sections as part of a whole which is a work based
|
120
|
+
on the Program, the distribution of the whole must be on the terms of
|
121
|
+
this License, whose permissions for other licensees extend to the
|
122
|
+
entire whole, and thus to each and every part regardless of who wrote it.
|
123
|
+
|
124
|
+
Thus, it is not the intent of this section to claim rights or contest
|
125
|
+
your rights to work written entirely by you; rather, the intent is to
|
126
|
+
exercise the right to control the distribution of derivative or
|
127
|
+
collective works based on the Program.
|
128
|
+
|
129
|
+
In addition, mere aggregation of another work not based on the Program
|
130
|
+
with the Program (or with a work based on the Program) on a volume of
|
131
|
+
a storage or distribution medium does not bring the other work under
|
132
|
+
the scope of this License.
|
133
|
+
|
134
|
+
3. You may copy and distribute the Program (or a work based on it,
|
135
|
+
under Section 2) in object code or executable form under the terms of
|
136
|
+
Sections 1 and 2 above provided that you also do one of the following:
|
137
|
+
|
138
|
+
a) Accompany it with the complete corresponding machine-readable
|
139
|
+
source code, which must be distributed under the terms of Sections
|
140
|
+
1 and 2 above on a medium customarily used for software interchange; or,
|
141
|
+
|
142
|
+
b) Accompany it with a written offer, valid for at least three
|
143
|
+
years, to give any third party, for a charge no more than your
|
144
|
+
cost of physically performing source distribution, a complete
|
145
|
+
machine-readable copy of the corresponding source code, to be
|
146
|
+
distributed under the terms of Sections 1 and 2 above on a medium
|
147
|
+
customarily used for software interchange; or,
|
148
|
+
|
149
|
+
c) Accompany it with the information you received as to the offer
|
150
|
+
to distribute corresponding source code. (This alternative is
|
151
|
+
allowed only for noncommercial distribution and only if you
|
152
|
+
received the program in object code or executable form with such
|
153
|
+
an offer, in accord with Subsection b above.)
|
154
|
+
|
155
|
+
The source code for a work means the preferred form of the work for
|
156
|
+
making modifications to it. For an executable work, complete source
|
157
|
+
code means all the source code for all modules it contains, plus any
|
158
|
+
associated interface definition files, plus the scripts used to
|
159
|
+
control compilation and installation of the executable. However, as a
|
160
|
+
special exception, the source code distributed need not include
|
161
|
+
anything that is normally distributed (in either source or binary
|
162
|
+
form) with the major components (compiler, kernel, and so on) of the
|
163
|
+
operating system on which the executable runs, unless that component
|
164
|
+
itself accompanies the executable.
|
165
|
+
|
166
|
+
If distribution of executable or object code is made by offering
|
167
|
+
access to copy from a designated place, then offering equivalent
|
168
|
+
access to copy the source code from the same place counts as
|
169
|
+
distribution of the source code, even though third parties are not
|
170
|
+
compelled to copy the source along with the object code.
|
171
|
+
|
172
|
+
4. You may not copy, modify, sublicense, or distribute the Program
|
173
|
+
except as expressly provided under this License. Any attempt
|
174
|
+
otherwise to copy, modify, sublicense or distribute the Program is
|
175
|
+
void, and will automatically terminate your rights under this License.
|
176
|
+
However, parties who have received copies, or rights, from you under
|
177
|
+
this License will not have their licenses terminated so long as such
|
178
|
+
parties remain in full compliance.
|
179
|
+
|
180
|
+
5. You are not required to accept this License, since you have not
|
181
|
+
signed it. However, nothing else grants you permission to modify or
|
182
|
+
distribute the Program or its derivative works. These actions are
|
183
|
+
prohibited by law if you do not accept this License. Therefore, by
|
184
|
+
modifying or distributing the Program (or any work based on the
|
185
|
+
Program), you indicate your acceptance of this License to do so, and
|
186
|
+
all its terms and conditions for copying, distributing or modifying
|
187
|
+
the Program or works based on it.
|
188
|
+
|
189
|
+
6. Each time you redistribute the Program (or any work based on the
|
190
|
+
Program), the recipient automatically receives a license from the
|
191
|
+
original licensor to copy, distribute or modify the Program subject to
|
192
|
+
these terms and conditions. You may not impose any further
|
193
|
+
restrictions on the recipients' exercise of the rights granted herein.
|
194
|
+
You are not responsible for enforcing compliance by third parties to
|
195
|
+
this License.
|
196
|
+
|
197
|
+
7. If, as a consequence of a court judgment or allegation of patent
|
198
|
+
infringement or for any other reason (not limited to patent issues),
|
199
|
+
conditions are imposed on you (whether by court order, agreement or
|
200
|
+
otherwise) that contradict the conditions of this License, they do not
|
201
|
+
excuse you from the conditions of this License. If you cannot
|
202
|
+
distribute so as to satisfy simultaneously your obligations under this
|
203
|
+
License and any other pertinent obligations, then as a consequence you
|
204
|
+
may not distribute the Program at all. For example, if a patent
|
205
|
+
license would not permit royalty-free redistribution of the Program by
|
206
|
+
all those who receive copies directly or indirectly through you, then
|
207
|
+
the only way you could satisfy both it and this License would be to
|
208
|
+
refrain entirely from distribution of the Program.
|
209
|
+
|
210
|
+
If any portion of this section is held invalid or unenforceable under
|
211
|
+
any particular circumstance, the balance of the section is intended to
|
212
|
+
apply and the section as a whole is intended to apply in other
|
213
|
+
circumstances.
|
214
|
+
|
215
|
+
It is not the purpose of this section to induce you to infringe any
|
216
|
+
patents or other property right claims or to contest validity of any
|
217
|
+
such claims; this section has the sole purpose of protecting the
|
218
|
+
integrity of the free software distribution system, which is
|
219
|
+
implemented by public license practices. Many people have made
|
220
|
+
generous contributions to the wide range of software distributed
|
221
|
+
through that system in reliance on consistent application of that
|
222
|
+
system; it is up to the author/donor to decide if he or she is willing
|
223
|
+
to distribute software through any other system and a licensee cannot
|
224
|
+
impose that choice.
|
225
|
+
|
226
|
+
This section is intended to make thoroughly clear what is believed to
|
227
|
+
be a consequence of the rest of this License.
|
228
|
+
|
229
|
+
8. If the distribution and/or use of the Program is restricted in
|
230
|
+
certain countries either by patents or by copyrighted interfaces, the
|
231
|
+
original copyright holder who places the Program under this License
|
232
|
+
may add an explicit geographical distribution limitation excluding
|
233
|
+
those countries, so that distribution is permitted only in or among
|
234
|
+
countries not thus excluded. In such case, this License incorporates
|
235
|
+
the limitation as if written in the body of this License.
|
236
|
+
|
237
|
+
9. The Free Software Foundation may publish revised and/or new versions
|
238
|
+
of the General Public License from time to time. Such new versions will
|
239
|
+
be similar in spirit to the present version, but may differ in detail to
|
240
|
+
address new problems or concerns.
|
241
|
+
|
242
|
+
Each version is given a distinguishing version number. If the Program
|
243
|
+
specifies a version number of this License which applies to it and "any
|
244
|
+
later version", you have the option of following the terms and conditions
|
245
|
+
either of that version or of any later version published by the Free
|
246
|
+
Software Foundation. If the Program does not specify a version number of
|
247
|
+
this License, you may choose any version ever published by the Free Software
|
248
|
+
Foundation.
|
249
|
+
|
250
|
+
10. If you wish to incorporate parts of the Program into other free
|
251
|
+
programs whose distribution conditions are different, write to the author
|
252
|
+
to ask for permission. For software which is copyrighted by the Free
|
253
|
+
Software Foundation, write to the Free Software Foundation; we sometimes
|
254
|
+
make exceptions for this. Our decision will be guided by the two goals
|
255
|
+
of preserving the free status of all derivatives of our free software and
|
256
|
+
of promoting the sharing and reuse of software generally.
|
257
|
+
|
258
|
+
NO WARRANTY
|
259
|
+
|
260
|
+
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
261
|
+
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
262
|
+
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
263
|
+
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
264
|
+
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
265
|
+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
266
|
+
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
267
|
+
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
268
|
+
REPAIR OR CORRECTION.
|
269
|
+
|
270
|
+
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
271
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
272
|
+
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
273
|
+
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
274
|
+
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
275
|
+
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
276
|
+
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
277
|
+
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
278
|
+
POSSIBILITY OF SUCH DAMAGES.
|
279
|
+
|
280
|
+
END OF TERMS AND CONDITIONS
|
281
|
+
|
282
|
+
Appendix: How to Apply These Terms to Your New Programs
|
283
|
+
|
284
|
+
If you develop a new program, and you want it to be of the greatest
|
285
|
+
possible use to the public, the best way to achieve this is to make it
|
286
|
+
free software which everyone can redistribute and change under these terms.
|
287
|
+
|
288
|
+
To do so, attach the following notices to the program. It is safest
|
289
|
+
to attach them to the start of each source file to most effectively
|
290
|
+
convey the exclusion of warranty; and each file should have at least
|
291
|
+
the "copyright" line and a pointer to where the full notice is found.
|
292
|
+
|
293
|
+
<one line to give the program's name and a brief idea of what it does.>
|
294
|
+
Copyright (C) 19yy <name of author>
|
295
|
+
|
296
|
+
This program is free software; you can redistribute it and/or modify
|
297
|
+
it under the terms of the GNU General Public License as published by
|
298
|
+
the Free Software Foundation; either version 2 of the License, or
|
299
|
+
(at your option) any later version.
|
300
|
+
|
301
|
+
This program is distributed in the hope that it will be useful,
|
302
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
303
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
304
|
+
GNU General Public License for more details.
|
305
|
+
|
306
|
+
You should have received a copy of the GNU General Public License
|
307
|
+
along with this program; if not, write to the Free Software
|
308
|
+
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
309
|
+
|
310
|
+
Also add information on how to contact you by electronic and paper mail.
|
311
|
+
|
312
|
+
If the program is interactive, make it output a short notice like this
|
313
|
+
when it starts in an interactive mode:
|
314
|
+
|
315
|
+
Gnomovision version 69, Copyright (C) 19yy name of author
|
316
|
+
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
317
|
+
This is free software, and you are welcome to redistribute it
|
318
|
+
under certain conditions; type `show c' for details.
|
319
|
+
|
320
|
+
The hypothetical commands `show w' and `show c' should show the appropriate
|
321
|
+
parts of the General Public License. Of course, the commands you use may
|
322
|
+
be called something other than `show w' and `show c'; they could even be
|
323
|
+
mouse-clicks or menu items--whatever suits your program.
|
324
|
+
|
325
|
+
You should also get your employer (if you work as a programmer) or your
|
326
|
+
school, if any, to sign a "copyright disclaimer" for the program, if
|
327
|
+
necessary. Here is a sample; alter the names:
|
328
|
+
|
329
|
+
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
330
|
+
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
331
|
+
|
332
|
+
<signature of Ty Coon>, 1 April 1989
|
333
|
+
Ty Coon, President of Vice
|
334
|
+
|
335
|
+
This General Public License does not permit incorporating your program into
|
336
|
+
proprietary programs. If your program is a subroutine library, you may
|
337
|
+
consider it more useful to permit linking proprietary applications with the
|
338
|
+
library. If this is what you want to do, use the GNU Library General
|
339
|
+
Public License instead of this License.
|
data/README
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
Ril is just a simple IRC "library" that is made to make building IRC bots
|
2
|
+
easier. Instead of focusing on creating functions, and binding messages. Ril
|
3
|
+
is designed so that you can build a completely functional IRC bot within
|
4
|
+
minutes of opening your favorite editor and saving the file. The magic is that
|
5
|
+
you don't need to handle anything that is on the IRC under layer, only create
|
6
|
+
an object that inherits Ril::RilBot, and start defining your methods, the
|
7
|
+
syntax is as follows:
|
8
|
+
|
9
|
+
def on_privmsg(userinfo, target, message)
|
10
|
+
nick, user, host = userinfo_to_a(userinfo)
|
11
|
+
|
12
|
+
puts "<#{nick}/#{target}> #{message}"
|
13
|
+
end
|
14
|
+
|
15
|
+
-or-
|
16
|
+
|
17
|
+
def on_375(userinfo, target, message)
|
18
|
+
@message_of_the_day = ""
|
19
|
+
end
|
20
|
+
|
21
|
+
def on_372(userinfo, target, message)
|
22
|
+
@message_of_the_day += "#{message}\n"
|
23
|
+
end
|
24
|
+
|
25
|
+
all functions will be called with the three parameters +userinfo+, +target+,
|
26
|
+
and +message+, depending on the type of message it is, may mean that +target+
|
27
|
+
will be nil, and +message+ will have the data you are looking for, or vice
|
28
|
+
versa, so some IRC protocol knowledge is required. Check out the examples, for
|
29
|
+
more fun!
|
30
|
+
|
31
|
+
Thanks for looking,
|
32
|
+
The Ril Tream
|
data/examples/vbot.rb
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
#! /usr/bin/env ruby
|
2
|
+
#
|
3
|
+
# vbot.rb - just prints the version!
|
4
|
+
# simple bot that connects to <server> with <nick>, joins <channel>, and
|
5
|
+
# handles the one command !version
|
6
|
+
|
7
|
+
require 'ril'
|
8
|
+
include Ril
|
9
|
+
|
10
|
+
# c:VersionBot
|
11
|
+
class VersionBot < RilBot
|
12
|
+
# hanle a PRIVMSG message.
|
13
|
+
def on_privmsg(userinfo, target, message)
|
14
|
+
command = message.split(' ').first
|
15
|
+
|
16
|
+
if command == '!version'
|
17
|
+
privmsg(target, version)
|
18
|
+
end
|
19
|
+
end # on_privmsg
|
20
|
+
|
21
|
+
# ERR_NOMOTD
|
22
|
+
def on_422(userinfo, target, message)
|
23
|
+
on_376(userinfo, target, message)
|
24
|
+
end # on_422
|
25
|
+
|
26
|
+
# RPL_ENDOFMOTD
|
27
|
+
def on_376(userinfo, target, message)
|
28
|
+
join($channel)
|
29
|
+
end # on_376
|
30
|
+
end # /c:VersionBot
|
31
|
+
|
32
|
+
if __FILE__ == $0
|
33
|
+
if ARGV.length != 3
|
34
|
+
puts "Usage: #{$0} <irc server> <nickname> <channel>"
|
35
|
+
exit 1
|
36
|
+
end
|
37
|
+
|
38
|
+
$channel = ARGV[2]
|
39
|
+
|
40
|
+
vbot = VersionBot.new(:hostname => ARGV[0],
|
41
|
+
:nickname => ARGV[1], :verbose => true)
|
42
|
+
vbot.run
|
43
|
+
end
|
data/lib/ril.rb
ADDED
@@ -0,0 +1,365 @@
|
|
1
|
+
###
|
2
|
+
# ril.rb - ruby irc library
|
3
|
+
# $Release Version: 0.1.1 $
|
4
|
+
# $Revision: 4 $
|
5
|
+
# by Joey Kinsella <jkinsella(at)rubyforge(dot)org>
|
6
|
+
#
|
7
|
+
# This program is free software; you can redistribute it and/or modify
|
8
|
+
# it under the terms of the GNU General Public License as published by
|
9
|
+
# the Free Software Foundation; either version 2 of the License, or
|
10
|
+
# (at your option) any later version.
|
11
|
+
#
|
12
|
+
# This program is distributed in the hope that it will be useful,
|
13
|
+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
14
|
+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
15
|
+
# GNU General Public License for more details.
|
16
|
+
#
|
17
|
+
# You should have received a copy of the GNU General Public License
|
18
|
+
# along with this program; if not, write to the Free Software
|
19
|
+
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
20
|
+
#
|
21
|
+
####
|
22
|
+
require 'socket'
|
23
|
+
|
24
|
+
module Ril
|
25
|
+
Ril_VERSION = "Ril - Ruby IRC Library v0.1.1 by Joey Kinsella"
|
26
|
+
|
27
|
+
####
|
28
|
+
# c:RilBot
|
29
|
+
|
30
|
+
# The RilBot object creates a connection to an IRC server, and then sits
|
31
|
+
# in a processing loop, calling the appropriate functions.
|
32
|
+
#
|
33
|
+
# The idea behind RilBot, is to create your own bot object that inherits
|
34
|
+
# RilBot, and then override the on_* methods, with your own.
|
35
|
+
#
|
36
|
+
class RilBot
|
37
|
+
|
38
|
+
# initializes an instance of RilBot.
|
39
|
+
#
|
40
|
+
# * server_args is a hash variable containing appropriate settings.
|
41
|
+
#
|
42
|
+
# == IRC related settings ==
|
43
|
+
# :hostname => server to connect to [required]
|
44
|
+
# :port => port number to connect to [defaults to 6667]
|
45
|
+
# :nickname => nickname to use [required]
|
46
|
+
# :username => username to use, [defaults to nickname if not set]
|
47
|
+
# :realname => realname to use, [defaults to nickname if not set]
|
48
|
+
# :password => PASS to send to server
|
49
|
+
#
|
50
|
+
# == RilBot related settings ==
|
51
|
+
# :verbose => true or false, if true prints the IRC messages out.
|
52
|
+
#
|
53
|
+
# * If a block is given it is executed when the IRC server sends either a
|
54
|
+
# * 422 (ERR_NOMOTD), or 376 (RPL_ENDOFMOTD). it will be called with one
|
55
|
+
# * parameter, which is just a reference to self.
|
56
|
+
#
|
57
|
+
def initialize(server_args, &block)
|
58
|
+
# verbose flag
|
59
|
+
@verbose = server_args[:verbose]
|
60
|
+
@verbose = false if @verbose.nil?
|
61
|
+
|
62
|
+
# identified flag
|
63
|
+
@identified = false
|
64
|
+
|
65
|
+
# keep the run loop running
|
66
|
+
@run_loop = true
|
67
|
+
|
68
|
+
# server to connect to.
|
69
|
+
@hostname = server_args[:hostname]
|
70
|
+
raise ArgumentError, "No hostname defined." if @hostname.nil?
|
71
|
+
|
72
|
+
# need a nickname to use
|
73
|
+
@nickname = server_args[:nickname]
|
74
|
+
raise ArgumentError, "No nickname defined." if @nickname.nil?
|
75
|
+
|
76
|
+
# port, defaults to 6667 (obviously)
|
77
|
+
@port = server_args[:port]
|
78
|
+
@port = 6667 if @port.nil?
|
79
|
+
|
80
|
+
# username
|
81
|
+
@username = server_args[:username]
|
82
|
+
@username = @nickname if @username.nil?
|
83
|
+
|
84
|
+
# realname
|
85
|
+
@realname = server_args[:realname]
|
86
|
+
@realname = @nickname if @realname.nil?
|
87
|
+
|
88
|
+
# IRC password
|
89
|
+
@irc_password = server_args[:password]
|
90
|
+
|
91
|
+
# initialize method keeper
|
92
|
+
@method_keeper = Hash.new
|
93
|
+
|
94
|
+
vputs "connecting to irc://#{@hostname}:#{@port}"
|
95
|
+
|
96
|
+
# bind block
|
97
|
+
if block_given?
|
98
|
+
@method_keeper['first_run'] = block
|
99
|
+
end
|
100
|
+
|
101
|
+
# bind the default methods...
|
102
|
+
bind_ping(method(:on_ping))
|
103
|
+
bind_notice_auth(method(:on_notice_auth))
|
104
|
+
|
105
|
+
begin
|
106
|
+
# try to connect.
|
107
|
+
@socket = TCPSocket.new(@hostname, @port)
|
108
|
+
rescue
|
109
|
+
vputs "Failed to connect to irc://#{@hostname}:#{@port}"
|
110
|
+
raise
|
111
|
+
end
|
112
|
+
end # initialize
|
113
|
+
|
114
|
+
# binds to ``NOTICE AUTH''
|
115
|
+
# Will either call the method pointed to by callback_obj, or execute
|
116
|
+
# the given block, this function should have one parameter, and it
|
117
|
+
# will contain the text given to you from the server. +msg+
|
118
|
+
def bind_notice_auth(callback_obj = nil, &block)
|
119
|
+
if block_given?
|
120
|
+
@method_keeper['notice_auth'] = block
|
121
|
+
elsif callback_obj.nil? == false
|
122
|
+
@method_keeper['notice_auth'] = callback_obj
|
123
|
+
else
|
124
|
+
raise ArgumentError
|
125
|
+
end
|
126
|
+
end # bind_notice_auth
|
127
|
+
|
128
|
+
# binds to PING message
|
129
|
+
# will call the binded function with the servers hostname.
|
130
|
+
def bind_ping(callback_obj = nil, &block)
|
131
|
+
if block_given?
|
132
|
+
@method_keeper['ping'] = block
|
133
|
+
elsif callback_obj.nil? == false
|
134
|
+
@method_keeper['ping'] = callback_obj
|
135
|
+
else
|
136
|
+
raise ArgumentError
|
137
|
+
end
|
138
|
+
end
|
139
|
+
|
140
|
+
# runs the bot in a main loop, sitting on the socket waiting for stuff
|
141
|
+
# to happen, then calling the appropriate bound function.
|
142
|
+
def run
|
143
|
+
# the irc standard denotes that no message is over 512, but I'll
|
144
|
+
# double that here, if for some reason you use this library on a
|
145
|
+
# non RFC compliant server.
|
146
|
+
while @run_loop and (irc_msg = @socket.recv(1024)) != ""
|
147
|
+
parse(irc_msg)
|
148
|
+
end
|
149
|
+
end # run
|
150
|
+
|
151
|
+
# call this when you want to kill the bot.
|
152
|
+
def stop
|
153
|
+
@run_loop = false
|
154
|
+
|
155
|
+
@socket.close
|
156
|
+
end
|
157
|
+
|
158
|
+
# returns whether or not you are identified to the server
|
159
|
+
def identified?
|
160
|
+
@identified
|
161
|
+
end # identified?
|
162
|
+
|
163
|
+
# returns the nickname you are currently using.
|
164
|
+
def my_nick
|
165
|
+
@nickname
|
166
|
+
end # my_nick
|
167
|
+
|
168
|
+
# little utility function to convert a +userinfo+ hash to an array
|
169
|
+
# useful so you can do:
|
170
|
+
# nickname, username, hostname = userinfo_to_a(userinfo)
|
171
|
+
def userinfo_to_a(userinfo)
|
172
|
+
[ userinfo[:nickname], userinfo[:username], userinfo[:hostname] ]
|
173
|
+
end # userinfo_to_a
|
174
|
+
|
175
|
+
######
|
176
|
+
# start IRC stuff
|
177
|
+
###
|
178
|
+
|
179
|
+
# sends +msg+ as a raw IRC message, eg: PRIVMSG #ruby :hello
|
180
|
+
def send_raw(msg)
|
181
|
+
vputs ">>> #{msg}"
|
182
|
+
|
183
|
+
if msg.length > 512
|
184
|
+
vputs "*** WARNING: +msg+ is over 512 bytes cutting..."
|
185
|
+
msg = msg[0..511]
|
186
|
+
end
|
187
|
+
|
188
|
+
@socket.puts msg
|
189
|
+
end
|
190
|
+
|
191
|
+
# send +message+ to +target+, if +safety+ is true check to see if
|
192
|
+
# +target+ is my_nick, if so don't send..
|
193
|
+
def privmsg(target, message, safety = true)
|
194
|
+
return if target == my_nick and safety == true
|
195
|
+
|
196
|
+
send_raw("PRIVMSG #{target} :#{message}")
|
197
|
+
end # privmsg
|
198
|
+
|
199
|
+
# sends +message+ to +target+ via notice, if +safety+ is true check to see
|
200
|
+
# if +target+ is my_nick, if so don't send...
|
201
|
+
def notice(target, message, safety = true)
|
202
|
+
return if target == my_nick and safety == true
|
203
|
+
|
204
|
+
send_raw("NOTICE #{target} :#{message}")
|
205
|
+
end # notice
|
206
|
+
|
207
|
+
# joins +channel+ with +key+
|
208
|
+
#
|
209
|
+
# if +channel+ is an array it will join each channel in that array.
|
210
|
+
# +key+ can also be an array of keys.
|
211
|
+
def join(channel, key = nil)
|
212
|
+
channels = (channel.is_a? Array) ? channel.join(",") : channel
|
213
|
+
keys = (key.is_a? Array) ? key.join(",") : key
|
214
|
+
keys = "" if keys.nil?
|
215
|
+
|
216
|
+
send_raw("JOIN #{channels} #{keys}")
|
217
|
+
end # join
|
218
|
+
|
219
|
+
# parts +channel+, leaving them with +part_msg+
|
220
|
+
def part(channel, part_msg = nil)
|
221
|
+
send_raw("PART #{channel} :#{msg}")
|
222
|
+
end # part
|
223
|
+
|
224
|
+
# adjusts mode to +mode+ on +target+, with +mode_opts+
|
225
|
+
#
|
226
|
+
# if +mode_opts+ is an array it will be converted to a space delimited string.
|
227
|
+
def mode(target, mode, mode_opts = nil)
|
228
|
+
mode_opts = "" if mode_opts.nil?
|
229
|
+
mode_opts = (mode_opts.is_a? Array) ? mode_opts.join(" ") : mode_opts
|
230
|
+
|
231
|
+
send_raw("MODE #{target} #{mode} #{mode_opts}")
|
232
|
+
end # mode
|
233
|
+
|
234
|
+
# changes topic on +channel+ to +new_topic+
|
235
|
+
#
|
236
|
+
# if +new_topic+ is nil, it will unset the topic.
|
237
|
+
def topic(channel, new_topic = nil)
|
238
|
+
new_topic = "" if new_topic.nil?
|
239
|
+
|
240
|
+
send_raw("TOPIC #{channel} :#{new_topic}")
|
241
|
+
end # topic
|
242
|
+
|
243
|
+
# invite +nick+ to +channel+
|
244
|
+
def invite(channel, nick)
|
245
|
+
send_raw("INVITE #{channel} #{nick}")
|
246
|
+
end # invite
|
247
|
+
|
248
|
+
# set an away message to +message+
|
249
|
+
#
|
250
|
+
# if +message+ is nil, it will remove your away message.
|
251
|
+
def away(message = nil)
|
252
|
+
send_raw("AWAY :#{message}") unless message.nil?
|
253
|
+
send_raw("AWAY") if message.nil?
|
254
|
+
end # away
|
255
|
+
|
256
|
+
# quits the server with +message+
|
257
|
+
#
|
258
|
+
# if +message+ is nil, then it just quits reporting version info.
|
259
|
+
def quit(message = nil)
|
260
|
+
message = version() if quit.nil?
|
261
|
+
|
262
|
+
stop
|
263
|
+
send_raw("QUIT :#{message}")
|
264
|
+
end # quit
|
265
|
+
|
266
|
+
# handles a PING response, if you override this function
|
267
|
+
# be sure to send a PONG back.
|
268
|
+
def on_ping(hostname)
|
269
|
+
send_raw("PONG :#{hostname}")
|
270
|
+
end # on_ping
|
271
|
+
|
272
|
+
# handles a NOTICE AUTH response, if you override this method
|
273
|
+
# be sure to send NICK, USER, PASS, and the .identified? method
|
274
|
+
# will become completely useless... +msg+ is just what was sent
|
275
|
+
# as the message.
|
276
|
+
def on_notice_auth(msg)
|
277
|
+
unless @identified
|
278
|
+
send_raw("NICK #{@nickname}\r\nUSER #{@username} 0 0 :#{@realname}")
|
279
|
+
send_raw("PASS #{@irc_password}") if @irc_password.nil? == false
|
280
|
+
|
281
|
+
@identified = true
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
protected
|
286
|
+
def version
|
287
|
+
Ril::Ril_VERSION
|
288
|
+
end
|
289
|
+
|
290
|
+
private
|
291
|
+
# prints +str+ if verbosity is enabled.
|
292
|
+
def vputs(str)
|
293
|
+
puts str if @verbose
|
294
|
+
end
|
295
|
+
|
296
|
+
# parses the irc +msg+
|
297
|
+
def parse(msg)
|
298
|
+
vputs "<<< #{msg}"
|
299
|
+
|
300
|
+
msg.each_line do |m|
|
301
|
+
prefix, data = m.split(' :')
|
302
|
+
data.chomp! unless data.nil?
|
303
|
+
|
304
|
+
if prefix == 'NOTICE AUTH'
|
305
|
+
unless @method_keeper['notice_auth'].nil?
|
306
|
+
@method_keeper['notice_auth'].call(data)
|
307
|
+
end
|
308
|
+
elsif prefix == 'PING'
|
309
|
+
unless @method_keeper['ping'].nil?
|
310
|
+
@method_keeper['ping'].call(data)
|
311
|
+
end
|
312
|
+
else
|
313
|
+
irc_message = prefix.split(' ')[1]
|
314
|
+
|
315
|
+
if irc_message == "422" or irc_message == "376"
|
316
|
+
unless @method_keeper['first_run'].nil?
|
317
|
+
@method_keeper['first_run'].call(self)
|
318
|
+
|
319
|
+
# we don't want this running if your bot does a MOTD.
|
320
|
+
@method_keeper['first_run'] = nil
|
321
|
+
end
|
322
|
+
end
|
323
|
+
|
324
|
+
# run the appropriate method...
|
325
|
+
lookup_method(irc_message, prefix, data)
|
326
|
+
end # prefix == ???
|
327
|
+
end # msg.each
|
328
|
+
end # parse
|
329
|
+
|
330
|
+
# this does the actual parsing, and running of methods...
|
331
|
+
def lookup_method(message, prefix, data)
|
332
|
+
# prefix chunked out by a space...
|
333
|
+
prefix_a = prefix.split(' ')
|
334
|
+
|
335
|
+
if prefix_a.nil? and $DEBUG
|
336
|
+
vputs ">>>DEBUGGING<<<"
|
337
|
+
vputs "message: #{message}"
|
338
|
+
vputs "prefix: #{prefix}"
|
339
|
+
vputs "data: #{data}"
|
340
|
+
vputs ">>>DEBUGGING<<<"
|
341
|
+
end
|
342
|
+
|
343
|
+
prefix_a[0].slice!(0)
|
344
|
+
|
345
|
+
if prefix_a[0].index('!').nil?
|
346
|
+
userinfo = { :hostname => prefix_a[0] }
|
347
|
+
else
|
348
|
+
userinfo = {
|
349
|
+
:nickname => prefix_a[0].split('!')[0],
|
350
|
+
:username => prefix_a[0].split('!')[1].split('@')[0],
|
351
|
+
:hostname => prefix_a[0].split('@')[0],
|
352
|
+
}
|
353
|
+
end
|
354
|
+
|
355
|
+
prefix_a.slice!(0, 2)
|
356
|
+
target = prefix_a.join(' ')
|
357
|
+
|
358
|
+
callback = "on_#{message}".downcase.to_sym
|
359
|
+
if self.respond_to?(callback)
|
360
|
+
method(callback).call(userinfo, target, data)
|
361
|
+
end
|
362
|
+
end # lookup_method
|
363
|
+
end # /c:RilBot
|
364
|
+
|
365
|
+
end # module
|
metadata
ADDED
@@ -0,0 +1,56 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: ril
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Joey Kinsella
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2009-07-25 00:00:00 -04:00
|
13
|
+
default_executable:
|
14
|
+
dependencies: []
|
15
|
+
|
16
|
+
description: Ril is a inheritence based IRC library.
|
17
|
+
email: jkinsella@rubyforge.org
|
18
|
+
executables: []
|
19
|
+
|
20
|
+
extensions: []
|
21
|
+
|
22
|
+
extra_rdoc_files: []
|
23
|
+
|
24
|
+
files:
|
25
|
+
- lib/ril.rb
|
26
|
+
- examples/vbot.rb
|
27
|
+
- README
|
28
|
+
- COPYING
|
29
|
+
has_rdoc: true
|
30
|
+
homepage: http://rubyforge.org/projects/ril
|
31
|
+
post_install_message:
|
32
|
+
rdoc_options: []
|
33
|
+
|
34
|
+
require_paths:
|
35
|
+
- lib
|
36
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: "0"
|
41
|
+
version:
|
42
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - ">="
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: "0"
|
47
|
+
version:
|
48
|
+
requirements: []
|
49
|
+
|
50
|
+
rubyforge_project: http://ril.rubyforge.org/
|
51
|
+
rubygems_version: 1.3.1
|
52
|
+
signing_key:
|
53
|
+
specification_version: 2
|
54
|
+
summary: provides IRC support to ruby
|
55
|
+
test_files: []
|
56
|
+
|