nonnative 3.14.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 802f0ee020ba8e7c6cef867895d30c6491ace313fec8103aa6b99726c8402666
-  data.tar.gz: 70d522685a3c9cfbc872ee36549d9ba8274be60138a79db68e64c83115fd7cb5
+  metadata.gz: 8c6665f1bde87f38b1ba0622168efd569d1cce78df5773597984ab3eb07e07e6
+  data.tar.gz: 5662743abeb5f331675ef634754c024fed13f876664d5e0beccea21199c47f9a
 SHA512:
-  metadata.gz: a0b3e8502437cfd6d3a556a8a6f10901a2a89d85a4689fbad3c68d6819e03b4cccf5a51de3cfd66b86827d66f768891f68ee41c91b3ea504345c7f25d22178c8
-  data.tar.gz: b16ef6cfe6099e9a62be954178c71a743fb297ece661be2651239c8501707af30e1609e58abfe99bc58d007777a45c99505eb374484c0ba9788e886d0b876e42
+  metadata.gz: 1ec6d29ca79065600e123c9ec4e78d3d0b8ca76f06538b88c21b771f7be3ffce428f77949c80da574f7420826385e637de94f164711be82a5c7bc664a8ca9e41
+  data.tar.gz: 0aba7bdf975ef0f28ae9eb5f14ab4a78d8cf160ac09e63ebaff38d8edddbec8bb3fb94855dec864f18972771ad97076bcb0cfae2e5ad3713e6e0f87e65c38de6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nonnative (3.14.0)
+    nonnative (3.15.0)
       concurrent-ruby (>= 1, < 2)
       config (>= 5, < 6)
       cucumber (>= 7, < 12)

data/README.md

@@ -410,7 +410,7 @@ Define your server:
 ```ruby
 module Nonnative
   module Features
-    class Hello < Sinatra::Application
+    class HelloService < Nonnative::HTTPService
       get '/hello' do
         'Hello World!'
       end
@@ -418,7 +418,7 @@ module Nonnative
 
     class HTTPServer < Nonnative::HTTPServer
       def initialize(service)
-        super(Sinatra.new(Hello), service)
+        super(HelloService.new, service)
       end
     end
   end
@@ -543,7 +543,7 @@ end
 
 Define your server:
 
-Assume the gRPC service base class and response types below come from your generated gRPC stubs.
+Assume the gRPC service type and response types below come from your generated gRPC stubs.
 
 ```ruby
 module Nonnative

data/lib/nonnative/error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nonnative
-  # Base class for all Nonnative errors.
+  # Parent error for all Nonnative errors.
   #
   # Catch this error type if you want to handle any exception raised by this gem.
   #

data/lib/nonnative/http_proxy_server.rb

@@ -7,7 +7,7 @@
 #
 # This file defines two classes:
 #
-# - {Nonnative::HTTPProxy}: a Sinatra application that implements the proxying behavior.
+# - {Nonnative::HTTPProxy}: an HTTP service that implements the proxying behavior.
 # - {Nonnative::HTTPProxyServer}: a {Nonnative::HTTPServer} wrapper that runs the proxy app under Puma.
 #
 # Notes:
@@ -17,12 +17,12 @@
 # @see Nonnative::HTTPServer
 # @see Nonnative::Server
 module Nonnative
-  # Sinatra application implementing a simple forward proxy.
+  # HTTP service implementing a simple forward proxy.
   #
-  # The upstream host is configured via Sinatra settings (see {Nonnative::HTTPProxyServer}).
+  # The upstream host is configured via service settings (see {Nonnative::HTTPProxyServer}).
   #
   # Supported HTTP verbs: GET, POST, PUT, PATCH, DELETE.
