simple-httpd 0.3.0 → 0.3.1

data/lib/simple/httpd/server.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Metrics/PerceivedComplexity, Metrics/AbcSize
+
 class Simple::Httpd
   module Server
     extend self
@@ -8,16 +10,13 @@ class Simple::Httpd
       def <<(msg); end
     end
 
-    def listen!(app, environment: "development", host: nil, port:, logger: nil)
+    def listen!(app, environment: "development", host: nil, port:)
       expect! app != nil
 
       host ||= "127.0.0.1"
       URI("http://#{host}:#{port}") # validate host and port
 
-      logger ||= ::Simple::Httpd.logger
-
-      prepare_logger!(logger)
-      logger.info "Starting httpd server on http://#{host}:#{port}/"
+      ::Simple::Httpd.logger.info "Starting httpd server on http://#{host}:#{port}/"
 
       app = ::Rack::Lint.new(app) if environment != "production"
 
@@ -30,32 +29,45 @@ class Simple::Httpd
                            Host: host,
                            Port: port,
                            environment: environment,
-                           Logger: logger,
+                           Logger: build_logger,
                            AccessLog: [[NullLogger, ""]]
     end
 
     private
 
-    # When Webrick is being shut down via SIGTERM - which we do at least during
-    # rspec-httpd triggered runs - it sends a fatal message to the logger. We catch
-    # it - to "downgrade" it to INFO - but we still abort.
-    def prepare_logger!(logger)
+    def build_logger
+      # We create a fresh STDERR logger. The log level is taken from Simple::Httpd -
+      # but is at maximum :info, since we don't want to log internals of Webrick & co.
+      #
+      # (Note that our own services would probably use ::Simple::Httpd.logger, which
+      # sticks at the current level.)
+      if ::Simple::Httpd.custom_logger?
+        logger = ::Simple::Httpd.logger
+      else
+        log_level = ::Simple::Httpd.logger.debug? ? :info : ::Simple::Httpd.logger.level
+        logger = ::Logger.new STDERR, level: log_level
+      end
+
+      # When Webrick is being shut down via SIGTERM - which we do at least during
+      # rspec-httpd triggered runs - it sends a fatal message to the logger. We catch
+      # it - to "downgrade" it to INFO - but we still abort.
       def logger.fatal(msg, &block)
         if msg.is_a?(SignalException) && msg.signo == ::Signal.list["TERM"]
-          if %w(test development).include?(::Simple::Httpd.env)
-            info "Received SIGTERM: hard killing server (due to running in #{::Simple::Httpd.env.inspect} environment)"
-            Simple::Httpd::Server.exit!
+          env = ::Simple::Httpd.env
+          if %w(test development).include?(env)
+            ::Simple::Httpd.logger.info "Received SIGTERM: hard killing server (due to running in #{env.inspect} environment)"
+            ::Simple::Httpd::Server.send :exit!
           else
-            info "Received SIGTERM: shutting down server..."
+            ::Simple::Httpd.logger.info "Received SIGTERM: shutting down server..."
             exit 1
           end
         end
 
         super
       end
-    end
 
-    public
+      logger
+    end
 
     def exit!(exit_status = 1)
       # Run SimpleCov if exists, and if this is the PID that started SimpleCov in the first place.

data/lib/simple/httpd/service_adapter.rb

