mojodna-xmpp4r 0.4.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +83 -0
- data/COPYING +340 -0
- data/LICENSE +59 -0
- data/README.rdoc +133 -0
- data/README_ruby19.txt +43 -0
- data/Rakefile +252 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/README +56 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/adventure.rb +23 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/adventuremuc.rb +136 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/cube.xml +15 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/tower.xml +69 -0
- data/data/doc/xmpp4r/examples/advanced/adventure/world.rb +424 -0
- data/data/doc/xmpp4r/examples/advanced/fileserve.conf +11 -0
- data/data/doc/xmpp4r/examples/advanced/fileserve.rb +346 -0
- data/data/doc/xmpp4r/examples/advanced/getonline.rb +56 -0
- data/data/doc/xmpp4r/examples/advanced/gtkmucclient.rb +315 -0
- data/data/doc/xmpp4r/examples/advanced/migrate.rb +88 -0
- data/data/doc/xmpp4r/examples/advanced/minimuc.rb +266 -0
- data/data/doc/xmpp4r/examples/advanced/pep-aggregator/index.xsl +235 -0
- data/data/doc/xmpp4r/examples/advanced/pep-aggregator/pep-aggregator.rb +147 -0
- data/data/doc/xmpp4r/examples/advanced/recvfile.rb +84 -0
- data/data/doc/xmpp4r/examples/advanced/rosterdiscovery.rb +129 -0
- data/data/doc/xmpp4r/examples/advanced/sendfile.conf +10 -0
- data/data/doc/xmpp4r/examples/advanced/sendfile.rb +72 -0
- data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr.rb +51 -0
- data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_jabber.rb +43 -0
- data/data/doc/xmpp4r/examples/advanced/shellmgr/shellmgr_test.rb +10 -0
- data/data/doc/xmpp4r/examples/advanced/versionpoll.rb +109 -0
- data/data/doc/xmpp4r/examples/advanced/xmpping.rb +146 -0
- data/data/doc/xmpp4r/examples/advanced/xmppingrc.sample +14 -0
- data/data/doc/xmpp4r/examples/basic/change_password.rb +41 -0
- data/data/doc/xmpp4r/examples/basic/client.rb +70 -0
- data/data/doc/xmpp4r/examples/basic/component.rb +11 -0
- data/data/doc/xmpp4r/examples/basic/echo.rb +37 -0
- data/data/doc/xmpp4r/examples/basic/jabbersend.rb +41 -0
- data/data/doc/xmpp4r/examples/basic/mass_sender.rb +68 -0
- data/data/doc/xmpp4r/examples/basic/muc_owner_config.rb +12 -0
- data/data/doc/xmpp4r/examples/basic/mucinfo.rb +41 -0
- data/data/doc/xmpp4r/examples/basic/mucsimplebot.rb +82 -0
- data/data/doc/xmpp4r/examples/basic/register.rb +42 -0
- data/data/doc/xmpp4r/examples/basic/remove_registration.rb +18 -0
- data/data/doc/xmpp4r/examples/basic/roster.rb +44 -0
- data/data/doc/xmpp4r/examples/basic/rosterprint.rb +50 -0
- data/data/doc/xmpp4r/examples/basic/rosterrename.rb +34 -0
- data/data/doc/xmpp4r/examples/basic/rosterwatch.rb +171 -0
- data/data/doc/xmpp4r/examples/basic/send_vcard.rb +67 -0
- data/data/doc/xmpp4r/examples/basic/tune_client.rb +56 -0
- data/data/doc/xmpp4r/examples/basic/tune_server.rb +58 -0
- data/data/doc/xmpp4r/examples/basic/versionbot.rb +75 -0
- data/lib/xmpp4r/base64.rb +32 -0
- data/lib/xmpp4r/bytestreams/helper/filetransfer.rb +319 -0
- data/lib/xmpp4r/bytestreams/helper/ibb/base.rb +257 -0
- data/lib/xmpp4r/bytestreams/helper/ibb/initiator.rb +31 -0
- data/lib/xmpp4r/bytestreams/helper/ibb/target.rb +47 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb +152 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb +86 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb +198 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb +65 -0
- data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb +73 -0
- data/lib/xmpp4r/bytestreams/iq/bytestreams.rb +170 -0
- data/lib/xmpp4r/bytestreams/iq/si.rb +206 -0
- data/lib/xmpp4r/bytestreams.rb +15 -0
- data/lib/xmpp4r/callbacks.rb +133 -0
- data/lib/xmpp4r/caps/c.rb +67 -0
- data/lib/xmpp4r/caps/helper/generator.rb +160 -0
- data/lib/xmpp4r/caps/helper/helper.rb +87 -0
- data/lib/xmpp4r/caps.rb +1 -0
- data/lib/xmpp4r/client.rb +344 -0
- data/lib/xmpp4r/command/helper/responder.rb +53 -0
- data/lib/xmpp4r/command/iq/command.rb +154 -0
- data/lib/xmpp4r/component.rb +103 -0
- data/lib/xmpp4r/connection.rb +219 -0
- data/lib/xmpp4r/dataforms/x/data.rb +297 -0
- data/lib/xmpp4r/dataforms.rb +5 -0
- data/lib/xmpp4r/debuglog.rb +42 -0
- data/lib/xmpp4r/delay/x/delay.rb +99 -0
- data/lib/xmpp4r/delay.rb +5 -0
- data/lib/xmpp4r/discovery/helper/helper.rb +58 -0
- data/lib/xmpp4r/discovery/helper/responder.rb +165 -0
- data/lib/xmpp4r/discovery/iq/discoinfo.rb +211 -0
- data/lib/xmpp4r/discovery/iq/discoitems.rb +147 -0
- data/lib/xmpp4r/discovery.rb +8 -0
- data/lib/xmpp4r/errors.rb +283 -0
- data/lib/xmpp4r/feature_negotiation/iq/feature.rb +28 -0
- data/lib/xmpp4r/feature_negotiation.rb +5 -0
- data/lib/xmpp4r/framework/base.rb +55 -0
- data/lib/xmpp4r/framework/bot.rb +148 -0
- data/lib/xmpp4r/httpbinding/client.rb +275 -0
- data/lib/xmpp4r/httpbinding.rb +5 -0
- data/lib/xmpp4r/idgenerator.rb +37 -0
- data/lib/xmpp4r/iq.rb +221 -0
- data/lib/xmpp4r/jid.rb +167 -0
- data/lib/xmpp4r/last/helper/helper.rb +37 -0
- data/lib/xmpp4r/last/iq/last.rb +67 -0
- data/lib/xmpp4r/last.rb +2 -0
- data/lib/xmpp4r/location/helper/helper.rb +56 -0
- data/lib/xmpp4r/location/location.rb +179 -0
- data/lib/xmpp4r/location.rb +2 -0
- data/lib/xmpp4r/message.rb +181 -0
- data/lib/xmpp4r/muc/helper/mucbrowser.rb +92 -0
- data/lib/xmpp4r/muc/helper/mucclient.rb +462 -0
- data/lib/xmpp4r/muc/helper/simplemucclient.rb +332 -0
- data/lib/xmpp4r/muc/iq/mucadmin.rb +23 -0
- data/lib/xmpp4r/muc/iq/mucadminitem.rb +20 -0
- data/lib/xmpp4r/muc/iq/mucowner.rb +15 -0
- data/lib/xmpp4r/muc/item.rb +143 -0
- data/lib/xmpp4r/muc/x/muc.rb +70 -0
- data/lib/xmpp4r/muc/x/mucuserinvite.rb +60 -0
- data/lib/xmpp4r/muc/x/mucuseritem.rb +36 -0
- data/lib/xmpp4r/muc.rb +14 -0
- data/lib/xmpp4r/presence.rb +232 -0
- data/lib/xmpp4r/pubsub/children/configuration.rb +86 -0
- data/lib/xmpp4r/pubsub/children/event.rb +49 -0
- data/lib/xmpp4r/pubsub/children/item.rb +35 -0
- data/lib/xmpp4r/pubsub/children/items.rb +53 -0
- data/lib/xmpp4r/pubsub/children/node_config.rb +48 -0
- data/lib/xmpp4r/pubsub/children/publish.rb +38 -0
- data/lib/xmpp4r/pubsub/children/retract.rb +41 -0
- data/lib/xmpp4r/pubsub/children/subscription.rb +62 -0
- data/lib/xmpp4r/pubsub/children/subscription_config.rb +67 -0
- data/lib/xmpp4r/pubsub/children/unsubscribe.rb +48 -0
- data/lib/xmpp4r/pubsub/helper/nodebrowser.rb +130 -0
- data/lib/xmpp4r/pubsub/helper/nodehelper.rb +156 -0
- data/lib/xmpp4r/pubsub/helper/oauth_service_helper.rb +107 -0
- data/lib/xmpp4r/pubsub/helper/servicehelper.rb +456 -0
- data/lib/xmpp4r/pubsub/iq/pubsub.rb +19 -0
- data/lib/xmpp4r/pubsub.rb +8 -0
- data/lib/xmpp4r/query.rb +15 -0
- data/lib/xmpp4r/rexmladdons.rb +157 -0
- data/lib/xmpp4r/roster/helper/roster.rb +519 -0
- data/lib/xmpp4r/roster/iq/roster.rb +215 -0
- data/lib/xmpp4r/roster/x/roster.rb +138 -0
- data/lib/xmpp4r/roster.rb +7 -0
- data/lib/xmpp4r/rpc/helper/client.rb +123 -0
- data/lib/xmpp4r/rpc/helper/server.rb +74 -0
- data/lib/xmpp4r/rpc/helper/xmlrpcaddons.rb +67 -0
- data/lib/xmpp4r/rpc/iq/rpc.rb +23 -0
- data/lib/xmpp4r/rpc.rb +2 -0
- data/lib/xmpp4r/sasl.rb +243 -0
- data/lib/xmpp4r/semaphore.rb +38 -0
- data/lib/xmpp4r/stream.rb +531 -0
- data/lib/xmpp4r/streamparser.rb +81 -0
- data/lib/xmpp4r/tune/helper/helper.rb +58 -0
- data/lib/xmpp4r/tune/tune.rb +113 -0
- data/lib/xmpp4r/tune.rb +2 -0
- data/lib/xmpp4r/vcard/helper/vcard.rb +84 -0
- data/lib/xmpp4r/vcard/iq/vcard.rb +109 -0
- data/lib/xmpp4r/vcard.rb +6 -0
- data/lib/xmpp4r/version/helper/responder.rb +72 -0
- data/lib/xmpp4r/version/helper/simpleresponder.rb +44 -0
- data/lib/xmpp4r/version/iq/version.rb +105 -0
- data/lib/xmpp4r/version.rb +7 -0
- data/lib/xmpp4r/x.rb +37 -0
- data/lib/xmpp4r/xhtml/html.rb +115 -0
- data/lib/xmpp4r/xhtml.rb +1 -0
- data/lib/xmpp4r/xmpp4r.rb +18 -0
- data/lib/xmpp4r/xmppelement.rb +168 -0
- data/lib/xmpp4r/xmppstanza.rb +162 -0
- data/lib/xmpp4r.rb +116 -0
- data/setup.rb +1586 -0
- data/test/bytestreams/tc_ibb.rb +186 -0
- data/test/bytestreams/tc_socks5bytestreams.rb +113 -0
- data/test/caps/tc_helper.rb +156 -0
- data/test/dataforms/tc_data.rb +81 -0
- data/test/delay/tc_xdelay.rb +51 -0
- data/test/discovery/tc_responder.rb +91 -0
- data/test/lib/assert_equal_xml.rb +14 -0
- data/test/lib/clienttester.rb +120 -0
- data/test/muc/tc_muc_mucclient.rb +830 -0
- data/test/muc/tc_muc_simplemucclient.rb +114 -0
- data/test/muc/tc_mucowner.rb +50 -0
- data/test/pubsub/tc_helper.rb +722 -0
- data/test/pubsub/tc_nodeconfig.rb +54 -0
- data/test/pubsub/tc_subscriptionconfig.rb +41 -0
- data/test/roster/tc_helper.rb +514 -0
- data/test/roster/tc_iqqueryroster.rb +173 -0
- data/test/roster/tc_xroster.rb +73 -0
- data/test/rpc/tc_helper.rb +96 -0
- data/test/tc_callbacks.rb +129 -0
- data/test/tc_class_names.rb +146 -0
- data/test/tc_client.rb +30 -0
- data/test/tc_errors.rb +146 -0
- data/test/tc_idgenerator.rb +30 -0
- data/test/tc_iq.rb +113 -0
- data/test/tc_iqquery.rb +31 -0
- data/test/tc_jid.rb +204 -0
- data/test/tc_message.rb +132 -0
- data/test/tc_presence.rb +150 -0
- data/test/tc_rexml.rb +139 -0
- data/test/tc_stream.rb +229 -0
- data/test/tc_streamComponent.rb +95 -0
- data/test/tc_streamError.rb +131 -0
- data/test/tc_streamSend.rb +59 -0
- data/test/tc_streamparser.rb +120 -0
- data/test/tc_xmppstanza.rb +135 -0
- data/test/ts_xmpp4r.rb +53 -0
- data/test/tune/tc_helper_recv.rb +84 -0
- data/test/tune/tc_helper_send.rb +74 -0
- data/test/tune/tc_tune.rb +79 -0
- data/test/vcard/tc_helper.rb +49 -0
- data/test/vcard/tc_iqvcard.rb +62 -0
- data/test/version/tc_helper.rb +60 -0
- data/test/version/tc_iqqueryversion.rb +97 -0
- data/test/xhtml/tc_html.rb +41 -0
- data/tools/gen_requires.bash +31 -0
- data/tools/xmpp4r-gemspec-test.rb +11 -0
- data/xmpp4r.gemspec +304 -0
- metadata +346 -0
@@ -0,0 +1,179 @@
|
|
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 'time'
|
6
|
+
require 'xmpp4r/xmppelement'
|
7
|
+
require 'rexml/element'
|
8
|
+
|
9
|
+
module Jabber
|
10
|
+
module UserLocation
|
11
|
+
NS_USERLOCATION = 'http://jabber.org/protocol/geoloc'
|
12
|
+
ALLOWABLE_ATTRIBUTES = %w(accuracy alt area bearing building country
|
13
|
+
datum description floor lat locality lon postalcode region room
|
14
|
+
speed street text timestamp uri)
|
15
|
+
|
16
|
+
##
|
17
|
+
# The <geoloc> XMPP element, as defined in XEP-0080 User Location
|
18
|
+
#
|
19
|
+
# See http://xmpp.org/extensions/xep-0080.html - this element
|
20
|
+
# encapsulates data about a user's current location. These are
|
21
|
+
# expressed as child elements such as <locality>, <lat>, etc.
|
22
|
+
# which are also managed by this class.
|
23
|
+
#
|
24
|
+
# If the element has no children then it indicates that the user
|
25
|
+
# has stopped publishing their location.
|
26
|
+
class Location < XMPPElement
|
27
|
+
name_xmlns 'geoloc', NS_USERLOCATION
|
28
|
+
force_xmlns true
|
29
|
+
|
30
|
+
##
|
31
|
+
# Construct a new <location> element.
|
32
|
+
#
|
33
|
+
# Supply no arguments to make an empty element to indicate that
|
34
|
+
# location is no longer being published.
|
35
|
+
#
|
36
|
+
# attributes:: [Hash] location attributes
|
37
|
+
def initialize(attributes = {})
|
38
|
+
super()
|
39
|
+
|
40
|
+
# validate attributes
|
41
|
+
attributes = attributes.select do |k,v|
|
42
|
+
ALLOWABLE_ATTRIBUTES.include?(k) && !v.nil?
|
43
|
+
end
|
44
|
+
|
45
|
+
attributes.each do |k,v|
|
46
|
+
v = x.xmlschema if v.is_a?(Time)
|
47
|
+
add_element(REXML::Element.new(k)).text = v.to_s
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
|
52
|
+
##
|
53
|
+
# Returns true if a location is currently being published, otherwise false.
|
54
|
+
def published?
|
55
|
+
(elements.size > 0)
|
56
|
+
end
|
57
|
+
|
58
|
+
##
|
59
|
+
# Get the accuracy attribute of this location.
|
60
|
+
def accuracy
|
61
|
+
first_element('accuracy').text if first_element('accuracy')
|
62
|
+
end
|
63
|
+
|
64
|
+
##
|
65
|
+
# Get the alt attribute of this location.
|
66
|
+
def alt
|
67
|
+
first_element('alt').text if first_element('alt')
|
68
|
+
end
|
69
|
+
|
70
|
+
##
|
71
|
+
# Get the area attribute of this location.
|
72
|
+
def area
|
73
|
+
first_element('area').text if first_element('area')
|
74
|
+
end
|
75
|
+
|
76
|
+
##
|
77
|
+
# Get the bearing attribute of this location.
|
78
|
+
def bearing
|
79
|
+
first_element('bearing').text if first_element('bearing')
|
80
|
+
end
|
81
|
+
|
82
|
+
##
|
83
|
+
# Get the building attribute of this location.
|
84
|
+
def building
|
85
|
+
first_element('building').text if first_element('building')
|
86
|
+
end
|
87
|
+
|
88
|
+
##
|
89
|
+
# Get the country attribute of this location.
|
90
|
+
def country
|
91
|
+
first_element('country').text if first_element('country')
|
92
|
+
end
|
93
|
+
|
94
|
+
##
|
95
|
+
# Get the datum attribute of this location.
|
96
|
+
def datum
|
97
|
+
first_element('datum').text if first_element('datum')
|
98
|
+
end
|
99
|
+
|
100
|
+
##
|
101
|
+
# Get the description attribute of this location.
|
102
|
+
def description
|
103
|
+
first_element('description').text if first_element('description')
|
104
|
+
end
|
105
|
+
|
106
|
+
##
|
107
|
+
# Get the floor attribute of this location.
|
108
|
+
def floor
|
109
|
+
first_element('floor').text if first_element('floor')
|
110
|
+
end
|
111
|
+
|
112
|
+
##
|
113
|
+
# Get the lat attribute of this location.
|
114
|
+
def lat
|
115
|
+
first_element('lat').text if first_element('lat')
|
116
|
+
end
|
117
|
+
|
118
|
+
##
|
119
|
+
# Get the locality attribute of this location.
|
120
|
+
def locality
|
121
|
+
first_element('locality').text if first_element('locality')
|
122
|
+
end
|
123
|
+
|
124
|
+
##
|
125
|
+
# Get the lon attribute of this location.
|
126
|
+
def lon
|
127
|
+
first_element('lon').text if first_element('lon')
|
128
|
+
end
|
129
|
+
|
130
|
+
##
|
131
|
+
# Get the postalcode attribute of this location.
|
132
|
+
def postalcode
|
133
|
+
first_element('postalcode').text if first_element('postalcode')
|
134
|
+
end
|
135
|
+
|
136
|
+
##
|
137
|
+
# Get the region attribute of this location.
|
138
|
+
def region
|
139
|
+
first_element('region').text if first_element('region')
|
140
|
+
end
|
141
|
+
|
142
|
+
##
|
143
|
+
# Get the room attribute of this location.
|
144
|
+
def room
|
145
|
+
first_element('room').text if first_element('room')
|
146
|
+
end
|
147
|
+
|
148
|
+
##
|
149
|
+
# Get the speed attribute of this location.
|
150
|
+
def speed
|
151
|
+
first_element('speed').text if first_element('speed')
|
152
|
+
end
|
153
|
+
|
154
|
+
##
|
155
|
+
# Get the street attribute of this location.
|
156
|
+
def street
|
157
|
+
first_element('street').text if first_element('street')
|
158
|
+
end
|
159
|
+
|
160
|
+
##
|
161
|
+
# Get the text attribute of this location.
|
162
|
+
def text
|
163
|
+
first_element('text').text if first_element('text')
|
164
|
+
end
|
165
|
+
|
166
|
+
##
|
167
|
+
# Get the timestamp attribute of this location.
|
168
|
+
def timestamp
|
169
|
+
first_element('timestamp').text if first_element('timestamp')
|
170
|
+
end
|
171
|
+
|
172
|
+
##
|
173
|
+
# Get the uri attribute of this location.
|
174
|
+
def uri
|
175
|
+
first_element('uri').text if first_element('uri')
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
@@ -0,0 +1,181 @@
|
|
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/xmppstanza'
|
6
|
+
require 'xmpp4r/x'
|
7
|
+
|
8
|
+
module Jabber
|
9
|
+
##
|
10
|
+
# The Message class manages the <message/> stanzas,
|
11
|
+
# which is used for all messaging communication.
|
12
|
+
class Message < XMPPStanza
|
13
|
+
|
14
|
+
CHAT_STATES = %w(active composing gone inactive paused).freeze
|
15
|
+
|
16
|
+
name_xmlns 'message', 'jabber:client'
|
17
|
+
force_xmlns true
|
18
|
+
|
19
|
+
include XParent
|
20
|
+
|
21
|
+
##
|
22
|
+
# Create a new message
|
23
|
+
# >to:: a JID or a String object to send the message to.
|
24
|
+
# >body:: the message's body
|
25
|
+
def initialize(to = nil, body = nil)
|
26
|
+
super()
|
27
|
+
if not to.nil?
|
28
|
+
set_to(to)
|
29
|
+
end
|
30
|
+
if !body.nil?
|
31
|
+
add_element(REXML::Element.new("body").add_text(body))
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
##
|
36
|
+
# Get the type of the Message stanza
|
37
|
+
#
|
38
|
+
# The following Symbols are allowed:
|
39
|
+
# * :chat
|
40
|
+
# * :error
|
41
|
+
# * :groupchat
|
42
|
+
# * :headline
|
43
|
+
# * :normal
|
44
|
+
# result:: [Symbol] or nil
|
45
|
+
def type
|
46
|
+
case super
|
47
|
+
when 'chat' then :chat
|
48
|
+
when 'error' then :error
|
49
|
+
when 'groupchat' then :groupchat
|
50
|
+
when 'headline' then :headline
|
51
|
+
when 'normal' then :normal
|
52
|
+
else nil
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
##
|
57
|
+
# Set the type of the Message stanza (see Message#type for details)
|
58
|
+
# v:: [Symbol] or nil
|
59
|
+
def type=(v)
|
60
|
+
case v
|
61
|
+
when :chat then super('chat')
|
62
|
+
when :error then super('error')
|
63
|
+
when :groupchat then super('groupchat')
|
64
|
+
when :headline then super('headline')
|
65
|
+
when :normal then super('normal')
|
66
|
+
else super(nil)
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
##
|
71
|
+
# Set the type of the Message stanza (chaining-friendly)
|
72
|
+
# v:: [Symbol] or nil
|
73
|
+
def set_type(v)
|
74
|
+
self.type = v
|
75
|
+
self
|
76
|
+
end
|
77
|
+
|
78
|
+
##
|
79
|
+
# Returns the message's body, or nil.
|
80
|
+
# This is the message's plain-text content.
|
81
|
+
def body
|
82
|
+
first_element_text('body')
|
83
|
+
end
|
84
|
+
|
85
|
+
##
|
86
|
+
# Sets the message's body
|
87
|
+
#
|
88
|
+
# b:: [String] body to set
|
89
|
+
def body=(b)
|
90
|
+
replace_element_text('body', b)
|
91
|
+
end
|
92
|
+
|
93
|
+
##
|
94
|
+
# Sets the message's body
|
95
|
+
#
|
96
|
+
# b:: [String] body to set
|
97
|
+
# return:: [REXML::Element] self for chaining
|
98
|
+
def set_body(b)
|
99
|
+
self.body = b
|
100
|
+
self
|
101
|
+
end
|
102
|
+
|
103
|
+
##
|
104
|
+
# sets the message's subject
|
105
|
+
#
|
106
|
+
# s:: [String] subject to set
|
107
|
+
def subject=(s)
|
108
|
+
replace_element_text('subject', s)
|
109
|
+
end
|
110
|
+
|
111
|
+
##
|
112
|
+
# sets the message's subject
|
113
|
+
#
|
114
|
+
# s:: [String] subject to set
|
115
|
+
# return:: [REXML::Element] self for chaining
|
116
|
+
def set_subject(s)
|
117
|
+
self.subject = s
|
118
|
+
self
|
119
|
+
end
|
120
|
+
|
121
|
+
##
|
122
|
+
# Returns the message's subject, or nil
|
123
|
+
def subject
|
124
|
+
first_element_text('subject')
|
125
|
+
end
|
126
|
+
|
127
|
+
##
|
128
|
+
# sets the message's thread
|
129
|
+
# s:: [String] thread to set
|
130
|
+
def thread=(s)
|
131
|
+
delete_elements('thread')
|
132
|
+
replace_element_text('thread', s) unless s.nil?
|
133
|
+
end
|
134
|
+
|
135
|
+
##
|
136
|
+
# gets the message's thread (chaining-friendly)
|
137
|
+
# Please note that this are not [Thread] but a [String]-Identifier to track conversations
|
138
|
+
# s:: [String] thread to set
|
139
|
+
def set_thread(s)
|
140
|
+
self.thread = s
|
141
|
+
self
|
142
|
+
end
|
143
|
+
|
144
|
+
##
|
145
|
+
# Returns the message's thread, or nil
|
146
|
+
def thread
|
147
|
+
first_element_text('thread')
|
148
|
+
end
|
149
|
+
|
150
|
+
##
|
151
|
+
# Returns the current chat state, or :active if no chat state is set
|
152
|
+
def chat_state
|
153
|
+
each_elements(*CHAT_STATES) { |el| return el.name.to_sym }
|
154
|
+
set_chat_state(:active)
|
155
|
+
return :active
|
156
|
+
end
|
157
|
+
|
158
|
+
##
|
159
|
+
# Sets the chat state :active, :composing, :gone, :inactive, :paused
|
160
|
+
def chat_state=(s)
|
161
|
+
s = s.to_s
|
162
|
+
raise InvalidChatState, "Chat state must be one of #{CHAT_STATES.join(', ')}" unless CHAT_STATES.include?(s)
|
163
|
+
CHAT_STATES.each { |state| delete_elements(state) }
|
164
|
+
add_element(REXML::Element.new(s).add_namespace('http://jabber.org/protocol/chatstates'))
|
165
|
+
end
|
166
|
+
|
167
|
+
##
|
168
|
+
# Sets the message's chat state
|
169
|
+
def set_chat_state(s)
|
170
|
+
self.chat_state = s
|
171
|
+
self
|
172
|
+
end
|
173
|
+
|
174
|
+
CHAT_STATES.each do |state|
|
175
|
+
define_method("#{state}?") do
|
176
|
+
chat_state == state.to_sym
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
end
|
181
|
+
end
|
@@ -0,0 +1,92 @@
|
|
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/discovery'
|
6
|
+
|
7
|
+
module Jabber
|
8
|
+
module MUC
|
9
|
+
##
|
10
|
+
# The MUCBrowser helper can be used to discover
|
11
|
+
# Multi-User-Chat components via Service Discovery
|
12
|
+
#
|
13
|
+
# See JEP 0045 sections 6.1. and 6.2.
|
14
|
+
#
|
15
|
+
# Usage of its functions should be threaded as
|
16
|
+
# responses can take a while
|
17
|
+
class MUCBrowser
|
18
|
+
##
|
19
|
+
# Initialize a new MUCBrowser helper
|
20
|
+
def initialize(stream)
|
21
|
+
@stream = stream
|
22
|
+
end
|
23
|
+
|
24
|
+
##
|
25
|
+
# Retrieve the name of a MUC component,
|
26
|
+
# depending upon whether the target entity supports
|
27
|
+
# the MUC protocol.
|
28
|
+
#
|
29
|
+
# A return-value of nil does *not* mean that the entity
|
30
|
+
# does not exist or does not support Service Discovery!
|
31
|
+
# nil just means that this is not a MUC-compliant service.
|
32
|
+
#
|
33
|
+
# Throws an ServerError when receiving
|
34
|
+
# <tt><iq type='error'/></tt>
|
35
|
+
# jid:: [JID] Target entity (set only domain!)
|
36
|
+
# return:: [String] or [nil]
|
37
|
+
def muc_name(jid)
|
38
|
+
iq = Iq.new(:get, jid)
|
39
|
+
iq.from = @stream.jid # Enable components to use this
|
40
|
+
iq.add(Discovery::IqQueryDiscoInfo.new)
|
41
|
+
|
42
|
+
res = nil
|
43
|
+
|
44
|
+
@stream.send_with_id(iq) do |answer|
|
45
|
+
if answer.type == :result
|
46
|
+
answer.query.each_element('feature') { |feature|
|
47
|
+
# Look if the component has a MUC or Groupchat feature
|
48
|
+
if feature.var == 'http://jabber.org/protocol/muc' or feature.var == 'gc-1.0'
|
49
|
+
# If so, get the identity
|
50
|
+
if answer.query.first_element('identity')
|
51
|
+
res = answer.query.first_element('identity').iname
|
52
|
+
end
|
53
|
+
end
|
54
|
+
}
|
55
|
+
true
|
56
|
+
else
|
57
|
+
false
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
res
|
62
|
+
end
|
63
|
+
|
64
|
+
##
|
65
|
+
# Retrieve the existing rooms of a MUC component
|
66
|
+
#
|
67
|
+
# The resulting Hash contains pairs of room JID and room name
|
68
|
+
#
|
69
|
+
# Usage:
|
70
|
+
# my_mucbrowse_helper.muc_rooms('conference.jabber.org').each { |jid,name| ... }
|
71
|
+
#
|
72
|
+
# Throws an exception when receiving <tt><iq type='error'/></tt>
|
73
|
+
# jid:: [JID] Target entity (set only domain!)
|
74
|
+
# return:: [Hash]
|
75
|
+
def muc_rooms(jid)
|
76
|
+
iq = Iq.new(:get, jid)
|
77
|
+
iq.from = @stream.jid # Enable components to use this
|
78
|
+
iq.add(Discovery::IqQueryDiscoItems.new)
|
79
|
+
|
80
|
+
rooms = {}
|
81
|
+
|
82
|
+
@stream.send_with_id(iq) do |answer|
|
83
|
+
answer.query.each_element('item') { |item|
|
84
|
+
rooms[item.jid] = item.iname
|
85
|
+
}
|
86
|
+
end
|
87
|
+
|
88
|
+
rooms
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|