adhearsion-activerecord 0.1.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,4 @@
1
+ source "http://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in adhearsion-activerecord.gemspec
4
+ 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,62 @@
1
+ adhearsion-activerecord
2
+
3
+ ================
4
+
5
+ adhearsion-activerecord is an Adhearsion Plugin providing ActiveRecord compatibility.
6
+
7
+ Features
8
+ --------
9
+
10
+ * FIXME (list of features and unsolved problems)
11
+
12
+ Requirements
13
+ ------------
14
+
15
+ * Adhearsion 2.0+
16
+
17
+ Install
18
+ -------
19
+
20
+ Add `adhearsion-activerecord` to your Adhearsion app's Gemfile.
21
+
22
+ Configuration
23
+ -------------
24
+
25
+ In your Adhearsion app configuration file, add the following values:
26
+
27
+ ```ruby
28
+ Adhearsion.config[:adhearsion_activerecord] do |config|
29
+ config.username = "db-user"
30
+ config.password = "db-password"
31
+ config.database = "database-id"
32
+ config.adapter = "db-adapter" # i.e. mysql, sqlite3
33
+ config.host = "db-host" # i.e. localhost
34
+ config.port = "db-port".to_i # i.e. 3306
35
+ end
36
+ ```
37
+
38
+ Author
39
+ ------
40
+
41
+ Original author: [Juan de Bravo](https://github.com/juandebravo)
42
+
43
+ Links
44
+ -----
45
+ * [Source](https://github.com/adhearsion/adhearsion-activerecord)
46
+ * [Documentation](http://rdoc.info/github/adhearsion/adhearsion-activerecord/master/frames)
47
+ * [Bug Tracker](https://github.com/adhearsion/adhearsion-activerecord/issues)
48
+
49
+ Note on Patches/Pull Requests
50
+ -----------------------------
51
+
52
+ * Fork the project.
53
+ * Make your feature addition or bug fix.
54
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
55
+ * Commit, do not mess with rakefile, version, or history.
56
+ * 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
57
+ * Send me a pull request. Bonus points for topic branches.
58
+
59
+ Copyright
60
+ ---------
61
+
62
+ Check [License file](https://github.com/adhearsion/adhearsion-activerecord/blob/master/LICENSE)
data/Rakefile ADDED
@@ -0,0 +1,13 @@
1
+ require "bundler/gem_tasks"
2
+ require "bundler/setup"
3
+
4
+
5
+ require 'rspec/core'
6
+ require 'rspec/core/rake_task'
7
+
8
+ RSpec::Core::RakeTask.new(:spec) do |spec|
9
+ spec.pattern = 'spec/**/*_spec.rb'
10
+ spec.rspec_opts = '--colour --format doc'
11
+ end
12
+
13
+ task :default => :spec
@@ -0,0 +1,26 @@
1
+ # -*- encoding: utf-8 -*-
2
+ $:.push File.expand_path("../lib", __FILE__)
3
+
4
+ require "adhearsion/activerecord/version"
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = "adhearsion-activerecord"
8
+ s.version = Adhearsion::ActiveRecord::VERSION
9
+ s.authors = ["juandebravo", "Ben Langfeld"]
10
+ s.email = ["juandebravo@gmail.com", "ben@langfeld.me"]
11
+ s.homepage = ""
12
+ s.summary = %q{This gem provides an Adhearsion plugin to handle the ActiveRecord and database integration}
13
+ s.description = %q{This gem provides an Adhearsion plugin to handle the ActiveRecord and database integration}
14
+
15
+ s.rubyforge_project = "adhearsion-activerecord"
16
+
17
+ s.files = `git ls-files`.split("\n")
18
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
19
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
20
+ s.require_paths = ["lib"]
21
+
22
+ s.add_runtime_dependency "adhearsion", ['>= 2.0.0.alpha1']
23
+ s.add_runtime_dependency "activerecord"
24
+ # specify any dependencies here; for example:
25
+ s.add_development_dependency "rspec"
26
+ end
@@ -0,0 +1 @@
1
+ require 'adhearsion/activerecord'
@@ -0,0 +1,10 @@
1
+ require "adhearsion"
2
+ require "active_support/dependencies/autoload"
3
+
4
+ require "adhearsion/activerecord/version"
5
+ require "adhearsion/activerecord/plugin"
6
+
7
+ module Adhearsion
8
+ module ActiveRecord
9
+ end
10
+ end
@@ -0,0 +1,35 @@
1
+ module Adhearsion
2
+ module ActiveRecord
3
+
4
+ ##
5
+ # Adhearsion Plugin that defines the ActiveRecord configuration options
6
+ # and includes a hook to start the ActiveRecord service in Adhearsion initialization process
7
+ class Plugin < Adhearsion::Plugin
8
+ extend ActiveSupport::Autoload
9
+
10
+ autoload :Service, 'adhearsion/activerecord/plugin/service'
11
+
12
+ # Configure a database to use ActiveRecord-backed models.
13
+ # See ActiveRecord::Base.establish_connection for the appropriate settings here.
14
+ #
15
+ # MySQL options are preconfigured. If you want o use another adapter, make sure to include the
16
+ # required options in your configuration file
17
+ config :adhearsion_activerecord do
18
+ adapter "mysql" , :desc => "Database adapter. It should be an adapter supported by ActiveRecord"
19
+ database "test" , :desc => "Database to connect to."
20
+ username "admin" , :desc => "valid db username"
21
+ password "" , :desc => "valid password"
22
+ host "localhost" , :desc => "host where the database is installed"
23
+ port 3306 , :desc => "port where the database is listening"
24
+ model_paths [] , :desc => 'paths to model files to load'
25
+ end
26
+
27
+ # Include the ActiveRecord service in plugins initialization process
28
+ init :adhearsion_activerecord do
29
+ Service.start
30
+ end
31
+
32
+ end
33
+
34
+ end
35
+ end
@@ -0,0 +1,74 @@
1
+ module Adhearsion
2
+ module ActiveRecord
3
+ class Plugin
4
+ class Service
5
+ class << self
6
+
7
+ ##
8
+ # Start the ActiveRecord connection with the configured database
9
+ def start
10
+ raise "Must supply an adapter argument to the ActiveRecord configuration" if (config.adapter.nil? || config.adapter.empty?)
11
+
12
+ require_dependencies
13
+ require_models
14
+
15
+ params = config.__values.select { |k,v| !v.nil? }
16
+
17
+ # You may need to uncomment the following line for older versions of ActiveRecord
18
+ # ActiveRecord::Base.allow_concurrency = true
19
+ establish_connection params.tap { |p| p.delete :model_paths }
20
+
21
+ ::ActiveRecord::Base.logger = logger
22
+
23
+ create_call_hook_for_connection_cleanup
24
+ end
25
+
26
+ ##
27
+ # Stop the database connection
28
+ def stop
29
+ ::ActiveRecord::Base.remove_connection
30
+ end
31
+
32
+ private
33
+
34
+ def create_call_hook_for_connection_cleanup
35
+ Adhearsion::Events.register_callback([:before_call]) do
36
+ ::ActiveRecord::Base.verify_active_connections!
37
+ end
38
+ end
39
+
40
+
41
+ def require_dependencies
42
+ begin
43
+ require 'active_record'
44
+ rescue LoadError
45
+ logger.fatal "Database support requires the \"activerecord\" gem."
46
+ # Silence the abort so we don't get an ugly backtrace
47
+ abort ""
48
+ end
49
+ end
50
+
51
+ def require_models
52
+ Array(config.model_paths).each { |model| load model }
53
+ end
54
+
55
+ ##
56
+ # Start the ActiveRecord connection with the configured database
57
+ #
58
+ # @param params [Hash] Options to establish the database connection
59
+ def establish_connection params
60
+ p params
61
+ ::ActiveRecord::Base.establish_connection params
62
+ end
63
+
64
+ ##
65
+ # Access to activerecord plugin configuration
66
+ def config
67
+ @config ||= Adhearsion.config[:adhearsion_activerecord]
68
+ end
69
+
70
+ end # class << self
71
+ end # Service
72
+ end # Plugin
73
+ end # ActiveRecord
74
+ end # Adhearsion
@@ -0,0 +1,5 @@
1
+ module Adhearsion
2
+ module ActiveRecord
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,69 @@
1
+ require 'spec_helper'
2
+
3
+ describe Adhearsion::ActiveRecord::Plugin::Service do
4
+
5
+ describe "when starting the ActiveRecord connection" do
6
+
7
+ def tempfile_with_contents(contents)
8
+ Tempfile.new("bogus_model").tap do |file|
9
+ file.puts contents
10
+ file.flush
11
+ end
12
+ end
13
+
14
+ def sample_user_model
15
+ <<-CODE
16
+ class User < ActiveRecord::Base
17
+ validates_uniqueness_of :name
18
+ end
19
+ CODE
20
+ end
21
+
22
+ let :options do
23
+ {
24
+ :adapter => "mysql",
25
+ :database => "test",
26
+ :username => "admin",
27
+ :password => "",
28
+ :host => "localhost",
29
+ :port => 3306
30
+ }
31
+ end
32
+
33
+ it "should raise an exception when no adapter has been configured" do
34
+ Adhearsion.config[:adhearsion_activerecord].adapter = nil
35
+ lambda { Adhearsion::Plugin.init_plugins }.should raise_error "Must supply an adapter argument to the ActiveRecord configuration"
36
+ end
37
+
38
+ it "establishes the connection with the not nil config values as options" do
39
+ Adhearsion.config.adhearsion_activerecord.database = "test"
40
+ Adhearsion::ActiveRecord::Plugin::Service.should_receive(:require_models).once.and_return true
41
+ Adhearsion::ActiveRecord::Plugin::Service.should_receive(:establish_connection).with(options).and_return true
42
+ Adhearsion::ActiveRecord::Plugin::Service.start
43
+ end
44
+
45
+ it "establishes the connection with the updated configuration" do
46
+ Adhearsion.config.adhearsion_activerecord do |config|
47
+ config.adapter = "sqlite3"
48
+ config.database = "foo.sqlite3"
49
+ config.username = nil
50
+ config.password = nil
51
+ config.host = nil
52
+ config.port = nil
53
+ end
54
+ Adhearsion::ActiveRecord::Plugin::Service.should_receive(:require_models).once.and_return true
55
+ Adhearsion::ActiveRecord::Plugin::Service.should_receive(:establish_connection).with({:adapter => "sqlite3", :database => "foo.sqlite3"}).and_return true
56
+ Adhearsion::ActiveRecord::Plugin::Service.start
57
+ end
58
+
59
+ it "should make any required models available in the main namespace" do
60
+ bogus_model = tempfile_with_contents sample_user_model
61
+ Adhearsion.config.adhearsion_activerecord.model_paths = [bogus_model.path]
62
+ Adhearsion::ActiveRecord::Plugin::Service.should_receive(:establish_connection).with(options).and_return true
63
+ Adhearsion::ActiveRecord::Plugin::Service.start
64
+ User.superclass.should be ActiveRecord::Base
65
+ end
66
+
67
+ end
68
+
69
+ end
@@ -0,0 +1,71 @@
1
+ require 'spec_helper'
2
+
3
+ describe Adhearsion::ActiveRecord::Plugin do
4
+
5
+ describe "while accessing the plugin configuration" do
6
+
7
+ it "should retrieve a valid configuration instance" do
8
+ Adhearsion.config.adhearsion_activerecord.should be_instance_of Loquacious::Configuration
9
+ end
10
+
11
+ it "should configure properly the adapter" do
12
+ Adhearsion.config[:adhearsion_activerecord].adapter.should == 'mysql'
13
+ end
14
+
15
+ it "should configure properly the username" do
16
+ Adhearsion.config[:adhearsion_activerecord].username.should == "admin"
17
+ end
18
+
19
+ it "should configure properly the password" do
20
+ Adhearsion.config[:adhearsion_activerecord].password.should be_empty
21
+ end
22
+
23
+ it "should configure properly the host" do
24
+ Adhearsion.config[:adhearsion_activerecord].host.should == "localhost"
25
+ end
26
+
27
+ it "should configure properly the port" do
28
+ Adhearsion.config[:adhearsion_activerecord].port.should == 3306
29
+ end
30
+
31
+ it "should configure properly the model_paths" do
32
+ Adhearsion.config[:adhearsion_activerecord].model_paths.should == []
33
+ end
34
+
35
+ end
36
+
37
+ describe "while configuring a specific config value" do
38
+ it "ovewrites properly the adapter value" do
39
+ Adhearsion.config[:adhearsion_activerecord].adapter = "sqlite3"
40
+ Adhearsion.config[:adhearsion_activerecord].adapter.should == "sqlite3"
41
+ end
42
+
43
+ it "ovewrites properly the username value" do
44
+ Adhearsion.config[:adhearsion_activerecord].username = "jon"
45
+ Adhearsion.config[:adhearsion_activerecord].username.should == "jon"
46
+ end
47
+
48
+ it "ovewrites properly the password value" do
49
+ Adhearsion.config[:adhearsion_activerecord].password = "valid-credentials"
50
+ Adhearsion.config[:adhearsion_activerecord].password.should == "valid-credentials"
51
+ end
52
+
53
+ it "ovewrites properly the host value" do
54
+ Adhearsion.config[:adhearsion_activerecord].host = "example"
55
+ Adhearsion.config[:adhearsion_activerecord].host.should == "example"
56
+ end
57
+
58
+ it "ovewrites properly the port value" do
59
+ Adhearsion.config[:adhearsion_activerecord].port = 3307
60
+ Adhearsion.config[:adhearsion_activerecord].port.should == 3307
61
+ end
62
+
63
+ end
64
+
65
+ describe "while loading plugins" do
66
+ it "should load the init block and start the service" do
67
+ Adhearsion::ActiveRecord::Plugin::Service.should_receive(:start).once.and_return true
68
+ Adhearsion::Plugin.init_plugins
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,11 @@
1
+ require 'spec_helper'
2
+
3
+ describe Adhearsion::ActiveRecord do
4
+
5
+ subject { Adhearsion::ActiveRecord }
6
+
7
+ it "should be a module" do
8
+ subject.should be_kind_of Module
9
+ end
10
+
11
+ end
@@ -0,0 +1,13 @@
1
+ require 'adhearsion/activerecord'
2
+
3
+ RSpec.configure do |config|
4
+ config.before(:each) do
5
+ Adhearsion.config[:adhearsion_activerecord].adapter = "mysql"
6
+ Adhearsion.config[:adhearsion_activerecord].database = "test"
7
+ Adhearsion.config[:adhearsion_activerecord].username = "admin"
8
+ Adhearsion.config[:adhearsion_activerecord].password = ""
9
+ Adhearsion.config[:adhearsion_activerecord].host = "localhost"
10
+ Adhearsion.config[:adhearsion_activerecord].port = 3306
11
+ Adhearsion.config[:adhearsion_activerecord].model_paths = []
12
+ end
13
+ end
metadata ADDED
@@ -0,0 +1,108 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: adhearsion-activerecord
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - juandebravo
9
+ - Ben Langfeld
10
+ autorequire:
11
+ bindir: bin
12
+ cert_chain: []
13
+ date: 2012-01-18 00:00:00.000000000 Z
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: adhearsion
17
+ requirement: &2168903400 !ruby/object:Gem::Requirement
18
+ none: false
19
+ requirements:
20
+ - - ! '>='
21
+ - !ruby/object:Gem::Version
22
+ version: 2.0.0.alpha1
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: *2168903400
26
+ - !ruby/object:Gem::Dependency
27
+ name: activerecord
28
+ requirement: &2168902700 !ruby/object:Gem::Requirement
29
+ none: false
30
+ requirements:
31
+ - - ! '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: *2168902700
37
+ - !ruby/object:Gem::Dependency
38
+ name: rspec
39
+ requirement: &2168901880 !ruby/object:Gem::Requirement
40
+ none: false
41
+ requirements:
42
+ - - ! '>='
43
+ - !ruby/object:Gem::Version
44
+ version: '0'
45
+ type: :development
46
+ prerelease: false
47
+ version_requirements: *2168901880
48
+ description: This gem provides an Adhearsion plugin to handle the ActiveRecord and
49
+ database integration
50
+ email:
51
+ - juandebravo@gmail.com
52
+ - ben@langfeld.me
53
+ executables: []
54
+ extensions: []
55
+ extra_rdoc_files: []
56
+ files:
57
+ - .gitignore
58
+ - .rspec
59
+ - Gemfile
60
+ - LICENSE
61
+ - README.md
62
+ - Rakefile
63
+ - adhearsion-activerecord.gemspec
64
+ - lib/adhearsion-activerecord.rb
65
+ - lib/adhearsion/activerecord.rb
66
+ - lib/adhearsion/activerecord/plugin.rb
67
+ - lib/adhearsion/activerecord/plugin/service.rb
68
+ - lib/adhearsion/activerecord/version.rb
69
+ - spec/adhearsion/activerecord/plugin/service_spec.rb
70
+ - spec/adhearsion/activerecord/plugin_spec.rb
71
+ - spec/adhearsion/activerecord_spec.rb
72
+ - spec/spec_helper.rb
73
+ homepage: ''
74
+ licenses: []
75
+ post_install_message:
76
+ rdoc_options: []
77
+ require_paths:
78
+ - lib
79
+ required_ruby_version: !ruby/object:Gem::Requirement
80
+ none: false
81
+ requirements:
82
+ - - ! '>='
83
+ - !ruby/object:Gem::Version
84
+ version: '0'
85
+ segments:
86
+ - 0
87
+ hash: 3783427714437506130
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ none: false
90
+ requirements:
91
+ - - ! '>='
92
+ - !ruby/object:Gem::Version
93
+ version: '0'
94
+ segments:
95
+ - 0
96
+ hash: 3783427714437506130
97
+ requirements: []
98
+ rubyforge_project: adhearsion-activerecord
99
+ rubygems_version: 1.8.10
100
+ signing_key:
101
+ specification_version: 3
102
+ summary: This gem provides an Adhearsion plugin to handle the ActiveRecord and database
103
+ integration
104
+ test_files:
105
+ - spec/adhearsion/activerecord/plugin/service_spec.rb
106
+ - spec/adhearsion/activerecord/plugin_spec.rb
107
+ - spec/adhearsion/activerecord_spec.rb
108
+ - spec/spec_helper.rb