iodine 0.7.16 → 0.7.17

data/ext/iodine/iodine_tls.h

@@ -0,0 +1,13 @@
+#ifndef H_IODINE_TLS_H
+#define H_IODINE_TLS_H
+
+#include "iodine.h"
+
+#include "fio_tls.h"
+
+void iodine_init_tls(void);
+fio_tls_s *iodine_tls2c(VALUE self);
+
+extern VALUE IodineTLSClass;
+
+#endif

data/ext/iodine/mustache_parser.h

@@ -1,5 +1,5 @@
 /*
-Copyright: Boaz Segev, 2018
+Copyright: Boaz Segev, 2018-2019
 License: MIT
 
 Feel free to copy, use and enjoy according to the license provided.

data/ext/iodine/redis_engine.c

@@ -1,5 +1,5 @@
 /*
-Copyright: Boaz segev, 2016-2017
+Copyright: Boaz segev, 2016-2019
 License: MIT
 
 Feel free to copy, use and enjoy according to the license provided.
@@ -390,6 +390,12 @@ Connection Callbacks (fio_protocol_s) and Engine
 /** defined later - connects to Redis */
 static void redis_connect(void *r, void *i);
 
+#define defer_redis_connect(r, i)                                              \
+  do {                                                                         \
+    fio_atomic_add(&(r)->ref, 1);                                              \
+    fio_defer(redis_connect, (r), (i));                                        \
+  } while (0);
+
 /** Called when a data is available, but will not run concurrently */
 static void redis_on_data(intptr_t uuid, fio_protocol_s *pr) {
   struct redis_engine_internal_s *internal =
@@ -430,7 +436,7 @@ static void redis_on_close(intptr_t uuid, fio_protocol_s *pr) {
                         (int)getpid());
       }
       fio_atomic_sub(&r->ref, 1);
-      fio_defer(redis_connect, r, internal);
+      defer_redis_connect(r, internal);
     } else {
       redis_free(r);
     }
@@ -505,7 +511,7 @@ static void redis_on_connect(intptr_t uuid, void *i_) {
     }
     fio_pubsub_reattach(&r->en);
     if (r->pub_data.uuid == -1) {
-      fio_defer(redis_connect, r, &r->pub_data);
+      defer_redis_connect(r, &r->pub_data);
     }
     FIO_LOG_INFO("(redis %d) subscription connection established.",
                  (int)getpid());
