troystribling-agent_xmpp 0.0.0 → 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. data/README.rdoc +397 -2
  2. data/Rakefile +33 -21
  3. data/VERSION +1 -1
  4. data/agent_xmpp.gemspec +78 -33
  5. data/lib/agent_xmpp.rb +11 -7
  6. data/lib/agent_xmpp/app.rb +0 -5
  7. data/lib/agent_xmpp/app/boot.rb +47 -33
  8. data/lib/agent_xmpp/app/controller.rb +135 -19
  9. data/lib/agent_xmpp/client.rb +6 -1
  10. data/lib/agent_xmpp/client/client.rb +22 -155
  11. data/lib/agent_xmpp/client/connection.rb +41 -250
  12. data/lib/agent_xmpp/client/message_delegate.rb +706 -0
  13. data/lib/agent_xmpp/client/message_pipe.rb +176 -0
  14. data/lib/agent_xmpp/client/publish_model.rb +65 -0
  15. data/lib/agent_xmpp/{app/format.rb → client/response.rb} +19 -24
  16. data/lib/agent_xmpp/client/roster_model.rb +139 -0
  17. data/lib/agent_xmpp/client/services_model.rb +97 -0
  18. data/lib/agent_xmpp/config.rb +45 -0
  19. data/lib/agent_xmpp/main.rb +126 -0
  20. data/lib/agent_xmpp/patches.rb +6 -2
  21. data/lib/agent_xmpp/patches/{standard_library_patches/array.rb → array.rb} +14 -7
  22. data/lib/agent_xmpp/patches/{standard_library_patches/float.rb → float.rb} +0 -0
  23. data/lib/agent_xmpp/patches/{standard_library_patches/hash.rb → hash.rb} +3 -3
  24. data/lib/agent_xmpp/patches/{standard_library_patches/object.rb → object.rb} +3 -3
  25. data/lib/agent_xmpp/patches/rexml.rb +69 -0
  26. data/lib/agent_xmpp/patches/{standard_library_patches/string.rb → string.rb} +5 -0
  27. data/lib/agent_xmpp/xmpp.rb +17 -0
  28. data/lib/agent_xmpp/xmpp/element.rb +159 -0
  29. data/lib/agent_xmpp/xmpp/error_response.rb +179 -0
  30. data/lib/agent_xmpp/xmpp/iq.rb +90 -0
  31. data/lib/agent_xmpp/xmpp/iq_command.rb +47 -0
  32. data/lib/agent_xmpp/xmpp/iq_disco.rb +205 -0
  33. data/lib/agent_xmpp/xmpp/iq_pubsub.rb +268 -0
  34. data/lib/agent_xmpp/xmpp/iq_roster.rb +183 -0
  35. data/lib/agent_xmpp/xmpp/iq_version.rb +89 -0
  36. data/lib/agent_xmpp/xmpp/jid.rb +150 -0
  37. data/lib/agent_xmpp/xmpp/message.rb +82 -0
  38. data/lib/agent_xmpp/xmpp/presence.rb +127 -0
  39. data/lib/agent_xmpp/xmpp/sasl.rb +241 -0
  40. data/lib/agent_xmpp/xmpp/stanza.rb +107 -0
  41. data/lib/agent_xmpp/xmpp/x_data.rb +269 -0
  42. data/test/app/app.rb +134 -0
  43. data/test/cases/test_application_message_processing.rb +65 -0
  44. data/test/cases/test_errors.rb +24 -0
  45. data/test/cases/test_presence_management.rb +139 -0
  46. data/test/cases/test_roster_management.rb +214 -0
  47. data/test/cases/test_service_discovery.rb +168 -0
  48. data/test/cases/test_session_management.rb +120 -0
  49. data/test/cases/test_version_discovery.rb +67 -0
  50. data/test/helpers/matchers.rb +23 -0
  51. data/test/helpers/mocks.rb +82 -0
  52. data/test/helpers/test_case_extensions.rb +45 -0
  53. data/test/helpers/test_client.rb +44 -0
  54. data/test/helpers/test_delegate.rb +61 -0
  55. data/test/helpers/test_helper.rb +91 -0
  56. data/test/messages/application_messages.rb +206 -0
  57. data/test/messages/error_messages.rb +35 -0
  58. data/test/messages/presence_messages.rb +66 -0
  59. data/test/messages/roster_messages.rb +126 -0
  60. data/test/messages/service_discovery_messages.rb +201 -0
  61. data/test/messages/session_messages.rb +158 -0
  62. data/test/messages/version_discovery_messages.rb +69 -0
  63. data/test/peer/peer.rb +36 -0
  64. data/test/xml_messages.txt +197 -0
  65. metadata +82 -42
  66. data/bin/agent_xmpp +0 -56
  67. data/lib/agent_xmpp/app/chat_message_body_controller.rb +0 -16
  68. data/lib/agent_xmpp/app/map.rb +0 -45
  69. data/lib/agent_xmpp/app/routes.rb +0 -77
  70. data/lib/agent_xmpp/app/view.rb +0 -49
  71. data/lib/agent_xmpp/client/parser.rb +0 -71
  72. data/lib/agent_xmpp/patches/standard_library_patches.rb +0 -5
  73. data/lib/agent_xmpp/patches/xmpp4r_patches.rb +0 -3
  74. data/lib/agent_xmpp/patches/xmpp4r_patches/command.rb +0 -26
  75. data/lib/agent_xmpp/patches/xmpp4r_patches/iq.rb +0 -26
  76. data/lib/agent_xmpp/patches/xmpp4r_patches/x_data.rb +0 -116
  77. data/lib/agent_xmpp/utils.rb +0 -2
  78. data/lib/agent_xmpp/utils/logger.rb +0 -24
  79. data/lib/agent_xmpp/utils/roster.rb +0 -23
  80. data/lib/agent_xmpp/version.rb +0 -6
  81. data/test/agent_xmpp_test.rb +0 -7
  82. data/test/test_helper.rb +0 -10
