iodine 0.7.59 → 0.8.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.59
+  version: 0.8.0
 platform: ruby
 authors:
 - Boaz Segev
@@ -10,270 +10,144 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: spec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: A fast HTTP / Websocket Server with built-in Pub/Sub support (with or
-  without Redis), static file support and many other features, optimized for Ruby
-  MRI on Linux / BSD / macOS / Windows
+  without a RESP3 database such as Valkey or Redis), static file support and many
+  other features, optimized for Ruby MRI on Linux / BSD / macOS / Windows
 email:
-- bo@plezi.io
+- bo@bowild.com
 executables:
 - iodine
 extensions:
 - ext/iodine/extconf.rb
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
+- ".clang-format"
 - ".rspec"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
-- LIMITS.md
 - README.md
 - Rakefile
 - SECURITY.md
-- SPEC-PubSub-Draft.md
-- SPEC-WebSocket-Draft.md
-- bin/console
-- bin/info.md
-- bin/mustache_bench.rb
-- bin/poc/Gemfile.lock
-- bin/poc/README.md
-- bin/poc/config.ru
-- bin/poc/gemfile
-- bin/poc/www/index.html
-- examples/async_task.ru
-- examples/bates/README.md
-- examples/bates/config.ru
-- examples/bates/david+bold.pdf
-- examples/bates/public/drop-pdf.png
-- examples/bates/public/index.html
+- examples/chatroom.nru
+- examples/client
+- examples/config-hello.nru
+- examples/config-hello.ru
+- examples/config-hijack.ru
+- examples/config-shootout.ru
+- examples/config.nru
+- examples/config.rb
 - examples/config.ru
-- examples/echo.ru
-- examples/etag.ru
-- examples/hello.ru
-- examples/pubsub_engine.ru
-- examples/rack3.ru
-- examples/redis.ru
-- examples/shootout.ru
-- examples/sub-protocols.ru
-- examples/tcp_client.rb
-- examples/x-sendfile.ru
+- examples/fake
+- examples/hello_neorack
+- examples/routes.nru
+- examples/routes.ru
 - exe/iodine
 - ext/iodine/extconf.rb
-- ext/iodine/fio.c
-- ext/iodine/fio.h
-- ext/iodine/fio_cli.c
-- ext/iodine/fio_cli.h
-- ext/iodine/fio_json_parser.h
-- ext/iodine/fio_siphash.c
-- ext/iodine/fio_siphash.h
-- ext/iodine/fio_tls.h
-- ext/iodine/fio_tls_missing.c
-- ext/iodine/fio_tls_openssl.c
-- ext/iodine/fio_tmpfile.h
-- ext/iodine/fiobj.h
-- ext/iodine/fiobj4fio.h
-- ext/iodine/fiobj_ary.c
-- ext/iodine/fiobj_ary.h
-- ext/iodine/fiobj_data.c
-- ext/iodine/fiobj_data.h
-- ext/iodine/fiobj_hash.c
-- ext/iodine/fiobj_hash.h
-- ext/iodine/fiobj_json.c
-- ext/iodine/fiobj_json.h
-- ext/iodine/fiobj_mem.h
-- ext/iodine/fiobj_mustache.c
-- ext/iodine/fiobj_mustache.h
-- ext/iodine/fiobj_numbers.c
-- ext/iodine/fiobj_numbers.h
-- ext/iodine/fiobj_str.c
-- ext/iodine/fiobj_str.h
-- ext/iodine/fiobject.c
-- ext/iodine/fiobject.h
-- ext/iodine/hpack.h
-- ext/iodine/http.c
-- ext/iodine/http.h
-- ext/iodine/http1.c
-- ext/iodine/http1.h
-- ext/iodine/http1_parser.h
-- ext/iodine/http_internal.c
-- ext/iodine/http_internal.h
-- ext/iodine/http_mime_parser.h
+- ext/iodine/fio-stl.h
+- ext/iodine/fio-stl.md
 - ext/iodine/iodine.c
 - ext/iodine/iodine.h
