event_stream_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 498814773bcffd664024e918c1f94e32393e6b8af266fe88084cadb4cd8c86d7
+  data.tar.gz: da45b31afcb41e23bb2fb4dbde9d0c5ed173d8fb8ac0759464129528b19e49bd
+SHA512:
+  metadata.gz: 2123d8df807cb4cb1a3f1981f3bd3d59eec2393579d4c41bc7a4f597be6f827e285ef8cffb37abfd12d9266e69febe5be09ad79f7dff53ef288c950ffc077603
+  data.tar.gz: dbadc0f0bc184c0d08f8e6466f4384ce51baf25da1d97bbc90ba75a0d92f3a48468dc82882015f82d17d5f047d64625ddffe8897a51dd7b8e972a19b3d585fbb

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# event_stream_parser
+
+A lightweight, fully spec-compliant parser for the
+[event stream](https://www.w3.org/TR/eventsource/) format.
+
+It only deals with the parsing of events and not any of the client/transport
+aspects. This is not a Server-sent Events (SSE) client.
+
+Under the hood, it's a stateful parser that receives chunks (that are received
+from an HTTP client, for example) and emits events as it parses them. But it
+remembers the last event id and reconnection time and keeps emitting them as
+long as they are not overwritten by new ones.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'event_stream_parser'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install event_stream_parser
+```
+
+## Usage
+
+Create a new Parser and give it a block to receive events:
+
+```rb
+parser = EventStreamParser::Parser.new
+
+parser.feed do |type, data, id, reconnection_time|
+  puts "Event type: #{type}"
+  puts "Event data: #{data}"
+  puts "Event id: #{id}"
+  puts "Reconnection time: #{reconnection_time}"
+end
+```
+
+Then, feed it chunks as they come in:
+
+```rb
+do_something_that_yields_chunks do { |chunk| parser.feed(chunk) }
+```
+
+Or use the `stream` method to generate a proc that you can pass to a chunk
+producer:
+
+```rb
+parser_stream = parser.stream do |type, data, id, reconnection_time|
+  puts "Event type: #{type}"
+  puts "Event data: #{data}"
+  puts "Event id: #{id}"
+  puts "Reconnection time: #{reconnection_time}"
+end
+
+do_something_that_yields_chunks(&parser_stream)
+```
+
+## Development
+
+After checking out the repo:
+
+1. Run `bundle` to install dependencies.
+2. Run `rake test` to run the tests.
+3. Run `rubocop` to run Rubocop.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/Shopify/event_stream_parser. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Read more about contributing [here](https://github.com/Shopify/event_stream_parser/blob/main/CONTRIBUTING.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in this repository is expected to follow the
+[Code of Conduct](https://github.com/Shopify/event_stream_parser/blob/main/CODE_OF_CONDUCT.md).

data/lib/event_stream_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EventStreamParser
+  VERSION = "0.1.0"
+end

data/lib/event_stream_parser.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+require "event_stream_parser/version"
+
+module EventStreamParser
+  ##
+  # Implements a spec-compliant event stream parser, following:
+  #
+  # https://html.spec.whatwg.org/multipage/server-sent-events.html
+  # Section: 9.2.6 Interpreting an event stream
+  #
+  # Code comments are copied from the spec.
+  #
+  class Parser
+    UTF_8_BOM = [0xEF, 0xBB, 0xBF].pack("C*").force_encoding("UTF-8").freeze
+
+    def initialize
+      ##
+      # When a stream is parsed, a data buffer, an event type buffer, and a last
+      # event ID buffer must be associated with it. They must be initialized to
+      # the empty string.
+      #
+      @data_buffer = +""
+      @event_type_buffer = +""
+      @last_event_id_buffer = +""
+
+      @reconnection_time = nil
+      @buffer = +""
+      @first_chunk = true
+      @last_delimiter = nil
+    end
+
+    def feed(chunk, &proc)
+      ##
+      # The UTF-8 decode algorithm strips one leading UTF-8 Byte Order Mark (BOM),
+      # if any.
+      #
+      if @first_chunk
+        chunk = chunk.delete_prefix(UTF_8_BOM)
+        @first_chunk = false
+      end
+
+      @buffer << chunk
+
+      ##
+      # The stream must then be parsed by reading everything line by line, with a
+      # U+000D CARRIAGE RETURN U+000A LINE FEED (CRLF) character pair, a single
+      # U+000A LINE FEED (LF) character not preceded by a U+000D CARRIAGE RETURN
+      # (CR) character, and a single U+000D CARRIAGE RETURN (CR) character not
+      # followed by a U+000A LINE FEED (LF) character being the ways in which a
+      # line can end.
+      #
+      if @last_delimiter == "\r"
+        @buffer.delete_prefix!("\n")
+      end
+
+      while (line = @buffer.slice!(/.*?(?<delim>\r\n|\r|\n)/))
+        line.chomp!
+        @last_delimiter = $~[:delim]
+        process_line(line, &proc)
+      end
+      ##
+      # Once the end of the file is reached, any pending data must be discarded.
+      # (If the file ends in the middle of an event, before the final empty line,
+      # the incomplete event is not dispatched.)
+      #
+    end
+
+    def stream
+      proc { |chunk| feed(chunk) { |*args| yield(*args) } }
+    end
+
+    private
+
+    def process_line(line, &proc)
+      ##
+      # Lines must be processed, in the order they are received, as follows:
+      #
+      case line
+      ##
+      # If the line is empty (a blank line)
+      #
+      when ""
+        ##
+        # Dispatch the event, as defined below.
+        #
+        dispatch_event(&proc)
+      ##
+      # If the line starts with a U+003A COLON character (:)
+      #
+      when /^:/
+        ##
+        # Ignore the line.
+        #
+        ignore
+      ##
+      # If the line contains a U+003A COLON character (:)
+      #
+      # Collect the characters on the line before the first U+003A COLON character
+      # (:), and let field be that string.
+      #
+      # Collect the characters on the line after the first U+003A COLON character
+      # (:), and let value be that string. If value starts with a U+0020 SPACE
+      # character, remove it from value.
+      #
+      when /\A(?<field>[^:]+):\s?(?<value>.*)\z/
+        ##
+        # Process the field using the steps described below, using field as the
+        # field name and value as the field value.
+        #
+        process_field($~[:field], $~[:value])
+      ##
+      # Otherwise, the string is not empty but does not contain a U+003A COLON
+      # character (:)
+      #
+      else
+        ##
+        # Process the field using the steps described below, using the whole line
+        # as the field name, and the empty string as the field value.
+        #
+        process_field(line, "")
+      end
+    end
+
+    def process_field(field, value)
+      ##
+      # The steps to process the field given a field name and a field value depend
+      # on the field name, as given in the following list. Field names must be
+      # compared literally, with no case folding performed.
+      #
+      case field
+      ##
+      # If the field name is "event"
+      #
+      when "event"
+        ##
+        # Set the event type buffer to field value.
+        #
+        @event_type_buffer = value
+      ##
+      # If the field name is "data"
+      #
+      when "data"
+        ##
+        # Append the field value to the data buffer, then append a single U+000A
+        # LINE FEED (LF) character to the data buffer.
+        #
+        @data_buffer << value << "\n"
+      ##
+      # If the field name is "id"
+      #
+      when "id"
+        ##
+        # If the field value does not contain U+0000 NULL, then set the last event
+        # ID buffer to the field value. Otherwise, ignore the field.
+        #
+        @last_event_id_buffer = value unless value.include?("\u0000")
+      ##
+      # If the field name is "retry"
+      #
+      when "retry"
+        ##
+        # If the field value consists of only ASCII digits, then interpret the
+        # field value as an integer in base ten, and set the event stream's
+        # reconnection time to that integer. Otherwise, ignore the field.
+        #
+        @reconnection_time = value.to_i if /\A\d+\z/.match?(value)
+      ##
+      # Otherwise
+      #
+      else
+        ##
+        # The field is ignored.
+        #
+        ignore
+      end
+    end
+
+    def dispatch_event
+      ##
+      # When the user agent is required to dispatch the event, the user agent must
+      # process the data buffer, the event type buffer, and the last event ID
+      # buffer using steps appropriate for the user agent.
+      #
+      # For web browsers, the appropriate steps to dispatch the event are as
+      # follows:
+      #
+      # 1. Set the last event ID string of the event source to the value of the
+      #    last event ID buffer. The buffer does not get reset, so the last event
+      #    ID string of the event source remains set to this value until the next
+      #    time it is set by the server.
+      #
+      # Note: If an event doesn't have an "id" field, but an earlier event did set
+      # the event source's last event ID string, then the event's lastEventId
+      # field will be set to the value of whatever the last seen "id" field was.
+      #
+      id = @last_event_id_buffer
+      ##
+      # 2. If the data buffer is an empty string, set the data buffer and the
+      #    event type buffer to the empty string and return.
+      #
+      if @data_buffer.empty?
+        @data_buffer = +""
+        @event_type_buffer = +""
+        return
+      end
+      ##
+      # 3. If the data buffer's last character is a U+000A LINE FEED (LF)
+      #    character, then remove the last character from the data buffer.
+      #
+      @data_buffer.chomp!
+      ##
+      # 5. Initialize event's type attribute to "message", its data attribute to
+      #    data, ...
+      # 6. If the event type buffer has a value other than the empty string,
+      #    change the type of the newly created event to equal the value of the
+      #    event type buffer.
+      #
+      # For other user agents, the appropriate steps to dispatch the event are
+      # implementation dependent, but at a minimum they must set the data and
+      # event type buffers to the empty string before returning.
+      #
+      type = @event_type_buffer
+      data = @data_buffer
+      ##
+      # 7. Set the data buffer and the event type buffer to the empty string.
+      #
+      @data_buffer = +""
+      @event_type_buffer = +""
+
+      yield type, data, id, @reconnection_time
+    end
+
+    def ignore; end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: event_stream_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ates Goral
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 
+email:
+- ates.goral@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE.md
+- README.md
+- lib/event_stream_parser.rb
+- lib/event_stream_parser/version.rb
+homepage: https://github.com/Shopify/event_stream_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.7
+requirements: []
+rubygems_version: 3.4.20
+signing_key: 
+specification_version: 4
+summary: A spec-compliant event stream parser
+test_files: []