ruby_skynet 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/Gemfile ADDED
@@ -0,0 +1,13 @@
1
+ source :rubygems
2
+
3
+ group :test do
4
+ gem "shoulda"
5
+ end
6
+
7
+ gem "semantic_logger"
8
+ gem "resilient_socket"
9
+ # For looking up Service entries in Doozer
10
+ gem "multi_json"
11
+ # Wire format when communicating with services
12
+ gem "bson"
13
+ gem "bson_ext", :platform => :ruby
data/Gemfile.lock ADDED
@@ -0,0 +1,49 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ activesupport (3.2.8)
5
+ i18n (~> 0.6)
6
+ multi_json (~> 1.0)
7
+ beefcake (0.3.7)
8
+ bouncy-castle-java (1.5.0146.1)
9
+ bson (1.7.0)
10
+ bson (1.7.0-java)
11
+ bson_ext (1.7.0)
12
+ bson (~> 1.7.0)
13
+ eventmachine (1.0.0)
14
+ eventmachine (1.0.0-java)
15
+ fraggle (4.0.1)
16
+ beefcake (~> 0.3)
17
+ eventmachine
18
+ gene_pool (1.3.0)
19
+ i18n (0.6.1)
20
+ jruby-openssl (0.7.7)
21
+ bouncy-castle-java (>= 1.5.0146.1)
22
+ multi_json (1.3.6)
23
+ rake (0.9.2.2)
24
+ resilient_socket (0.0.2)
25
+ semantic_logger
26
+ semantic_logger (0.6.2)
27
+ sync_attr
28
+ shoulda (3.1.1)
29
+ shoulda-context (~> 1.0)
30
+ shoulda-matchers (~> 1.2)
31
+ shoulda-context (1.0.0)
32
+ shoulda-matchers (1.3.0)
33
+ activesupport (>= 3.0.0)
34
+ sync_attr (0.1.1)
35
+
36
+ PLATFORMS
37
+ java
38
+ ruby
39
+
40
+ DEPENDENCIES
41
+ bson
42
+ bson_ext
43
+ fraggle
44
+ gene_pool
45
+ jruby-openssl
46
+ rake
47
+ resilient_socket
48
+ semantic_logger
49
+ shoulda
data/LICENSE.txt ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2012 Clarity Services, Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,119 @@
1
+ ruby_skynet
2
+ ===========
3
+
4
+ Ruby Client for calling [Skynet](https://github.com/bketelsen/skynet) services.
5
+ Will also implement the server side so that [Skynet](https://github.com/bketelsen/skynet) Services can be hosted in Ruby
6
+
7
+ * http://github.com/ClarityServices/ruby_skynet
8
+
9
+ ### Example
10
+
11
+ ```ruby
12
+ require 'rubygems'
13
+ require 'ruby_skynet'
14
+ RubySkynet::Client.connect('TutorialService') do |tutorial_service|
15
+ p tutorial_service.call('AddOne', 'value' => 5)
16
+ end
17
+ ```
18
+
19
+ For details on installing and running the Tutorial Service:
20
+
21
+ ### Logging
22
+
23
+ Since ruby_skynet uses SemanticLogger, trace level logging of all TCP/IP
24
+ calls can be enabled as follows:
25
+
26
+ ```ruby
27
+ require 'rubygems'
28
+ require 'ruby_skynet'
29
+ SemanticLogger::Logger.default_level = :trace
30
+ SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new('skynet.log')
31
+
32
+ RubySkynet::Client.connect('TutorialService') do |tutorial_service|
33
+ p tutorial_service.call('AddOne', 'value' => 5)
34
+ end
35
+ ```
36
+
37
+ ### Architecture
38
+
39
+ ruby_skynet implements its own doozer client which has been tested against
40
+ the doozer fork: https://github.com/4ad/doozerd.
41
+ The doozer client uses the active ruby_protobuf project for marshaling data
42
+ for communicating with doozer
43
+
44
+ ### Dependencies
45
+
46
+ - Ruby MRI 1.8.7 (or above), Ruby 1.9.3, Or JRuby 1.6.3 (or above)
47
+ - [SemanticLogger](http://github.com/ClarityServices/semantic-logger)
48
+ - [ResilientSocket](http://github.com/ClarityServices/ruby_skynet)
49
+ - [ruby_protobuf](https://github.com/macks/ruby-protobuf)
50
+ - [multi_json](https://github.com/intridea/multi_json)
51
+
52
+ ### Install
53
+
54
+ gem install ruby_skynet
55
+
56
+ ### Future
57
+
58
+ * Implement Skynet Service in Ruby so that it can be called from Go lang, etc.
59
+ * Immediately drop connections to a service on a host when that instance
60
+ shuts down or stops. ( Doozer::Wait )
61
+ * More intelligent selection of available Skynet services. For example
62
+ nearest, or looking at load etc.
63
+
64
+ Development
65
+ -----------
66
+
67
+ Want to contribute to Resilient Socket?
68
+
69
+ First clone the repo and run the tests:
70
+
71
+ git clone git://github.com/ClarityServices/ruby_skynet.git
72
+ cd ruby_skynet
73
+ jruby -S rake test
74
+
75
+ Feel free to ping the mailing list with any issues and we'll try to resolve it.
76
+
77
+ Contributing
78
+ ------------
79
+
80
+ Once you've made your great commits:
81
+
82
+ 1. [Fork](http://help.github.com/forking/) ruby_skynet
83
+ 2. Create a topic branch - `git checkout -b my_branch`
84
+ 3. Push to your branch - `git push origin my_branch`
85
+ 4. Create an [Issue](http://github.com/ClarityServices/ruby_skynet/issues) with a link to your branch
86
+ 5. That's it!
87
+
88
+ Meta
89
+ ----
90
+
91
+ * Code: `git clone git://github.com/ClarityServices/ruby_skynet.git`
92
+ * Home: <https://github.com/ClarityServices/ruby_skynet>
93
+ * Docs: TODO <http://ClarityServices.github.com/ruby_skynet/>
94
+ * Bugs: <http://github.com/reidmorrison/ruby_skynet/issues>
95
+ * Gems: <http://rubygems.org/gems/ruby_skynet>
96
+
97
+ This project uses [Semantic Versioning](http://semver.org/).
98
+
99
+ Authors
100
+ -------
101
+
102
+ Reid Morrison :: reidmo@gmail.com :: @reidmorrison
103
+
104
+ License
105
+ -------
106
+
107
+ Copyright 2012 Clarity Services, Inc.
108
+
109
+ Licensed under the Apache License, Version 2.0 (the "License");
110
+ you may not use this file except in compliance with the License.
111
+ You may obtain a copy of the License at
112
+
113
+ http://www.apache.org/licenses/LICENSE-2.0
114
+
115
+ Unless required by applicable law or agreed to in writing, software
116
+ distributed under the License is distributed on an "AS IS" BASIS,
117
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
118
+ See the License for the specific language governing permissions and
119
+ limitations under the License.
data/Rakefile ADDED
@@ -0,0 +1,40 @@
1
+ lib = File.expand_path('../lib/', __FILE__)
2
+ $:.unshift lib unless $:.include?(lib)
3
+
4
+ require 'rubygems'
5
+ require 'rake/clean'
6
+ require 'rake/testtask'
7
+ require 'date'
8
+ require 'ruby_skynet/version'
9
+
10
+ desc "Build gem"
11
+ task :gem do |t|
12
+ gemspec = Gem::Specification.new do |spec|
13
+ spec.name = 'ruby_skynet'
14
+ spec.version = RubySkynet::VERSION
15
+ spec.platform = Gem::Platform::RUBY
16
+ spec.authors = ['Reid Morrison']
17
+ spec.email = ['reidmo@gmail.com']
18
+ spec.homepage = 'https://github.com/ClarityServices/ruby_skynet'
19
+ spec.date = Date.today.to_s
20
+ spec.summary = "Skynet Ruby Client"
21
+ spec.description = "Ruby Client for invoking Skynet services"
22
+ spec.files = FileList["./**/*"].exclude('*.gem', 'nbproject').map{|f| f.sub(/^\.\//, '')}
23
+ spec.has_rdoc = true
24
+ spec.add_dependency 'semantic_logger'
25
+ spec.add_dependency 'resilient_socket'
26
+ spec.add_dependency 'multi_json'
27
+ spec.add_dependency 'bson'
28
+ end
29
+ Gem::Builder.new(gemspec).build
30
+ end
31
+
32
+ desc "Run Test Suite"
33
+ task :test do
34
+ Rake::TestTask.new(:functional) do |t|
35
+ t.test_files = FileList['test/*_test.rb']
36
+ t.verbose = true
37
+ end
38
+
39
+ Rake::Task['functional'].invoke
40
+ end