-  class HTTPProxy < Sinatra::Application
+  class HTTPProxy < Nonnative::HTTPService
     NON_FORWARDABLE_HEADERS = %w[
       Host
       Accept-Encoding
@@ -135,13 +135,11 @@ module Nonnative
     # @param host [String] upstream host to proxy to (HTTPS)
     # @param service [Nonnative::ConfigurationServer] server configuration
     def initialize(host, service)
-      app = Sinatra.new(Nonnative::HTTPProxy) do
-        configure do
-          set :host, host
-        end
+      http_service = Class.new(Nonnative::HTTPProxy) do
+        set :host, host
       end
 
-      super(app, service)
+      super(http_service.new, service)
     end
   end
 end

data/lib/nonnative/http_server.rb

@@ -3,19 +3,19 @@
 module Nonnative
   # Puma-based HTTP server runner.
   #
-  # This is a convenience server implementation for running a Rack/Sinatra application in-process
-  # under Nonnative's server lifecycle. It binds to the configured server `host` and first `ports` entry.
+  # This is a convenience server implementation for running an HTTP service in-process under
+  # Nonnative's server lifecycle. It binds to the configured server `host` and first `ports` entry.
   #
   # The server is started and stopped by {Nonnative::Server} via {#perform_start} / {#perform_stop}.
   #
-  # @example Running a Sinatra app
+  # @example Running an HTTP service
+  #   class HelloHTTPService < Nonnative::HTTPService
+  #     get('/hello') { 'Hello World!' }
+  #   end
+  #
   #   class HelloHTTPServer < Nonnative::HTTPServer
   #     def initialize(service)
-  #       app = Sinatra.new do
-  #         get('/hello') { 'Hello World!' }
-  #       end
-  #
-  #       super(app, service)
+  #       super(HelloHTTPService.new, service)
   #     end
   #   end
   #
@@ -34,18 +34,18 @@ module Nonnative
   #
   # @see Nonnative::Server
   class HTTPServer < Nonnative::Server
-    # Creates a Puma server for the given Rack app and runner configuration.
+    # Creates a Puma server for the given HTTP service and runner configuration.
     #
-    # @param app [#call] a Rack-compatible application (e.g. Sinatra/Rack app)
+    # @param http_service [#call] an HTTP service instance
     # @param service [Nonnative::ConfigurationServer] server configuration
-    def initialize(app, service)
+    def initialize(http_service, service)
       # Keep the log IO so the server lifecycle can release Puma's file handle on stop.
       @log = File.open(service.log, 'a')
       options = {
         log_writer: Puma::LogWriter.new(log, log),
         force_shutdown_after: service.timeout
       }
-      @server = Puma::Server.new(app, Puma::Events.new, options)
+      @server = Puma::Server.new(http_service, Puma::Events.new, options)
 
       super(service)
     end

data/lib/nonnative/http_service.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Nonnative
+  # HTTP service run by {Nonnative::HTTPServer}.
+  #
+  # Subclass this instead of `Sinatra::Application` when defining an in-process HTTP server for
+  # Nonnative. {Nonnative::HTTPServer} accepts a service instance and runs it under Puma.
+  class HTTPService < Sinatra::Application
+  end
+end

data/lib/nonnative/proxy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nonnative
-  # Base class for proxy implementations.
+  # Parent type for proxy implementations.
   #
   # A proxy is responsible for interposing behavior between a client and a target service.
   # Runtime services create a proxy instance via {Nonnative::ProxyFactory} based on `service.proxy.kind`.

data/lib/nonnative/version.rb

@@ -4,5 +4,5 @@ module Nonnative
   # The current gem version.
   #
   # @return [String]
-  VERSION = '3.14.0'
+  VERSION = '3.15.0'
 end

data/lib/nonnative.rb

@@ -91,6 +91,7 @@ require 'nonnative/tcp_probe'
 require 'nonnative/http_probe'
 require 'nonnative/grpc_health'
 require 'nonnative/grpc_probe'
+require 'nonnative/http_service'
 require 'nonnative/http_server'
 require 'nonnative/http_proxy_server'
 require 'nonnative/grpc_server'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nonnative
 version: !ruby/object:Gem::Version
-  version: 3.14.0
+  version: 3.15.0
 platform: ruby
 authors:
 - Alejandro Falkowski
@@ -310,6 +310,7 @@ files:
 - lib/nonnative/http_probe.rb
 - lib/nonnative/http_proxy_server.rb
 - lib/nonnative/http_server.rb
+- lib/nonnative/http_service.rb
 - lib/nonnative/invalid_data_socket_pair.rb
 - lib/nonnative/no_proxy.rb
 - lib/nonnative/not_found_error.rb