@@ -551,9 +557,11 @@ static void redis_on_connect_failed(intptr_t uuid, void *i_) {
 static void redis_connect(void *r_, void *i_) {
   redis_engine_s *r = r_;
   struct redis_engine_internal_s *i = i_;
-  if (r->flag == 0 || i->uuid != -1 || !fio_is_running())
+  if (r->flag == 0 || i->uuid != -1 || !fio_is_running()) {
+    redis_free(r);
     return;
-  fio_atomic_add(&r->ref, 1);
+  }
+  // fio_atomic_add(&r->ref, 1);
   i->uuid = fio_connect(.address = r->address, .port = r->port,
                         .on_connect = redis_on_connect, .udata = i,
                         .on_fail = redis_on_connect_failed);
@@ -785,7 +793,7 @@ static void redis_on_facil_start(void *r_) {
   redis_engine_s *r = r_;
   r->flag = 1;
   if (!fio_is_valid(r->sub_data.uuid)) {
-    fio_defer(redis_connect, r, &r->sub_data);
+    defer_redis_connect(r, &r->sub_data);
   }
 }
 static void redis_on_facil_shutdown(void *r_) {

data/ext/iodine/redis_engine.h

@@ -1,5 +1,5 @@
 /*
-Copyright: Boaz segev, 2016-2017
+Copyright: Boaz segev, 2016-2019
 License: MIT
 
 Feel free to copy, use and enjoy according to the license provided.

data/ext/iodine/resp_parser.h

@@ -1,5 +1,5 @@
 /*
-Copyright: Boaz segev, 2016-2017
+Copyright: Boaz segev, 2016-2019
 License: MIT
 
 Feel free to copy, use and enjoy according to the license provided.

data/ext/iodine/websocket_parser.h

@@ -1,5 +1,5 @@
 /*
-copyright: Boaz Segev, 2017
+copyright: Boaz Segev, 2017-2019
 license: MIT
 
 Feel free to copy, use and enjoy according to the license specified.

data/ext/iodine/websockets.c

@@ -1,5 +1,5 @@
 /*
-copyright: Boaz Segev, 2016-2018
+copyright: Boaz Segev, 2016-2019
 license: MIT
 
 Feel free to copy, use and enjoy according to the license provided.

data/ext/iodine/websockets.h

@@ -1,5 +1,5 @@
 /*
-copyright: Boaz Segev, 2016-2018
+copyright: Boaz Segev, 2016-2019
 license: MIT
 
 Feel free to copy, use and enjoy according to the license provided.

data/iodine.gemspec

@@ -34,7 +34,8 @@ Gem::Specification.new do |spec|
   spec.requirements << 'A Unix based system: Linux / macOS / BSD.'
   spec.requirements << 'An updated C compiler.'
   spec.requirements << 'Ruby >= 2.2.2 required for Rack 2.'
-  spec.requirements << 'Ruby >= 2.4.0 recommended.'
+  spec.requirements << 'Ruby >= 2.5.0 recommended.'
+  spec.requirements << 'TLS requires OpenSSL >= 1.1.0'
 
   spec.add_development_dependency 'bundler', '>= 1.10', '< 2.0'
   spec.add_development_dependency 'rake', '~> 12.0', '< 13.0'

data/lib/iodine.rb

@@ -1,4 +1,5 @@
-require 'socket' # TCPSocket is used internally for Hijack support
+require 'socket'  # TCPSocket is used internally for Hijack support
+# require 'openssl' # For SSL/TLS support using OpenSSL
 
 require 'iodine/version'
 require 'iodine/iodine'
@@ -47,9 +48,7 @@ require 'iodine/iodine'
 #
 # 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 and Unix Sockets connections include {listen} and {connect}.
-#
-# Methods for HTTP connections include {listen2http}.
+# 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.
 #
@@ -76,6 +75,15 @@ module Iodine
     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).
@@ -154,8 +162,14 @@ end
 ### Parse CLI for default HTTP settings
 Iodine::Base::CLI.parse
 
+### 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_HTTP_ARGS[:redis_], ping: Iodine::DEFAULT_HTTP_ARGS[:redis_ping_]) if Iodine::DEFAULT_HTTP_ARGS[:redis_]
+Iodine::PubSub.default = Iodine::PubSub::Redis.new(Iodine::DEFAULT_SETTINGS[:redis_], ping: Iodine::DEFAULT_SETTINGS[:redis_ping_]) if Iodine::DEFAULT_SETTINGS[:redis_]
 
 ### Puma / Thin DSL compatibility - depracated (DSLs are evil)
 

data/lib/iodine/connection.rb

@@ -1,4 +1,17 @@
 module Iodine
+
+  # The default connection settings used by {Iodine.listen} and {Iodine.connect}.
+  #
+  # It's a Hash object that allows Iodine default values to be manipulated. i.e.:
+  #
+  #       DEFAULT_SETTINGS[:port] = "8080" # replaces the default port, which is `ENV["port"] || "3000"`.
+  DEFAULT_SETTINGS = {}
+
+  # @deprecated use {Iodine::DEFAULT_SETTINGS}.
+  #
+  # The default connection settings used by {Iodine.listen} and {Iodine.connect}.
+  DEFAULT_HTTP_ARGS = DEFAULT_SETTINGS
+
   # Iodine's {Iodine::Connection} class is the class that TCP/IP, WebSockets and SSE connections inherit from.
   #
   # Instances of this class are passed to the callback objects. i.e.:

data/lib/iodine/mustache.rb

@@ -29,9 +29,10 @@ module Iodine
   #     require 'mustache'
   #     require 'iodine'
   #
+  #     # Benchmark code was copied, in part, from:
+  #     #   https://github.com/mustache/mustache/blob/master/benchmarks/render_collection_benchmark.rb
+  #     # The test is, sadly, biased and doesn't test for missing elements, proc/method resolution or template partials.
   #     def benchmark_mustache
-  #       # benchmark code was copied, in part, from:
-  #       #   https://github.com/mustache/mustache/blob/master/benchmarks/render_collection_benchmark.rb
   #       template = """
   #       {{#products}}
   #         <div class='product_brick'>
@@ -52,16 +53,12 @@ module Iodine
   #       IO.write "test_template.mustache", template
   #       filename = "test_template.mustache"
   #
-  #       data_1 = {
-  #         products: [ {
-  #           :external_index=>"This <product> should've been \"properly\" escaped.",
-  #           :url=>"/products/7",
-  #           :image=>"products/product.jpg"
-  #         } ]
-  #       }
   #       data_1000 = {
   #         products: []
   #       }
+  #       data_1000_escaped = {
+  #         products: []
+  #       }
   #
   #       1000.times do
   #         data_1000[:products] << {
@@ -69,13 +66,6 @@ module Iodine
   #           :url=>"/products/7",
   #           :image=>"products/product.jpg"
   #         }
-  #       end
-  #
-  #       data_1000_escaped = {
-  #         products: []
-  #       }
-  #
-  #       1000.times do
   #         data_1000_escaped[:products] << {
   #           :external_index=>"This <product> should've been \"properly\" escaped.",
   #           :url=>"/products/7",
@@ -86,14 +76,7 @@ module Iodine
   #       view = Mustache.new
   #       view.template = template
   #       view.render # Call render once so the template will be compiled
-  #       iodine_view = Iodine::Mustache.new(filename)
-  #
-  #       puts "Ruby Mustache rendering (and HTML escaping) results in:",
-  #            view.render(data_1), "",
-  #            "Notice that Iodine::Mustache rendering (and HTML escaping) results in agressive escaping:",
-  #            iodine_view.render(data_1), "", "----"
-  #
-  #       # return;
+  #       iodine_view = Iodine::Mustache.new(template: template)
   #
   #       Benchmark.ips do |x|
   #         x.report("Ruby Mustache render list of 1000") do |times|

data/lib/iodine/tls.rb

@@ -0,0 +1,16 @@
+module Iodine
+  # Iodine's {Iodine::TLS} instances hold SSL/TLS settings for secure connections.
+  #
+  # This allows both secure client connections and secure server connections to be established.
+  #
+  #     tls = Iodine::TLS.new "localhost" # self-signed certificate
+  #     Iodine.listen service: "http", handler: APP, tls: tls
+  #
+  # Iodine abstracts away the underlying SSL/TLS library to minimize the risk of misuse and insecure settings.
+  #
+  # Calling TLS methods when no SSL/TLS library is available should result in iodine crashing. This is expected behavior.
+  #
+  # At the moment, only OpenSSL is supported. BearSSL support is planned.
+	class TLS
+	end
+end

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = '0.7.16'.freeze
+  VERSION = '0.7.17'.freeze
 end

data/lib/rack/handler/iodine.rb

@@ -7,7 +7,7 @@ module Iodine
     # Runs a Rack app, as par the Rack handler requirements.
     def self.run(app, options = {})
       # nested applications... is that a thing?
-      Iodine.listen2http(app: app, port: options[:Port], address: options[:Address])
+      Iodine.listen(service: :http, handler: app, port: options[:Port], address: options[:Address])
 
       # start Iodine
       Iodine.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.7.16
+  version: 0.7.17
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -110,7 +111,7 @@ files:
 - README.md
 - Rakefile
 - SPEC-PubSub-Draft.md
-- SPEC-Websocket-Draft.md
+- SPEC-WebSocket-Draft.md
 - bin/console
 - bin/info.md
 - bin/mustache_bench.rb
@@ -126,6 +127,8 @@ files:
 - 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
@@ -135,6 +138,9 @@ files:
 - 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
@@ -189,6 +195,8 @@ files:
 - 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
@@ -203,6 +211,7 @@ files:
 - 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
@@ -211,7 +220,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 'Thank you for installing Iodine 0.7.16.
+post_install_message: 'Thank you for installing Iodine 0.7.17.
 
 '
 rdoc_options: []
@@ -232,7 +241,8 @@ requirements:
 - 'A Unix based system: Linux / macOS / BSD.'
 - An updated C compiler.
 - Ruby >= 2.2.2 required for Rack 2.
-- Ruby >= 2.4.0 recommended.
+- Ruby >= 2.5.0 recommended.
+- TLS requires OpenSSL >= 1.1.0
 rubyforge_project: 
 rubygems_version: 2.7.7
 signing_key: