simple-httpd 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00457b4ed11c8a501e43a4c4826ef6d78722b072ffff0bab1b0c609c797e14f7
-  data.tar.gz: ed35d788fba032b31b971f29e07b23cf490ffc1d96a3aff9369bc812bda22dde
+  metadata.gz: 02564f089db886a8701424a42bedbe88bb6401febc4eb397b5630560bd82595a
+  data.tar.gz: 139371909bee1f7045f51d5ad6a0ee4b18f080eb461e8a8770c16ad506fb7e73
 SHA512:
-  metadata.gz: 0d57c201cad87a16655eb6e05a4b527176603ab063d08878b44711741babd3fb62140224b5e7cfd0c6ff3e2937c5d177c6ffcb4d88143903f99d36bd5d937f02
-  data.tar.gz: a55d03f273b5a634262a55916c15690bf845641f69af2217a82d4a778b84af089cdb3722df89c25d4d1d847a2654f4c858c141900115e895c8fa3d8ef55dbc4b
+  metadata.gz: 52fdf766ce5cd92ef52426f739c4fb3ec3af76703c6e2190bc20873d0a3f01c28ed6e0f22aa3d79870fb8e13d755b61cf0280935747429d693278d175036766d
+  data.tar.gz: 7b88cdc01ea262105f25dbdb5fcd28c75d464cd5d0e1bda597e51002355310f2dc96ccecedd64bb5e1266306e01fcadfc6ea98609352b9a56eb1db2a0d1ce298

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.7

data/README.md

@@ -30,13 +30,9 @@ They become available at the location specified by their filename and extension.
 
 ### Dynamic assets
 
-Each mounted directory which contains ruby source files is converted into a sinatra application, which consists of a root configuration and controllers for each action file.
+Each mounted directory might contain a "routes.rb" ruby source file which is loaded in the context of a Sinatra controller to set up routes. Example:
 