-- ext/iodine/iodine_caller.c
+- ext/iodine/iodine_arg_helper.h
 - ext/iodine/iodine_caller.h
-- ext/iodine/iodine_connection.c
+- ext/iodine/iodine_cli.h
+- ext/iodine/iodine_compression.h
 - ext/iodine/iodine_connection.h
-- ext/iodine/iodine_defer.c
+- ext/iodine/iodine_core.h
+- ext/iodine/iodine_crypto.h
 - ext/iodine/iodine_defer.h
-- ext/iodine/iodine_fiobj2rb.h
-- ext/iodine/iodine_helpers.c
-- ext/iodine/iodine_helpers.h
-- ext/iodine/iodine_http.c
-- ext/iodine/iodine_http.h
-- ext/iodine/iodine_json.c
 - ext/iodine/iodine_json.h
-- ext/iodine/iodine_mustache.c
+- ext/iodine/iodine_listener.h
+- ext/iodine/iodine_log.h
+- ext/iodine/iodine_minimap.h
 - ext/iodine/iodine_mustache.h
-- ext/iodine/iodine_pubsub.c
-- ext/iodine/iodine_pubsub.h
-- ext/iodine/iodine_rack_io.c
-- ext/iodine/iodine_rack_io.h
-- ext/iodine/iodine_store.c
+- ext/iodine/iodine_pubsub_eng.h
+- ext/iodine/iodine_pubsub_history.h
+- ext/iodine/iodine_pubsub_msg.h
+- ext/iodine/iodine_redis.h
 - ext/iodine/iodine_store.h
-- ext/iodine/iodine_tcp.c
-- ext/iodine/iodine_tcp.h
-- ext/iodine/iodine_tls.c
+- ext/iodine/iodine_threads.h
 - ext/iodine/iodine_tls.h
-- ext/iodine/mustache_parser.h
-- ext/iodine/redis_engine.c
-- ext/iodine/redis_engine.h
-- ext/iodine/resp_parser.h
-- ext/iodine/websocket_parser.h
-- ext/iodine/websockets.c
-- ext/iodine/websockets.h
+- ext/iodine/iodine_utils.h
 - iodine.gemspec
 - lib/iodine.rb
-- lib/iodine/connection.rb
-- lib/iodine/json.rb
-- lib/iodine/mustache.rb
-- lib/iodine/pubsub.rb
-- lib/iodine/rack_utils.rb
-- lib/iodine/tls.rb
+- lib/iodine/benchmark.rb
+- lib/iodine/documentation.rb
 - lib/iodine/version.rb
-- lib/rack/handler/iodine.rb
-- logo.png
+- logo.svg
+- mustache.md
+- sig/iodine.rbs
 homepage: https://github.com/boazsegev/iodine
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: |-
-  Thank you for installing Iodine 0.7.59.
-  Remember: if iodine supports your business, it's only fair to give value back (code contributions / donations).
+  homepage_uri: https://github.com/boazsegev/iodine
+  source_code_uri: https://github.com/boazsegev/iodine
+  changelog_uri: https://github.com/boazsegev/iodine/blob/master/CHANGELOG.md
+post_install_message: Thank you for installing Iodine 0.8.0.
 rdoc_options: []
 require_paths:
 - lib
-- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- 'A Unix based system: Linux / macOS / BSD.'
-- An updated C compiler.
-- Ruby >= 2.3.8 (Ruby EOL).
-- Ruby >= 2.5.0 recommended.
-- TLS requires OpenSSL >= 1.1.0.
-- Or Windows with Ruby >= 3.0.0 build with MingW and MingW as compiler.
+requirements: []
 rubygems_version: 4.0.3
 specification_version: 4
 summary: iodine - a fast HTTP / Websocket Server with Pub/Sub support, optimized for

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,40 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-### System Information
-
- - **OS**:             [e.g. macOS 10.15.4]
- - **Ruby**:         [e.g. 2.7.0]
- - **Version**:     [e.g. 0.7.38]
- - **OpenSSL**:  [OpenSSL 1.1.1f 20 Mar 2020]
-
-### Description
-
-A clear and concise description of what the bug is.
-
-### Rack App to Reproduce
-
-```ruby
-APP = proc {|env| [200, {}, ["Hello World"]] }
-run APP
-```
-
-### Testing code
-
-```sh
-curl http://localhost:3000/
-```
-
-### Expected behavior
-
-A clear and concise description of what you expected to happen.
-
-### Actual behavior
-
-A clear and concise description of what actually happened.

