nats-pure 2.2.1 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +201 -0
  3. data/README.md +251 -0
  4. data/lib/nats/io/client.rb +215 -144
  5. data/lib/nats/io/errors.rb +6 -0
  6. data/lib/nats/io/jetstream/msg/ack_methods.rb +8 -4
  7. data/lib/nats/io/msg.rb +3 -1
  8. data/lib/nats/io/rails.rb +29 -0
  9. data/lib/nats/io/subscription.rb +70 -5
  10. data/lib/nats/io/version.rb +1 -1
  11. data/lib/nats/io/websocket.rb +75 -0
  12. data/sig/nats/io/client.rbs +304 -0
  13. data/sig/nats/io/errors.rbs +54 -0
  14. data/sig/nats/io/jetstream/api.rbs +35 -0
  15. data/sig/nats/io/jetstream/errors.rbs +54 -0
  16. data/sig/nats/io/jetstream/js/config.rbs +11 -0
  17. data/sig/nats/io/jetstream/js/header.rbs +17 -0
  18. data/sig/nats/io/jetstream/js/status.rbs +13 -0
  19. data/sig/nats/io/jetstream/js/sub.rbs +14 -0
  20. data/sig/nats/io/jetstream/js.rbs +27 -0
  21. data/sig/nats/io/jetstream/manager.rbs +33 -0
  22. data/sig/nats/io/jetstream/msg/ack.rbs +35 -0
  23. data/sig/nats/io/jetstream/msg/ack_methods.rbs +25 -0
  24. data/sig/nats/io/jetstream/msg/metadata.rbs +15 -0
  25. data/sig/nats/io/jetstream/msg.rbs +6 -0
  26. data/sig/nats/io/jetstream/pull_subscription.rbs +14 -0
  27. data/sig/nats/io/jetstream/push_subscription.rbs +7 -0
  28. data/sig/nats/io/jetstream.rbs +15 -0
  29. data/sig/nats/io/kv/api.rbs +8 -0
  30. data/sig/nats/io/kv/bucket_status.rbs +17 -0
  31. data/sig/nats/io/kv/errors.rbs +30 -0
  32. data/sig/nats/io/kv/manager.rbs +11 -0
  33. data/sig/nats/io/kv.rbs +39 -0
  34. data/sig/nats/io/msg.rbs +14 -0
  35. data/sig/nats/io/parser.rbs +32 -0
  36. data/sig/nats/io/subscription.rbs +33 -0
  37. data/sig/nats/io/version.rbs +9 -0
  38. data/sig/nats/nuid.rbs +32 -0
  39. metadata +49 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 21e90ec654ece66516fdfac7d16036695ea1afae5f76143e087c8f11564b2135
4
- data.tar.gz: 3c7644d2bb03f0a9b8fbc982e88a0ea1119d49ed79b849611209755e8b641437
3
+ metadata.gz: f963530316a2132bf59b1408a2d4e8393db94d429787c3d16c0317f8ff2fd555
4
+ data.tar.gz: 69f369b23184f5cdf53fd886019708cbe9559d69a30d9aa7e0ca6e6e80d37f56
5
5
  SHA512:
6
- metadata.gz: 06da3807dd934cd955a4dad34a44927b8885e99b5fe43a641ca7e95ddb8231132f837012d4052d3abac84c025bcc05941c8a2277ed224433f8fab16d7cd4c18e
7
- data.tar.gz: 12608f0a54fb270de3bda898e4ce2831c166b60b525717de450827e1840e15a5b2b9dd4cf80676490350effc48eb79a31656c46b4eed0af6cd21b264fb03deda
6
+ metadata.gz: 550f13d0ed5e3bbd3203a681c86aa0fce2d6d459bbe61f06722908fcac72922369d650eec270d5222b28ed335fd5b0acdbbd3ba8134ffe1d9de49bc82774afdd
7
+ data.tar.gz: ff2d22028e5af8d49ec88cd5018f485a054c3f638d2b0118bea4c7beb0f2fbb98277a0dac84c61673da3858a045b725a5ef1c02d68464c9a7fb4c4e44e24f4c3
data/LICENSE 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 [yyyy] [name of copyright owner]
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,251 @@
1
+ # NATS - Pure Ruby Client
2
+
3
+ A thread safe [Ruby](http://ruby-lang.org) client for the [NATS messaging system](https://nats.io) written in pure Ruby.
4
+
5
+ [![License Apache 2.0](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)[![Build Status](https://travis-ci.org/nats-io/nats-pure.rb.svg)](http://travis-ci.org/nats-io/nats-pure.rb)[![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=5&v=2.3.0)](https://rubygems.org/gems/nats-pure/versions/2.3.0)
6
+
7
+ ## Getting Started
8
+
9
+ ```bash
10
+ gem install nats-pure
11
+ ```
12
+
13
+ ## Basic Usage
14
+
15
+ ```ruby
16
+ require 'nats/client'
17
+
18
+ nats = NATS.connect("demo.nats.io")
19
+ puts "Connected to #{nats.connected_server}"
20
+
21
+ # Simple subscriber
22
+ nats.subscribe("foo.>") { |msg, reply, subject| puts "Received on '#{subject}': '#{msg}'" }
23
+
24
+ # Simple Publisher
25
+ nats.publish('foo.bar.baz', 'Hello World!')
26
+
27
+ # Unsubscribing
28
+ sub = nats.subscribe('bar') { |msg| puts "Received : '#{msg}'" }
29
+ sub.unsubscribe()
30
+
31
+ # Requests with a block handles replies asynchronously
32
+ nats.request('help', 'please', max: 5) { |response| puts "Got a response: '#{response}'" }
33
+
34
+ # Replies
35
+ sub = nats.subscribe('help') do |msg|
36
+ puts "Received on '#{msg.subject}': '#{msg.data}' with headers: #{msg.header}"
37
+ msg.respond("I'll help!")
38
+ end
39
+
40
+ # Request without a block waits for response or timeout
41
+ begin
42
+ msg = nats.request('help', 'please', timeout: 0.5)
43
+ puts "Received on '#{msg.subject}': #{msg.data}"
44
+ rescue NATS::Timeout
45
+ puts "nats: request timed out"
46
+ end
47
+
48
+ # Request using a message with headers
49
+ begin
50
+ msg = NATS::Msg.new(subject: "help", headers: {foo: 'bar'})
51
+ resp = nats.request_msg(msg)
52
+ puts "Received on '#{resp.subject}': #{resp.data}"
53
+ rescue NATS::Timeout => e
54
+ puts "nats: request timed out: #{e}"
55
+ end
56
+
57
+ # Server roundtrip which fails if it does not happen within 500ms
58
+ begin
59
+ nats.flush(0.5)
60
+ rescue NATS::Timeout
61
+ puts "nats: flush timeout"
62
+ end
63
+
64
+ # Closes connection to NATS
65
+ nats.close
66
+ ```
67
+
68
+ ## JetStream Usage
69
+
70
+ Introduced in v2.0.0 series, the client can now publish and receive messages from JetStream.
71
+
72
+ ```ruby
73
+ require 'nats/client'
74
+
75
+ nc = NATS.connect("nats://demo.nats.io:4222")
76
+ js = nc.jetstream
77
+
78
+ js.add_stream(name: "mystream", subjects: ["foo"])
79
+
80
+ Thread.new do
81
+ loop do
82
+ # Periodically publish messages
83
+ js.publish("foo", "Hello JetStream!")
84
+ sleep 0.1
85
+ end
86
+ end
87
+
88
+ psub = js.pull_subscribe("foo", "bar")
89
+
90
+ loop do
91
+ begin
92
+ msgs = psub.fetch(5)
93
+ msgs.each do |msg|
94
+ msg.ack
95
+ end
96
+ rescue NATS::IO::Timeout
97
+ puts "Retry later..."
98
+ end
99
+ end
100
+ ```
101
+
102
+ ## Clustered Usage
103
+
104
+ ```ruby
105
+ require 'nats/client'
106
+
107
+ cluster_opts = {
108
+ servers: ["nats://127.0.0.1:4222", "nats://127.0.0.1:4223"],
109
+ dont_randomize_servers: true,
110
+ reconnect_time_wait: 0.5,
111
+ max_reconnect_attempts: 2
112
+ }
113
+
114
+ nats = NATS.connect(cluster_opts)
115
+ puts "Connected to #{nats.connected_server}"
116
+
117
+
118
+ nats.on_error do |e|
119
+ puts "Error: #{e}"
120
+ end
121
+
122
+ nats.on_reconnect do
123
+ puts "Reconnected to server at #{nats.connected_server}"
124
+ end
125
+
126
+ nats.on_disconnect do
127
+ puts "Disconnected!"
128
+ end
129
+
130
+ nats.on_close do
131
+ puts "Connection to NATS closed"
132
+ end
133
+
134
+ nats.subscribe("hello") do |msg|
135
+ puts "#{Time.now} - Received: #{msg.data}"
136
+ end
137
+
138
+ n = 0
139
+ loop do
140
+ n += 1
141
+ nats.publish("hello", "world.#{n}")
142
+ sleep 0.1
143
+ end
144
+ ```
145
+
146
+ ## TLS
147
+
148
+ It is possible to setup a custom TLS connection to NATS by passing
149
+ an [OpenSSL](http://ruby-doc.org/stdlib-2.3.2/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html) context to the client to be used on connect:
150
+
151
+ ```ruby
152
+ tls_context = OpenSSL::SSL::SSLContext.new
153
+ tls_context.ssl_version = :TLSv1_2
154
+
155
+ NATS.connect({
156
+ servers: ['tls://127.0.0.1:4444'],
157
+ reconnect: false,
158
+ tls: {
159
+ context: tls_context
160
+ }
161
+ })
162
+ ```
163
+
164
+ ## WebSocket
165
+
166
+ Since NATS Server v2.2 it is possible to connect to a NATS server [using WebSocket](https://docs.nats.io/running-a-nats-service/configuration/websocket).
167
+
168
+ 1. Add a [`websocket`](https://github.com/imanel/websocket-ruby) gem to your Gemfile:
169
+
170
+ ```ruby
171
+ # Gemfile
172
+ gem 'websocket'
173
+ ```
174
+
175
+ 2. Connect to WebSocket-enabled NATS Server using `ws` or `wss` protocol in URLs (for plain and secure connection respectively):
176
+
177
+ ```ruby
178
+ nats = NATS.connect("wss://demo.nats.io:8443")
179
+ ```
180
+
181
+ 3. Use NATS as usual.
182
+
183
+ ### NKEYS and JWT User Credentials
184
+
185
+ This requires server with version >= 2.0.0
186
+
187
+ Starting from [v0.6.0](https://github.com/nats-io/nats-pure.rb/releases/tag/v0.6.0) release of the client,
188
+ you can also optionally install [NKEYS](https://github.com/nats-io/nkeys.rb) in order to use
189
+ the new NATS v2.0 auth features:
190
+
191
+ ```bash
192
+ gem install nkeys
193
+ ```
194
+
195
+ NATS servers have a new security and authentication mechanism to authenticate with user credentials and NKEYS. A single file containing the JWT and NKEYS to authenticate against a NATS v2 server can be set with the `user_credentials` option:
196
+
197
+ ```ruby
198
+ NATS.connect("tls://connect.ngs.global", user_credentials: "/path/to/creds")
199
+ ```
200
+
201
+ This will create two callback handlers to present the user JWT and sign the nonce challenge from the server. The core client library never has direct access to your private key and simply performs the callback for signing the server challenge. The library will load and wipe and clear the objects it uses for each connect or reconnect.
202
+
203
+ Bare NKEYS are also supported. The nkey seed should be in a read only file, e.g. `seed.txt`.
204
+
205
+ ```bash
206
+ > cat seed.txt
207
+ # This is my seed nkey!
208
+ SUAGMJH5XLGZKQQWAWKRZJIGMOU4HPFUYLXJMXOO5NLFEO2OOQJ5LPRDPM
209
+ ```
210
+
211
+ Then in the client specify the path to the seed using the `nkeys_seed` option:
212
+
213
+ ```ruby
214
+ NATS.connect("tls://connect.ngs.global", nkeys_seed: "path/to/seed.txt")
215
+ ```
216
+
217
+ ### Cluster Server Discovery
218
+
219
+ By default, when you connect to a NATS server that's in a cluster,
220
+ the client will take information about servers it doesn't know about yet.
221
+ This can be disabled at connection time:
222
+
223
+ ```ruby
224
+ NATS.connect(servers: ['nats://127.0.0.1:4444'], ignore_discovered_urls: true)
225
+ ```
226
+
227
+ ### Ractor Usage
228
+
229
+ Using NATS within a Ractor requires URI 0.11.0 or greater to be installed.
230
+
231
+ ```ruby
232
+ Ractor.new do
233
+ ractor_nats = NATS.connect('demo.nats.io')
234
+
235
+ ractor_nats.subscribe('foo') do |msg, reply|
236
+ puts "Received on '#{msg.subject}': '#{msg.data}' with headers: #{msg.header}"
237
+ ractor_nats.publish(reply, 'baz')
238
+ end
239
+
240
+ sleep
241
+ end
242
+
243
+ nats = NATS.connect('demo.nats.io')
244
+ response = nats.request('foo', 'bar', timeout: 0.5)
245
+ puts response.data
246
+ ```
247
+
248
+ ## License
249
+
250
+ Unless otherwise noted, the NATS source files are distributed under
251
+ the Apache Version 2.0 license found in the LICENSE file.