@@ -0,0 +1,108 @@
+require "simple-service"
+
+module Simple::Httpd::ServiceAdapter
+  def mount_service(service)
+    @service = service
+
+    instance_eval do
+      def dispatch!
+        ::Simple::Service.with_context(context)
+        super
+      ensure
+        ::Simple::Service.context = nil
+      end
+
+      yield(service)
+    end
+  ensure
+    @service = nil
+  end
+
+  def get(path, opts = {}, &block)
+    install_route("GET", path, opts, &block)
+  end
+
+  def post(path, opts = {}, &block)
+    install_route("POST", path, opts, &block)
+  end
+
+  def put(path, opts = {}, &block)
+    install_route("PUT", path, opts, &block)
+  end
+
+  def delete(path, opts = {}, &block)
+    install_route("DELETE", path, opts, &block)
+  end
+
+  def head(path, opts = {}, &block)
+    install_route("HEAD", path, opts, &block)
+  end
+
+  private
+
+  def service_route?(_verb, path, opts, &block)
+    return false unless @service
+    return false if block
+    return false unless opts.empty?
+    return false unless path.is_a?(Hash) && path.size == 1
+
+    true
+  end
+
+  def install_route(verb, path, opts, &block)
+    if service_route?(verb, path, opts, &block)
+      path, action_name = *path.first
+      handle_service_route(verb, path, action_name)
+    else
+      handle_non_service_route(verb, path, opts, &block)
+    end
+  end
+
+  def handle_service_route(verb, path, action_name)
+    # Fetch action's source_location. This also verifies that the action
+    # is defined in the first place.
+    action = ::Simple::Service.action(@service, action_name)
+
+    describe_route!(verb: verb, path: path, source_location: action.source_location)
+
+    # get service reference into binding, to make it available for the route
+    # definition's callback block.
+    service = @service
+
+    # define sinatra route.
+    route(verb, path) do
+      ::Simple::Service.with_context(context) do
+        # [TODO] - symbolizing keys opens up this for DDOS effects.
+        # THIS MUST BE FIXED IN simple-service.
+        flags = self.params.inject({}) { |hsh, (k,v)| hsh.update k.to_sym => v }
+        args = self.parsed_body.inject({}) { |hsh, (k,v)| hsh.update k.to_sym => v }
+
+        result = ::Simple::Service.invoke2(service, action_name, args: args, flags: flags)
+        encode_result(result)
+      end
+    end
+  end
+
+  def handle_non_service_route(verb, path, opts, &block)
+    describe_route!(verb: verb, path: path, source_location: block.source_location) if block
+
+    route(verb, path, opts) do
+      result = instance_eval(&block)
+      unless headers["Content-Type"]
+        result = encode_result(result)
+      end
+      result
+    end
+  end
+
+  module Helpers
+    def context
+      # We return nil here. nil *is* a valid value for Simple::Service.with_context.
+      # Important is that with_context is being called.
+      nil
+    end
+  end
+end
+
+::Simple::Httpd::BaseController.extend(::Simple::Httpd::ServiceAdapter)
+::Simple::Httpd::BaseController.helpers(::Simple::Httpd::ServiceAdapter::Helpers)

data/simple-httpd.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "sinatra", "~> 2"
   # gem.add_dependency "sinatra-reloader", "~> 1"
   gem.add_dependency "expectation", "~> 1"
-  gem.add_dependency "simple-cli", "~> 0.3.0"
+  gem.add_dependency "simple-cli", "~> 0.3.3"
+  gem.add_dependency "simple-service", "~> 0.1.2"
 end
 #require "expectation"

data/spec/simple/httpd/base_controller/httpd_cors_spec.rb

@@ -7,9 +7,14 @@ describe Simple::Httpd do
       expect(http.response.headers.keys).to include("access-control-allow-origin")
     end
 
-    it "returns CORS headers" do
-      http.get "/README.txt"
-      expect(http.response.headers.keys).not_to include("access-control-allow-origin")
+    it "sends proper headers in all request methods" do
+      verbs = [ :get, :post, :put, :delete, :options, :head ]
+      verbs.each do |verb|
+      http.send verb, "/info/inspect?qux"
+
+      expect_response 200
+      expect(http.response.headers.keys).to include("access-control-allow-origin")
+end
     end
   end
 end

data/spec/simple/httpd/base_controller/httpd_url_building_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Simple::Httpd do
+  describe "full_url" do
+    it "builds a full_url" do
+      http.get "/spec/full_url"
+      expect_response("http://127.0.0.1:12345/foo?search=s&page=1")
+    end
+  end
+
+  describe "url" do
+    it "returns X-Processing headers on dynamic responses" do
+      http.get "/spec/url"
+      expect_response("foo?search=s&page=1")
+    end
+  end
+end

data/spec/simple/httpd/helpers_spec.rb

@@ -1,15 +1,32 @@
 require "spec_helper"
 
-describe Simple::Httpd do
-  describe "helpers" do
-    it "loads helpers from the same directory tree" do
-      http.get "/helpers/ex2"
-      expect_response "ex2_helper"
+describe "Simple::Httpd::Helpers" do
+  H = Simple::Httpd::Helpers
+  
+  describe ".filtered_stacktrace" do
+    def some_stacktrace(depth = 1)
+      if depth == 0
+        caller
+      else
+        some_stacktrace(depth-1)
+      end
     end
 
