rage-iodine 1.7.58

data/lib/iodine.rb

@@ -0,0 +1,274 @@
+require 'stringio' # Used internally as a default RackIO
+require 'socket'  # TCPSocket is used internally for Hijack support
+# require 'openssl' # For SSL/TLS support using OpenSSL
+
+require_relative './iodine/version'
+require_relative './iodine/iodine_ext' # loading a binary C extension
+
+# Iodine is an HTTP / WebSocket server as well as an Evented Network Tool Library. In essense, Iodine is a Ruby port for the [facil.io](http://facil.io) C library.
+#
+# Here is a simple telnet based echo server using Iodine (see full list at {Iodine::Connection}):
+#
+#
+#       require 'iodine'
+#       # define the protocol for our service
+#       module EchoProtocol
+#         def on_open(client)
+#           # Set a connection timeout
+#           client.timeout = 10
+#           # Write a welcome message
+#           client.write "Echo server running on Iodine #{Iodine::VERSION}.\r\n"
+#         end
+#         # this is called for incoming data - note data might be fragmented.
+#         def on_message(client, data)
+#           # write the data we received
+#           client.write "echo: #{data}"
+#           # close the connection when the time comes
+#           client.close if data =~ /^bye[\n\r]/
+#         end
+#         # called if the connection is still open and the server is shutting down.
+#         def on_shutdown(client)
+#           # write the data we received
+#           client.write "Server going away\r\n"
+#         end
+#         extend self
+#       end
+#       # create the service instance, the block returns a connection handler.
+#       Iodine.listen(port: "3000") { EchoProtocol }
+#       # start the service
+#       Iodine.threads = 1
+#       Iodine.start
+#
+#
+#
+# Methods for setting up and starting {Iodine} include {start}, {threads}, {threads=}, {workers} and {workers=}.
+#
+# Methods for setting startup / operational callbacks include {on_idle}, {on_state}.
+#
+# Methods for asynchronous execution include {run} (same as {defer}), {run_after} and {run_every}.
+#
+# Methods for application wide pub/sub include {subscribe}, {unsubscribe} and {publish}. Connection specific pub/sub methods are documented in the {Iodine::Connection} class).
+#
+# Methods for TCP/IP, Unix Sockets and HTTP connections include {listen} and {connect}.
+#
+# Note that the HTTP server supports both TCP/IP and Unix Sockets as well as SSE / WebSockets extensions.
+#
+# Iodine doesn't call {patch_rack} automatically, but doing so will improve Rack's performace.
+#
+# Please read the {file:README.md} file for an introduction to Iodine.
+#
+module Iodine
+
+    # Will monkey patch some Rack methods to increase their performance.
+    #
+    # This is recommended, see {Iodine::Rack::Utils} for details.
+    def self.patch_rack
+      begin
+        require 'rack'
+      rescue LoadError
+      end
+      ::Rack::Utils.class_eval do
+        Iodine::Base::MonkeyPatch::RackUtils.methods(false).each do |m|
+          ::Rack::Utils.define_singleton_method(m,
+                Iodine::Base::MonkeyPatch::RackUtils.instance_method(m) )
+        end
+      end
+    end
+
+
+    # @deprecated use {Iodine.listen} with `service: :http`.
+    #
+    # Sets a block of code to run once a Worker process shuts down (both in single process mode and cluster mode).
+    def self.listen2http(args, &block)
+      warn "Iodine.listen2http is deprecated, use Iodine.listen(service: :http)."
+      args[:service] = :http;
+      Iodine.listen(args, &block)
+    end
+
+    # @deprecated use {Iodine.on_state}.
+    #
+    # Sets a block of code to run before a new worker process is forked (cluster mode only).
+    def self.before_fork(&block)
+      warn "Iodine.before_fork is deprecated, use Iodine.on_state(:before_fork)."
+      Iodine.on_state(:before_fork, &block)
+    end
+    # @deprecated use {Iodine.on_state}.
+    #
+    # Sets a block of code to run after a new worker process is forked (cluster mode only).
+    #
+    # Code runs in both the parent and the child.
+    def self.after_fork(&block)
+      warn "Iodine.after_fork is deprecated, use Iodine.on_state(:after_fork)."
+      Iodine.on_state(:after_fork, &block)
+    end
+    # @deprecated use {Iodine.on_state}.
+    #
+    # Sets a block of code to run in the worker process, after a new worker process is forked (cluster mode only).
+    def self.after_fork_in_worker(&block)
+      warn "Iodine.after_fork_in_worker is deprecated, use Iodine.on_state(:enter_child)."
+      Iodine.on_state(:enter_child, &block)
+    end
+    # @deprecated use {Iodine.on_state}.
+    #
+    # Sets a block of code to run in the master / root process, after a new worker process is forked (cluster mode only).
+    def self.after_fork_in_master(&block)
+      warn "Iodine.after_fork_in_master is deprecated, use Iodine.on_state(:enter_master)."
+      Iodine.on_state(:enter_master, &block)
+    end
+    # @deprecated use {Iodine.on_state}.
+    #
+    # Sets a block of code to run once a Worker process shuts down (both in single process mode and cluster mode).
+    def self.on_shutdown(&block)
+      warn "Iodine.on_shutdown is deprecated, use Iodine.on_state(:on_finish)."
+      Iodine.on_state(:on_finish, &block)
+    end
+
+    module PubSub
+      # @deprecated use {Iodine::PubSub.detach}.
+      def self.dettach(engine)
+        warn "Iodine::PubSub.dettach is deprecated (was a typo), use Iodine::PubSub.detach(engine)."
+        Iodine::PubSub.detach(engine)
+      end
+    end
+
+    ### trap some signals to avoid excessive exception reports
+    begin
+      old_sigint = Signal.trap("SIGINT") { old_sigint.call if old_sigint.respond_to?(:call) }
+    rescue Exception
+    end
+    begin
+      old_sigterm = Signal.trap("SIGTERM") { old_sigterm.call if old_sigterm.respond_to?(:call) }
+    rescue Exception
+    end
+    begin
+      old_sigpipe = Signal.trap("SIGPIPE") { old_sigpipe.call if old_sigpipe.respond_to?(:call) }
+    rescue Exception
+    end
+    begin
+      old_sigusr1 = Signal.trap("SIGUSR1") { old_sigusr1.call if old_sigusr1.respond_to?(:call) }
+    rescue Exception
+    end
+end
+
+require 'rack/handler/iodine' unless defined? ::Iodine::Rack::IODINE_RACK_LOADED
+
+
+### Automatic ActiveRecord and Sequel support for forking (preventing connection sharing)
+Iodine.on_state(:before_fork)  do
+  if defined?(ActiveRecord) && defined?(ActiveRecord::Base) && ActiveRecord::Base.respond_to?(:connection)
+    begin
+      ActiveRecord::Base.connection.disconnect!
+    rescue
+    end
+  end
+  if defined?(Sequel)
+    begin
+      Sequel::DATABASES.each { |database| database.disconnect }
+    rescue
+    end
+  end
+end
+Iodine.on_state(:after_fork)  do
+  if defined?(ActiveRecord) && defined?(ActiveRecord::Base) && ActiveRecord::Base.respond_to?(:establish_connection)
+    begin
+      ActiveRecord::Base.establish_connection
+    rescue
+    end
+  end
+end
+
+### Parse CLI for default HTTP settings
+Iodine::Base::CLI.parse if defined?(IODINE_PARSE_CLI) && IODINE_PARSE_CLI
+
+### Set default port (if missing)
+Iodine::DEFAULT_SETTINGS[:port] ||= (ENV["PORT"] || "3000")
+
+### Set default binding (if missing)
+Iodine::DEFAULT_SETTINGS[:address] ||= nil
+
+### Initialize Redis if set in CLI
+Iodine::PubSub.default = Iodine::PubSub::Redis.new(Iodine::DEFAULT_SETTINGS[:redis_], ping: Iodine::DEFAULT_SETTINGS[:redis_ping_]) if Iodine::DEFAULT_SETTINGS[:redis_]
+
+### PID file generation
+if Iodine::DEFAULT_SETTINGS[:pid_]
+  pid_filename = Iodine::DEFAULT_SETTINGS[:pid_]
+  Iodine::DEFAULT_SETTINGS.delete :pid_
+  pid_filename << "iodine.pid" if(pid_filename[-1] == '/')
+  if File.exist?(pid_filename)
+    raise "pid filename shold point to a valid file name (not a folder)!" if(!File.file?(pid_filename))
+    File.delete(pid_filename)
+  end
+  Iodine.on_state(:pre_start) do
+    IO.binwrite(pid_filename, "#{Process.pid}\r\n")
+  end
+  Iodine.on_state(:on_finish) do
+    File.delete(pid_filename)
+  end
+end
+
+### Puma / Thin DSL compatibility - depracated (DSLs are evil)
+
+if(!defined?(after_fork))
+  # @deprecated use {Iodine.on_state}.
+  #
+  # Performs a block of code whenever a new worker process spins up (performed once per worker).
+  def after_fork(*args, &block)
+    warn "after_fork is deprecated, use Iodine.on_state(:after_fork)."
+    Iodine.on_state(:after_fork, &block)
+  end
+end
+if(!defined?(after_fork_in_worker))
+  # @deprecated use {Iodine.on_state}.
+  #
+  # Performs a block of code whenever a new worker process spins up (performed once per worker).
+  def after_fork_in_worker(*args, &block)
+    warn "after_fork_in_worker is deprecated, use Iodine.on_state(:enter_child)."
+    Iodine.on_state(:enter_child, &block)
+  end
+end
+if(!defined?(after_fork_in_master))
+  # @deprecated use {Iodine.on_state}.
+  #
+  # Performs a block of code whenever a new worker process spins up (performed once per worker).
+  def after_fork_in_master(*args, &block)
+    warn "after_fork_in_master is deprecated, use Iodine.on_state(:enter_master)."
+    Iodine.on_state(:enter_master, &block)
+  end
+end
+if(!defined?(on_worker_boot))
+  # @deprecated use {Iodine.on_state}.
+  #
+  # Performs a block of code before a new worker process spins up (performed once per worker).
+  def on_worker_boot(*args, &block)
+    warn "on_worker_boot is deprecated, use Iodine.on_state(:after_fork)."
+    Iodine.on_state(:after_fork, &block)
+  end
+end
+if(!defined?(on_worker_fork))
+  # @deprecated use {Iodine.on_state}.
+  #
+  # Performs a block of code before a new worker process spins up (performed once per worker).
+  def on_worker_fork(*args, &block)
+    warn "on_worker_fork is deprecated, use Iodine.on_state(:before_fork)."
+    Iodine.on_state(:before_fork, &block)
+  end
+end
+if(!defined?(before_fork))
+  # @deprecated use {Iodine.on_state}.
+  #
+  # Performs a block of code just before a new worker process spins up (performed once per worker, in the master thread).
+  def before_fork(*args, &block)
+    warn "before_fork is deprecated, use Iodine.on_state(:before_fork)."
+    Iodine.on_state(:before_fork, &block)
+  end
+end
+
+
+#############
+## At end of loading
+
+### Load configuration filer
+if Iodine::DEFAULT_SETTINGS[:conf_]
+  require Iodine::DEFAULT_SETTINGS[:conf_]
+  Iodine::DEFAULT_SETTINGS.delete :conf_
+end

