server_sent_events 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.rubocop.yml +26 -0
- data/.simplecov +3 -0
- data/.travis.yml +11 -0
- data/.yardopts +3 -0
- data/Gemfile +6 -0
- data/LICENSE +177 -0
- data/README.md +49 -0
- data/Rakefile +6 -0
- data/bin/console +7 -0
- data/bin/setup +8 -0
- data/lib/server_sent_events.rb +21 -0
- data/lib/server_sent_events/client.rb +45 -0
- data/lib/server_sent_events/event.rb +58 -0
- data/lib/server_sent_events/parser.rb +79 -0
- data/lib/server_sent_events/version.rb +5 -0
- data/server_sent_events.gemspec +38 -0
- metadata +161 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: d2a14d5579c3aa4589a9cadba9949cad5ffe9c99
|
|
4
|
+
data.tar.gz: c199ba41ee2efdc438e970daecfb61d38d8e344d
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 53122ce14c14aac45f9cf44012c412eeac994cb721affe72b263895ca63d288c5f106740528499cf099314b138fcf74b45dff0b14a4ce4a972908e1c1d8c5af8
|
|
7
|
+
data.tar.gz: 9f3cc292fb00a173f0f35aa3af7babd3b45783a427dc4238bf072f41c6bb4673672d26fc5084d18c45ad00c4ae8bf4905ebeb80a2dab4a600c425227dca9af06
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
AllCops:
|
|
2
|
+
TargetRubyVersion: 2.3
|
|
3
|
+
Exclude:
|
|
4
|
+
- server_sent_events.gemspec
|
|
5
|
+
- Gemfile
|
|
6
|
+
- Rakefile
|
|
7
|
+
- bin/**
|
|
8
|
+
|
|
9
|
+
Layout/MultilineOperationIndentation:
|
|
10
|
+
EnforcedStyle: indented
|
|
11
|
+
|
|
12
|
+
Style/StringLiterals:
|
|
13
|
+
EnforcedStyle: double_quotes
|
|
14
|
+
|
|
15
|
+
Style/Documentation:
|
|
16
|
+
Enabled: false
|
|
17
|
+
|
|
18
|
+
Style/BracesAroundHashParameters:
|
|
19
|
+
EnforcedStyle: context_dependent
|
|
20
|
+
|
|
21
|
+
Metrics/AbcSize:
|
|
22
|
+
Max: 20
|
|
23
|
+
|
|
24
|
+
Metrics/BlockLength:
|
|
25
|
+
Exclude:
|
|
26
|
+
- spec/**/*.rb
|
data/.simplecov
ADDED
data/.travis.yml
ADDED
data/.yardopts
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
data/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Ruby library for using server-sent events
|
|
2
|
+
|
|
3
|
+
This repository contains server_sent_events gem sources.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
Add this line to your application's Gemfile:
|
|
9
|
+
|
|
10
|
+
gem "server_sent_events"
|
|
11
|
+
|
|
12
|
+
And then execute:
|
|
13
|
+
|
|
14
|
+
$ bundle
|
|
15
|
+
|
|
16
|
+
Or install it yourself as:
|
|
17
|
+
|
|
18
|
+
$ gem install server_sent_events
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
Minimal program that listens to server events and simply prints them to
|
|
24
|
+
console would look something like this:
|
|
25
|
+
|
|
26
|
+
require "server_sent_events"
|
|
27
|
+
|
|
28
|
+
ServerSentEvents.listen("http://127.0.0.1:8001") do |event|
|
|
29
|
+
puts event
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## Development
|
|
34
|
+
|
|
35
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then,
|
|
36
|
+
run `rake spec` to run the tests. You can also run `bin/console` for an
|
|
37
|
+
interactive prompt that will allow you to experiment.
|
|
38
|
+
|
|
39
|
+
To install this gem onto your local machine, run `bundle exec rake install`.
|
|
40
|
+
To release a new version, update the version number in `version.rb`, and then
|
|
41
|
+
run `bundle exec rake release`, which will create a git tag for the version,
|
|
42
|
+
push git commits and tags, and push the `.gem` file to
|
|
43
|
+
[rubygems.org](https://rubygems.org).
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
## Contributing
|
|
47
|
+
|
|
48
|
+
Bug reports and pull requests are welcome on GitHub at
|
|
49
|
+
https://github.com/xlab-si/server-sent-events-ruby.
|
data/Rakefile
ADDED
data/bin/console
ADDED
data/bin/setup
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "uri"
|
|
4
|
+
|
|
5
|
+
require "server_sent_events/version"
|
|
6
|
+
require "server_sent_events/client"
|
|
7
|
+
require "server_sent_events/parser"
|
|
8
|
+
|
|
9
|
+
module ServerSentEvents
|
|
10
|
+
# Convenience method go the up-and running fast.
|
|
11
|
+
#
|
|
12
|
+
# In order to start listening to server events, this is all the code that we
|
|
13
|
+
# need:
|
|
14
|
+
#
|
|
15
|
+
# ServerSentEvents.listen("http://example.com") do |event|
|
|
16
|
+
# puts event
|
|
17
|
+
# end
|
|
18
|
+
def self.listen(address, headers = {}, &callback)
|
|
19
|
+
Client.new(URI(address), Parser.new, headers).listen(&callback)
|
|
20
|
+
end
|
|
21
|
+
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "net/http"
|
|
4
|
+
|
|
5
|
+
require "server_sent_events/event"
|
|
6
|
+
|
|
7
|
+
module ServerSentEvents
|
|
8
|
+
# Client is a class whose responsibility is to stream the response data from
|
|
9
|
+
# the server, feed that data into parser and call user supplied block when
|
|
10
|
+
# events are detected.
|
|
11
|
+
class Client
|
|
12
|
+
# Create new SSE client.
|
|
13
|
+
#
|
|
14
|
+
# Note that creating new client does not establish connection to the
|
|
15
|
+
# server. Connection is established by the {#listen} call and torn down
|
|
16
|
+
# automatically when {#listen returns}.
|
|
17
|
+
#
|
|
18
|
+
# @param address [URI] endpoint to connect to
|
|
19
|
+
# @param parser [Parser] object that should be used to parse incoming data
|
|
20
|
+
# @param headers [Hash] additional headers that should be added to request
|
|
21
|
+
def initialize(address, parser, headers = {})
|
|
22
|
+
@address = address
|
|
23
|
+
@headers = headers
|
|
24
|
+
@parser = parser
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Listen for events from the server.
|
|
28
|
+
#
|
|
29
|
+
# To perform some action when event arrives, specify a block that gets
|
|
30
|
+
# executed eact time new event is availble like this:
|
|
31
|
+
#
|
|
32
|
+
# client.listen { |e| puts e }
|
|
33
|
+
def listen
|
|
34
|
+
Net::HTTP.start(@address.host, @address.port) do |http|
|
|
35
|
+
# TODO(@tadeboro): Add support for adding custom headers (auth)
|
|
36
|
+
http.request(Net::HTTP::Get.new(@address)) do |response|
|
|
37
|
+
# TODO(@tadeboro): Handle non-200 here
|
|
38
|
+
response.read_body do |chunk|
|
|
39
|
+
@parser.push(chunk).each { |e| yield(e) }
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module ServerSentEvents
|
|
4
|
+
# Class that represents server event.
|
|
5
|
+
#
|
|
6
|
+
# This class can be used to construct new events on the server and then
|
|
7
|
+
# serialize them for the transfer or is returned as a result of {Parser}
|
|
8
|
+
# action on the client.
|
|
9
|
+
class Event
|
|
10
|
+
attr_reader :id, :event, :data
|
|
11
|
+
|
|
12
|
+
def initialize
|
|
13
|
+
@data = ""
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
# Set event key-value pair.
|
|
17
|
+
#
|
|
18
|
+
# Note that the only valid keys are `id`, `event` and `data`, last one
|
|
19
|
+
# being a bit special. Calling `set("data", "some data")` will **apend**
|
|
20
|
+
# this the string `some data` to existing data using newline as a
|
|
21
|
+
# separator.
|
|
22
|
+
#
|
|
23
|
+
# @param key [String] key to use
|
|
24
|
+
# @param value [String] data to set/append
|
|
25
|
+
def set(key, value)
|
|
26
|
+
case key
|
|
27
|
+
when "id" then @id = value
|
|
28
|
+
when "event" then @event = value
|
|
29
|
+
when "data" then append_data(value)
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Serialize event into form for transmission.
|
|
34
|
+
#
|
|
35
|
+
# Output of this method call can be written directly into the socket.
|
|
36
|
+
def to_s
|
|
37
|
+
repr = ""
|
|
38
|
+
repr += "id: #{id}\n" if id
|
|
39
|
+
repr += "event: #{event}\n" if event
|
|
40
|
+
if data.empty?
|
|
41
|
+
repr += "data: \n"
|
|
42
|
+
else
|
|
43
|
+
data.split("\n").each { |l| repr += "data: #{l}\n" }
|
|
44
|
+
end
|
|
45
|
+
repr += "\n"
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def ==(other)
|
|
49
|
+
other.id == id && other.event == event && other.data == data
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
private
|
|
53
|
+
|
|
54
|
+
def append_data(chunk)
|
|
55
|
+
@data = @data.empty? ? chunk : "#{@data}\n#{chunk}"
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "server_sent_events/event"
|
|
4
|
+
|
|
5
|
+
module ServerSentEvents
|
|
6
|
+
# Instances of this class can be used to parse incoming data into {Event}s.
|
|
7
|
+
# This class is most commonly used by the {Client} to convert data from the
|
|
8
|
+
# server into series of events.
|
|
9
|
+
#
|
|
10
|
+
# This parser strictly follows the parsing and interpreting parts of the
|
|
11
|
+
# [html spec][spec].
|
|
12
|
+
#
|
|
13
|
+
# [spec]: https://html.spec.whatwg.org/multipage/server-sent-events.html
|
|
14
|
+
#
|
|
15
|
+
# To use the parser, simply create new instance and feed it data using
|
|
16
|
+
# {#push} method:
|
|
17
|
+
#
|
|
18
|
+
# parser = Parser.new
|
|
19
|
+
# loop do
|
|
20
|
+
# parser.push(get_data_from_somewhere).each do |event|
|
|
21
|
+
# do_something_with(event)
|
|
22
|
+
# end
|
|
23
|
+
# end
|
|
24
|
+
class Parser
|
|
25
|
+
LINE_DELIMITER = /\r\n|\r|\n/
|
|
26
|
+
|
|
27
|
+
def initialize
|
|
28
|
+
@buffer = ""
|
|
29
|
+
@event = Event.new
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Add new data to parser.
|
|
33
|
+
#
|
|
34
|
+
# Newly pushed data is added to any remaining data from previous calls,
|
|
35
|
+
# which is then checked for any complete events that are returned.
|
|
36
|
+
#
|
|
37
|
+
# Note that push can generate zero, one or more events, depending on data
|
|
38
|
+
# from previous runs and currently passed-in data. After the call returns,
|
|
39
|
+
# all complete events are returned (internal buffer contains only
|
|
40
|
+
# incomplete event or is empty).
|
|
41
|
+
#
|
|
42
|
+
# @return [Array<Event>] complete events
|
|
43
|
+
def push(data)
|
|
44
|
+
@buffer += data
|
|
45
|
+
process_buffer
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
private
|
|
49
|
+
|
|
50
|
+
def process_buffer
|
|
51
|
+
events = []
|
|
52
|
+
start = 0
|
|
53
|
+
while (index = @buffer.index(LINE_DELIMITER, start))
|
|
54
|
+
event = process_buffer_line(@buffer[start...index])
|
|
55
|
+
events << event if event
|
|
56
|
+
start = index + (@buffer[index, 2] == "\r\n" ? 2 : 1)
|
|
57
|
+
end
|
|
58
|
+
@buffer = @buffer.slice(start..-1)
|
|
59
|
+
events
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def process_buffer_line(line)
|
|
63
|
+
return emit_event if line.empty?
|
|
64
|
+
return nil if line[0] == ":"
|
|
65
|
+
|
|
66
|
+
key, value = line.split(":", 2)
|
|
67
|
+
value = "" if value.nil?
|
|
68
|
+
value = value.slice(1..-1) if value[0] == " "
|
|
69
|
+
@event.set(key, value)
|
|
70
|
+
nil
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
def emit_event
|
|
74
|
+
e = @event
|
|
75
|
+
@event = Event.new
|
|
76
|
+
e
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
3
|
+
require "server_sent_events/version"
|
|
4
|
+
|
|
5
|
+
Gem::Specification.new do |spec|
|
|
6
|
+
spec.name = "server_sent_events"
|
|
7
|
+
spec.version = ServerSentEvents::VERSION
|
|
8
|
+
spec.authors = ["Tadej Borovšak"]
|
|
9
|
+
spec.email = ["tadej.borovsak@xlab.si"]
|
|
10
|
+
|
|
11
|
+
spec.summary = "Library for dealing with server-sent events"
|
|
12
|
+
spec.homepage = "https://github.com/xlab-si/server-sent-events-ruby"
|
|
13
|
+
spec.license = "Apache-2.0"
|
|
14
|
+
|
|
15
|
+
if spec.respond_to?(:metadata)
|
|
16
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
|
17
|
+
else
|
|
18
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
|
19
|
+
"public gem pushes."
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
23
|
+
f.match(%r{^(test|spec|features)/})
|
|
24
|
+
end
|
|
25
|
+
spec.bindir = "exe"
|
|
26
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
|
27
|
+
spec.require_paths = ["lib"]
|
|
28
|
+
|
|
29
|
+
spec.required_ruby_version = "~> 2.1"
|
|
30
|
+
|
|
31
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
|
32
|
+
spec.add_development_dependency "pry", "~> 0.11.3"
|
|
33
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
|
34
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
|
35
|
+
spec.add_development_dependency "rubocop", "~> 0.59.1"
|
|
36
|
+
spec.add_development_dependency "simplecov", "~> 0.16.1"
|
|
37
|
+
spec.add_development_dependency "yard", "~> 0.9.16"
|
|
38
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: server_sent_events
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Tadej Borovšak
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: exe
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2018-09-22 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: bundler
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '1.16'
|
|
20
|
+
type: :development
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '1.16'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: pry
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: 0.11.3
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: 0.11.3
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: rake
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '10.0'
|
|
48
|
+
type: :development
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '10.0'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: rspec
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '3.0'
|
|
62
|
+
type: :development
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '3.0'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: rubocop
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: 0.59.1
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: 0.59.1
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: simplecov
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: 0.16.1
|
|
90
|
+
type: :development
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: 0.16.1
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: yard
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: 0.9.16
|
|
104
|
+
type: :development
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - "~>"
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: 0.9.16
|
|
111
|
+
description:
|
|
112
|
+
email:
|
|
113
|
+
- tadej.borovsak@xlab.si
|
|
114
|
+
executables: []
|
|
115
|
+
extensions: []
|
|
116
|
+
extra_rdoc_files: []
|
|
117
|
+
files:
|
|
118
|
+
- ".gitignore"
|
|
119
|
+
- ".rspec"
|
|
120
|
+
- ".rubocop.yml"
|
|
121
|
+
- ".simplecov"
|
|
122
|
+
- ".travis.yml"
|
|
123
|
+
- ".yardopts"
|
|
124
|
+
- Gemfile
|
|
125
|
+
- LICENSE
|
|
126
|
+
- README.md
|
|
127
|
+
- Rakefile
|
|
128
|
+
- bin/console
|
|
129
|
+
- bin/setup
|
|
130
|
+
- lib/server_sent_events.rb
|
|
131
|
+
- lib/server_sent_events/client.rb
|
|
132
|
+
- lib/server_sent_events/event.rb
|
|
133
|
+
- lib/server_sent_events/parser.rb
|
|
134
|
+
- lib/server_sent_events/version.rb
|
|
135
|
+
- server_sent_events.gemspec
|
|
136
|
+
homepage: https://github.com/xlab-si/server-sent-events-ruby
|
|
137
|
+
licenses:
|
|
138
|
+
- Apache-2.0
|
|
139
|
+
metadata:
|
|
140
|
+
allowed_push_host: https://rubygems.org
|
|
141
|
+
post_install_message:
|
|
142
|
+
rdoc_options: []
|
|
143
|
+
require_paths:
|
|
144
|
+
- lib
|
|
145
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
146
|
+
requirements:
|
|
147
|
+
- - "~>"
|
|
148
|
+
- !ruby/object:Gem::Version
|
|
149
|
+
version: '2.1'
|
|
150
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
151
|
+
requirements:
|
|
152
|
+
- - ">="
|
|
153
|
+
- !ruby/object:Gem::Version
|
|
154
|
+
version: '0'
|
|
155
|
+
requirements: []
|
|
156
|
+
rubyforge_project:
|
|
157
|
+
rubygems_version: 2.5.2.2
|
|
158
|
+
signing_key:
|
|
159
|
+
specification_version: 4
|
|
160
|
+
summary: Library for dealing with server-sent events
|
|
161
|
+
test_files: []
|