adhearsion-xmpp 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,5 @@
1
+ *.gem
2
+ .bundle
3
+ Gemfile.lock
4
+ pkg/*
5
+ vendor/ruby
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --colour
2
+ --format doc
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "http://rubygems.org"
2
+
3
+ gem 'adhearsion', :git => 'git://github.com/adhearsion/adhearsion.git', :branch => :develop
4
+
5
+ # Specify your gem's dependencies in adhearsion-xmpp.gemspec
6
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,456 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 2.1, February 1999
3
+
4
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ [This is the first released version of the Lesser GPL. It also counts
10
+ as the successor of the GNU Library Public License, version 2, hence
11
+ the version number 2.1.]
12
+
13
+ Preamble
14
+
15
+ The licenses for most software are designed to take away your
16
+ freedom to share and change it. By contrast, the GNU General Public
17
+ Licenses are intended to guarantee your freedom to share and change
18
+ free software--to make sure the software is free for all its users.
19
+
20
+ This license, the Lesser General Public License, applies to some
21
+ specially designated software packages--typically libraries--of the
22
+ Free Software Foundation and other authors who decide to use it. You
23
+ can use it too, but we suggest you first think carefully about whether
24
+ this license or the ordinary General Public License is the better
25
+ strategy to use in any particular case, based on the explanations below.
26
+
27
+ When we speak of free software, we are referring to freedom of use,
28
+ not price. Our General Public Licenses are designed to make sure that
29
+ you have the freedom to distribute copies of free software (and charge
30
+ for this service if you wish); that you receive source code or can get
31
+ it if you want it; that you can change the software and use pieces of
32
+ it in new free programs; and that you are informed that you can do
33
+ these things.
34
+
35
+ To protect your rights, we need to make restrictions that forbid
36
+ distributors to deny you these rights or to ask you to surrender these
37
+ rights. These restrictions translate to certain responsibilities for
38
+ you if you distribute copies of the library or if you modify it.
39
+
40
+ For example, if you distribute copies of the library, whether gratis
41
+ or for a fee, you must give the recipients all the rights that we gave
42
+ you. You must make sure that they, too, receive or can get the source
43
+ code. If you link other code with the library, you must provide
44
+ complete object files to the recipients, so that they can relink them
45
+ with the library after making changes to the library and recompiling
46
+ it. And you must show them these terms so they know their rights.
47
+
48
+ We protect your rights with a two-step method: (1) we copyright the
49
+ library, and (2) we offer you this license, which gives you legal
50
+ permission to copy, distribute and/or modify the library.
51
+
52
+ To protect each distributor, we want to make it very clear that
53
+ there is no warranty for the free library. Also, if the library is
54
+ modified by someone else and passed on, the recipients should know
55
+ that what they have is not the original version, so that the original
56
+ author's reputation will not be affected by problems that might be
57
+ introduced by others.
58
+
59
+ Finally, software patents pose a constant threat to the existence of
60
+ any free program. We wish to make sure that a company cannot
61
+ effectively restrict the users of a free program by obtaining a
62
+ restrictive license from a patent holder. Therefore, we insist that
63
+ any patent license obtained for a version of the library must be
64
+ consistent with the full freedom of use specified in this license.
65
+
66
+ Most GNU software, including some libraries, is covered by the
67
+ ordinary GNU General Public License. This license, the GNU Lesser
68
+ General Public License, applies to certain designated libraries, and
69
+ is quite different from the ordinary General Public License. We use
70
+ this license for certain libraries in order to permit linking those
71
+ libraries into non-free programs.
72
+
73
+ When a program is linked with a library, whether statically or using
74
+ a shared library, the combination of the two is legally speaking a
75
+ combined work, a derivative of the original library. The ordinary
76
+ General Public License therefore permits such linking only if the
77
+ entire combination fits its criteria of freedom. The Lesser General
78
+ Public License permits more lax criteria for linking other code with
79
+ the library.
80
+
81
+ We call this license the "Lesser" General Public License because it
82
+ does Less to protect the user's freedom than the ordinary General
83
+ Public License. It also provides other free software developers Less
84
+ of an advantage over competing non-free programs. These disadvantages
85
+ are the reason we use the ordinary General Public License for many
86
+ libraries. However, the Lesser license provides advantages in certain
87
+ special circumstances.
88
+
89
+ For example, on rare occasions, there may be a special need to
90
+ encourage the widest possible use of a certain library, so that it becomes
91
+ a de-facto standard. To achieve this, non-free programs must be
92
+ allowed to use the library. A more frequent case is that a free
93
+ library does the same job as widely used non-free libraries. In this
94
+ case, there is little to gain by limiting the free library to free
95
+ software only, so we use the Lesser General Public License.
96
+
97
+ In other cases, permission to use a particular library in non-free
98
+ programs enables a greater number of people to use a large body of
99
+ free software. For example, permission to use the GNU C Library in
100
+ non-free programs enables many more people to use the whole GNU
101
+ operating system, as well as its variant, the GNU/Linux operating
102
+ system.
103
+
104
+ Although the Lesser General Public License is Less protective of the
105
+ users' freedom, it does ensure that the user of a program that is
106
+ linked with the Library has the freedom and the wherewithal to run
107
+ that program using a modified version of the Library.
108
+
109
+ The precise terms and conditions for copying, distribution and
110
+ modification follow. Pay close attention to the difference between a
111
+ "work based on the library" and a "work that uses the library". The
112
+ former contains code derived from the library, whereas the latter must
113
+ be combined with the library in order to run.
114
+
115
+ GNU LESSER GENERAL PUBLIC LICENSE
116
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117
+
118
+ 0. This License Agreement applies to any software library or other
119
+ program which contains a notice placed by the copyright holder or
120
+ other authorized party saying it may be distributed under the terms of
121
+ this Lesser General Public License (also called "this License").
122
+ Each licensee is addressed as "you".
123
+
124
+ A "library" means a collection of software functions and/or data
125
+ prepared so as to be conveniently linked with application programs
126
+ (which use some of those functions and data) to form executables.
127
+
128
+ The "Library", below, refers to any such software library or work
129
+ which has been distributed under these terms. A "work based on the
130
+ Library" means either the Library or any derivative work under
131
+ copyright law: that is to say, a work containing the Library or a
132
+ portion of it, either verbatim or with modifications and/or translated
133
+ straightforwardly into another language. (Hereinafter, translation is
134
+ included without limitation in the term "modification".)
135
+
136
+ "Source code" for a work means the preferred form of the work for
137
+ making modifications to it. For a library, complete source code means
138
+ all the source code for all modules it contains, plus any associated
139
+ interface definition files, plus the scripts used to control compilation
140
+ and installation of the library.
141
+
142
+ Activities other than copying, distribution and modification are not
143
+ covered by this License; they are outside its scope. The act of
144
+ running a program using the Library is not restricted, and output from
145
+ such a program is covered only if its contents constitute a work based
146
+ on the Library (independent of the use of the Library in a tool for
147
+ writing it). Whether that is true depends on what the Library does
148
+ and what the program that uses the Library does.
149
+
150
+ 1. You may copy and distribute verbatim copies of the Library's
151
+ complete source code as you receive it, in any medium, provided that
152
+ you conspicuously and appropriately publish on each copy an
153
+ appropriate copyright notice and disclaimer of warranty; keep intact
154
+ all the notices that refer to this License and to the absence of any
155
+ warranty; and distribute a copy of this License along with the
156
+ Library.
157
+
158
+ You may charge a fee for the physical act of transferring a copy,
159
+ and you may at your option offer warranty protection in exchange for a
160
+ fee.
161
+
162
+ 2. You may modify your copy or copies of the Library or any portion
163
+ of it, thus forming a work based on the Library, and copy and
164
+ distribute such modifications or work under the terms of Section 1
165
+ above, provided that you also meet all of these conditions:
166
+
167
+ a) The modified work must itself be a software library.
168
+
169
+ b) You must cause the files modified to carry prominent notices
170
+ stating that you changed the files and the date of any change.
171
+
172
+ c) You must cause the whole of the work to be licensed at no
173
+ charge to all third parties under the terms of this License.
174
+
175
+ d) If a facility in the modified Library refers to a function or a
176
+ table of data to be supplied by an application program that uses
177
+ the facility, other than as an argument passed when the facility
178
+ is invoked, then you must make a good faith effort to ensure that,
179
+ in the event an application does not supply such function or
180
+ table, the facility still operates, and performs whatever part of
181
+ its purpose remains meaningful.
182
+
183
+ (For example, a function in a library to compute square roots has
184
+ a purpose that is entirely well-defined independent of the
185
+ application. Therefore, Subsection 2d requires that any
186
+ application-supplied function or table used by this function must
187
+ be optional: if the application does not supply it, the square
188
+ root function must still compute square roots.)
189
+
190
+ These requirements apply to the modified work as a whole. If
191
+ identifiable sections of that work are not derived from the Library,
192
+ and can be reasonably considered independent and separate works in
193
+ themselves, then this License, and its terms, do not apply to those
194
+ sections when you distribute them as separate works. But when you
195
+ distribute the same sections as part of a whole which is a work based
196
+ on the Library, the distribution of the whole must be on the terms of
197
+ this License, whose permissions for other licensees extend to the
198
+ entire whole, and thus to each and every part regardless of who wrote
199
+ it.
200
+
201
+ Thus, it is not the intent of this section to claim rights or contest
202
+ your rights to work written entirely by you; rather, the intent is to
203
+ exercise the right to control the distribution of derivative or
204
+ collective works based on the Library.
205
+
206
+ In addition, mere aggregation of another work not based on the Library
207
+ with the Library (or with a work based on the Library) on a volume of
208
+ a storage or distribution medium does not bring the other work under
209
+ the scope of this License.
210
+
211
+ 3. You may opt to apply the terms of the ordinary GNU General Public
212
+ License instead of this License to a given copy of the Library. To do
213
+ this, you must alter all the notices that refer to this License, so
214
+ that they refer to the ordinary GNU General Public License, version 2,
215
+ instead of to this License. (If a newer version than version 2 of the
216
+ ordinary GNU General Public License has appeared, then you can specify
217
+ that version instead if you wish.) Do not make any other change in
218
+ these notices.
219
+
220
+ Once this change is made in a given copy, it is irreversible for
221
+ that copy, so the ordinary GNU General Public License applies to all
222
+ subsequent copies and derivative works made from that copy.
223
+
224
+ This option is useful when you wish to copy part of the code of
225
+ the Library into a program that is not a library.
226
+
227
+ 4. You may copy and distribute the Library (or a portion or
228
+ derivative of it, under Section 2) in object code or executable form
229
+ under the terms of Sections 1 and 2 above provided that you accompany
230
+ it with the complete corresponding machine-readable source code, which
231
+ must be distributed under the terms of Sections 1 and 2 above on a
232
+ medium customarily used for software interchange.
233
+
234
+ If distribution of object code is made by offering access to copy
235
+ from a designated place, then offering equivalent access to copy the
236
+ source code from the same place satisfies the requirement to
237
+ distribute the source code, even though third parties are not
238
+ compelled to copy the source along with the object code.
239
+
240
+ 5. A program that contains no derivative of any portion of the
241
+ Library, but is designed to work with the Library by being compiled or
242
+ linked with it, is called a "work that uses the Library". Such a
243
+ work, in isolation, is not a derivative work of the Library, and
244
+ therefore falls outside the scope of this License.
245
+
246
+ However, linking a "work that uses the Library" with the Library
247
+ creates an executable that is a derivative of the Library (because it
248
+ contains portions of the Library), rather than a "work that uses the
249
+ library". The executable is therefore covered by this License.
250
+ Section 6 states terms for distribution of such executables.
251
+
252
+ When a "work that uses the Library" uses material from a header file
253
+ that is part of the Library, the object code for the work may be a
254
+ derivative work of the Library even though the source code is not.
255
+ Whether this is true is especially significant if the work can be
256
+ linked without the Library, or if the work is itself a library. The
257
+ threshold for this to be true is not precisely defined by law.
258
+
259
+ If such an object file uses only numerical parameters, data
260
+ structure layouts and accessors, and small macros and small inline
261
+ functions (ten lines or less in length), then the use of the object
262
+ file is unrestricted, regardless of whether it is legally a derivative
263
+ work. (Executables containing this object code plus portions of the
264
+ Library will still fall under Section 6.)
265
+
266
+ Otherwise, if the work is a derivative of the Library, you may
267
+ distribute the object code for the work under the terms of Section 6.
268
+ Any executables containing that work also fall under Section 6,
269
+ whether or not they are linked directly with the Library itself.
270
+
271
+ 6. As an exception to the Sections above, you may also combine or
272
+ link a "work that uses the Library" with the Library to produce a
273
+ work containing portions of the Library, and distribute that work
274
+ under terms of your choice, provided that the terms permit
275
+ modification of the work for the customer's own use and reverse
276
+ engineering for debugging such modifications.
277
+
278
+ You must give prominent notice with each copy of the work that the
279
+ Library is used in it and that the Library and its use are covered by
280
+ this License. You must supply a copy of this License. If the work
281
+ during execution displays copyright notices, you must include the
282
+ copyright notice for the Library among them, as well as a reference
283
+ directing the user to the copy of this License. Also, you must do one
284
+ of these things:
285
+
286
+ a) Accompany the work with the complete corresponding
287
+ machine-readable source code for the Library including whatever
288
+ changes were used in the work (which must be distributed under
289
+ Sections 1 and 2 above); and, if the work is an executable linked
290
+ with the Library, with the complete machine-readable "work that
291
+ uses the Library", as object code and/or source code, so that the
292
+ user can modify the Library and then relink to produce a modified
293
+ executable containing the modified Library. (It is understood
294
+ that the user who changes the contents of definitions files in the
295
+ Library will not necessarily be able to recompile the application
296
+ to use the modified definitions.)
297
+
298
+ b) Use a suitable shared library mechanism for linking with the
299
+ Library. A suitable mechanism is one that (1) uses at run time a
300
+ copy of the library already present on the user's computer system,
301
+ rather than copying library functions into the executable, and (2)
302
+ will operate properly with a modified version of the library, if
303
+ the user installs one, as long as the modified version is
304
+ interface-compatible with the version that the work was made with.
305
+
306
+ c) Accompany the work with a written offer, valid for at
307
+ least three years, to give the same user the materials
308
+ specified in Subsection 6a, above, for a charge no more
309
+ than the cost of performing this distribution.
310
+
311
+ d) If distribution of the work is made by offering access to copy
312
+ from a designated place, offer equivalent access to copy the above
313
+ specified materials from the same place.
314
+
315
+ e) Verify that the user has already received a copy of these
316
+ materials or that you have already sent this user a copy.
317
+
318
+ For an executable, the required form of the "work that uses the
319
+ Library" must include any data and utility programs needed for
320
+ reproducing the executable from it. However, as a special exception,
321
+ the materials to be distributed need not include anything that is
322
+ normally distributed (in either source or binary form) with the major
323
+ components (compiler, kernel, and so on) of the operating system on
324
+ which the executable runs, unless that component itself accompanies
325
+ the executable.
326
+
327
+ It may happen that this requirement contradicts the license
328
+ restrictions of other proprietary libraries that do not normally
329
+ accompany the operating system. Such a contradiction means you cannot
330
+ use both them and the Library together in an executable that you
331
+ distribute.
332
+
333
+ 7. You may place library facilities that are a work based on the
334
+ Library side-by-side in a single library together with other library
335
+ facilities not covered by this License, and distribute such a combined
336
+ library, provided that the separate distribution of the work based on
337
+ the Library and of the other library facilities is otherwise
338
+ permitted, and provided that you do these two things:
339
+
340
+ a) Accompany the combined library with a copy of the same work
341
+ based on the Library, uncombined with any other library
342
+ facilities. This must be distributed under the terms of the
343
+ Sections above.
344
+
345
+ b) Give prominent notice with the combined library of the fact
346
+ that part of it is a work based on the Library, and explaining
347
+ where to find the accompanying uncombined form of the same work.
348
+
349
+ 8. You may not copy, modify, sublicense, link with, or distribute
350
+ the Library except as expressly provided under this License. Any
351
+ attempt otherwise to copy, modify, sublicense, link with, or
352
+ distribute the Library is void, and will automatically terminate your
353
+ rights under this License. However, parties who have received copies,
354
+ or rights, from you under this License will not have their licenses
355
+ terminated so long as such parties remain in full compliance.
356
+
357
+ 9. You are not required to accept this License, since you have not
358
+ signed it. However, nothing else grants you permission to modify or
359
+ distribute the Library or its derivative works. These actions are
360
+ prohibited by law if you do not accept this License. Therefore, by
361
+ modifying or distributing the Library (or any work based on the
362
+ Library), you indicate your acceptance of this License to do so, and
363
+ all its terms and conditions for copying, distributing or modifying
364
+ the Library or works based on it.
365
+
366
+ 10. Each time you redistribute the Library (or any work based on the
367
+ Library), the recipient automatically receives a license from the
368
+ original licensor to copy, distribute, link with or modify the Library
369
+ subject to these terms and conditions. You may not impose any further
370
+ restrictions on the recipients' exercise of the rights granted herein.
371
+ You are not responsible for enforcing compliance by third parties with
372
+ this License.
373
+
374
+ 11. If, as a consequence of a court judgment or allegation of patent
375
+ infringement or for any other reason (not limited to patent issues),
376
+ conditions are imposed on you (whether by court order, agreement or
377
+ otherwise) that contradict the conditions of this License, they do not
378
+ excuse you from the conditions of this License. If you cannot
379
+ distribute so as to satisfy simultaneously your obligations under this
380
+ License and any other pertinent obligations, then as a consequence you
381
+ may not distribute the Library at all. For example, if a patent
382
+ license would not permit royalty-free redistribution of the Library by
383
+ all those who receive copies directly or indirectly through you, then
384
+ the only way you could satisfy both it and this License would be to
385
+ refrain entirely from distribution of the Library.
386
+
387
+ If any portion of this section is held invalid or unenforceable under any
388
+ particular circumstance, the balance of the section is intended to apply,
389
+ and the section as a whole is intended to apply in other circumstances.
390
+
391
+ It is not the purpose of this section to induce you to infringe any
392
+ patents or other property right claims or to contest validity of any
393
+ such claims; this section has the sole purpose of protecting the
394
+ integrity of the free software distribution system which is
395
+ implemented by public license practices. Many people have made
396
+ generous contributions to the wide range of software distributed
397
+ through that system in reliance on consistent application of that
398
+ system; it is up to the author/donor to decide if he or she is willing
399
+ to distribute software through any other system and a licensee cannot
400
+ impose that choice.
401
+
402
+ This section is intended to make thoroughly clear what is believed to
403
+ be a consequence of the rest of this License.
404
+
405
+ 12. If the distribution and/or use of the Library is restricted in
406
+ certain countries either by patents or by copyrighted interfaces, the
407
+ original copyright holder who places the Library under this License may add
408
+ an explicit geographical distribution limitation excluding those countries,
409
+ so that distribution is permitted only in or among countries not thus
410
+ excluded. In such case, this License incorporates the limitation as if
411
+ written in the body of this License.
412
+
413
+ 13. The Free Software Foundation may publish revised and/or new
414
+ versions of the Lesser General Public License from time to time.
415
+ Such new versions will be similar in spirit to the present version,
416
+ but may differ in detail to address new problems or concerns.
417
+
418
+ Each version is given a distinguishing version number. If the Library
419
+ specifies a version number of this License which applies to it and
420
+ "any later version", you have the option of following the terms and
421
+ conditions either of that version or of any later version published by
422
+ the Free Software Foundation. If the Library does not specify a
423
+ license version number, you may choose any version ever published by
424
+ the Free Software Foundation.
425
+
426
+ 14. If you wish to incorporate parts of the Library into other free
427
+ programs whose distribution conditions are incompatible with these,
428
+ write to the author to ask for permission. For software which is
429
+ copyrighted by the Free Software Foundation, write to the Free
430
+ Software Foundation; we sometimes make exceptions for this. Our
431
+ decision will be guided by the two goals of preserving the free status
432
+ of all derivatives of our free software and of promoting the sharing
433
+ and reuse of software generally.
434
+
435
+ NO WARRANTY
436
+
437
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446
+
447
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456
+ DAMAGES.
data/README.md ADDED
@@ -0,0 +1,59 @@
1
+ adhearsion-xmpp
2
+ ========
3
+
4
+ adhearsion-xmpp is an Adhearsion Plugin providing XMPP connectivity.
5
+
6
+ Features
7
+ --------
8
+
9
+ * FIXME (list of features and unsolved problems)
10
+
11
+ Requirements
12
+ ------------
13
+
14
+ * Adhearsion 2.0+
15
+
16
+ Install
17
+ -------
18
+
19
+ Add `adhearsion-xmpp` to your Adhearsion app's Gemfile.
20
+
21
+ Configuration
22
+ -------------
23
+
24
+ In your Adhearsion app configuration file, add the following values:
25
+
26
+ ```ruby
27
+ Adhearsion.config do |config|
28
+ config.xmpp.jid = "valid-jid"
29
+ config.xmpp.password = "valid-password"
30
+ config.xmpp.host = "valid-host"
31
+ config.xmpp.port = "valid-port"
32
+ end
33
+ ```
34
+
35
+ Author
36
+ ------
37
+
38
+ Original author: [Juan de Bravo](https://github.com/juandebravo)
39
+
40
+ Links
41
+ -----
42
+ * [Source](https://github.com/adhearsion/adhearsion-xmpp)
43
+ * [Documentation](http://rdoc.info/github/adhearsion/adhearsion-xmpp/master/frames)
44
+ * [Bug Tracker](https://github.com/adhearsion/adhearsion-xmpp/issues)
45
+
46
+ Note on Patches/Pull Requests
47
+ -----------------------------
48
+
49
+ * Fork the project.
50
+ * Make your feature addition or bug fix.
51
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
52
+ * Commit, do not mess with rakefile, version, or history.
53
+ * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
54
+ * Send me a pull request. Bonus points for topic branches.
55
+
56
+ Copyright
57
+ ---------
58
+
59
+ Check [License file](https://github.com/adhearsion/adhearsion-xmpp/blob/master/LICENSE)
data/Rakefile ADDED
@@ -0,0 +1,16 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ require "bundler/setup"
4
+
5
+
6
+ task :default => :spec
7
+
8
+ require 'rspec/core'
9
+ require 'rspec/core/rake_task'
10
+
11
+ RSpec::Core::RakeTask.new(:spec) do |spec|
12
+ spec.pattern = 'spec/**/*_spec.rb'
13
+ spec.rspec_opts = '--colour --format doc'
14
+ end
15
+
16
+ task :default => :spec
@@ -0,0 +1,28 @@
1
+ # -*- encoding: utf-8 -*-
2
+ $:.push File.expand_path("../lib", __FILE__)
3
+ require "adhearsion/xmpp/version"
4
+
5
+ Gem::Specification.new do |s|
6
+ s.name = "adhearsion-xmpp"
7
+ s.version = Adhearsion::XMPP::VERSION
8
+ s.authors = ["Juan de Bravo", "Ben Langfeld", "Jason Goecke", "Ben Klang"]
9
+ s.email = ["juandebravo@gmail.com", "ben@langfeld.me", "jsgoecke@voxeo.com", "bklang@mojolingo.com"]
10
+ s.homepage = "https://github.com/adhearsion/adhearsion-xmpp"
11
+ s.summary = %q{Send and receive XMPP messages in your Adhearsion application}
12
+ s.description = %q{This gem provides the XMPP plugin to Adhearsion, allowing your Adhearsion application to send and receive messages and react to presence changes.}
13
+
14
+ s.rubyforge_project = "adhearsion-xmpp"
15
+
16
+ s.files = `git ls-files`.split("\n")
17
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
18
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
19
+ s.require_paths = ["lib"]
20
+
21
+ s.add_runtime_dependency "activesupport", [">= 3.0.10"]
22
+ s.add_runtime_dependency "i18n", ">= 0.5.0"
23
+ s.add_runtime_dependency "blather", ">= 0.5.7"
24
+ s.add_runtime_dependency "jruby-openssl" if defined?(JRUBY_VERSION)
25
+
26
+ s.add_development_dependency "rspec", "~> 2.7.0"
27
+ s.add_development_dependency "rake", ">= 0.9.2"
28
+ end
@@ -0,0 +1 @@
1
+ require 'adhearsion/xmpp'
@@ -0,0 +1,37 @@
1
+ require "adhearsion"
2
+ require "active_support/dependencies/autoload"
3
+ require "adhearsion/xmpp/version"
4
+ require "adhearsion/xmpp/plugin" # Because the autoloader is lazy this never gets loaded!
5
+
6
+ module Adhearsion
7
+ ##
8
+ # Adhearsion Plugin that defines the XMPP configuration options
9
+ # and includes a hook to start the XMPP service in Adhearsion initialization process
10
+ class XMPP
11
+ extend ActiveSupport::Autoload
12
+ #autoload :Plugin
13
+ autoload :Connection
14
+
15
+ cattr_accessor :plugin, :handlers
16
+
17
+ class << self
18
+ def register_handlers(&block)
19
+ raise ArgumentError, "You must supply a block" unless block_given?
20
+ self.handlers ||= ThreadSafeArray.new
21
+ handlers << block
22
+ handlers.each do |handler|
23
+ unless plugin.nil?
24
+ # Plugin has already initialized. Add these handlers directly.
25
+ plugin.connection.instance_eval &handler
26
+ end
27
+ end
28
+ end
29
+
30
+ delegate :connection, :to => :plugin
31
+
32
+ def method_missing(m, *args, &block)
33
+ plugin.connection.send m, *args, &block
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,65 @@
1
+ require 'blather/client'
2
+
3
+ module Adhearsion
4
+ class XMPP
5
+ module Connection
6
+
7
+ class << self
8
+
9
+ attr_accessor :client
10
+
11
+ ##
12
+ # Open the XMPP connection
13
+ #
14
+ # @param [String] jid the client/component JID to connect to
15
+ # @param [String] password
16
+ # @param [String] server
17
+ # @param [Integer] port
18
+ def start(jid, password, server, port)
19
+ Blather.logger = logger
20
+ setup_client_object jid, password, server, port
21
+ register_event_namespaces
22
+ register_default_client_handlers
23
+ Adhearsion::Events.register_callback(:after_initialized) do
24
+ connect
25
+ end
26
+ end
27
+
28
+ # Close the XMPP connection
29
+ def stop
30
+ shutdown
31
+ end
32
+
33
+ private
34
+
35
+ def setup_client_object(jid, password, server, port)
36
+ self.client = Blather::Client.setup(jid, password, server, port)
37
+ end
38
+
39
+ def connect
40
+ EventMachine.run {client.connect}
41
+ end
42
+
43
+ def register_event_namespaces
44
+ Adhearsion::Events.register_namespace_name "/xmpp"
45
+ end
46
+
47
+ def register_default_client_handlers
48
+ client.register_handler(:ready) do
49
+ logger.info "Connected to XMPP server! Send messages to #{client.jid.stripped}."
50
+ end
51
+
52
+ client.register_handler(:disconnected) do
53
+ if Adhearsion.status == :running
54
+ logger.warn "XMPP Disconnected. Reconnecting."
55
+ connect
56
+ end
57
+ # TODO: fix this to reconnect XMPP cleanly
58
+ end
59
+ end
60
+
61
+ end
62
+
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,69 @@
1
+ module Adhearsion
2
+ class XMPP
3
+ class Plugin < Adhearsion::Plugin
4
+
5
+ # Default configuration for XMPP connection.
6
+ config :xmpp do
7
+ use_punchblock true , :desc => "Re-use Punchblock's XMPP connection. Boolean."
8
+ jid nil , :desc => "Client/component JID to connect to. String."
9
+ password nil , :desc => "Password identifier. String."
10
+ server nil , :desc => "XMPP server hostname. May be omitted if server can be determined from JID. String."
11
+ port nil , :desc => "XMPP server port. May be omitted if server can be determined from JID. Integer."
12
+ end
13
+
14
+ # Include the XMPP service in plugins initialization process
15
+ init :xmpp, :after => :punchblock do
16
+ Adhearsion::XMPP.plugin = Adhearsion::XMPP::Plugin.new
17
+ Adhearsion::XMPP.handlers.each do |handler|
18
+ Adhearsion::XMPP.connection.instance_eval &handler
19
+ end unless Adhearsion::XMPP.handlers.nil?
20
+ end
21
+
22
+ run :xmpp do
23
+ Adhearsion::XMPP.plugin.run_plugin
24
+ end
25
+
26
+ def initialize
27
+ @config ||= Adhearsion.config[:xmpp]
28
+ init_blather unless @config.use_punchblock
29
+ end
30
+
31
+ def run_plugin
32
+ run_blather unless @config.use_punchblock
33
+ end
34
+
35
+ def start_punchblock
36
+ # Nothing needed here; everything is delegated
37
+ nil
38
+ end
39
+
40
+ def init_blather
41
+ raise "Must supply a jid argument to the XMPP configuration" if (@config.jid.nil? || @config.jid.empty?)
42
+ raise "Must supply a password argument to the XMPP configuration" if (@config.password.nil? || @config.password.empty?)
43
+
44
+ Connection.extend Blather::DSL
45
+ Connection.start @config.jid, @config.password, @config.server, @config.port
46
+ end
47
+
48
+ ##
49
+ # Stop the XMPP connection
50
+ def stop
51
+ stop_blather unless @config.use_punchblock
52
+ end
53
+
54
+ def stop_blather
55
+ Connection.stop
56
+ end
57
+
58
+ def connection
59
+ @config.use_punchblock ?
60
+ PunchblockPlugin.connection :
61
+ Connection
62
+ end
63
+
64
+ def client
65
+ @config.use_punchblock ? PunchblockPlugin.client : Connection.client
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,5 @@
1
+ module Adhearsion
2
+ class XMPP
3
+ VERSION = "0.2.0"
4
+ end
5
+ end
@@ -0,0 +1,78 @@
1
+ require 'spec_helper'
2
+
3
+ describe Adhearsion::XMPP::Plugin do
4
+
5
+ describe "while accessing the plugin configuration" do
6
+
7
+ it "should retrieve a valid configuration instance" do
8
+ Adhearsion.config.xmpp.should be_instance_of Loquacious::Configuration
9
+ end
10
+
11
+ it "should configure properly the jid" do
12
+ Adhearsion.config[:xmpp].jid.should be_nil
13
+ end
14
+
15
+ it "should configure properly the password" do
16
+ Adhearsion.config[:xmpp].password.should be_nil
17
+ end
18
+
19
+ it "should configure properly the server" do
20
+ Adhearsion.config[:xmpp].server.should be_nil
21
+ end
22
+
23
+ it "should configure properly the port" do
24
+ Adhearsion.config[:xmpp].port.should be_nil
25
+ end
26
+
27
+ end
28
+
29
+ describe "while configuring a specific config value" do
30
+ before do
31
+ @jid = Adhearsion.config[:xmpp].jid
32
+ @password = Adhearsion.config[:xmpp].password
33
+ @server = Adhearsion.config[:xmpp].server
34
+ @port = Adhearsion.config[:xmpp].port
35
+ end
36
+
37
+ after do
38
+ Adhearsion.config[:xmpp].jid = @jid
39
+ Adhearsion.config[:xmpp].password = @password
40
+ Adhearsion.config[:xmpp].server = @server
41
+ Adhearsion.config[:xmpp].port = @port
42
+ end
43
+
44
+ it "ovewrites properly the jid value" do
45
+ Adhearsion.config[:xmpp].jid = "usera"
46
+ Adhearsion.config[:xmpp].jid.should == "usera"
47
+ end
48
+
49
+ it "ovewrites properly the password value" do
50
+ Adhearsion.config[:xmpp].password = "password"
51
+ Adhearsion.config[:xmpp].password.should == "password"
52
+ end
53
+
54
+ it "ovewrites properly the server value" do
55
+ Adhearsion.config[:xmpp].server = "www.myhost.com"
56
+ Adhearsion.config[:xmpp].server.should == "www.myhost.com"
57
+ end
58
+
59
+ it "ovewrites properly the port value" do
60
+ Adhearsion.config[:xmpp].port = 5223
61
+ Adhearsion.config[:xmpp].port.should == 5223
62
+ end
63
+ end
64
+
65
+ describe "when re-using Punchblock's connection" do
66
+ it "should not attempt to start Punchblock's client on start" do
67
+ pending
68
+ end
69
+
70
+ it "should not attempt to start Punchblock's client on stop" do
71
+ pending
72
+ end
73
+ end
74
+
75
+ describe "when using a separate Blather connection" do
76
+ pending
77
+ end
78
+ end
@@ -0,0 +1,69 @@
1
+ require 'spec_helper'
2
+
3
+ describe Adhearsion::XMPP do
4
+
5
+ subject { Adhearsion::XMPP }
6
+
7
+ before :each do
8
+ Adhearsion::XMPP.plugin = nil
9
+ Adhearsion::XMPP.handlers = nil
10
+ end
11
+
12
+ it 'should delegate methods to the plugin connection' do
13
+ Adhearsion::XMPP.plugin = mock :plugin
14
+ connection = mock :connection
15
+ Adhearsion::XMPP.plugin.should_receive(:connection).and_return connection
16
+ connection.should_receive(:foo)
17
+
18
+ Adhearsion::XMPP.foo
19
+ end
20
+
21
+ it 'should hold on to a handler before the plugin is initialized' do
22
+ mock_handler = lambda { :does_not_matter }
23
+ Adhearsion::PunchblockPlugin.should_not_receive(:connection)
24
+
25
+ Adhearsion::XMPP.register_handlers &mock_handler
26
+ Adhearsion::XMPP.handlers.pop.should be mock_handler
27
+ end
28
+
29
+ it 'should hold on to multiple handlers' do
30
+ handler1 = lambda { :does_not_matter }
31
+ handler2 = lambda { :still_does_not_matter }
32
+
33
+ Adhearsion::XMPP.register_handlers &handler1
34
+ Adhearsion::XMPP.register_handlers &handler2
35
+ Adhearsion::XMPP.handlers.shift.should == handler1
36
+ Adhearsion::XMPP.handlers.shift.should == handler2
37
+ end
38
+
39
+ it 'should immediately register the handlers if the plugin is initialized' do
40
+ mock_handler = lambda { :does_not_matter }
41
+ Adhearsion::XMPP.plugin = mock :plugin
42
+ connection = mock :connection
43
+ Adhearsion::XMPP.plugin.should_receive(:connection).and_return connection
44
+ connection.should_receive(:instance_eval).once.with(&mock_handler)
45
+
46
+ Adhearsion::XMPP.register_handlers &mock_handler
47
+ end
48
+
49
+ it 'should register all stored handlers' do
50
+ handler1 = lambda { :does_not_matter }
51
+ handler2 = lambda { :still_does_not_matter }
52
+
53
+ Adhearsion::XMPP.register_handlers &handler1
54
+
55
+
56
+ Adhearsion::XMPP.plugin = mock :plugin
57
+ connection = mock :connection
58
+ Adhearsion::XMPP.plugin.should_receive(:connection).twice.and_return connection
59
+ connection.should_receive(:instance_eval).once.with(&handler1)
60
+ connection.should_receive(:instance_eval).once.with(&handler2)
61
+
62
+ Adhearsion::XMPP.register_handlers &handler2
63
+ end
64
+
65
+ it 'should raise ArgumentError if called without a block' do
66
+ expect { Adhearsion::XMPP.register_handlers }.to raise_error ArgumentError
67
+ end
68
+
69
+ end
@@ -0,0 +1,13 @@
1
+ require 'adhearsion/xmpp'
2
+
3
+ module Adhearsion
4
+ class PunchblockPlugin
5
+ end
6
+ end
7
+
8
+ def reset_adhearsion_xmpp_config
9
+ Adhearsion.config[:xmpp].jid = nil
10
+ Adhearsion.config[:xmpp].password = nil
11
+ Adhearsion.config[:xmpp].server = "localhost"
12
+ Adhearsion.config[:xmpp].port = 5222
13
+ end
metadata ADDED
@@ -0,0 +1,126 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: adhearsion-xmpp
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Juan de Bravo
9
+ - Ben Langfeld
10
+ - Jason Goecke
11
+ - Ben Klang
12
+ autorequire:
13
+ bindir: bin
14
+ cert_chain: []
15
+ date: 2012-02-21 00:00:00.000000000Z
16
+ dependencies:
17
+ - !ruby/object:Gem::Dependency
18
+ name: activesupport
19
+ requirement: &2156881480 !ruby/object:Gem::Requirement
20
+ none: false
21
+ requirements:
22
+ - - ! '>='
23
+ - !ruby/object:Gem::Version
24
+ version: 3.0.10
25
+ type: :runtime
26
+ prerelease: false
27
+ version_requirements: *2156881480
28
+ - !ruby/object:Gem::Dependency
29
+ name: i18n
30
+ requirement: &2156880440 !ruby/object:Gem::Requirement
31
+ none: false
32
+ requirements:
33
+ - - ! '>='
34
+ - !ruby/object:Gem::Version
35
+ version: 0.5.0
36
+ type: :runtime
37
+ prerelease: false
38
+ version_requirements: *2156880440
39
+ - !ruby/object:Gem::Dependency
40
+ name: blather
41
+ requirement: &2156879980 !ruby/object:Gem::Requirement
42
+ none: false
43
+ requirements:
44
+ - - ! '>='
45
+ - !ruby/object:Gem::Version
46
+ version: 0.5.7
47
+ type: :runtime
48
+ prerelease: false
49
+ version_requirements: *2156879980
50
+ - !ruby/object:Gem::Dependency
51
+ name: rspec
52
+ requirement: &2156879480 !ruby/object:Gem::Requirement
53
+ none: false
54
+ requirements:
55
+ - - ~>
56
+ - !ruby/object:Gem::Version
57
+ version: 2.7.0
58
+ type: :development
59
+ prerelease: false
60
+ version_requirements: *2156879480
61
+ - !ruby/object:Gem::Dependency
62
+ name: rake
63
+ requirement: &2156878740 !ruby/object:Gem::Requirement
64
+ none: false
65
+ requirements:
66
+ - - ! '>='
67
+ - !ruby/object:Gem::Version
68
+ version: 0.9.2
69
+ type: :development
70
+ prerelease: false
71
+ version_requirements: *2156878740
72
+ description: This gem provides the XMPP plugin to Adhearsion, allowing your Adhearsion
73
+ application to send and receive messages and react to presence changes.
74
+ email:
75
+ - juandebravo@gmail.com
76
+ - ben@langfeld.me
77
+ - jsgoecke@voxeo.com
78
+ - bklang@mojolingo.com
79
+ executables: []
80
+ extensions: []
81
+ extra_rdoc_files: []
82
+ files:
83
+ - .gitignore
84
+ - .rspec
85
+ - Gemfile
86
+ - LICENSE
87
+ - README.md
88
+ - Rakefile
89
+ - adhearsion-xmpp.gemspec
90
+ - lib/adhearsion-xmpp.rb
91
+ - lib/adhearsion/xmpp.rb
92
+ - lib/adhearsion/xmpp/connection.rb
93
+ - lib/adhearsion/xmpp/plugin.rb
94
+ - lib/adhearsion/xmpp/version.rb
95
+ - spec/adhearsion/xmpp/plugin_spec.rb
96
+ - spec/adhearsion/xmpp_spec.rb
97
+ - spec/spec_helper.rb
98
+ homepage: https://github.com/adhearsion/adhearsion-xmpp
99
+ licenses: []
100
+ post_install_message:
101
+ rdoc_options: []
102
+ require_paths:
103
+ - lib
104
+ required_ruby_version: !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ! '>='
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ required_rubygems_version: !ruby/object:Gem::Requirement
111
+ none: false
112
+ requirements:
113
+ - - ! '>='
114
+ - !ruby/object:Gem::Version
115
+ version: '0'
116
+ requirements: []
117
+ rubyforge_project: adhearsion-xmpp
118
+ rubygems_version: 1.8.10
119
+ signing_key:
120
+ specification_version: 3
121
+ summary: Send and receive XMPP messages in your Adhearsion application
122
+ test_files:
123
+ - spec/adhearsion/xmpp/plugin_spec.rb
124
+ - spec/adhearsion/xmpp_spec.rb
125
+ - spec/spec_helper.rb
126
+ has_rdoc: