gmcmillan-xmpp4r 0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (215) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG +91 -0
  3. data/COPYING +340 -0
  4. data/LICENSE +59 -0
  5. data/README.rdoc +122 -0
  6. data/README_ruby19.txt +43 -0
  7. data/Rakefile +258 -0
  8. data/data/doc/xmpp4r/examples/advanced/adventure/README +56 -0
  9. data/data/doc/xmpp4r/examples/advanced/adventure/adventure.rb +23 -0
  10. data/data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb +136 -0
  11. data/data/doc/xmpp4r/examples/advanced/adventure/cube.xml +15 -0
  12. data/data/doc/xmpp4r/examples/advanced/adventure/tower.xml +69 -0
  13. data/data/doc/xmpp4r/examples/advanced/adventure/world.rb +424 -0
  14. data/data/doc/xmpp4r/examples/advanced/fileserve.conf +11 -0
  15. data/data/doc/xmpp4r/examples/advanced/fileserve.rb +346 -0
  16. data/data/doc/xmpp4r/examples/advanced/getonline.rb +56 -0
  17. data/data/doc/xmpp4r/examples/advanced/gtkmucclient.rb +315 -0
  18. data/data/doc/xmpp4r/examples/advanced/migrate.rb +88 -0
  19. data/data/doc/xmpp4r/examples/advanced/minimuc.rb +266 -0
  20. data/data/doc/xmpp4r/examples/advanced/pep-aggregator/index.xsl +235 -0
  21. data/data/doc/xmpp4r/examples/advanced/pep-aggregator/pep-aggregator.rb +147 -0
  22. data/data/doc/xmpp4r/examples/advanced/recvfile.rb +85 -0
  23. data/data/doc/xmpp4r/examples/advanced/rosterdiscovery.rb +129 -0
  24. data/data/doc/xmpp4r/examples/advanced/sendfile.conf +10 -0
  25. data/data/doc/xmpp4r/examples/advanced/sendfile.rb +72 -0
  26. data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr.rb +51 -0
  27. data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_jabber.rb +43 -0
  28. data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_test.rb +10 -0
  29. data/data/doc/xmpp4r/examples/advanced/versionpoll.rb +109 -0
  30. data/data/doc/xmpp4r/examples/advanced/xmpping.rb +146 -0
  31. data/data/doc/xmpp4r/examples/advanced/xmppingrc.sample +14 -0
  32. data/data/doc/xmpp4r/examples/basic/change_password.rb +41 -0
  33. data/data/doc/xmpp4r/examples/basic/client.rb +70 -0
  34. data/data/doc/xmpp4r/examples/basic/component.rb +11 -0
  35. data/data/doc/xmpp4r/examples/basic/echo.rb +37 -0
  36. data/data/doc/xmpp4r/examples/basic/jabbersend.rb +41 -0
  37. data/data/doc/xmpp4r/examples/basic/mass_sender.rb +68 -0
  38. data/data/doc/xmpp4r/examples/basic/muc_owner_config.rb +12 -0
  39. data/data/doc/xmpp4r/examples/basic/mucinfo.rb +41 -0
  40. data/data/doc/xmpp4r/examples/basic/mucsimplebot.rb +82 -0
  41. data/data/doc/xmpp4r/examples/basic/register.rb +42 -0
  42. data/data/doc/xmpp4r/examples/basic/remove_registration.rb +18 -0
  43. data/data/doc/xmpp4r/examples/basic/roster.rb +44 -0
  44. data/data/doc/xmpp4r/examples/basic/rosterprint.rb +50 -0
  45. data/data/doc/xmpp4r/examples/basic/rosterrename.rb +34 -0
  46. data/data/doc/xmpp4r/examples/basic/rosterwatch.rb +171 -0
  47. data/data/doc/xmpp4r/examples/basic/send_vcard.rb +67 -0
  48. data/data/doc/xmpp4r/examples/basic/tune_client.rb +56 -0
  49. data/data/doc/xmpp4r/examples/basic/tune_server.rb +58 -0
  50. data/data/doc/xmpp4r/examples/basic/versionbot.rb +75 -0
  51. data/lib/xmpp4r.rb +118 -0
  52. data/lib/xmpp4r/base64.rb +32 -0
  53. data/lib/xmpp4r/bytestreams.rb +15 -0
  54. data/lib/xmpp4r/bytestreams/helper/filetransfer.rb +321 -0
  55. data/lib/xmpp4r/bytestreams/helper/ibb/base.rb +257 -0
  56. data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb +31 -0
  57. data/lib/xmpp4r/bytestreams/helper/ibb/target.rb +54 -0
  58. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb +153 -0
  59. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb +86 -0
  60. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb +198 -0
  61. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb +65 -0
  62. data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb +82 -0
  63. data/lib/xmpp4r/bytestreams/iq/bytestreams.rb +170 -0
  64. data/lib/xmpp4r/bytestreams/iq/si.rb +206 -0
  65. data/lib/xmpp4r/callbacks.rb +133 -0
  66. data/lib/xmpp4r/caps.rb +1 -0
  67. data/lib/xmpp4r/caps/c.rb +67 -0
  68. data/lib/xmpp4r/caps/helper/generator.rb +160 -0
  69. data/lib/xmpp4r/caps/helper/helper.rb +84 -0
  70. data/lib/xmpp4r/client.rb +345 -0
  71. data/lib/xmpp4r/command/helper/responder.rb +53 -0
  72. data/lib/xmpp4r/command/iq/command.rb +154 -0
  73. data/lib/xmpp4r/component.rb +103 -0
  74. data/lib/xmpp4r/connection.rb +231 -0
  75. data/lib/xmpp4r/dataforms.rb +5 -0
  76. data/lib/xmpp4r/dataforms/x/data.rb +297 -0
  77. data/lib/xmpp4r/debuglog.rb +63 -0
  78. data/lib/xmpp4r/delay.rb +5 -0
  79. data/lib/xmpp4r/delay/x/delay.rb +99 -0
  80. data/lib/xmpp4r/discovery.rb +8 -0
  81. data/lib/xmpp4r/discovery/helper/helper.rb +58 -0
  82. data/lib/xmpp4r/discovery/helper/responder.rb +165 -0
  83. data/lib/xmpp4r/discovery/iq/discoinfo.rb +211 -0
  84. data/lib/xmpp4r/discovery/iq/discoitems.rb +147 -0
  85. data/lib/xmpp4r/entity_time.rb +6 -0
  86. data/lib/xmpp4r/entity_time/iq.rb +45 -0
  87. data/lib/xmpp4r/entity_time/responder.rb +57 -0
  88. data/lib/xmpp4r/errors.rb +284 -0
  89. data/lib/xmpp4r/feature_negotiation.rb +5 -0
  90. data/lib/xmpp4r/feature_negotiation/iq/feature.rb +28 -0
  91. data/lib/xmpp4r/framework/base.rb +55 -0
  92. data/lib/xmpp4r/framework/bot.rb +148 -0
  93. data/lib/xmpp4r/httpbinding.rb +5 -0
  94. data/lib/xmpp4r/httpbinding/client.rb +275 -0
  95. data/lib/xmpp4r/idgenerator.rb +37 -0
  96. data/lib/xmpp4r/iq.rb +221 -0
  97. data/lib/xmpp4r/jid.rb +167 -0
  98. data/lib/xmpp4r/last.rb +2 -0
  99. data/lib/xmpp4r/last/helper/helper.rb +37 -0
  100. data/lib/xmpp4r/last/iq/last.rb +67 -0
  101. data/lib/xmpp4r/location.rb +2 -0
  102. data/lib/xmpp4r/location/helper/helper.rb +56 -0
  103. data/lib/xmpp4r/location/location.rb +179 -0
  104. data/lib/xmpp4r/message.rb +226 -0
  105. data/lib/xmpp4r/muc.rb +14 -0
  106. data/lib/xmpp4r/muc/helper/mucbrowser.rb +92 -0
  107. data/lib/xmpp4r/muc/helper/mucclient.rb +469 -0
  108. data/lib/xmpp4r/muc/helper/simplemucclient.rb +332 -0
  109. data/lib/xmpp4r/muc/iq/mucadmin.rb +23 -0
  110. data/lib/xmpp4r/muc/iq/mucadminitem.rb +20 -0
  111. data/lib/xmpp4r/muc/iq/mucowner.rb +15 -0
  112. data/lib/xmpp4r/muc/item.rb +143 -0
  113. data/lib/xmpp4r/muc/x/muc.rb +70 -0
  114. data/lib/xmpp4r/muc/x/mucuserinvite.rb +60 -0
  115. data/lib/xmpp4r/muc/x/mucuseritem.rb +36 -0
  116. data/lib/xmpp4r/presence.rb +232 -0
  117. data/lib/xmpp4r/pubsub.rb +8 -0
  118. data/lib/xmpp4r/pubsub/children/configuration.rb +86 -0
  119. data/lib/xmpp4r/pubsub/children/event.rb +49 -0
  120. data/lib/xmpp4r/pubsub/children/item.rb +35 -0
  121. data/lib/xmpp4r/pubsub/children/items.rb +53 -0
  122. data/lib/xmpp4r/pubsub/children/node_config.rb +48 -0
  123. data/lib/xmpp4r/pubsub/children/publish.rb +38 -0
  124. data/lib/xmpp4r/pubsub/children/retract.rb +41 -0
  125. data/lib/xmpp4r/pubsub/children/subscription.rb +62 -0
  126. data/lib/xmpp4r/pubsub/children/subscription_config.rb +67 -0
  127. data/lib/xmpp4r/pubsub/children/unsubscribe.rb +63 -0
  128. data/lib/xmpp4r/pubsub/helper/nodebrowser.rb +129 -0
  129. data/lib/xmpp4r/pubsub/helper/nodehelper.rb +156 -0
  130. data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb +90 -0
  131. data/lib/xmpp4r/pubsub/helper/servicehelper.rb +490 -0
  132. data/lib/xmpp4r/pubsub/iq/pubsub.rb +19 -0
  133. data/lib/xmpp4r/query.rb +15 -0
  134. data/lib/xmpp4r/reliable.rb +168 -0
  135. data/lib/xmpp4r/rexmladdons.rb +197 -0
  136. data/lib/xmpp4r/roster.rb +7 -0
  137. data/lib/xmpp4r/roster/helper/roster.rb +532 -0
  138. data/lib/xmpp4r/roster/iq/roster.rb +215 -0
  139. data/lib/xmpp4r/roster/x/roster.rb +138 -0
  140. data/lib/xmpp4r/rpc.rb +2 -0
  141. data/lib/xmpp4r/rpc/helper/client.rb +123 -0
  142. data/lib/xmpp4r/rpc/helper/server.rb +74 -0
  143. data/lib/xmpp4r/rpc/helper/xmlrpcaddons.rb +67 -0
  144. data/lib/xmpp4r/rpc/iq/rpc.rb +23 -0
  145. data/lib/xmpp4r/sasl.rb +259 -0
  146. data/lib/xmpp4r/semaphore.rb +38 -0
  147. data/lib/xmpp4r/stream.rb +611 -0
  148. data/lib/xmpp4r/streamparser.rb +66 -0
  149. data/lib/xmpp4r/test/listener_mocker.rb +118 -0
  150. data/lib/xmpp4r/tune.rb +2 -0
  151. data/lib/xmpp4r/tune/helper/helper.rb +58 -0
  152. data/lib/xmpp4r/tune/tune.rb +113 -0
  153. data/lib/xmpp4r/vcard.rb +6 -0
  154. data/lib/xmpp4r/vcard/helper/vcard.rb +84 -0
  155. data/lib/xmpp4r/vcard/iq/vcard.rb +109 -0
  156. data/lib/xmpp4r/version.rb +7 -0
  157. data/lib/xmpp4r/version/helper/responder.rb +72 -0
  158. data/lib/xmpp4r/version/helper/simpleresponder.rb +44 -0
  159. data/lib/xmpp4r/version/iq/version.rb +105 -0
  160. data/lib/xmpp4r/x.rb +37 -0
  161. data/lib/xmpp4r/xhtml.rb +1 -0
  162. data/lib/xmpp4r/xhtml/html.rb +115 -0
  163. data/lib/xmpp4r/xmpp4r.rb +20 -0
  164. data/lib/xmpp4r/xmppelement.rb +168 -0
  165. data/lib/xmpp4r/xmppstanza.rb +162 -0
  166. data/setup.rb +1586 -0
  167. data/test/bytestreams/tc_ibb.rb +188 -0
  168. data/test/bytestreams/tc_socks5bytestreams.rb +114 -0
  169. data/test/caps/tc_helper.rb +158 -0
  170. data/test/dataforms/tc_data.rb +81 -0
  171. data/test/delay/tc_xdelay.rb +51 -0
  172. data/test/discovery/tc_responder.rb +91 -0
  173. data/test/entity_time/tc_responder.rb +65 -0
  174. data/test/last/tc_helper.rb +75 -0
  175. data/test/lib/assert_equal_xml.rb +14 -0
  176. data/test/lib/clienttester.rb +149 -0
  177. data/test/muc/tc_muc_mucclient.rb +834 -0
  178. data/test/muc/tc_muc_simplemucclient.rb +114 -0
  179. data/test/muc/tc_mucowner.rb +50 -0
  180. data/test/pubsub/tc_helper.rb +785 -0
  181. data/test/pubsub/tc_nodeconfig.rb +61 -0
  182. data/test/pubsub/tc_subscriptionconfig.rb +41 -0
  183. data/test/roster/tc_helper.rb +523 -0
  184. data/test/roster/tc_iqqueryroster.rb +173 -0
  185. data/test/roster/tc_xroster.rb +73 -0
  186. data/test/rpc/tc_helper.rb +96 -0
  187. data/test/tc_callbacks.rb +129 -0
  188. data/test/tc_class_names.rb +146 -0
  189. data/test/tc_client.rb +30 -0
  190. data/test/tc_errors.rb +146 -0
  191. data/test/tc_idgenerator.rb +30 -0
  192. data/test/tc_iq.rb +113 -0
  193. data/test/tc_iqquery.rb +31 -0
  194. data/test/tc_jid.rb +204 -0
  195. data/test/tc_presence.rb +150 -0
  196. data/test/tc_rexml.rb +139 -0
  197. data/test/tc_stream.rb +193 -0
  198. data/test/tc_streamComponent.rb +105 -0
  199. data/test/tc_streamError.rb +129 -0
  200. data/test/tc_streamSend.rb +59 -0
  201. data/test/tc_streamparser.rb +137 -0
  202. data/test/tc_xmppstanza.rb +135 -0
  203. data/test/ts_xmpp4r.rb +44 -0
  204. data/test/tune/tc_helper_recv.rb +82 -0
  205. data/test/tune/tc_helper_send.rb +74 -0
  206. data/test/tune/tc_tune.rb +79 -0
  207. data/test/vcard/tc_helper.rb +49 -0
  208. data/test/vcard/tc_iqvcard.rb +62 -0
  209. data/test/version/tc_helper.rb +60 -0
  210. data/test/version/tc_iqqueryversion.rb +97 -0
  211. data/test/xhtml/tc_html.rb +41 -0
  212. data/tools/gen_requires.bash +31 -0
  213. data/tools/xmpp4r-gemspec-test.rb +11 -0
  214. data/xmpp4r.gemspec +249 -0
  215. metadata +299 -0
