aws-eventstream-1.3.0/0000755000004100000410000000000014537134176014703 5ustar www-datawww-dataaws-eventstream-1.3.0/CHANGELOG.md0000644000004100000410000000164314537134176016520 0ustar www-datawww-dataUnreleased Changes ------------------ 1.3.0 (2023-11-22) ------------------ * Feature - AWS SDK for Ruby no longer supports Ruby runtime versions 2.3 and 2.4. 1.2.0 (2021-09-01) ------------------ * Feature - AWS SDK for Ruby no longer supports Ruby runtime versions 1.9, 2.0, 2.1, and 2.2. 1.1.1 (2021-03-04) ------------------ * Issue - Include LICENSE, CHANGELOG, and VERSION files with this gem. 1.1.0 (2020-04-08) ------------------ * Feature - Remove internal ByteBuffer and replace with String to remove dup and string mutation. 1.0.3 (2019-04-24) ------------------ * Issue - Use single quotes for string where interpolation is not done. 1.0.2 (2019-03-11) ------------------ * Issue - public #encode_headers method 1.0.1 (2018-06-15) ------------------ * Issue - #decode_chunk buffers insufficient prelude message 1.0.0 (2018-05-10) ------------------ * Feature - Initial release of `aws-eventstream` gem. aws-eventstream-1.3.0/aws-eventstream.gemspec0000644000004100000410000000302214537134176021372 0ustar www-datawww-data######################################################### # This file has been automatically generated by gem2tgz # ######################################################### # -*- encoding: utf-8 -*- # stub: aws-eventstream 1.3.0 ruby lib Gem::Specification.new do |s| s.name = "aws-eventstream".freeze s.version = "1.3.0" s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version= s.metadata = { "changelog_uri" => "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-eventstream/CHANGELOG.md", "source_code_uri" => "https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-eventstream" } if s.respond_to? :metadata= s.require_paths = ["lib".freeze] s.authors = ["Amazon Web Services".freeze] s.date = "2023-11-22" s.description = "Amazon Web Services event stream library. Decodes and encodes binary stream under `vnd.amazon.event-stream` content-type".freeze s.files = ["CHANGELOG.md".freeze, "LICENSE.txt".freeze, "VERSION".freeze, "lib/aws-eventstream.rb".freeze, "lib/aws-eventstream/decoder.rb".freeze, "lib/aws-eventstream/encoder.rb".freeze, "lib/aws-eventstream/errors.rb".freeze, "lib/aws-eventstream/header_value.rb".freeze, "lib/aws-eventstream/message.rb".freeze, "lib/aws-eventstream/types.rb".freeze] s.homepage = "https://github.com/aws/aws-sdk-ruby".freeze s.licenses = ["Apache-2.0".freeze] s.required_ruby_version = Gem::Requirement.new(">= 2.5".freeze) s.rubygems_version = "3.3.15".freeze s.summary = "AWS Event Stream Library".freeze end aws-eventstream-1.3.0/lib/0000755000004100000410000000000014537134176015451 5ustar www-datawww-dataaws-eventstream-1.3.0/lib/aws-eventstream/0000755000004100000410000000000014537134176020576 5ustar www-datawww-dataaws-eventstream-1.3.0/lib/aws-eventstream/header_value.rb0000644000004100000410000000215314537134176023550 0ustar www-datawww-data# frozen_string_literal: true module Aws module EventStream class HeaderValue def initialize(options) @type = options.fetch(:type) @value = options[:format] ? format_value(options.fetch(:value)) : options.fetch(:value) end attr_reader :value # @return [String] type of the header value # complete type list see Aws::EventStream::Types attr_reader :type private def format_value(value) case @type when 'timestamp' then format_timestamp(value) when 'uuid' then format_uuid(value) else value end end def format_uuid(value) bytes = value.bytes # For user-friendly uuid representation, # format binary bytes into uuid string format uuid_pattern = [ [ 3, 2, 1, 0 ], [ 5, 4 ], [ 7, 6 ], [ 8, 9 ], 10..15 ] uuid_pattern.map {|p| p.map {|n| "%02x" % bytes.to_a[n] }.join }.join('-') end def format_timestamp(value) # millis_since_epoch to sec_since_epoch Time.at(value / 1000.0) end end end end aws-eventstream-1.3.0/lib/aws-eventstream/encoder.rb0000644000004100000410000001067314537134176022551 0ustar www-datawww-data# frozen_string_literal: true require 'zlib' module Aws module EventStream # This class provides #encode method for encoding # Aws::EventStream::Message into binary. # # * {#encode} - encode Aws::EventStream::Message into binary # when output IO-like object is provided, binary string # would be written to IO. If not, the encoded binary string # would be returned directly # # ## Examples # # message = Aws::EventStream::Message.new( # headers: { # "foo" => Aws::EventStream::HeaderValue.new( # value: "bar", type: "string" # ) # }, # payload: "payload" # ) # encoder = Aws::EventsStream::Encoder.new # file = Tempfile.new # # # encode into IO ouput # encoder.encode(message, file) # # # get encoded binary string # encoded_message = encoder.encode(message) # # file.read == encoded_message # # => true # class Encoder # bytes of total overhead in a message, including prelude # and 4 bytes total message crc checksum OVERHEAD_LENGTH = 16 # Maximum header length allowed (after encode) 128kb MAX_HEADERS_LENGTH = 131072 # Maximum payload length allowed (after encode) 16mb MAX_PAYLOAD_LENGTH = 16777216 # Encodes Aws::EventStream::Message to output IO when # provided, else return the encoded binary string # # @param [Aws::EventStream::Message] message # # @param [IO#write, nil] io An IO-like object that # responds to `#write`, encoded message will be # written to this IO when provided # # @return [nil, String] when output IO is provided, # encoded message will be written to that IO, nil # will be returned. Else, encoded binary string is # returned. def encode(message, io = nil) encoded = encode_message(message) if io io.write(encoded) io.close else encoded end end # Encodes an Aws::EventStream::Message # into String # # @param [Aws::EventStream::Message] message # # @return [String] def encode_message(message) # create context buffer with encode headers encoded_header = encode_headers(message) header_length = encoded_header.bytesize # encode payload if message.payload.length > MAX_PAYLOAD_LENGTH raise Aws::EventStream::Errors::EventPayloadLengthExceedError.new end encoded_payload = message.payload.read total_length = header_length + encoded_payload.bytesize + OVERHEAD_LENGTH # create message buffer with prelude section encoded_prelude = encode_prelude(total_length, header_length) # append message context (headers, payload) encoded_content = [ encoded_prelude, encoded_header, encoded_payload, ].pack('a*a*a*') # append message checksum message_checksum = Zlib.crc32(encoded_content) [encoded_content, message_checksum].pack('a*N') end # Encodes headers part of an Aws::EventStream::Message # into String # # @param [Aws::EventStream::Message] message # # @return [String] def encode_headers(message) header_entries = message.headers.map do |key, value| encoded_key = [key.bytesize, key].pack('Ca*') # header value pattern, value_length, type_index = Types.pattern[value.type] encoded_value = [type_index].pack('C') # boolean types doesn't need to specify value next [encoded_key, encoded_value].pack('a*a*') if !!pattern == pattern encoded_value = [encoded_value, value.value.bytesize].pack('a*S>') unless value_length [ encoded_key, encoded_value, pattern ? [value.value].pack(pattern) : value.value, ].pack('a*a*a*') end header_entries.join.tap do |encoded_header| break encoded_header if encoded_header.bytesize <= MAX_HEADERS_LENGTH raise Aws::EventStream::Errors::EventHeadersLengthExceedError.new end end private def encode_prelude(total_length, headers_length) prelude_body = [total_length, headers_length].pack('NN') checksum = Zlib.crc32(prelude_body) [prelude_body, checksum].pack('a*N') end end end end aws-eventstream-1.3.0/lib/aws-eventstream/message.rb0000644000004100000410000000076514537134176022557 0ustar www-datawww-data# frozen_string_literal: true module Aws module EventStream class Message def initialize(options) @headers = options[:headers] || {} @payload = options[:payload] || StringIO.new end # @return [Hash] headers of a message attr_reader :headers # @return [IO] payload of a message, size not exceed 16MB. # StringIO is returned for <= 1MB payload # Tempfile is returned for > 1MB payload attr_reader :payload end end end aws-eventstream-1.3.0/lib/aws-eventstream/errors.rb0000644000004100000410000000243614537134176022444 0ustar www-datawww-data# frozen_string_literal: true module Aws module EventStream module Errors # Raised when reading bytes exceed buffer total bytes class ReadBytesExceedLengthError < RuntimeError def initialize(target_byte, total_len) msg = "Attempting reading bytes to offset #{target_byte} exceeds"\ " buffer length of #{total_len}" super(msg) end end # Raise when insufficient bytes of a message is received class IncompleteMessageError < RuntimeError def initialize(*args) super('Not enough bytes for event message') end end class PreludeChecksumError < RuntimeError def initialize(*args) super('Prelude checksum mismatch') end end class MessageChecksumError < RuntimeError def initialize(*args) super('Message checksum mismatch') end end class EventPayloadLengthExceedError < RuntimeError def initialize(*args) super("Payload length of a message should be under 16mb.") end end class EventHeadersLengthExceedError < RuntimeError def initialize(*args) super("Encoded headers length of a message should be under 128kb.") end end end end end aws-eventstream-1.3.0/lib/aws-eventstream/types.rb0000644000004100000410000000152614537134176022273 0ustar www-datawww-data# frozen_string_literal: true module Aws module EventStream # Message Header Value Types module Types def self.types [ 'bool_true', 'bool_false', 'byte', 'short', 'integer', 'long', 'bytes', 'string', 'timestamp', 'uuid' ] end # pack/unpack pattern, byte size, type idx def self.pattern { 'bool_true' => [true, 0, 0], 'bool_false' => [false, 0, 1], 'byte' => ["c", 1, 2], 'short' => ["s>", 2, 3], 'integer' => ["l>", 4, 4], 'long' => ["q>", 8, 5], 'bytes' => [nil, nil, 6], 'string' => [nil, nil, 7], 'timestamp' => ["q>", 8, 8], 'uuid' => [nil, 16, 9] } end end end end aws-eventstream-1.3.0/lib/aws-eventstream/decoder.rb0000644000004100000410000001554014537134176022535 0ustar www-datawww-data# frozen_string_literal: true require 'stringio' require 'tempfile' require 'zlib' module Aws module EventStream # This class provides method for decoding binary inputs into # single or multiple messages (Aws::EventStream::Message). # # * {#decode} - decodes messages from an IO like object responds # to #read that containing binary data, returning decoded # Aws::EventStream::Message along the way or wrapped in an enumerator # # ## Examples # # decoder = Aws::EventStream::Decoder.new # # # decoding from IO # decoder.decode(io) do |message| # message.headers # # => { ... } # message.payload # # => StringIO / Tempfile # end # # # alternatively # message_pool = decoder.decode(io) # message_pool.next # # => Aws::EventStream::Message # # * {#decode_chunk} - decodes a single message from a chunk of data, # returning message object followed by boolean(indicating eof status # of data) in an array object # # ## Examples # # # chunk containing exactly one message data # message, chunk_eof = decoder.decode_chunk(chunk_str) # message # # => Aws::EventStream::Message # chunk_eof # # => true # # # chunk containing a partial message # message, chunk_eof = decoder.decode_chunk(chunk_str) # message # # => nil # chunk_eof # # => true # # chunk data is saved at decoder's message_buffer # # # chunk containing more that one data message # message, chunk_eof = decoder.decode_chunk(chunk_str) # message # # => Aws::EventStream::Message # chunk_eof # # => false # # extra chunk data is saved at message_buffer of the decoder # class Decoder include Enumerable ONE_MEGABYTE = 1024 * 1024 private_constant :ONE_MEGABYTE # bytes of prelude part, including 4 bytes of # total message length, headers length and crc checksum of prelude PRELUDE_LENGTH = 12 private_constant :PRELUDE_LENGTH # 4 bytes message crc checksum CRC32_LENGTH = 4 private_constant :CRC32_LENGTH # @param [Hash] options The initialization options. # @option options [Boolean] :format (true) When `false` it # disables user-friendly formatting for message header values # including timestamp and uuid etc. def initialize(options = {}) @format = options.fetch(:format, true) @message_buffer = '' end # Decodes messages from a binary stream # # @param [IO#read] io An IO-like object # that responds to `#read` # # @yieldparam [Message] message # @return [Enumerable, nil] Returns a new Enumerable # containing decoded messages if no block is given def decode(io, &block) raw_message = io.read decoded_message = decode_message(raw_message) return wrap_as_enumerator(decoded_message) unless block_given? # fetch message only raw_event, _eof = decoded_message block.call(raw_event) end # Decodes a single message from a chunk of string # # @param [String] chunk A chunk of string to be decoded, # chunk can contain partial event message to multiple event messages # When not provided, decode data from #message_buffer # # @return [Array] Returns single decoded message # and boolean pair, the boolean flag indicates whether this chunk # has been fully consumed, unused data is tracked at #message_buffer def decode_chunk(chunk = nil) @message_buffer = [@message_buffer, chunk].pack('a*a*') if chunk decode_message(@message_buffer) end private # exposed via object.send for testing attr_reader :message_buffer def wrap_as_enumerator(decoded_message) Enumerator.new do |yielder| yielder << decoded_message end end def decode_message(raw_message) # incomplete message prelude received return [nil, true] if raw_message.bytesize < PRELUDE_LENGTH prelude, content = raw_message.unpack("a#{PRELUDE_LENGTH}a*") # decode prelude total_length, header_length = decode_prelude(prelude) # incomplete message received, leave it in the buffer return [nil, true] if raw_message.bytesize < total_length content, checksum, remaining = content.unpack("a#{total_length - PRELUDE_LENGTH - CRC32_LENGTH}Na*") unless Zlib.crc32([prelude, content].pack('a*a*')) == checksum raise Errors::MessageChecksumError end # decode headers and payload headers, payload = decode_context(content, header_length) @message_buffer = remaining [Message.new(headers: headers, payload: payload), remaining.empty?] end def decode_prelude(prelude) # prelude contains length of message and headers, # followed with CRC checksum of itself content, checksum = prelude.unpack("a#{PRELUDE_LENGTH - CRC32_LENGTH}N") raise Errors::PreludeChecksumError unless Zlib.crc32(content) == checksum content.unpack('N*') end def decode_context(content, header_length) encoded_header, encoded_payload = content.unpack("a#{header_length}a*") [ extract_headers(encoded_header), extract_payload(encoded_payload) ] end def extract_headers(buffer) scanner = buffer headers = {} until scanner.bytesize == 0 # header key key_length, scanner = scanner.unpack('Ca*') key, scanner = scanner.unpack("a#{key_length}a*") # header value type_index, scanner = scanner.unpack('Ca*') value_type = Types.types[type_index] unpack_pattern, value_length = Types.pattern[value_type] value = if !!unpack_pattern == unpack_pattern # boolean types won't have value specified unpack_pattern else value_length, scanner = scanner.unpack('S>a*') unless value_length unpacked_value, scanner = scanner.unpack("#{unpack_pattern || "a#{value_length}"}a*") unpacked_value end headers[key] = HeaderValue.new( format: @format, value: value, type: value_type ) end headers end def extract_payload(encoded) encoded.bytesize <= ONE_MEGABYTE ? payload_stringio(encoded) : payload_tempfile(encoded) end def payload_stringio(encoded) StringIO.new(encoded) end def payload_tempfile(encoded) payload = Tempfile.new payload.binmode payload.write(encoded) payload.rewind payload end end end end aws-eventstream-1.3.0/lib/aws-eventstream.rb0000644000004100000410000000044414537134176021125 0ustar www-datawww-data# frozen_string_literal: true require_relative 'aws-eventstream/decoder' require_relative 'aws-eventstream/encoder' require_relative 'aws-eventstream/message' require_relative 'aws-eventstream/header_value' require_relative 'aws-eventstream/types' require_relative 'aws-eventstream/errors' aws-eventstream-1.3.0/LICENSE.txt0000644000004100000410000002613614537134176016536 0ustar www-datawww-data Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. aws-eventstream-1.3.0/VERSION0000644000004100000410000000000614537134176015747 0ustar www-datawww-data1.3.0