liveresource 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/BSDL +24 -0
- data/COPYING +59 -0
- data/GPL +339 -0
- data/README.md +289 -0
- data/Rakefile +47 -0
- data/benchmark/benchmark_helper.rb +19 -0
- data/benchmark/method_benchmark.rb +94 -0
- data/lib/live_resource.rb +66 -0
- data/lib/live_resource/attributes.rb +77 -0
- data/lib/live_resource/declarations.rb +200 -0
- data/lib/live_resource/finders.rb +43 -0
- data/lib/live_resource/log_helper.rb +24 -0
- data/lib/live_resource/methods.rb +41 -0
- data/lib/live_resource/methods/dispatcher.rb +176 -0
- data/lib/live_resource/methods/forward.rb +23 -0
- data/lib/live_resource/methods/future.rb +27 -0
- data/lib/live_resource/methods/method.rb +93 -0
- data/lib/live_resource/methods/token.rb +22 -0
- data/lib/live_resource/redis_client.rb +100 -0
- data/lib/live_resource/redis_client/attributes.rb +40 -0
- data/lib/live_resource/redis_client/methods.rb +194 -0
- data/lib/live_resource/redis_client/registration.rb +25 -0
- data/lib/live_resource/resource.rb +44 -0
- data/lib/live_resource/resource_proxy.rb +180 -0
- data/old/benchmark/attribute_benchmark.rb +58 -0
- data/old/benchmark/thread_benchmark.rb +89 -0
- data/old/examples/attribute.rb +22 -0
- data/old/examples/attribute_rmw.rb +30 -0
- data/old/examples/attribute_subscriber.rb +32 -0
- data/old/examples/method_provider_sleep.rb +22 -0
- data/old/examples/methods.rb +37 -0
- data/old/lib/live_resource/subscriber.rb +98 -0
- data/old/redis_test.rb +127 -0
- data/old/state_publisher_test.rb +139 -0
- data/old/test/attribute_modify_test.rb +52 -0
- data/old/test/attribute_options_test.rb +54 -0
- data/old/test/attribute_subscriber_test.rb +94 -0
- data/old/test/composite_resource_test.rb +61 -0
- data/old/test/method_sender_test.rb +41 -0
- data/old/test/redis_api_test.rb +185 -0
- data/old/test/simple_attribute_test.rb +75 -0
- data/test/attribute_test.rb +212 -0
- data/test/declarations_test.rb +119 -0
- data/test/logger_test.rb +44 -0
- data/test/method_call_test.rb +223 -0
- data/test/method_forward_continue_test.rb +83 -0
- data/test/method_params_test.rb +81 -0
- data/test/method_routing_test.rb +59 -0
- data/test/multiple_class_test.rb +47 -0
- data/test/new_api_DISABLED.rb +127 -0
- data/test/test_helper.rb +9 -0
- data/test/volume_create_DISABLED.rb +74 -0
- metadata +129 -0
data/.gitignore
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
*~
|
data/BSDL
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
Copyright (C) 2010-2012 Spectra Logic. All rights reserved.
|
2
|
+
|
3
|
+
Redistribution and use in source and binary forms, with or without
|
4
|
+
modification, are permitted provided that the following conditions
|
5
|
+
are met:
|
6
|
+
|
7
|
+
1. Redistributions of source code must retain the above copyright
|
8
|
+
notice, this list of conditions and the following disclaimer.
|
9
|
+
|
10
|
+
2. Redistributions in binary form must reproduce the above copyright
|
11
|
+
notice, this list of conditions and the following disclaimer in the
|
12
|
+
documentation and/or other materials provided with the distribution.
|
13
|
+
|
14
|
+
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
15
|
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
16
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
17
|
+
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
18
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
19
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
20
|
+
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
21
|
+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
22
|
+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
23
|
+
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
24
|
+
SUCH DAMAGE.
|
data/COPYING
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
LiveResource is copyrighted free software by Spectra Logic
|
2
|
+
<public@joshcarter.com>. You can redistribute it and/or modify it
|
3
|
+
under either the terms of the 2-clause BSDL (see the file BSDL), or
|
4
|
+
the conditions below:
|
5
|
+
|
6
|
+
1. You may make and give away verbatim copies of the source form of the
|
7
|
+
software without restriction, provided that you duplicate all of the
|
8
|
+
original copyright notices and associated disclaimers.
|
9
|
+
|
10
|
+
2. You may modify your copy of the software in any way, provided that
|
11
|
+
you do at least ONE of the following:
|
12
|
+
|
13
|
+
a) place your modifications in the Public Domain or otherwise
|
14
|
+
make them Freely Available, such as by posting said
|
15
|
+
modifications to Usenet or an equivalent medium, or by
|
16
|
+
allowing the author to include your modifications in the
|
17
|
+
software.
|
18
|
+
|
19
|
+
b) use the modified software only within your corporation or
|
20
|
+
organization.
|
21
|
+
|
22
|
+
c) give non-standard binaries non-standard names, with
|
23
|
+
instructions on where to get the original software
|
24
|
+
distribution.
|
25
|
+
|
26
|
+
d) make other distribution arrangements with the author.
|
27
|
+
|
28
|
+
3. You may distribute the software in object code or binary form,
|
29
|
+
provided that you do at least ONE of the following:
|
30
|
+
|
31
|
+
a) distribute the binaries and library files of the software,
|
32
|
+
together with instructions (in the manual page or
|
33
|
+
equivalent) on where to get the original distribution.
|
34
|
+
|
35
|
+
b) accompany the distribution with the machine-readable source of
|
36
|
+
the software.
|
37
|
+
|
38
|
+
c) give non-standard binaries non-standard names, with
|
39
|
+
instructions on where to get the original software distribution.
|
40
|
+
|
41
|
+
d) make other distribution arrangements with the author.
|
42
|
+
|
43
|
+
4. You may modify and include the part of the software into any other
|
44
|
+
software (possibly commercial). But some files in the distribution
|
45
|
+
are not written by the author, so that they are not under these terms.
|
46
|
+
|
47
|
+
For the list of those files and their copying conditions, see the
|
48
|
+
file LEGAL.
|
49
|
+
|
50
|
+
5. The scripts and library files supplied as input to or produced as
|
51
|
+
output from the software do not automatically fall under the
|
52
|
+
copyright of the software, but belong to whomever generated them,
|
53
|
+
and may be sold commercially, and may be aggregated with this
|
54
|
+
software.
|
55
|
+
|
56
|
+
6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
|
57
|
+
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
|
58
|
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
59
|
+
PURPOSE.
|
data/GPL
ADDED
@@ -0,0 +1,339 @@
|
|
1
|
+
GNU GENERAL PUBLIC LICENSE
|
2
|
+
Version 2, June 1991
|
3
|
+
|
4
|
+
Copyright (C) 1989, 1991 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
|
+
Preamble
|
10
|
+
|
11
|
+
The licenses for most software are designed to take away your
|
12
|
+
freedom to share and change it. By contrast, the GNU General Public
|
13
|
+
License is intended to guarantee your freedom to share and change free
|
14
|
+
software--to make sure the software is free for all its users. This
|
15
|
+
General Public License applies to most of the Free Software
|
16
|
+
Foundation's software and to any other program whose authors commit to
|
17
|
+
using it. (Some other Free Software Foundation software is covered by
|
18
|
+
the GNU Lesser General Public License instead.) You can apply it to
|
19
|
+
your programs, too.
|
20
|
+
|
21
|
+
When we speak of free software, we are referring to freedom, not
|
22
|
+
price. Our General Public Licenses are designed to make sure that you
|
23
|
+
have the freedom to distribute copies of free software (and charge for
|
24
|
+
this service if you wish), that you receive source code or can get it
|
25
|
+
if you want it, that you can change the software or use pieces of it
|
26
|
+
in new free programs; and that you know you can do these things.
|
27
|
+
|
28
|
+
To protect your rights, we need to make restrictions that forbid
|
29
|
+
anyone to deny you these rights or to ask you to surrender the rights.
|
30
|
+
These restrictions translate to certain responsibilities for you if you
|
31
|
+
distribute copies of the software, or if you modify it.
|
32
|
+
|
33
|
+
For example, if you distribute copies of such a program, whether
|
34
|
+
gratis or for a fee, you must give the recipients all the rights that
|
35
|
+
you have. You must make sure that they, too, receive or can get the
|
36
|
+
source code. And you must show them these terms so they know their
|
37
|
+
rights.
|
38
|
+
|
39
|
+
We protect your rights with two steps: (1) copyright the software, and
|
40
|
+
(2) offer you this license which gives you legal permission to copy,
|
41
|
+
distribute and/or modify the software.
|
42
|
+
|
43
|
+
Also, for each author's protection and ours, we want to make certain
|
44
|
+
that everyone understands that there is no warranty for this free
|
45
|
+
software. If the software is modified by someone else and passed on, we
|
46
|
+
want its recipients to know that what they have is not the original, so
|
47
|
+
that any problems introduced by others will not reflect on the original
|
48
|
+
authors' reputations.
|
49
|
+
|
50
|
+
Finally, any free program is threatened constantly by software
|
51
|
+
patents. We wish to avoid the danger that redistributors of a free
|
52
|
+
program will individually obtain patent licenses, in effect making the
|
53
|
+
program proprietary. To prevent this, we have made it clear that any
|
54
|
+
patent must be licensed for everyone's free use or not licensed at all.
|
55
|
+
|
56
|
+
The precise terms and conditions for copying, distribution and
|
57
|
+
modification follow.
|
58
|
+
|
59
|
+
GNU GENERAL PUBLIC LICENSE
|
60
|
+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
61
|
+
|
62
|
+
0. This License applies to any program or other work which contains
|
63
|
+
a notice placed by the copyright holder saying it may be distributed
|
64
|
+
under the terms of this General Public License. The "Program", below,
|
65
|
+
refers to any such program or work, and a "work based on the Program"
|
66
|
+
means either the Program or any derivative work under copyright law:
|
67
|
+
that is to say, a work containing the Program or a portion of it,
|
68
|
+
either verbatim or with modifications and/or translated into another
|
69
|
+
language. (Hereinafter, translation is included without limitation in
|
70
|
+
the term "modification".) Each licensee is addressed as "you".
|
71
|
+
|
72
|
+
Activities other than copying, distribution and modification are not
|
73
|
+
covered by this License; they are outside its scope. The act of
|
74
|
+
running the Program is not restricted, and the output from the Program
|
75
|
+
is covered only if its contents constitute a work based on the
|
76
|
+
Program (independent of having been made by running the Program).
|
77
|
+
Whether that is true depends on what the Program does.
|
78
|
+
|
79
|
+
1. You may copy and distribute verbatim copies of the Program's
|
80
|
+
source code as you receive it, in any medium, provided that you
|
81
|
+
conspicuously and appropriately publish on each copy an appropriate
|
82
|
+
copyright notice and disclaimer of warranty; keep intact all the
|
83
|
+
notices that refer to this License and to the absence of any warranty;
|
84
|
+
and give any other recipients of the Program a copy of this License
|
85
|
+
along with the Program.
|
86
|
+
|
87
|
+
You may charge a fee for the physical act of transferring a copy, and
|
88
|
+
you may at your option offer warranty protection in exchange for a fee.
|
89
|
+
|
90
|
+
2. You may modify your copy or copies of the Program or any portion
|
91
|
+
of it, thus forming a work based on the Program, and copy and
|
92
|
+
distribute such modifications or work under the terms of Section 1
|
93
|
+
above, provided that you also meet all of these conditions:
|
94
|
+
|
95
|
+
a) You must cause the modified files to carry prominent notices
|
96
|
+
stating that you changed the files and the date of any change.
|
97
|
+
|
98
|
+
b) You must cause any work that you distribute or publish, that in
|
99
|
+
whole or in part contains or is derived from the Program or any
|
100
|
+
part thereof, to be licensed as a whole at no charge to all third
|
101
|
+
parties under the terms of this License.
|
102
|
+
|
103
|
+
c) If the modified program normally reads commands interactively
|
104
|
+
when run, you must cause it, when started running for such
|
105
|
+
interactive use in the most ordinary way, to print or display an
|
106
|
+
announcement including an appropriate copyright notice and a
|
107
|
+
notice that there is no warranty (or else, saying that you provide
|
108
|
+
a warranty) and that users may redistribute the program under
|
109
|
+
these conditions, and telling the user how to view a copy of this
|
110
|
+
License. (Exception: if the Program itself is interactive but
|
111
|
+
does not normally print such an announcement, your work based on
|
112
|
+
the Program is not required to print an announcement.)
|
113
|
+
|
114
|
+
These requirements apply to the modified work as a whole. If
|
115
|
+
identifiable sections of that work are not derived from the Program,
|
116
|
+
and can be reasonably considered independent and separate works in
|
117
|
+
themselves, then this License, and its terms, do not apply to those
|
118
|
+
sections when you distribute them as separate works. But when you
|
119
|
+
distribute the same sections as part of a whole which is a work based
|
120
|
+
on the Program, the distribution of the whole must be on the terms of
|
121
|
+
this License, whose permissions for other licensees extend to the
|
122
|
+
entire whole, and thus to each and every part regardless of who wrote it.
|
123
|
+
|
124
|
+
Thus, it is not the intent of this section to claim rights or contest
|
125
|
+
your rights to work written entirely by you; rather, the intent is to
|
126
|
+
exercise the right to control the distribution of derivative or
|
127
|
+
collective works based on the Program.
|
128
|
+
|
129
|
+
In addition, mere aggregation of another work not based on the Program
|
130
|
+
with the Program (or with a work based on the Program) on a volume of
|
131
|
+
a storage or distribution medium does not bring the other work under
|
132
|
+
the scope of this License.
|
133
|
+
|
134
|
+
3. You may copy and distribute the Program (or a work based on it,
|
135
|
+
under Section 2) in object code or executable form under the terms of
|
136
|
+
Sections 1 and 2 above provided that you also do one of the following:
|
137
|
+
|
138
|
+
a) Accompany it with the complete corresponding machine-readable
|
139
|
+
source code, which must be distributed under the terms of Sections
|
140
|
+
1 and 2 above on a medium customarily used for software interchange; or,
|
141
|
+
|
142
|
+
b) Accompany it with a written offer, valid for at least three
|
143
|
+
years, to give any third party, for a charge no more than your
|
144
|
+
cost of physically performing source distribution, a complete
|
145
|
+
machine-readable copy of the corresponding source code, to be
|
146
|
+
distributed under the terms of Sections 1 and 2 above on a medium
|
147
|
+
customarily used for software interchange; or,
|
148
|
+
|
149
|
+
c) Accompany it with the information you received as to the offer
|
150
|
+
to distribute corresponding source code. (This alternative is
|
151
|
+
allowed only for noncommercial distribution and only if you
|
152
|
+
received the program in object code or executable form with such
|
153
|
+
an offer, in accord with Subsection b above.)
|
154
|
+
|
155
|
+
The source code for a work means the preferred form of the work for
|
156
|
+
making modifications to it. For an executable work, complete source
|
157
|
+
code means all the source code for all modules it contains, plus any
|
158
|
+
associated interface definition files, plus the scripts used to
|
159
|
+
control compilation and installation of the executable. However, as a
|
160
|
+
special exception, the source code distributed need not include
|
161
|
+
anything that is normally distributed (in either source or binary
|
162
|
+
form) with the major components (compiler, kernel, and so on) of the
|
163
|
+
operating system on which the executable runs, unless that component
|
164
|
+
itself accompanies the executable.
|
165
|
+
|
166
|
+
If distribution of executable or object code is made by offering
|
167
|
+
access to copy from a designated place, then offering equivalent
|
168
|
+
access to copy the source code from the same place counts as
|
169
|
+
distribution of the source code, even though third parties are not
|
170
|
+
compelled to copy the source along with the object code.
|
171
|
+
|
172
|
+
4. You may not copy, modify, sublicense, or distribute the Program
|
173
|
+
except as expressly provided under this License. Any attempt
|
174
|
+
otherwise to copy, modify, sublicense or distribute the Program is
|
175
|
+
void, and will automatically terminate your rights under this License.
|
176
|
+
However, parties who have received copies, or rights, from you under
|
177
|
+
this License will not have their licenses terminated so long as such
|
178
|
+
parties remain in full compliance.
|
179
|
+
|
180
|
+
5. You are not required to accept this License, since you have not
|
181
|
+
signed it. However, nothing else grants you permission to modify or
|
182
|
+
distribute the Program or its derivative works. These actions are
|
183
|
+
prohibited by law if you do not accept this License. Therefore, by
|
184
|
+
modifying or distributing the Program (or any work based on the
|
185
|
+
Program), you indicate your acceptance of this License to do so, and
|
186
|
+
all its terms and conditions for copying, distributing or modifying
|
187
|
+
the Program or works based on it.
|
188
|
+
|
189
|
+
6. Each time you redistribute the Program (or any work based on the
|
190
|
+
Program), the recipient automatically receives a license from the
|
191
|
+
original licensor to copy, distribute or modify the Program subject to
|
192
|
+
these terms and conditions. You may not impose any further
|
193
|
+
restrictions on the recipients' exercise of the rights granted herein.
|
194
|
+
You are not responsible for enforcing compliance by third parties to
|
195
|
+
this License.
|
196
|
+
|
197
|
+
7. If, as a consequence of a court judgment or allegation of patent
|
198
|
+
infringement or for any other reason (not limited to patent issues),
|
199
|
+
conditions are imposed on you (whether by court order, agreement or
|
200
|
+
otherwise) that contradict the conditions of this License, they do not
|
201
|
+
excuse you from the conditions of this License. If you cannot
|
202
|
+
distribute so as to satisfy simultaneously your obligations under this
|
203
|
+
License and any other pertinent obligations, then as a consequence you
|
204
|
+
may not distribute the Program at all. For example, if a patent
|
205
|
+
license would not permit royalty-free redistribution of the Program by
|
206
|
+
all those who receive copies directly or indirectly through you, then
|
207
|
+
the only way you could satisfy both it and this License would be to
|
208
|
+
refrain entirely from distribution of the Program.
|
209
|
+
|
210
|
+
If any portion of this section is held invalid or unenforceable under
|
211
|
+
any particular circumstance, the balance of the section is intended to
|
212
|
+
apply and the section as a whole is intended to apply in other
|
213
|
+
circumstances.
|
214
|
+
|
215
|
+
It is not the purpose of this section to induce you to infringe any
|
216
|
+
patents or other property right claims or to contest validity of any
|
217
|
+
such claims; this section has the sole purpose of protecting the
|
218
|
+
integrity of the free software distribution system, which is
|
219
|
+
implemented by public license practices. Many people have made
|
220
|
+
generous contributions to the wide range of software distributed
|
221
|
+
through that system in reliance on consistent application of that
|
222
|
+
system; it is up to the author/donor to decide if he or she is willing
|
223
|
+
to distribute software through any other system and a licensee cannot
|
224
|
+
impose that choice.
|
225
|
+
|
226
|
+
This section is intended to make thoroughly clear what is believed to
|
227
|
+
be a consequence of the rest of this License.
|
228
|
+
|
229
|
+
8. If the distribution and/or use of the Program is restricted in
|
230
|
+
certain countries either by patents or by copyrighted interfaces, the
|
231
|
+
original copyright holder who places the Program under this License
|
232
|
+
may add an explicit geographical distribution limitation excluding
|
233
|
+
those countries, so that distribution is permitted only in or among
|
234
|
+
countries not thus excluded. In such case, this License incorporates
|
235
|
+
the limitation as if written in the body of this License.
|
236
|
+
|
237
|
+
9. The Free Software Foundation may publish revised and/or new versions
|
238
|
+
of the General Public License from time to time. Such new versions will
|
239
|
+
be similar in spirit to the present version, but may differ in detail to
|
240
|
+
address new problems or concerns.
|
241
|
+
|
242
|
+
Each version is given a distinguishing version number. If the Program
|
243
|
+
specifies a version number of this License which applies to it and "any
|
244
|
+
later version", you have the option of following the terms and conditions
|
245
|
+
either of that version or of any later version published by the Free
|
246
|
+
Software Foundation. If the Program does not specify a version number of
|
247
|
+
this License, you may choose any version ever published by the Free Software
|
248
|
+
Foundation.
|
249
|
+
|
250
|
+
10. If you wish to incorporate parts of the Program into other free
|
251
|
+
programs whose distribution conditions are different, write to the author
|
252
|
+
to ask for permission. For software which is copyrighted by the Free
|
253
|
+
Software Foundation, write to the Free Software Foundation; we sometimes
|
254
|
+
make exceptions for this. Our decision will be guided by the two goals
|
255
|
+
of preserving the free status of all derivatives of our free software and
|
256
|
+
of promoting the sharing and reuse of software generally.
|
257
|
+
|
258
|
+
NO WARRANTY
|
259
|
+
|
260
|
+
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
261
|
+
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
262
|
+
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
263
|
+
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
264
|
+
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
265
|
+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
266
|
+
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
267
|
+
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
268
|
+
REPAIR OR CORRECTION.
|
269
|
+
|
270
|
+
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
271
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
272
|
+
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
273
|
+
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
274
|
+
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
275
|
+
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
276
|
+
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
277
|
+
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
278
|
+
POSSIBILITY OF SUCH DAMAGES.
|
279
|
+
|
280
|
+
END OF TERMS AND CONDITIONS
|
281
|
+
|
282
|
+
How to Apply These Terms to Your New Programs
|
283
|
+
|
284
|
+
If you develop a new program, and you want it to be of the greatest
|
285
|
+
possible use to the public, the best way to achieve this is to make it
|
286
|
+
free software which everyone can redistribute and change under these terms.
|
287
|
+
|
288
|
+
To do so, attach the following notices to the program. It is safest
|
289
|
+
to attach them to the start of each source file to most effectively
|
290
|
+
convey the exclusion of warranty; and each file should have at least
|
291
|
+
the "copyright" line and a pointer to where the full notice is found.
|
292
|
+
|
293
|
+
<one line to give the program's name and a brief idea of what it does.>
|
294
|
+
Copyright (C) <year> <name of author>
|
295
|
+
|
296
|
+
This program is free software; you can redistribute it and/or modify
|
297
|
+
it under the terms of the GNU General Public License as published by
|
298
|
+
the Free Software Foundation; either version 2 of the License, or
|
299
|
+
(at your option) any later version.
|
300
|
+
|
301
|
+
This program is distributed in the hope that it will be useful,
|
302
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
303
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
304
|
+
GNU General Public License for more details.
|
305
|
+
|
306
|
+
You should have received a copy of the GNU General Public License along
|
307
|
+
with this program; if not, write to the Free Software Foundation, Inc.,
|
308
|
+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
309
|
+
|
310
|
+
Also add information on how to contact you by electronic and paper mail.
|
311
|
+
|
312
|
+
If the program is interactive, make it output a short notice like this
|
313
|
+
when it starts in an interactive mode:
|
314
|
+
|
315
|
+
Gnomovision version 69, Copyright (C) year name of author
|
316
|
+
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
317
|
+
This is free software, and you are welcome to redistribute it
|
318
|
+
under certain conditions; type `show c' for details.
|
319
|
+
|
320
|
+
The hypothetical commands `show w' and `show c' should show the appropriate
|
321
|
+
parts of the General Public License. Of course, the commands you use may
|
322
|
+
be called something other than `show w' and `show c'; they could even be
|
323
|
+
mouse-clicks or menu items--whatever suits your program.
|
324
|
+
|
325
|
+
You should also get your employer (if you work as a programmer) or your
|
326
|
+
school, if any, to sign a "copyright disclaimer" for the program, if
|
327
|
+
necessary. Here is a sample; alter the names:
|
328
|
+
|
329
|
+
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
330
|
+
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
331
|
+
|
332
|
+
<signature of Ty Coon>, 1 April 1989
|
333
|
+
Ty Coon, President of Vice
|
334
|
+
|
335
|
+
This General Public License does not permit incorporating your program into
|
336
|
+
proprietary programs. If your program is a subroutine library, you may
|
337
|
+
consider it more useful to permit linking proprietary applications with the
|
338
|
+
library. If this is what you want to do, use the GNU Lesser General
|
339
|
+
Public License instead of this License.
|
data/README.md
ADDED
@@ -0,0 +1,289 @@
|
|
1
|
+
LiveResource 2
|
2
|
+
==============
|
3
|
+
|
4
|
+
LiveResource is a framework for coordinating processes, statuses, and
|
5
|
+
messaging within a distributed system. It provides the following
|
6
|
+
abilities:
|
7
|
+
|
8
|
+
* Call methods on objects in other threads and processes, locally or
|
9
|
+
on remote machines. Synchronous and asynchronous calling supported,
|
10
|
+
arguments and return values are serialized, exceptions are also
|
11
|
+
propagated back to the caller.
|
12
|
+
|
13
|
+
* Set attributes that other threads and processes can see.
|
14
|
+
|
15
|
+
These support a variety of use models, for example:
|
16
|
+
|
17
|
+
* Web application (Rails, Sinatra, etc.) which needs to gather state
|
18
|
+
from multiple places and render it on a web page. The app should
|
19
|
+
never block for long in its render path, so it needs to pull the
|
20
|
+
state *right now*. Daemons that know the state may be busy (blocked
|
21
|
+
on IO, for example), so they should *push* state into LiveResource
|
22
|
+
when they can, and let the GUI pull it when needed.
|
23
|
+
|
24
|
+
* Processes that need to call into another process to do a job. Any
|
25
|
+
process can search the list of resources by resource class, either
|
26
|
+
looking for a specific instance by name, grabbing any, or iterating
|
27
|
+
over all of them. It can call methods synchronously, looking just
|
28
|
+
like a Ruby method call, or async and check for the result later.
|
29
|
+
|
30
|
+
LiveResource is built for Ruby and is designed to be familiar to Ruby
|
31
|
+
programmers. It uses terms which are as Ruby-esque as possible instead
|
32
|
+
of borrowing from other domains (pub/sub, RMI, and so forth).
|
33
|
+
|
34
|
+
The underlying tools, however, are available to any language: Redis is
|
35
|
+
the hub for communications, and all objects are stored with YAML
|
36
|
+
encoding. Ports to other languages would be straightforward (and may
|
37
|
+
be forthcoming).
|
38
|
+
|
39
|
+
**NOTE: LiveResource 2 introduces significant improvements in its API,
|
40
|
+
but breaks compatibility with versions 1.x. The older API is
|
41
|
+
maintained on the `stable-1` branch.**
|
42
|
+
|
43
|
+
## Requirements
|
44
|
+
|
45
|
+
LiveResource requires:
|
46
|
+
|
47
|
+
* Ruby 1.9.3 or JRuby in 1.9 mode (`export JRUBY_OPTS=--1.9`).
|
48
|
+
|
49
|
+
* [Redis 2.2+.](http://redis.io/) server. (Redis 1.x does not support commands needed by LiveResource.)
|
50
|
+
|
51
|
+
* [redis-rb](https://github.com/ezmobius/redis-rb) gem.
|
52
|
+
|
53
|
+
## Attributes
|
54
|
+
|
55
|
+
Here's a resource with an attribute:
|
56
|
+
|
57
|
+
class FavoriteColor
|
58
|
+
include LiveResource::Resource
|
59
|
+
|
60
|
+
# Set up resource class and instance naming
|
61
|
+
resource_class :favorite_color
|
62
|
+
resource_name :object_id
|
63
|
+
|
64
|
+
# Declare remote attributes
|
65
|
+
remote_writer :favorite
|
66
|
+
end
|
67
|
+
|
68
|
+
resource = FavoriteColor.new
|
69
|
+
resource.favorite = "blue"
|
70
|
+
|
71
|
+
This resource demonstrates several points:
|
72
|
+
|
73
|
+
* LiveResource features are defined in the Resource modules -- you can
|
74
|
+
add LiveResource features to existing classes with little effort.
|
75
|
+
|
76
|
+
* "Remote" Attributes are defined much like Ruby's attributes:
|
77
|
+
`remote_reader`, `remote_writer`, and `remote_accessor` are used to
|
78
|
+
automatically create methods for reading and writing a given
|
79
|
+
attribute.
|
80
|
+
|
81
|
+
* LiveResource instances have both a class and a name, making your
|
82
|
+
remote interface look just like a normal Ruby object API. (When you
|
83
|
+
don't care about naming, tell LiveResource to assign names based on
|
84
|
+
`:object_id`.)
|
85
|
+
|
86
|
+
* By default, LiveResource connects to a Redis server at
|
87
|
+
`localhost:6379`, but you can change any Redis client parameters you
|
88
|
+
need to.
|
89
|
+
|
90
|
+
Now let's access the above-published favorite color:
|
91
|
+
|
92
|
+
r = LiveResource::any(:favorite_color)
|
93
|
+
r.favorite # --> "blue"
|
94
|
+
|
95
|
+
LiveResource includes the finders `find`, `any`, and `all`. The object
|
96
|
+
returned is a *proxy* for the real resource, which could be in a
|
97
|
+
different process or on a whole different machine.
|
98
|
+
|
99
|
+
Note that attributes can be set to any Ruby objects; they are
|
100
|
+
automatically marshaled using YAML. (If you want to create a
|
101
|
+
LiveResource interface in another programming language, you just need
|
102
|
+
a Redis client and YAML.)
|
103
|
+
|
104
|
+
## Attribute Read-Modify-Write
|
105
|
+
Reading an attribute is an atomic operation; so is writing one. However, sometimes you need to read,
|
106
|
+
modify, and write an attribute or set of attributes as an atomic operation. LiveResource provides a
|
107
|
+
special notation for that:
|
108
|
+
|
109
|
+
class FavoriteColor
|
110
|
+
include LiveResource::Resource
|
111
|
+
|
112
|
+
# Set up resource class and instance naming
|
113
|
+
resource_class :favorite_color
|
114
|
+
resource_name :object_id
|
115
|
+
|
116
|
+
remote_accessor :old_favorite
|
117
|
+
remote_accessor :favorite
|
118
|
+
|
119
|
+
# Update favorite color to anything except the currently-published
|
120
|
+
# favorite. Also save off the old favorite.
|
121
|
+
def update_favorite
|
122
|
+
colors = ['red', 'blue', 'green']
|
123
|
+
|
124
|
+
remote_attribute_modify(:old_favorite, :favorite) do |attribute, value|
|
125
|
+
# Value of block will become the new value of the given attribute.
|
126
|
+
if attribute == :old_favorite
|
127
|
+
# Make the old_favorite our current favorite
|
128
|
+
self.favorite
|
129
|
+
else
|
130
|
+
# Choose a new favorite
|
131
|
+
colors.delete(current_favorite)
|
132
|
+
colors.shuffle.first
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
136
|
+
|
137
|
+
The method `remote_attribute_modify` takes the attribute(s) to modify (as symbols) and a block. The block is
|
138
|
+
provided the attribute name and the current value of the attribute; the ending value of the block
|
139
|
+
becomes the new attribute value.
|
140
|
+
|
141
|
+
Rather than perform locking on an attribute (which would slow down *all* reads and writes), LiveResource performs *optimistic locking* thanks to features in Redis. If the value of the attribute changes while the `remote_attribute_modify` block is executing, LiveResource simply replays the block with the changed value. This preserves the performance of attribute read/write and eliminates potential deadlocks.
|
142
|
+
|
143
|
+
As a consequence, however, the **block passed to `remote_attribute_modify` should not change external state that relies on the block only executing once.**
|
144
|
+
|
145
|
+
## Methods
|
146
|
+
|
147
|
+
Attributes are good for publishing state information, but how do you
|
148
|
+
*interact* with a resource? LiveResource provides actor-like method
|
149
|
+
calling from one object to another. Like attributes, it works great
|
150
|
+
across processes and machines. An example:
|
151
|
+
|
152
|
+
#
|
153
|
+
# Running in process A
|
154
|
+
#
|
155
|
+
class MathResource
|
156
|
+
include LiveResource::Resource
|
157
|
+
|
158
|
+
remote_class :math
|
159
|
+
remote_name :object_id
|
160
|
+
|
161
|
+
def divide(dividend, divisor)
|
162
|
+
raise ArgumentError.new("cannot divide by zero") if divisor == 0
|
163
|
+
dividend / divisor
|
164
|
+
end
|
165
|
+
end
|
166
|
+
|
167
|
+
# Creating an instances starts its method dispatcher thread.
|
168
|
+
MathResource.new
|
169
|
+
sleep
|
170
|
+
|
171
|
+
#
|
172
|
+
# Running in processs B
|
173
|
+
#
|
174
|
+
m = LiveResource::any(:math)
|
175
|
+
m.divide(10, 5) # --> 2
|
176
|
+
m.divide(1, 0) # --> raises ArgumentError
|
177
|
+
|
178
|
+
The resource does not need to explicitly declare its remote methods;
|
179
|
+
any public methods are automatically remote-callable. (Methods of
|
180
|
+
superclasses, however, are not remoted.) When an instance is created,
|
181
|
+
a thread is also created to service remote method calls.
|
182
|
+
|
183
|
+
When you get a resource proxy (as in process B above) there are a
|
184
|
+
couple ways to call a remote method:
|
185
|
+
|
186
|
+
* Just call the method exactly as-is, like `divide(...)`, which blocks
|
187
|
+
the calling thread until the resource responds. If the resource's
|
188
|
+
method raises an exception, LiveResource's method dispatcher traps
|
189
|
+
the exception, serializes it, and the exception is raised in the
|
190
|
+
caller's thread.
|
191
|
+
|
192
|
+
* Call asynchronously in a fire-and-forget matter by adding an
|
193
|
+
exclamation point to the end of the method name, like
|
194
|
+
`divide!(...)`, with the downside of not being able to get a
|
195
|
+
response.
|
196
|
+
|
197
|
+
* Call asynchronously and get the return value later by adding a
|
198
|
+
question mark to the end of the method name, like `divide?(...)`,
|
199
|
+
which we'll discuss shortly.
|
200
|
+
|
201
|
+
### Call Method and Check Value Later
|
202
|
+
|
203
|
+
There are many times when blocking on a remote method isn't
|
204
|
+
acceptable. Continuing the above example, here's how to fire off the
|
205
|
+
method and come back for the result later:
|
206
|
+
|
207
|
+
m = LiveResource::any(:math)
|
208
|
+
m.divide?(10, 5)
|
209
|
+
# .. do something else ..
|
210
|
+
m.value # may block, then --> 2
|
211
|
+
|
212
|
+
m.divide?(15, 5)
|
213
|
+
m.done? # --> true or false
|
214
|
+
# .. time elapses ..
|
215
|
+
m.done? # --> true
|
216
|
+
m.value # will not block --> 3
|
217
|
+
|
218
|
+
m.divide?(20, 5)
|
219
|
+
m.value(10) # wait up to 10 seconds, then --> 4
|
220
|
+
|
221
|
+
The return value from question-mark form `method?` calls is a Future,
|
222
|
+
which allows both polling, blocking, and block-with-timeout
|
223
|
+
conventions.
|
224
|
+
|
225
|
+
### Forwarding Methods
|
226
|
+
|
227
|
+
TODO: needs documentation. In the meantime, refer to
|
228
|
+
`test/method_forward_continue_test.rb`.
|
229
|
+
|
230
|
+
## Configuring the Redis Client
|
231
|
+
|
232
|
+
LiveResource will try to connect to Redis at `localhost` and its
|
233
|
+
default port, 6379. If you need to change that, or any other client
|
234
|
+
parameters, just assign a new Redis client.
|
235
|
+
|
236
|
+
LiveResource::RedisClient.redis = Redis.new(hostname: 'machine-c.local')
|
237
|
+
|
238
|
+
## Missing LiveResource 1.x Features
|
239
|
+
|
240
|
+
Some features from 1.x have not been brought to 2.0 yet.
|
241
|
+
|
242
|
+
### Attribute Publish/Subscribe
|
243
|
+
|
244
|
+
NOTE: attribute pub/sub from LiveResource 1 is not currently supported
|
245
|
+
in LiveResource 2. It was never used within Spectra Logic, so it may
|
246
|
+
be dropped.
|
247
|
+
|
248
|
+
## To-Do
|
249
|
+
|
250
|
+
(This section is my to-do list for future versions of LiveResource. -jdc)
|
251
|
+
|
252
|
+
* More formally specify and test edge-case behaviors, for example:
|
253
|
+
|
254
|
+
- Getting/setting attributes that don't exist.
|
255
|
+
|
256
|
+
- Forward/continue with methods that fail, methods that time out
|
257
|
+
because no resource is available.
|
258
|
+
|
259
|
+
- Startup order problems with resources and clients of them. Any way
|
260
|
+
allow clients to wait and retry?
|
261
|
+
|
262
|
+
- Serialize exceptions in a less Ruby-specific manner.
|
263
|
+
|
264
|
+
- Merge exception backtrace properly. (ResourceProxy#wait_for_done)
|
265
|
+
|
266
|
+
* Benchmarking: try multiple redis clients
|
267
|
+
|
268
|
+
* Tools/Debugging:
|
269
|
+
|
270
|
+
- Text/graphical resource monitor/explorer
|
271
|
+
|
272
|
+
- Logging: allow runtime logging level changes (possibly via built-in remote method)
|
273
|
+
|
274
|
+
- Logging: syslog setup
|
275
|
+
|
276
|
+
* Finish rdoc, test to make sure it looks right.
|
277
|
+
|
278
|
+
## License / Copying
|
279
|
+
|
280
|
+
See the file `COPYING`.
|
281
|
+
|
282
|
+
## License / Copying
|
283
|
+
|
284
|
+
See the file `COPYING`.
|
285
|
+
|
286
|
+
## Contributors
|
287
|
+
|
288
|
+
LiveResource is brought to you by Josh Carter, Mark von Minden, and
|
289
|
+
Rob Grimm of Spectra Logic.
|