-    it "does not load helpers from other directory tree even on the same URL tree" do
-      http.get "/helpers/ex1"
-      expect_response status: 404
+    def filtered_stacktrace
+      H.filtered_stacktrace(some_stacktrace)
+    end
+
+    it "removes .rvm lines" do
+      actual = filtered_stacktrace
+
+      expect(actual.grep(/lines removed/).count).to eq(1)
+      expect(actual.grep(/helpers_spec/).count).to be > 1 
+      expect(actual.grep(/some_stacktrace/).count).to eq(1)
+    end
+
+    it "shortens paths" do
+      source_path = filtered_stacktrace.grep(/helpers_spec/).first
+      expect(source_path).to start_with("./")
     end
   end
 end

data/spec/simple/httpd/loading_helpers_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Simple::Httpd do
+  describe "helpers" do
+    it "loads helpers from the same directory tree" do
+      http.get "/helpers/ex2"
+      expect_response "ex2_helper"
+    end
+
+    it "does not load helpers from other directory tree even on the same URL tree" do
+      http.get "/helpers/ex1"
+      expect_response status: 404
+    end
+  end
+end

data/spec/simple/httpd/rspec_httpd_spec.rb

@@ -1,17 +1,33 @@
 require "spec_helper"
 
 describe "RSpec::Httpd features" do
-  it "sends proper headers" do
-    http.get "/info/inspect?qux"
+  VERBS_WO_BODY = [ :options, :head ]
 
-    result_lines = http.content.split("\n")
+  VERBS = [ :get, :post, :put, :delete ]
 
-    expect(result_lines).to include("QUERY_STRING=qux")
-    expect(result_lines).to include("REQUEST_METHOD=GET")
-    expect(result_lines).to include("REQUEST_PATH=/info/inspect")
-    expect(result_lines).to include("SERVER_NAME=127.0.0.1")
-    expect(result_lines).to include("SERVER_PORT=12345")
+  VERBS.each do |verb|
+    it "sends proper headers in #{verb} request" do
+      http.send verb, "/info/inspect?qux"
 
-    expect(http.response.headers["content-type"]).to match(/text\/plain/)
+      result_lines = http.content.split("\n")
+
+      expect(result_lines).to include("QUERY_STRING=qux")
+      expect(result_lines).to include("REQUEST_METHOD=#{verb.upcase}")
+      expect(result_lines).to include("REQUEST_PATH=/info/inspect")
+      expect(result_lines).to include("SERVER_NAME=127.0.0.1")
+      expect(result_lines).to include("SERVER_PORT=12345")
+
+      expect(http.response.headers["content-type"]).to match(/text\/plain/)
+    end
+  end
+
+  VERBS_WO_BODY = [ :options, :head ]
+
+  VERBS_WO_BODY.each do |verb|
+    it "supports #{verb} methods" do
+      http.send verb, "/info/inspect?qux"
+
+      expect_response 200
+    end
   end
 end

data/spec/simple/httpd/services/service_explicit_spec.rb

@@ -22,11 +22,6 @@ describe "explicit mounting of service" do
     expect_response 422
   end
 
-  it "ignores missing parameters arguments" do
-    http.post "/example_service/echo/1", { one: "foo", two: "bar" }
-    expect_response "one: [foo]/two: [bar]/a: [1]/b: []"
-  end
-
   it "properly extracts arguments and parameters" do
     http.put "/example_service/echo_context"
     expect_response /Simple::Service::Context/

data/spec/simple/httpd/services/sideloading_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe "sideloading" do
+  # mounting not at root level
+  it "sideloads code" do
+    http.get "/sideloaded_service"
+    expect_response("hello_world")
+  end
+end

data/spec/spec_helper.rb

@@ -12,15 +12,14 @@ end
 # You can comment parts of the command below by prepending the line with a '#'
 HTTPD_COMMAND = <<~CMD
   PORT=12345
-  bin/simple-httpd
+  bin/simple-httpd start
   --environment=test
   examples/ex1
   examples/ex2
   examples/ex3
   examples/v2:api/v2
   --services=examples/services