-Ruby files ending in `_helpers.rb`, e.g. `examples/ex1/ex1_helpers.rb` are executed in the context of a directory tree's root controller and provide functionality available in all action files. Typically they do not implement HTTP handlers themselves.
-
-All other ruby files implement HTTP handlers in typical sinatra fashion:
-
-    # in v2/jobs.rb
+    # in v2/routes.rb
     get "/queue/:id/events" do
       events = [
         { job_id: params[:id], id: "event1" },
@@ -46,16 +42,10 @@ All other ruby files implement HTTP handlers in typical sinatra fashion:
       json events
     end
 
-If this snippet is contained in a file `v2/jobs.rb` and the `v2` directory is mounted into `api/v2`, the snipped implements the handler for, for example, `GET /api/v2/jobs/queue/123/events`. In other words, the handler implement in the source file works on paths relative to a path combining the mount location and the file name.
-
-To implement a action on the mountpoint itself one uses the `root.rb` file. The following
-
-    # in v2/root.rb
-    get "/" do
-      json version: "123"
-    end
+Ruby files below `./helpers` in the dynamically loaded directory is loaded as a helper file when setting up a dynamic mount, e.g. `examples/ex1/helpers/ex1_helpers.rb` are executed in the context of a directory tree's root controller and provide functionality
+available in the `routes.rb` file.
 
-would implement `GET /api/v2`.
+[TODO] describe service usage.
 
 ## Command line usage
 
@@ -77,8 +67,7 @@ The arguments `ex1` and `ex2` serve at the `/` location. This notation really is
     port = 12345
 
     app = ::Simple::Httpd.build("/" => httpd_root_dir)
-    ::Simple::Httpd.listen! app, port: port,
-                                 logger: ::Logger.new(STDERR)
+    ::Simple::Httpd.listen! app, port: port, logger: ::Logger.new(STDERR)
 
 
 ## The example application

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.0

data/examples/README.md

@@ -18,14 +18,14 @@ The following explanations assume you started a server with the configuration me
 
 This directory currently contains these files:
 
-    - ex1/root.rb
+    - ex1/routes.rb
     - ex1/ex1_helpers.rb
     - ex2/helpers.rb
-    - ex2/root.rb
+    - ex2/routes.rb
     - ex2/info.rb
     - ex2/ex2_helpers.rb
     - ex2/README.txt
-    - v2/root.rb
+    - v2/routes.rb
     - v2/jobs.rb
     - v2/v2_helpers.rb
     - v2/api.js
@@ -34,8 +34,8 @@ This directory currently contains these files:
 
 The following lists some routes and where they are implemented:
 
-  GET "/"                         .. in ex1/root.rb
-  GET "/debug"                    .. in ex2/root.rb
+  GET "/"                         .. in ex1/routes.rb
+  GET "/debug"                    .. in ex2/routes.rb
   GET "/info/inspect"             .. in ex2/info.rb
-  GET "/api/v2/"                  .. in v2/root.rb
+  GET "/api/v2/"                  .. in v2/routes.rb
   GET "/api/v2/jobs/:id/events"   .. in v2/jobs.rb

data/examples/ex1/{root.rb → routes.rb}

@@ -21,3 +21,11 @@ end
 get "/sideloaded_service" do
   Ex1ServiceModule.hello_world
 end
+
+get "/spec/full_url" do
+  full_url "foo", search: "s", page: 1
+end
+
+get "/spec/url" do
+  url "foo", search: "s", page: 1
+end

data/examples/ex2/routes.rb

@@ -0,0 +1,22 @@
+get "/debug" do
+  debug params
+end
+
+[:get, :post, :put, :delete, :head].each do |verb|
+  send verb, "/info/inspect" do
+    content_type :text
+    request.env.map { |key, value| "#{key}=#{value}\n" }.grep(/^[A-Z]/).sort.join
+  end
+end
+
+get "/helpers/ex1" do
+  ex1_helper
+rescue NameError
+  not_found! "ex1_helper cannot be run"
+end
+
+get "/helpers/ex2" do
+  ex2_helper
+rescue NameError
+  not_found! "ex2_helper cannot be run"
+end

data/examples/v2/{jobs.rb → routes.rb}

@@ -1,9 +1,13 @@
-get "/info" do
+get "/" do
+  json version: "v2"
+end
+
+get "/jobs/info" do
   content_type :text
   "info"
 end
 
-get "/:id/events" do
+get "/jobs/:id/events" do
   events = [
     { job_id: params[:id], id: "event1" },
     { job_id: params[:id], id: "event2" }

data/lib/simple/httpd/rack/dynamic_mount.rb

@@ -5,7 +5,6 @@ require "expectation"
 # existing static files.
 class Simple::Httpd::Rack::DynamicMount
   H = ::Simple::Httpd::Helpers
-  Rack = ::Simple::Httpd::Rack
 
   extend Forwardable
 
@@ -27,13 +26,15 @@ class Simple::Httpd::Rack::DynamicMount
     @mount_point = mount_point
     @path = path.gsub(/\/\z/, "") # remove trailing "/"
 
-    setup_paths!
     ::Simple::Httpd::Reloader.attach self, paths: service_files, reloading_instance: nil
 
-    @root_controller = build_root_controller # also loads helpers
-    @url_map = build_url_map
+    @rack_app = H.subclass ::Simple::Httpd::BaseController,
+                           paths: helper_files + ["#{path}/routes.rb"],
+                           description: "<controller:#{H.shorten_path(path)}>"
 
-    @rack_app = ::Rack::URLMap.new(@url_map)
+    @rack_app.route_descriptions.each do |route|
+      describe_route! route.prefix(@mount_point)
+    end
   end
 
   # RouteDescriptions are being built during build_url_map
@@ -41,54 +42,15 @@ class Simple::Httpd::Rack::DynamicMount
 
   private
 
-  def logger
-    ::Simple::Httpd.logger
-  end
-
-  def setup_paths!
-    @source_paths = Dir.glob("#{path}/**/*.rb")
-    @helper_paths, @controller_paths = @source_paths.partition { |str| /_helper(s?)\.rb$/ =~ str }
-
-    logger.info "#{path}: found #{@source_paths.count} sources, #{@helper_paths.count} helpers"
-  end
-
   def service_files
-    @service_files ||= _service_files
-  end
-
-  def _service_files
-    return [] if path == "." # i.e. mounting current directory
-
-    service_path = "#{path}.services"
-    return [] unless Dir.exist?(service_path)
-
-    service_files = Dir.glob("#{service_path}/**/*.rb").sort
-    logger.info "#{service_path}: loading #{service_files.count} service file(s)"
+    service_files = Dir.glob("#{path}/services/**/*.rb").sort
+    ::Simple::Httpd.logger.info "#{path}: loading #{service_files.count} service file(s)" if service_files.count > 0
     service_files
   end
 
-  # wraps all helpers into a Simple::Httpd::BaseController subclass
-  def build_root_controller
-    H.subclass ::Simple::Httpd::BaseController,
-               paths: @helper_paths.sort,
-               description: "<root controller: #{H.shorten_path path}>"
-  end
-
-  def build_url_map
-    @controller_paths.sort.each_with_object({}) do |absolute_path, hsh|
-      relative_path = absolute_path[(path.length)..-1]
-
-      relative_mount_point = relative_path == "/root.rb" ? "/" : relative_path.gsub(/\.rb$/, "")
-      controller_class = H.subclass @root_controller,
-                                    paths: absolute_path,
-                                    description: "<controller:#{H.shorten_absolute_path(absolute_path)}>"
-
-      controller_class.route_descriptions.each do |route|
-        route = route.prefix(@mount_point, relative_mount_point)
-        describe_route! route
-      end
-
-      hsh.update relative_mount_point => controller_class
-    end
+  def helper_files
+    helper_files = Dir.glob("#{path}/helpers/**/*.rb").sort
+    ::Simple::Httpd.logger.info "#{path}: loading #{helper_files.count} helper file(s)" if helper_files.count > 0
+    helper_files
   end
 end

data/lib/simple/httpd/reloader.rb

@@ -50,12 +50,24 @@ module Simple::Httpd::Reloader
       "#{verb} #{H.shorten_path path}"
     end
 
-    if @__reloading_instance__
-      @__reloading_instance__.instance_eval File.read(path), path, 1
-    else
-      load path
+    silence_warnings do
+      if @__reloading_instance__
+        @__reloading_instance__.instance_eval File.read(path), path, 1
+      else
+        load path
+      end
     end
 
     @__source_mtimes_by_path__[path] = mtime
   end
+
+  def silence_warnings(&block)
+    _ = block
+
+    warn_level = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = warn_level
+  end
 end

data/lib/simple/httpd/service_integration.rb

@@ -1,3 +1,6 @@
+# rubocop:disable Lint/RescueException
+# rubocop:disable Metrics/AbcSize
+
 require "simple-service"
 
 module Simple::Httpd::ServiceIntegration
@@ -86,8 +89,11 @@ module Simple::Httpd::ServiceIntegration
       ::Simple::Service.with_context(context) do
         result = service.invoke(action_name, args: parsed_body, flags: stringified_params)
         encode_result(result)
+      rescue Errno::ENOENT => e
+        Simple::Httpd.logger.warn e.to_s
+        raise
       rescue Exception => e
-        Simple::Httpd.logger.warn "#{e}, from\n    #{e.backtrace[0,10].join("\n    ")}"
+        Simple::Httpd.logger.warn "#{e}, from\n    #{e.backtrace[0, 10].join("\n    ")}"
         raise
       end
     end
@@ -103,8 +109,11 @@ module Simple::Httpd::ServiceIntegration
           result = encode_result(result)
         end
         result
+      rescue Errno::ENOENT => e
+        Simple::Httpd.logger.warn e.to_s
+        raise
       rescue Exception => e
-        Simple::Httpd.logger.warn "#{e}, from\n    #{e.backtrace[0,10].join("\n    ")}"
+        Simple::Httpd.logger.warn "#{e}, from\n    #{e.backtrace[0, 10].join("\n    ")}"
         raise
       end
     end

data/spec/simple/httpd/base_spec.rb

@@ -8,7 +8,7 @@ describe Simple::Httpd do
   end
 
   describe "root routing" do
-    it "resolves routes from root.rb" do
+    it "resolves routes from routes.rb" do
       http.get "/"
       expect_response "root"
     end

data/spec/simple/httpd/dynamic_mounting_spec.rb

@@ -1,13 +1,13 @@
 require "spec_helper"
 
 describe "dynamic mounting" do
-  it "resolves routes from root.rb" do
+  it "resolves routes from routes.rb" do
     http.get "/"
     expect_response "root"
   end
 
   # mounting not at root level
-  it "gets deep route from a root.rb file not mounted at /" do
+  it "gets deep route from a routes.rb file not mounted at /" do
     http.get "/api/v2"
     expect(http.content).to eq("version" => "v2")
     expect(http.response.headers["content-type"]).to match(/application\/json/)
@@ -19,13 +19,13 @@ describe "dynamic mounting" do
     expect(http.response.headers["content-type"]).to match(/application\/javascript/)
   end
 
-  it "gets deep route from non-root.rb file" do
+  it "gets deep route from non-routes.rb file" do
     http.get "/api/v2/jobs/info"
     expect_response "info"
     expect(http.response.headers["content-type"]).to match(/text\/plain/)
   end
 
-  it "gets deep route with params from non-root.rb file" do
+  it "gets deep route with params from non-routes.rb file" do
     http.get "/api/v2/jobs/12/events"
     expect(http.response.headers["content-type"]).to match(/application\/json/)
     expect(http.content).to eq([{ "job_id" => "12", "id" => "event1" }, { "job_id" => "12", "id" => "event2" }])

data/spec/simple/httpd/static_mounting_spec.rb

@@ -7,7 +7,7 @@ describe "static mounting" do
   end
 
   it "does not return a forbidden static file" do
-    http.get "/root.rb"
+    http.get "/routes.rb"
     expect_response 404
   end
 end

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ HTTPD_COMMAND = <<~CMD
   --environment=test
   examples/ex1
   examples/ex2
-  examples/ex3
+  examples/ex3:example_service
   examples/v2:api/v2
   --services=examples/services
 #  2> log/test.log

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-httpd
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - radiospiel
@@ -90,6 +90,7 @@ files:
 - ".envrc"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".tm_properties"
 - Gemfile
 - Makefile
@@ -102,21 +103,18 @@ files:
 - bin/rspec
 - 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/ex1/routes.rb
+- examples/ex1/services/ex1_service_module.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/ex2/helpers/ex2_helpers.rb
+- examples/ex2/helpers/helpers.rb
+- examples/ex2/routes.rb
+- examples/ex3/routes.rb
 - examples/services/explicit_example_service.rb
 - examples/v2/api.js
-- examples/v2/jobs.rb
-- examples/v2/root.rb
-- examples/v2/v2_helpers.rb
+- examples/v2/helpers/v2_helpers.rb
+- examples/v2/routes.rb
 - lib/simple-httpd.rb
 - lib/simple-service.rb
 - lib/simple.rb

data/examples/ex1/spec.rb

@@ -1,7 +0,0 @@
-get "/full_url" do
-  full_url "foo", search: "s", page: 1
-end
-
-get "/url" do
-  url "foo", search: "s", page: 1
-end

data/examples/ex2/helpers.rb

@@ -1,15 +0,0 @@
-get "/ex1" do
-  begin
-    ex1_helper
-  rescue NameError
-    not_found! "ex1_helper cannot be run"
-  end
-end
-
-get "/ex2" do
-  begin
-    ex2_helper
-  rescue NameError
-    not_found! "ex2_helper cannot be run"
-  end
-end

data/examples/ex2/info.rb

@@ -1,6 +0,0 @@
-[:get, :post, :put, :delete, :head].each do |verb|
-  send verb, "/inspect" do
-    content_type :text
-    request.env.map { |key, value| "#{key}=#{value}\n" }.grep(/^[A-Z]/).sort.join
-  end
-end

data/examples/ex2/root.rb

@@ -1,3 +0,0 @@
-get "/debug" do
-  debug params
-end

data/examples/v2/root.rb

@@ -1,3 +0,0 @@
-get "/" do
-  json version: "v2"
-end