@@ -0,0 +1,5 @@
1
+ # =XMPP4R - XMPP Library for Ruby
2
+ # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
3
+ # Website::http://home.gna.org/xmpp4r/
4
+
5
+ require 'xmpp4r/dataforms/x/data.rb'
@@ -0,0 +1,297 @@
1
+ # =XMPP4R - XMPP Library for Ruby
2
+ # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
3
+ # Website::http://home.gna.org/xmpp4r/
4
+
5
+ require 'xmpp4r/x'
6
+ require 'xmpp4r/jid'
7
+
8
+ module Jabber
9
+ module Dataforms
10
+ ##
11
+ # Data Forms (JEP-0004) implementation
12
+ class XData < X
13
+ name_xmlns 'x', 'jabber:x:data'
14
+
15
+ def initialize(type=nil)
16
+ super()
17
+ self.type = type
18
+ end
19
+
20
+ ##
21
+ # Search a field by it's var-name
22
+ # var:: [String]
23
+ # result:: [XDataField] or [nil]
24
+ def field(var)
25
+ each_element { |xe|
26
+ return xe if xe.kind_of?(XDataField) and xe.var == var
27
+ }
28
+ nil
29
+ end
30
+
31
+ def fields(including_hidden=false)
32
+ fields = []
33
+ each_element do |xe|
34
+ if xe.kind_of?(XDataField) and (including_hidden or
35
+ (xe.type != :hidden and xe.type != :fixed))
36
+ fields << xe
37
+ end
38
+ end
39
+ fields
40
+ end
41
+
42
+ ##
43
+ # Type of this Data Form
44
+ # result:: * :cancel
45
+ # * :form
46
+ # * :result
47
+ # * :submit
48
+ # * nil
49
+ def type
50
+ case attributes['type']
51
+ when 'cancel' then :cancel
52
+ when 'form' then :form
53
+ when 'result' then :result
54
+ when 'submit' then :submit
55
+ else nil
56
+ end
57
+ end
58
+
59
+ ##
60
+ # Set the type (see type)
61
+ def type=(t)
62
+ case t
63
+ when :cancel then attributes['type'] = 'cancel'
64
+ when :form then attributes['type'] = 'form'
65
+ when :result then attributes['type'] = 'result'
66
+ when :submit then attributes['type'] = 'submit'
67
+ else attributes['type'] = nil
68
+ end
69
+ end
70
+
71
+ ##
72
+ # Get the Data Form title
73
+ # return:: [XDataTitle] or nil
74
+ def title
75
+ first_element('title')
76
+ end
77
+
78
+ ##
79
+ # Set the Data Form title
80
+ # title:: [String]
81
+ def title=(title)
82
+ delete_elements('title')
83
+ add_element(XDataTitle.new(title))
84
+ end
85
+
86
+ ##
87
+ # Get the Data Form instructions
88
+ # return:: [Array] of [XDataInstructions] or nil
89
+ def instructions
90
+ fields = []
91
+ each_element('instructions') do |xe|
92
+ fields << xe
93
+ end
94
+ fields
95
+ end
96
+
97
+ ##
98
+ # Add Data Form instructions
99
+ # i:: [String]
100
+ def instructions=(i)
101
+ add(XDataInstructions.new(i))
102
+ end
103
+
104
+ end
105
+
106
+
107
+ ##
108
+ # Child of XData, contains the title of this Data Form
109
+ class XDataTitle < XMPPElement
110
+ name_xmlns 'title', 'jabber:x:data'
111
+
112
+ def initialize(title=nil)
113
+ super()
114
+ add_text(title)
115
+ end
116
+
117
+ def to_s
118
+ text.to_s
119
+ end
120
+ def title
121
+ text
122
+ end
123
+ end
124
+
125
+ ##
126
+ # Child of XData, contains the instructions of this Data Form
127
+ class XDataInstructions < XMPPElement
128
+ name_xmlns 'instructions', 'jabber:x:data'
129
+
130
+ def initialize(instructions=nil)
131
+ super()
132
+ add_text(instructions)
133
+ end
134
+
135
+ def to_s
136
+ text.to_s
137
+ end
138
+
139
+ def instructions
140
+ text
141
+ end
142
+ end
143
+
144
+ ##
145
+ # Child of XData, contains configurable/configured options of this Data Form
146
+ class XDataField < XMPPElement
147
+ name_xmlns 'field', 'jabber:x:data'
148
+ def initialize(var=nil, type=nil)
149
+ super()
150
+ self.var = var
151
+ self.type = type
152
+ end
153
+
154
+ def label
155
+ attributes['label']
156
+ end
157
+
158
+ def label=(s)
159
+ attributes['label'] = s
160
+ end
161
+
162
+ def var
163
+ attributes['var']
164
+ end
165
+
166
+ def var=(s)
167
+ attributes['var'] = s
168
+ end
169
+
170
+ ##
171
+ # Type of this field
172
+ # result::
173
+ # * :boolean
174
+ # * :fixed
175
+ # * :hidden
176
+ # * :jid_multi
177
+ # * :jid_single
178
+ # * :list_multi
179
+ # * :list_single
180
+ # * :text_multi
181
+ # * :text_private
182
+ # * :text_single
183
+ # * nil
184
+ def type
185
+ case attributes['type']
186
+ when 'boolean' then :boolean
187
+ when 'fixed' then :fixed
188
+ when 'hidden' then :hidden
189
+ when 'jid-multi' then :jid_multi
190
+ when 'jid-single' then :jid_single
191
+ when 'list-multi' then :list_multi
192
+ when 'list-single' then :list_single
193
+ when 'text-multi' then :text_multi
194
+ when 'text-private' then :text_private
195
+ when 'text-single' then :text_single
196
+ else nil
197
+ end
198
+ end
199
+
200
+ ##
201
+ # Set the type of this field (see type)
202
+ def type=(t)
203
+ case t
204
+ when :boolean then attributes['type'] = 'boolean'
205
+ when :fixed then attributes['type'] = 'fixed'
206
+ when :hidden then attributes['type'] = 'hidden'
207
+ when :jid_multi then attributes['type'] = 'jid-multi'
208
+ when :jid_single then attributes['type'] = 'jid-single'
209
+ when :list_multi then attributes['type'] = 'list-multi'
210
+ when :list_single then attributes['type'] = 'list-single'
211
+ when :text_multi then attributes['type'] = 'text-multi'
212
+ when :text_private then attributes['type'] = 'text-private'
213
+ when :text_single then attributes['type'] = 'text-single'
214
+ else attributes['type'] = nil
215
+ end
216
+ end
217
+
218
+ ##
219
+ # Is this field required (has the <required/> child)?
220
+ def required?
221
+ res = false
222
+ each_element('required') { res = true }
223
+ res
224
+ end
225
+
226
+ ##
227
+ # Set if this field is required
228
+ # r:: [true] or [false]
229
+ def required=(r)
230
+ delete_elements('required')
231
+ if r
232
+ add REXML::Element.new('required')
233
+ end
234
+ end
235
+
236
+ ##
237
+ # Get the values (in a Data Form with type='submit')
238
+ def values
239
+ res = []
240
+ each_element('value') { |e|
241
+ res << e.text
242
+ }
243
+ res
244
+ end
245
+
246
+ ##
247
+ # Set the values
248
+ def values=(ary)
249
+ delete_elements('value')
250
+ ary.each { |v|
251
+ add(REXML::Element.new('value')).text = v
252
+ }
253
+ end
254
+
255
+ ##
256
+ # Get the first value
257
+ def value
258
+ values.first
259
+ end
260
+
261
+ ##
262
+ # Remove all and set one value
263
+ def value=(val)
264
+ self.values = [val]
265
+ end
266
+
267
+ ##
268
+ # Get the options (in a Data Form with type='form')
269
+ def options
270
+ res = {}
271
+ each_element('option') { |e|
272
+ value = nil
273
+ e.each_element('value') { |ve| value = ve.text }
274
+ res[value] = e.attributes['label']
275
+ }
276
+ res
277
+ end
278
+
279
+ ##
280
+ # Set the options
281
+ def options=(hsh)
282
+ delete_elements('option')
283
+ hsh.each { |value,label|
284
+ o = add(REXML::Element.new('option'))
285
+ o.attributes['label'] = label
286
+ o.add(REXML::Element.new('value')).text = value
287
+ }
288
+ end
289
+ end
290
+
291
+ ##
292
+ # The <reported/> element, can contain XDataField elements
293
+ class XDataReported < XMPPElement
294
+ name_xmlns 'reported', 'jabber:x:data'
295
+ end
296
+ end
297
+ end
@@ -0,0 +1,63 @@
1
+ # =XMPP4R - XMPP Library for Ruby
2
+ # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
3
+ # Website::http://home.gna.org/xmpp4r/
4
+
5
+ require 'logger'
6
+
7
+ module Jabber
8
+ def Jabber::logger
9
+ @@logger ||= Logger.new($stderr)
10
+ end
11
+
12
+ # Set the logger to use for debug and warn (if enabled)
13
+ def Jabber::logger=(logger)
14
+ @@logger = logger
15
+ end
16
+
17
+ # Is debugging mode enabled ?
18
+ @@debug = false
19
+
20
+ # Is warnings mode enabled ?
21
+ @@warnings = false
22
+
23
+ # Enable/disable debugging mode. When debug mode is enabled, information
24
+ # can be logged using Jabber::debuglog. When debug mode is disabled, calls
25
+ # to Jabber::debuglog are just ignored.
26
+ def Jabber::debug=(debug)
27
+ @@debug = debug
28
+ if @@debug
29
+ debuglog('Debugging mode enabled.')
30
+ #if debug is enabled, we should automatically enable warnings too
31
+ Jabber::warnings = true
32
+ end
33
+ end
34
+
35
+ # Enable/disable warnings mode.
36
+ def Jabber::warnings=(warnings)
37
+ @@warnings = warnings
38
+ if @@warnings
39
+ warnlog('Warnings mode enabled.')
40
+ end
41
+ end
42
+
43
+ # returns true if debugging mode is enabled. If you just want to log
44
+ # something if debugging is enabled, use Jabber::debuglog instead.
45
+ def Jabber::debug
46
+ @@debug
47
+ end
48
+
49
+ # Outputs a string only if debugging mode is enabled. If the string includes
50
+ # several lines, 4 spaces are added at the beginning of each line but the
51
+ # first one. Time is prepended to the string.
52
+ def Jabber::debuglog(string)
53
+ return if not @@debug
54
+ logger.debug string.chomp.gsub("\n", "\n ")
55
+ end
56
+
57
+ # Outputs a string only if warnings mode is enabled.
58
+ def Jabber::warnlog(string)
59
+ return if not @@warnings
60
+ logger.warn string.chomp.gsub("\n", "\n ")
61
+ end
62
+
63
+ end
@@ -0,0 +1,5 @@
1
+ # =XMPP4R - XMPP Library for Ruby
2
+ # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
3
+ # Website::http://home.gna.org/xmpp4r/
4
+
5
+ require 'xmpp4r/delay/x/delay.rb'
@@ -0,0 +1,99 @@
1
+ # =XMPP4R - XMPP Library for Ruby
2
+ # License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
3
+ # Website::http://home.gna.org/xmpp4r/
4
+
5
+ require 'xmpp4r/x'
6
+ require 'xmpp4r/jid'
7
+ require 'time'
8
+
9
+ module Jabber
10
+ module Delay
11
+ ##
12
+ # Implementation of JEP 0091
13
+ # for <x xmlns='jabber:x:delay' stamp='...' .../>
14
+ # applied on <message/> and <presence/> stanzas
15
+ #
16
+ # One may also use XDelay#text for a descriptive reason
17
+ # for the delay.
18
+ #
19
+ # Please note that you must require 'xmpp4r/xdelay' to use
20
+ # this class as it's not required by a basic XMPP implementation.
21
+ # <x/> elements with the specific namespace will then be
22
+ # converted to XDelay automatically.
23
+ class XDelay < X
24
+ name_xmlns 'x', 'jabber:x:delay'
25
+
26
+ ##
27
+ # Initialize a new XDelay element
28
+ #
29
+ # insertnow:: [Boolean] Set the stamp to [Time::now]
30
+ def initialize(insertnow=true)
31
+ super()
32
+
33
+ if insertnow
34
+ set_stamp(Time.now)
35
+ end
36
+ end
37
+
38
+ ##
39
+ # Get the timestamp
40
+ # result:: [Time] or nil
41
+ def stamp
42
+ if attributes['stamp']
43
+ begin
44
+ # Actually this should be Time.xmlschema,
45
+ # but "unfortunately, the 'jabber:x:delay' namespace predates" JEP 0082
46
+ Time.parse("#{attributes['stamp']}Z")
47
+ rescue ArgumentError
48
+ nil
49
+ end
50
+ else
51
+ nil
52
+ end
53
+ end
54
+
55
+ ##
56
+ # Set the timestamp
57
+ # t:: [Time] or nil
58
+ def stamp=(t)
59
+ if t.nil?
60
+ attributes['stamp'] = nil
61
+ else
62
+ attributes['stamp'] = t.strftime("%Y%m%dT%H:%M:%S")
63
+ end
64
+ end
65
+
66
+ ##
67
+ # Set the timestamp (chaining-friendly)
68
+ def set_stamp(t)
69
+ self.stamp = t
70
+ self
71
+ end
72
+
73
+ ##
74
+ # Get the timestamp's origin
75
+ # result:: [JID]
76
+ def from
77
+ if attributes['from']
78
+ JID.new(attributes['from'])
79
+ else
80
+ nil
81
+ end
82
+ end
83
+
84
+ ##
85
+ # Set the timestamp's origin
86
+ # jid:: [JID]
87
+ def from=(jid)
88
+ attributes['from'] = jid.nil? ? nil : jid.to_s
89
+ end
90
+
91
+ ##
92
+ # Set the timestamp's origin (chaining-friendly)
93
+ def set_from(jid)
94
+ self.from = jid
95
+ self
96
+ end
97
+ end
98
+ end
99
+ end