@@ -0,0 +1,241 @@
1
+ # Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
2
+ ##############################################################################################################
3
+ module AgentXmpp
4
+
5
+ #####-------------------------------------------------------------------------------------------------------
6
+ module Xmpp
7
+
8
+ #####-------------------------------------------------------------------------------------------------------
9
+ module SASL
10
+
11
+ #.....................................................................................................
12
+ NS_SASL = 'urn:ietf:params:xml:ns:xmpp-sasl'
13
+
14
+ #####-------------------------------------------------------------------------------------------------------
15
+ class << self
16
+
17
+ #.....................................................................................................
18
+ def new(mechanism)
19
+ case mechanism
20
+ when 'DIGEST-MD5'
21
+ DigestMD5.new
22
+ when 'PLAIN'
23
+ Plain.new
24
+ when 'ANONYMOUS'
25
+ Anonymous.new
26
+ else
27
+ raise AgentXmppError "Unknown SASL mechanism: #{mechanism}"
28
+ end
29
+ end
30
+
31
+ #.........................................................................................................
32
+ def authenticate(stream_mechanisms)
33
+ if stream_mechanisms.include?('PLAIN')
34
+ Send(new('PLAIN').auth(AgentXmpp.jid, AgentXmpp.password))
35
+ else
36
+ raise AgentXmppError, "PLAIN authentication required"
37
+ end
38
+ end
39
+
40
+ #### self
41
+ end
42
+
43
+ #####-------------------------------------------------------------------------------------------------------
44
+ class Base
45
+
46
+ #.....................................................................................................
47
+ def initialize
48
+ end
49
+
50
+ private
51
+
52
+ #.....................................................................................................
53
+ def generate_auth(mechanism, text=nil)
54
+ auth = REXML::Element.new 'auth'
55
+ auth.add_namespace NS_SASL
56
+ auth.attributes['mechanism'] = mechanism
57
+ auth.text = text
58
+ auth
59
+ end
60
+
61
+ #.....................................................................................................
62
+ def generate_nonce
63
+ Digest::MD5.hexdigest(Time.new.to_f.to_s)
64
+ end
65
+
66
+ #### Base
67
+ end
68
+
69
+ #####-------------------------------------------------------------------------------------------------------
70
+ class Plain < Base
71
+
72
+ #.....................................................................................................
73
+ def auth(jid, password)
74
+ auth_text = "#{jid.strip}\x00#{jid.node}\x00#{password}"
75
+ generate_auth('PLAIN', Base64::encode64(auth_text).gsub(/\s/, ''))
76
+ end
77
+
78
+ ### Plain
79
+ end
80
+
81
+ #####-------------------------------------------------------------------------------------------------------
82
+ class Anonymous < Base
83
+
84
+ #.....................................................................................................
85
+ def auth(password)
86
+ auth_text = "#{@stream.jid.node}"
87
+ error = nil
88
+ @stream.send(generate_auth('ANONYMOUS', Base64::encode64(auth_text).gsub(/\s/, ''))) do |reply|
89
+ error = reply.first_element(nil).name if reply.name != 'success'
90
+ true
91
+ end
92
+ raise error if error
93
+ end
94
+
95
+ #### Anonymous
96
+ end
97
+
98
+ #####-------------------------------------------------------------------------------------------------------
99
+ class DigestMD5 < Base
100
+
101
+ #.....................................................................................................
102
+ def initialize(stream)
103
+ super
104
+ challenge = {}
105
+ error = nil
106
+ @stream.send(generate_auth('DIGEST-MD5')) { |reply|
107
+ if reply.name == 'challenge' and reply.namespace == NS_SASL
108
+ challenge = decode_challenge(reply.text)
109
+ else
110
+ error = reply.first_element(nil).name
111
+ end
112
+ true
113
+ }
114
+ raise error if error
115
+ @nonce = challenge['nonce']
116
+ @realm = challenge['realm']
117
+ end
118
+
119
+ #.....................................................................................................
120
+ def decode_challenge(challenge)
121
+ text = Base64::decode64(challenge)
122
+ res = {}
123
+
124
+ state = :key
125
+ key = ''
126
+ value = ''
127
+
128
+ text.scan(/./) do |ch|
129
+ if state == :key
130
+ if ch == '='
131
+ state = :value
132
+ else
133
+ key += ch
134
+ end
135
+
136
+ elsif state == :value
137
+ if ch == ','
138
+ res[key] = value
139
+ key = ''
140
+ value = ''
141
+ state = :key
142
+ elsif ch == '"' and value == ''
143
+ state = :quote
144
+ else
145
+ value += ch
146
+ end
147
+
148
+ elsif state == :quote
149
+ if ch == '"'
150
+ state = :value
151
+ else
152
+ value += ch
153
+ end
154
+ end
155
+ end
156
+ res[key] = value unless key == ''
157
+
158
+ res
159
+ end
160
+
161
+ #.....................................................................................................
162
+ def auth(password)
163
+ response = {}
164
+ response['nonce'] = @nonce
165
+ response['charset'] = 'utf-8'
166
+ response['username'] = @stream.jid.node
167
+ response['realm'] = @realm || @stream.jid.domain
168
+ response['cnonce'] = generate_nonce
169
+ response['nc'] = '00000001'
170
+ response['qop'] = 'auth'
171
+ response['digest-uri'] = "xmpp/#{@stream.jid.domain}"
172
+ response['response'] = response_value(@stream.jid.node, @stream.jid.domain, response['digest-uri'], password, @nonce, response['cnonce'], response['qop'], response['authzid'])
173
+ response.each do |key,value|
174
+ unless %w(nc qop response charset).include? key
175
+ response[key] = "\"#{value}\""
176
+ end
177
+ end
178
+
179
+ response_text = response.collect { |k,v| "#{k}=#{v}" }.join(',')
180
+ r = REXML::Element.new('response')
181
+ r.add_namespace NS_SASL
182
+ r.text = Base64::encode64(response_text).gsub(/\s/, '')
183
+
184
+ success_already = false
185
+ error = nil
186
+ @stream.send(r) do |reply|
187
+ if reply.name == 'success'
188
+ success_already = true
189
+ elsif reply.name != 'challenge'
190
+ error = reply.first_element(nil).name
191
+ end
192
+ true
193
+ end
194
+
195
+ return if success_already
196
+ raise error if error
197
+
198
+ r.text = nil
199
+ @stream.send(r) do |reply|
200
+ if reply.name != 'success'
201
+ error = reply.first_element(nil).name
202
+ end
203
+ true
204
+ end
205
+ raise error if error
206
+
207
+ end
208
+
209
+ private
210
+
211
+ #.....................................................................................................
212
+ def h(s); Digest::MD5.digest(s); end
213
+
214
+ #.....................................................................................................
215
+ def hh(s); Digest::MD5.hexdigest(s); end
216
+
217
+ #.....................................................................................................
218
+ def response_value(username, realm, digest_uri, passwd, nonce, cnonce, qop, authzid)
219
+ a1_h = h("#{username}:#{realm}:#{passwd}")
220
+ a1 = "#{a1_h}:#{nonce}:#{cnonce}"
221
+ if authzid
222
+ a1 += ":#{authzid}"
223
+ end
224
+ if qop == 'auth-int' || qop == 'auth-conf'
225
+ a2 = "AUTHENTICATE:#{digest_uri}:00000000000000000000000000000000"
226
+ else
227
+ a2 = "AUTHENTICATE:#{digest_uri}"
228
+ end
229
+ hh("#{hh(a1)}:#{nonce}:00000001:#{cnonce}:#{qop}:#{hh(a2)}")
230
+ end
231
+ end
232
+
233
+ #### DigestMD5
234
+ end
235
+
236
+ #### XMPP
237
+ end
238
+
239
+ #### AgentXmpp
240
+ end
241
+
@@ -0,0 +1,107 @@
1
+ # Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
2
+ ##############################################################################################################
3
+ module AgentXmpp
4
+
5
+ #####-------------------------------------------------------------------------------------------------------
6
+ module Xmpp
7
+
8
+ #####-------------------------------------------------------------------------------------------------------
9
+ class IdGenerator
10
+
11
+ #.......................................................................................................
12
+ @last_id = 0
13
+
14
+ #.......................................................................................................
15
+ class << self
16
+
17
+ #.......................................................................................................
18
+ def generate_id
19
+ @last_id += 1
20
+ timefrac = Time.new.to_f.to_s.split(/\./, 2).last[-3..-1]
21
+ "#{@last_id}#{timefrac}"
22
+ end
23
+
24
+ #### self
25
+ end
26
+
27
+ #### IdGenerator
28
+ end
29
+
30
+ #####-------------------------------------------------------------------------------------------------------
31
+ class Stanza < Element
32
+
33
+ #.......................................................................................................
34
+ def Stanza.answer(stanza, import=true)
35
+ x = stanza.class.new
36
+ if import
37
+ x.import(stanza)
38
+ end
39
+ x.from = stanza.to
40
+ x.to = stanza.from
41
+ x.id = stanza.id
42
+ x
43
+ end
44
+
45
+ #.......................................................................................................
46
+ def error
47
+ first_element('error')
48
+ end
49
+
50
+ #.......................................................................................................
51
+ def answer(import=true)
52
+ Stanza.answer(self, import)
53
+ end
54
+
55
+ #.......................................................................................................
56
+ def normalize
57
+ end
58
+
59
+ #.......................................................................................................
60
+ def to
61
+ (a = attribute('to')).nil? ? a : Jid.new(a.value)
62
+ end
63
+
64
+ #.......................................................................................................
65
+ def to=(v)
66
+ add_attribute('to', v ? v.to_s : nil)
67
+ end
68
+
69
+ #.......................................................................................................
70
+ def from
71
+ (a = attribute('from')).nil? ? a : Jid.new(a.value)
72
+ end
73
+
74
+ #.......................................................................................................
75
+ def from=(v)
76
+ add_attribute('from', v ? v.to_s : nil)
77
+ end
78
+
79
+ #.......................................................................................................
80
+ def id
81
+ (a = attribute('id')).nil? ? a : a.value
82
+ end
83
+
84
+ #.......................................................................................................
85
+ def id=(v)
86
+ add_attribute('id', v.to_s)
87
+ end
88
+
89
+ #.......................................................................................................
90
+ def type
91
+ stanza_type = attributes['type']
92
+ stanza_type.nil? ? nil : stanza_type.to_sym
93
+ end
94
+
95
+ #.......................................................................................................
96
+ def type=(t)
97
+ attributes['type'] = t.to_s
98
+ end
99
+
100
+ #### Stanza
101
+ end
102
+
103
+ #### XMPP
104
+ end
105
+
106
+ #### AgentXmpp
107
+ end
@@ -0,0 +1,269 @@
1
+ # Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
2
+ ##############################################################################################################
3
+ module AgentXmpp
4
+
5
+ #####-------------------------------------------------------------------------------------------------------
6
+ module Xmpp
7
+
8
+ #####-------------------------------------------------------------------------------------------------------
9
+ class X < Element
10
+ name_xmlns 'x'
11
+ end
12
+
13
+ #####-------------------------------------------------------------------------------------------------------
14
+ module XParent
15
+
16
+ #.......................................................................................................
17
+ def x(wanted_xmlns=nil)
18
+ if wanted_xmlns.kind_of? Class and wanted_xmlns.ancestors.include? Element
19
+ wanted_xmlns = wanted_xmlns.new.namespace
20
+ end
21
+ elements.to_a('x').select{|x| wanted_xmlns.nil? or wanted_xmlns == x.namespace}.first
22
+ end
23
+
24
+ #### XParent
25
+ end
26
+
27
+ #####-------------------------------------------------------------------------------------------------------
28
+ class XData < X
29
+
30
+ #.....................................................................................................
31
+ name_xmlns 'x', 'jabber:x:data'
32
+
33
+ #.....................................................................................................
34
+ def initialize(type=nil)
35
+ super()
36
+ self.type = type
37
+ end
38
+
39
+ #.....................................................................................................
40
+ def fields
41
+ elements.to_a('field')
42
+ end
43
+
44
+ #.....................................................................................................
45
+ def items
46
+ elements.to_a('item')
47
+ end
48
+
49
+ #.....................................................................................................
50
+ def type
51
+ attributes['type'].to_sym
52
+ end
53
+
54
+ #.....................................................................................................
55
+ def type=(t)
56
+ attributes['type'] = t.to_s
57
+ end
58
+
59
+ #.....................................................................................................
60
+ def title
61
+ first_element('title')
62
+ end
63
+
64
+ #.....................................................................................................
65
+ def title=(title)
66
+ delete_elements('title')
67
+ add_element(XDataTitle.new(title))
68
+ end
69
+
70
+ #.....................................................................................................
71
+ def instructions
72
+ elements.inject('instructions', []) {|f, xe| f << xe}
73
+ end
74
+
75
+ #.....................................................................................................
76
+ def instructions=(i)
77
+ add(XDataInstructions.new(i))
78
+ end
79
+
80
+ #.....................................................................................................
81
+ def add_field_with_value(var, value, type=nil)
82
+ field = XDataField.new(var, type)
83
+ field.values = value
84
+ self << field
85
+ end
86
+
87
+ #.....................................................................................................
88
+ def to_native
89
+ f, i = fields, items
90
+ if f.length.eql?(1) and i.length.eql?(0)
91
+ to_scalar(f.first.values)
92
+ elsif f.length > 1 and i.length.eql?(0)
93
+ to_hash(f)
94
+ elsif i.length > 0
95
+ to_array_of_hashes(i)
96
+ else
97
+ nil
98
+ end
99
+ end
100
+
101
+ private
102
+
103
+ #.....................................................................................................
104
+ def to_scalar(vals)
105
+ vals.length.eql?(1) ? vals.first : vals
106
+ end
107
+
108
+ #.....................................................................................................
109
+ def to_hash(flds)
110
+ flds.inject({}) {|h,f| h[f.var] = to_scalar(f.values); h}
111
+ end
112
+
113
+ #.....................................................................................................
114
+ def to_array_of_hashes(itms)
115
+ itms.map{|i| to_hash(i.fields)}
116
+ end
117
+
118
+ end
119
+
120
+ #####-------------------------------------------------------------------------------------------------------
121
+ class XDataTitle < Element
122
+
123
+ #.....................................................................................................
124
+ name_xmlns 'title', 'jabber:x:data'
125
+
126
+ #.....................................................................................................
127
+ def initialize(title=nil)
128
+ super()
129
+ add_text(title)
130
+ end
131
+
132
+ #.....................................................................................................
133
+ def to_s
134
+ text.to_s
135
+ end
136
+
137
+ #.....................................................................................................
138
+ def title
139
+ text
140
+ end
141
+
142
+ end
143
+
144
+ #####-------------------------------------------------------------------------------------------------------
145
+ class XDataInstructions < Element
146
+
147
+ #.....................................................................................................
148
+ name_xmlns 'instructions', 'jabber:x:data'
149
+
150
+ #.....................................................................................................
151
+ def initialize(instructions=nil)
152
+ super()
153
+ add_text(instructions)
154
+ end
155
+
156
+ #.....................................................................................................
157
+ def to_s
158
+ text.to_s
159
+ end
160
+
161
+ #.....................................................................................................
162
+ def instructions
163
+ text
164
+ end
165
+ end
166
+
167
+ #####-------------------------------------------------------------------------------------------------------
168
+ class XDataField < Element
169
+
170
+ #.....................................................................................................
171
+ name_xmlns 'field', 'jabber:x:data'
172
+ xmpp_attribute :label, :var
173
+ xmpp_attribute :type, :sym => true
174
+
175
+ #.....................................................................................................
176
+ def initialize(var=nil, type=nil)
177
+ super()
178
+ self.var = var if var
179
+ self.type = type if type
180
+ end
181
+
182
+ #.....................................................................................................
183
+ def required?
184
+ res = false
185
+ each_element('required') { res = true }
186
+ res
187
+ end
188
+
189
+ #.....................................................................................................
190
+ def required=(r)
191
+ delete_elements('required')
192
+ add REXML::Element.new('required') if r
193
+ end
194
+
195
+ #.....................................................................................................
196
+ def values
197
+ elements.inject('value', []){|r,v| r << v.text}
198
+ end
199
+
200
+ #.....................................................................................................
201
+ def values=(ary)
202
+ delete_elements('value')
203
+ [ary].flatten.each {|v| add(REXML::Element.new('value')).text = v}
204
+ end
205
+
206
+ #.....................................................................................................
207
+ def options
208
+ elements.inject('option',{}) do |r, e|
209
+ value = nil
210
+ value = (ve = first_element('value')).nil? ? nil : ve.text
211
+ r[value] = e.attributes['label'] if value
212
+ r
213
+ end
214
+ end
215
+
216
+ #.....................................................................................................
217
+ def options=(hsh)
218
+ delete_elements('option')
219
+ hsh.each do |value,label|
220
+ o = add(REXML::Element.new('option'))
221
+ o.attributes['label'] = label
222
+ o.add(REXML::Element.new('value')).text = value
223
+ end
224
+ end
225
+ end
226
+
227
+ #####-------------------------------------------------------------------------------------------------------
228
+ class XDataReported < Element
229
+
230
+ #.....................................................................................................
231
+ name_xmlns 'reported', 'jabber:x:data'
232
+
233
+ #.....................................................................................................
234
+ def fields
235
+ elements.to_a('field')
236
+ end
237
+
238
+ #.....................................................................................................
239
+ def add_field(var)
240
+ self << XDataField.new(var)
241
+ end
242
+ end
243
+
244
+ #####-------------------------------------------------------------------------------------------------------
245
+ class XDataItem < Element
246
+
247
+ #.....................................................................................................
248
+ name_xmlns 'item', 'jabber:x:data'
249
+
250
+ #.....................................................................................................
251
+ def fields
252
+ elements.to_a('field')
253
+ end
254
+
255
+ #.....................................................................................................
256
+ def add_field_with_value(var, value, type=nil)
257
+ field = XDataField.new(var, type)
258
+ field.values = value
259
+ self << field
260
+ end
261
+
262
+ #### XDataItem
263
+ end
264
+
265
+ #### XMPP
266
+ end
267
+
268
+ #### AgentXmpp
269
+ end