data/lib/rack/handler/iodine.rb

@@ -0,0 +1,33 @@
+require 'iodine' unless defined?(::Iodine::VERSION)
+
+module Iodine
+  # Iodine's {Iodine::Rack} module provides a Rack compliant interface (connecting Iodine to Rack) for an HTTP and Websocket Server.
+  module Rack
+
+    # Runs a Rack app, as par the Rack handler requirements.
+    def self.run(app, options = {})
+      # nested applications... is that a thing?
+      Iodine.listen(service: :http, handler: app, port: options[:Port], address: options[:Host])
+
+      # start Iodine
+      Iodine.start
+
+      true
+    end
+
+    # patches an assumption by Rack, issue #98 code donated by @Shelvak (Néstor Coppi)
+    def self.shutdown
+      Iodine.stop
+    end
+
+    IODINE_RACK_LOADED = true
+  end
+end
+
+ENV['RACK_HANDLER'] ||= 'iodine'
+
+begin
+  ::Rack::Handler.register('iodine', 'Iodine::Rack') if defined?(::Rack::Handler)
+  ::Rack::Handler.register('Iodine', 'Iodine::Rack') if defined?(::Rack::Handler)
+rescue StandardError
+end

metadata

@@ -0,0 +1,284 @@
+--- !ruby/object:Gem::Specification
+name: rage-iodine
+version: !ruby/object:Gem::Version
+  version: 1.7.58
+platform: ruby
+authors:
+- Boaz Segev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.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'
+- !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'
+  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'
+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
+email:
+- bo@plezi.io
+executables:
+- iodine
+extensions:
+- ext/iodine/extconf.rb
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- LIMITS.md
+- README.md
+- Rakefile
+- 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/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
+- 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/iodine.c
+- ext/iodine/iodine.h
+- ext/iodine/iodine_caller.c
+- ext/iodine/iodine_caller.h
+- ext/iodine/iodine_connection.c
+- ext/iodine/iodine_connection.h
+- ext/iodine/iodine_defer.c
+- 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_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_store.h
+- ext/iodine/iodine_tcp.c
+- ext/iodine/iodine_tcp.h
+- ext/iodine/iodine_tls.c
+- 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/scheduler.c
+- ext/iodine/scheduler.h
+- ext/iodine/websocket_parser.h
+- ext/iodine/websockets.c
+- ext/iodine/websockets.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/version.rb
+- lib/rack/handler/iodine.rb
+- logo.png
+homepage: https://github.com/rage-rb/iodine
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: |-
+  Thank you for installing Iodine 1.7.58.
+  Remember: if iodine supports your business, it's only fair to give value back (code contributions / donations).
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+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.
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: iodine - a fast HTTP / Websocket Server with Pub/Sub support, optimized for
+  Ruby MRI on Linux / BSD / Windows
+test_files: []