-  Example::Service:service/example
-  2> log/test.log
+#  2> log/test.log
 CMD
 
 RSpec::Httpd.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-httpd
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - radiospiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-16 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: simple-service
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 description: Super-simple HTTPD server - sinatra w/gimmiks
 email: eno@radiospiel.org
 executables: []
@@ -87,15 +101,16 @@ files:
 - bin/rubocop
 - bin/simple-httpd
 - examples/README.md
+- examples/ex1.services/ex1_service_module.rb
 - examples/ex1/ex1_helpers.rb
 - examples/ex1/root.rb
+- examples/ex1/spec.rb
 - examples/ex2/README.txt
 - examples/ex2/ex2_helpers.rb
 - examples/ex2/helpers.rb
 - examples/ex2/info.rb
 - examples/ex2/root.rb
 - examples/ex3/example_service.rb
-- examples/services/example_service.rb
 - examples/services/explicit_example_service.rb
 - examples/v2/api.js
 - examples/v2/jobs.rb
@@ -111,20 +126,20 @@ files:
 - lib/simple/httpd/base_controller/debug.rb
 - lib/simple/httpd/base_controller/error_handling.rb
 - lib/simple/httpd/base_controller/json.rb
+- lib/simple/httpd/base_controller/request.rb
+- lib/simple/httpd/base_controller/result.rb
 - lib/simple/httpd/base_controller/x_processing.rb
 - lib/simple/httpd/cli.rb
 - lib/simple/httpd/helpers.rb
-- lib/simple/httpd/mount_spec.rb
+- lib/simple/httpd/mount.rb
 - lib/simple/httpd/rack.rb
 - lib/simple/httpd/rack/dynamic_mount.rb
 - lib/simple/httpd/rack/merger.rb
 - lib/simple/httpd/rack/static_mount.rb
+- lib/simple/httpd/route.rb
 - lib/simple/httpd/server.rb
-- lib/simple/httpd/service.rb
+- lib/simple/httpd/service_adapter.rb
 - lib/simple/httpd/version.rb
-- lib/simple/service.rb
-- lib/simple/service/action.rb
-- lib/simple/service/context.rb
 - log/.gitkeep
 - scripts/release
 - scripts/release.rb
@@ -133,13 +148,15 @@ files:
 - simple-httpd.gemspec
 - spec/simple/httpd/base_controller/httpd_cors_spec.rb
 - spec/simple/httpd/base_controller/httpd_debug_spec.rb
+- spec/simple/httpd/base_controller/httpd_url_building_spec.rb
 - spec/simple/httpd/base_controller/httpd_x_processing_copy.rb
 - spec/simple/httpd/base_spec.rb
 - spec/simple/httpd/dynamic_mounting_spec.rb
 - spec/simple/httpd/helpers_spec.rb
+- spec/simple/httpd/loading_helpers_spec.rb
 - spec/simple/httpd/rspec_httpd_spec.rb
 - spec/simple/httpd/services/service_explicit_spec.rb
-- spec/simple/httpd/services/service_spec.rb
+- spec/simple/httpd/services/sideloading_spec.rb
 - spec/simple/httpd/static_mounting_spec.rb
 - spec/spec_helper.rb
 - spec/support/004_simplecov.rb
@@ -168,13 +185,15 @@ summary: Super-simple HTTPD server
 test_files:
 - spec/simple/httpd/base_controller/httpd_cors_spec.rb
 - spec/simple/httpd/base_controller/httpd_debug_spec.rb
+- spec/simple/httpd/base_controller/httpd_url_building_spec.rb
 - spec/simple/httpd/base_controller/httpd_x_processing_copy.rb
 - spec/simple/httpd/base_spec.rb
 - spec/simple/httpd/dynamic_mounting_spec.rb
 - spec/simple/httpd/helpers_spec.rb
+- spec/simple/httpd/loading_helpers_spec.rb
 - spec/simple/httpd/rspec_httpd_spec.rb
 - spec/simple/httpd/services/service_explicit_spec.rb
-- spec/simple/httpd/services/service_spec.rb
+- spec/simple/httpd/services/sideloading_spec.rb
 - spec/simple/httpd/static_mounting_spec.rb
 - spec/spec_helper.rb
 - spec/support/004_simplecov.rb