data/.github/workflows/ruby.yml

@@ -1,42 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Building iodine
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby-version: ['2.3', '2.7', '3.0', '3.1', '3.2']
-        os: [ubuntu-latest, macos-latest] # , windows-latest
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby # see https://github.com/ruby/setup-ruby#versioning)
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Build and Test Iodine
-      run: |
-        echo CFLAGS = $CFLAGS
-        echo cflags = $cflags
-        echo HOME = $HOME
-        ruby -e 'puts Gem.default_dir'
-        bundle exec rake install
-#       env VERBOSE=1 bundle exec rspec --format documentation
-#    - name: Run tests
-#      run: bundle exec rake

data/.gitignore

@@ -1,20 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/old_stuff/
-*.bundle
-*.so
-*.gem
-
-.ruby-version
-.clang_complete
-
-.DS_Store
-spec/examples.txt
-spec/log

data/LIMITS.md

@@ -1,41 +0,0 @@
-# Iodine limits and settings
-
-I will, at some point, document these... here's the key points:
-
-## SSL/TLS
-
-* TLS support requires OpenSSL 1.1.0 and above. On Heroku, this requires `heroku-18`.
-
-* Iodine supports TLS 1.2 and above (depending on the OpenSSL version used).
-
-## HTTP limits
-
-* Uploads are adjustable and limited to ~50Mib by default.
-
-* HTTP connection timeout (keep-alive) is adjustable and set to ~60 seconds by default.
-
-* HTTP total header size is adjustable and limited to ~32Kib by default.
-
-* HTTP header line length size is limited to a hard-coded limit of 8Kb.
-
-* HTTP headers count is limited to a hard-coded limit of 128 headers.
-
-## Websocket
-
-* Incoming Websocket message size limits are adjustable and limited to ~250Kib by default.
-
-## EventSource / SSE
-
-* Iodine will automatically attempt to send a `ping` event instead of disconnecting the connection. The ping interval is the same as the HTTP connection timeout interval.
-
-## Pub/Sub
-
-* Channel names are binary safe and unlimited in length. However, name lengths effect performance.
-
-    **Do NOT allow clients to dictate the channel name**, as they might use extremely long names and cause resource starvation.
-
-* Pub/sub is limited to the process cluster. To use pub/sub with an external service (such as Redis) an "Engine" is required (see YARD documentation).
-
-* Pub/sub pattern matching supports only the Redis pattern matching approach. This makes patterns significantly more expensive and exact matches simpler and faster.
-
-    It's recommended to prefer exact channel/stream name matching when possible.

data/SPEC-PubSub-Draft.md

@@ -1,159 +0,0 @@
-# Ruby pub/sub API Specification Draft
-
-### Draft State
-
-This draft is under discussion and will be implemented by iodine starting with the 0.8.x versions.
-
----
-
-## Purpose
-
-This document details a Rack specification extension for publish/subscribe (pub/sub) modules that can extend WebSocket / EventSource Rack servers.
-
-The purpose of this specification is:
-
-1. To keep separation of concerns by avoiding inter-process-communication logic (IPC) in the application code base.
-
-   This is important since IPC is often implemented using pipes / sockets, which could introduce network and IO concerns into the application code.
-
-2. To specify a common publish/subscribe (pub/sub) API for servers and pub/sub modules, allowing applications to easily switch between conforming implementations and servers.
-
-    Since pub/sub design is idiomatic to WebSocket and EventSource approaches, as well as other reactive programming techniques, it is better if applications aren't locked in to a specific server / implementation.
-
-3. To provide common considerations and guidelines for pub/sub implementors to consider when implementing their pub/sub modules.
-
-    Some concerns are common for pub/sub implementors, such as integrating third party message brokers (Redis, RabbitMQ, Cassandra)
-
-## Pub/Sub Instance Methods
-
-Conforming pub/sub implementations **MUST** implement the following pub/sub instance methods:
-
-* `pubsub?` **MUST** return the pub/sub API version as an integer number. Currently, set to `0` (development version).
-
-* `subscribe(to, is_pattern = false) { |from, message| optional_block }` where:
-
-    * `to` is a named **channel** (or **pattern**).
-
-        The implementation **MAY** support pattern matching for named channels (`to`). The pattern matching algorithm used, if any, **SHOULD** be documented.
-
-        If the implementation does **NOT** support pattern matching and `is_pattern` is truthful, the implementation **MUST** raise and exception.
-
-        `to` **SHOULD** be a String, but implementations **MAY** support Symbols as aliases to Strings (in which case `:my_channel` is the same `'my_channel'`).
-
-    * `block` is optional and accepts (if provided) two arguments (`from` which is equal to `to` and `message` which contains the data's content).
-
-        `block` (if provided) **MUST** be called when a publication was received by the named channel.
-
-        If no `block` is provided:
-
-        * If the pub/sub instance is an extended WebSocket / EventSource (SSE) `client` object (see the WebSocket / EventSource extension draft) data should be directly sent to the `client`.
-
-        * If the pub/sub isn't linked with a `client` / connection, an exception **MUST** be raised.
-
-    If a subscription to `to` already exists for the same pub/sub instance, it should be *replaced* by the new subscription (the old subscription should be canceled / unsubscribed).
-
-    If the pub/sub instance is an extended WebSocket / EventSource (SSE) `client` object (see the WebSocket / EventSource extension draft), the subscription **MUST** be closed automatically when the connection is closed (when `on_close` is called).
-
-    Otherwise, the subscription **MUST** be closed automatically when the pub/sub object goes out of scope and is garbage collected (if this ever happens).
-    
-    The `subscribe` method **MUST** return `nil` on a known failure (i.e., when the connection is already closed), or any truthful value on success.
-
-* `unsubscribe(from, is_pattern = false)` should cancel a subscription to the `from` named channel / pattern.
-
-* `publish(to, message, engine = nil)` where:
-
-    * `to` is a named channel, same as detailed in `subscribe`.
-
-        Implementations **MAY** support pattern based publishing. This **SHOULD** be documented as well as how patterns are detected (as opposed to named channels). Note that pattern publishing isn't supported by common backends (such as Redis) and introduces complex privacy and security concerns.
-
-    * `message` a String containing the data to be published.
-
-        If `message` is NOT a String, the implementation **MAY** convert the data silently to JSON. Otherwise, the implementation **MUST** raise an exception.
-
-        `message` encoding (binary / UTZ-8) **MAY** be altered during publication, but any change **MUST** result in valid encoding.
-
-    * `engine` routes the publish method to the specified pub/sub Engine (see later on). If none is specified, the default engine should be used. If `false` is specified, the message **MUST** be forwarded to all subscribed clients on the **same process**.
-
-    The `publish` method **MUST** return `true` if a publication was scheduled (not necessarily performed). If it's already known that the publication would fail, the method should return `false`.
-
-    An implementation **MUST** call the relevant PubSubEngine's `publish` method after performing any internal book keeping logic. If `engine` is `nil`, the default PubSubEngine should be called. If `engine` is `false`, the implementation **MUST** forward the published message to the actual clients (if any).
-
-    A global alias for this method (allowing it to be accessed from outside active connections) **MAY** be defined as `Rack::PubSub.publish`.
-
-## Integrating a Pub/Sub module into a WebSocket / EventSource (SSE) `client` object
-
-A conforming pub/sub module **MUST** be designed so that it can be integrated into WebSocket / EventSource (SSE) `client` objects be `include`-ing their class.
-
-This **MUST** result in a behavior where subscriptions are destroyed / canceled once the `client` object state changes to "closed" - i.e., either when the `on_close` callback is called, or the first time the method `client.open?` returns `false`.
-
-The idiomatic way to add a pub/sub module to a `client`'s class is:
-
-```ruby
-client.class.prepend MyPubSubModule unless client.pubsub?
-```
-
-The pub/sub module **MUST** expect and support this behavior.
-
-**Note**: the use of `prepend` (rather than `include`) is chosen so that it's possible to override the `client`'s instance method of `pubsub?`.
-
-## Connecting to External Backends (pub/sub Engines)
-
-It is common for scaling applications to require an external message broker backend such as Redis, RabbitMQ, etc'. The following requirements set a common interface for such "engine" implementation and integration.
-
-Pub/sub implementations **MUST** implement the following module / class methods in one of their public classes / modules (iodine implements these under `Iodine::PubSub`):
-
-* `attach(engine)` where `engine` is a `PubSubEngine` object, as described in this specification.
-
-    When a pub/sub engine is attached, the implementation **MUST** inform the engine of any existing or future subscriptions.
-
-    The implementation **MUST** call the engine's `subscribe` callback for each existing (and future) subscription.
-
-    The implementation **MUST** allow multiple "engines" to be attached when multiple calls to `attach` are made.
-
-* `detach(engine)` where `engine` is a PubSubEngine object as described in this specification.
-
-    The implementation **MUST** remove the engine from the attached engine list. The opposite of `attach`.
-
-* `default=(engine)` sets a default pub/sub engine, where `engine` is a PubSubEngine object as described in this specification.
-
-    Implementations **MUST** forward any `publish` method calls to the default pub/sub engine, unless an `engine` is specified in arguments passes to the `publish` method.
-
-* `default` returns the current default pub/sub engine, where the engine is a PubSubEngine object as described in this specification.
-
-* `reset(engine)` where `engine` is a PubSubEngine object as described in this specification.
-
-    Implementations **MUST** behave as if the engine was newly registered and (re)inform the engine of any existing subscriptions by calling engine's `subscribe` callback for each existing subscription.
-
-A `PubSubEngine` instance object **MUST** implement the following methods:
-
-* `subscribe(to, is_pattern = false)` this method informs the engine that a subscription to the specified channel / pattern exists for the calling the process. It **MUST ONLY** be called **once** for all existing and future subscriptions to that channel within the process.
-
-    The method **MUST** return `true` if a subscription was scheduled (or performed) or `false` if the subscription is known to fail.
-
-    This method will be called by the pub/sub implementation (for each registered engine). The engine **MAY** assume that the method would never be called directly by an application / client.
-
-    This method **MUST NOT** raise an exception.
-
-* `unsubscribe(from, is_pattern = false)` this method informs an engine that there are no more subscriptions to the named channel / pattern for the calling process.
-
-    The method's semantics are similar to `subscribe` only is performs the opposite action.
-
-    This method **MUST NOT** raise an exception.
-
-    This method will be called by the pub/sub implementation (for each registered engine). The engine **MAY** assume that the method would never be called directly by an application / client.
-
-* `publish(channel, message)` where both `channel` is either a Symbol or a String (both being equivalent) and `message` **MUST** be a String.
-
-    This method will be called by the server when a message is published using the engine.
-
-    This method will be called by the pub/sub implementation (for each registered engine).
-
-    The engine **MUST** assume that the method **MAY** be called directly by an application / client.
-
-In order for a PubSubEngine instance object to publish messages to all subscribed clients on a particular process, it **SHOULD** call the implementation's global `publish` method with the engine set to `false`.
-
-i.e., if the implementation's global `publish` method is in a class called `Iodine`:
-
-```ruby
-Iodine.publish channel, message, false
-```