simple-httpd 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2cf16a40a84142155ccfdf2486e3f12d2a2be13429a942660136ba1c7ce5034
-  data.tar.gz: fe679b913fe4ea849945b797fd949ec4d4f9dc783d7ea252e358060037ec25e9
+  metadata.gz: 4a7ef636de1fafcba61a0e8d7ed71a235d9c4700633f8ef8a899028415ffa1c7
+  data.tar.gz: 2018dc0e1bd99ec1bdc40524bfe2701be509e252cb6655b21e629e996da22614
 SHA512:
-  metadata.gz: 36e023782c8602e0864b1787ee661b1b4c6df8b76ea28889a14acc77116b927c98dd7d720850337b011a7c32ad6694767a776ba92ed772953ebdf3960ff43932
-  data.tar.gz: 0011d3b37a962c6dd5b1781f5dfd934aef319b8e13033b370fc9f4b240fa921ef06475808d7780072cd6c82675db95103d6c856911dd8a61d4048f8a45430bd3
+  metadata.gz: dd3fc097a2342e19b79c087fec69c92db23085c2352d323c3b284e60eaa764543048f731063e0d3c31ad3e136dc1bb2518456c00519f9231c0f3cde57a96f0d2
+  data.tar.gz: aff819af94b2b12d8e02c1c966dc9eeb9eb6d3b4a805778d609600d2dc9ff33dccb435983ecf4e1221e5346b899ccd7b358d625756fe26b912bf662b94770226

data/.rubocop.yml

@@ -8,6 +8,7 @@ AllCops:
     - '*.gemspec'
     - 'Gemfile'
     - 'Rakefile'
+    - 'scripts/*.rb'
 
 Metrics/LineLength:
   Max: 140
@@ -87,3 +88,9 @@ Metrics/ParameterLists:
 
 Style/StringLiteralsInInterpolation:
   Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false

data/Gemfile

@@ -6,12 +6,14 @@ gemspec
 # --- Local overrides for runtime dependencies ------------------------------
 
 # gem "simple-cli", path: "../simple-cli"
+# gem "simple-service", path: "../simple-service"
 
 # --- Development and test dependencies ------------------------------
 
 group :development, :test do
-  gem "rspec-httpd", "~> 0.3.0"
+  gem "rspec-httpd", "~> 0.3.2"
   # gem "rspec-httpd", path: "../rspec-httpd"
+  # # gem "simple-http", path: "../simple-http"
 
   gem 'rake', '~> 11'
   gem 'rspec', '~> 3.7'

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/bin/simple-httpd

@@ -8,6 +8,4 @@ Bundler.setup
 require "simple/cli"
 require "simple/httpd/cli"
 
-# run the :main command with these arguments. This switches simple-cli into
-# non-subcommand mode.
-Simple::Httpd::CLI.run!(:main)
+Simple::CLI.run! Simple::Httpd::CLI

data/examples/ex1.services/ex1_service_module.rb

@@ -0,0 +1,8 @@
+# Not a real service, but still loaded automatically when mounting ex1
+module Ex1ServiceModule
+  extend self
+
+  def hello_world
+    "hello_world"
+  end
+end

data/examples/ex1/root.rb

@@ -9,3 +9,7 @@ end
 get "/exit" do
   exit 1
 end
+
+get "/sideloaded_service" do
+  Ex1ServiceModule.hello_world
+end

data/examples/ex1/spec.rb

@@ -0,0 +1,7 @@
+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/info.rb

@@ -1,4 +1,6 @@
-get "/inspect" do
-  content_type :text
-  request.env.map { |key, value| "#{key}=#{value}\n" }.grep(/^[A-Z]/).sort.join
+[: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/ex3/example_service.rb

@@ -7,7 +7,8 @@ mount_service ExplicitService do |service|
   post "/echo/:a" => :explicit_echo
 
   put "/echo_context" do
-    # def echo_context
-    service.call(:echo_context, parsed_body, params, context: context)
+    ::Simple::Service.with_context(context) do
+      ::Simple::Service.invoke(service, :echo_context)
+    end
   end
 end

data/lib/simple/httpd.rb

@@ -11,20 +11,29 @@ require "simple/service"
 require "simple/httpd/helpers"
 require "simple/httpd/base_controller"
 require "simple/httpd/version"
-require "simple/httpd/mount_spec"
+require "simple/httpd/mount"
 require "simple/httpd/server"
 
-require "simple/httpd/service"
+require "simple/httpd/service_adapter"
 
 class Simple::Httpd
   SELF = self
 
-  def self.logger=(logger)
-    @logger = logger
+  # returns a logger for Simple::Httpd.
+  #
+  # Initially we default to <tt>::Simple::CLI.logger</tt>. This gives colored
+  # logging during loading and mounting. Note that Simple::Httpd::Server builds
+  # its own logger instance to to pass that along to the web server.
+  def self.logger
+    @logger ||= ::Simple::CLI.logger
   end
 
-  def self.logger
-    @logger ||= ::Logger.new(STDERR, level: ::Logger::INFO)
+  def self.custom_logger?
+    @logger && @logger != ::Simple::CLI.logger
+  end
+
+  def self.logger=(logger)
+    @logger = logger
   end
 
   # Converts the passed in args into a Simple::Httpd application.
@@ -34,43 +43,49 @@ class Simple::Httpd
   # respond to call/3) it redirects to <tt>Server.listen!</tt> right
   # away - this way this method can be used as a helper method
   # to easily start a Rack server.
-  def self.listen!(*mount_specs, environment: "development", host: nil, port:, logger: nil, &block)
+  def self.listen!(*mounts, environment: "development", host: nil, port:, &block)
     # If there is no argument but a block use the block as a rack server
     if block
-      raise ArgumentError, "Can't deal w/block *and* mount_specs" unless mount_specs.empty?
+      raise ArgumentError, "Can't deal w/block *and* mounts" unless mounts.empty?
 
       app = block
-    elsif mount_specs.length == 1 && mount_specs.first.respond_to?(:call)
+    elsif mounts.length == 1 && mounts.first.respond_to?(:call)
       # there is one argument, and that looks like a Rack app: return that.
-      app = mount_specs.first
+      app = mounts.first
     else
       # Build a Httpd app, and listen
-      app = build(*mount_specs)
+      app = build(*mounts)
       app.rack
     end
 
-    Server.listen!(app, environment: environment, host: host, port: port, logger: logger)
+    Server.listen!(app, environment: environment, host: host, port: port)
   end
 
   # Converts the passed in arguments into a Simple::Httpd application.
   #
   # For a description of mounts see <tt>#add</tt>
-  def self.build(*mount_specs)
-    new(*mount_specs)
+  def self.build(*mounts)
+    new(*mounts)
   end
 
   private
 
   # Builds a Simple::Httpd application.
-  def initialize(*mount_specs)
-    @mount_specs = []
-    mount_specs.map do |mount_spec|
-      mount(mount_spec, at: nil)
+  def initialize(*mounts)
+    @mounts = []
+    mounts.map do |mount|
+      mount(mount, at: nil)
     end
   end
 
   public
 
+  def route_descriptions
+    @mounts.inject([]) do |ary, mount|
+      ary.concat mount.route_descriptions
+    end
+  end
+
   # Adds one or more mount_points
   #
   # Each entry in mounts can be either:
@@ -79,10 +94,10 @@ class Simple::Httpd
   # - a string denoting a mount_point, e.g. "path/to/root:/")
   # - a string denoting a "/" mount_point (e.g. "path", which is shorthand for "path:/")
   #
-  def mount(mount_spec, at: nil)
+  def mount(mount, at: nil)
     raise ArgumentError, "Cannot mount onto an already built app" if built?
 
-    @mount_specs << MountSpec.build(mount_spec, at: at)
+    @mounts << Mount.build(mount, at: at)
   end
 
   extend Forwardable
@@ -97,8 +112,8 @@ class Simple::Httpd
   def build_rack
     uri_map = {}
 
-    @mount_specs.group_by(&:mount_point).map do |mount_point, mount_specs|
-      apps = mount_specs.map(&:build_rack_apps).flatten
+    @mounts.group_by(&:mount_point).map do |mount_point, mounts|
+      apps = mounts.map(&:build_rack_apps).flatten
       uri_map[mount_point] = Rack.merge(apps)
     end
 
@@ -108,10 +123,4 @@ class Simple::Httpd
   def built?
     @rack != nil
   end
-
-  public
-
-  def listen!(environment:, port:, logger:)
-    SELF.listen!(rack, environment: environment, port: port, logger: logger)
-  end
 end

data/lib/simple/httpd/base_controller.rb

@@ -17,6 +17,12 @@ class Simple::Httpd::BaseController < Sinatra::Base
   end
 end
 
+require_relative "./route"
+
+class Simple::Httpd::BaseController
+  extend ::Simple::Httpd::RouteDescriptions
+end
+
 Dir.chdir __dir__ do
   Dir.glob("base_controller/*.rb").sort.each do |file|
     require_relative file

data/lib/simple/httpd/base_controller/build_url.rb

@@ -28,7 +28,7 @@ class Simple::Httpd::BaseController
     private
 
     def build_url_query(params)
-      params = params.reject { |_k, v| v.nil? || v.empty? }
+      params = params.reject { |_k, v| v.nil? || v.to_s.empty? }
       return nil if params.empty?
 
       params.map { |k, value| "#{k}=#{escape(value.to_s)}" }.join("&")

data/lib/simple/httpd/base_controller/debug.rb

@@ -1,6 +1,8 @@
 class Simple::Httpd::BaseController
   helpers do
     def debug(data)
+      require "pp"
+
       content_type "text/plain"
       halt data.pretty_inspect
     end

data/lib/simple/httpd/base_controller/error_handling.rb

@@ -1,7 +1,5 @@
 require_relative "./json"
 
-# rubocop:disable Metrics/ClassLength
-
 class Simple::Httpd::BaseController
   H = ::Simple::Httpd::Helpers
 
@@ -9,8 +7,6 @@ class Simple::Httpd::BaseController
   set :dump_errors, false
   set :raise_errors, false
 
-  set :raise_errors, true if ENV["RACK_ENV"] == "test"
-
   private
 
   def stringify_hash(hsh)
@@ -127,19 +123,27 @@ class Simple::Httpd::BaseController
 
   # -- print unspecified errors.
 
-  error do |exc|
-    content_type :text
-    message = <<~MSG
-      === #{exc.class.name} =====================
-      #{exc.message.chomp}
-
-      #{filtered_backtrace(exc)}
-      ==================================================================
-    MSG
-
-    STDERR.puts message
-    status 500
-    "\n#{message}\n"
+  if ENV["RACK_ENV"] == "production"
+    error do |exc|
+      content_type :text
+      status 500
+      exc.class.name
+    end
+  else
+    error do |exc|
+      content_type :text
+      message = <<~MSG
+        === #{exc.class.name} =====================
+        #{exc.message.chomp}
+
+        #{H.filtered_stacktrace(exc.backtrace).join("\n")}
+        ==================================================================
+      MSG
+
+      STDERR.puts message
+      status 500
+      "\n#{message}\n"
+    end
   end
 
   private
@@ -152,25 +156,4 @@ class Simple::Httpd::BaseController
     exc.message
     # "#{exc.message}, from #{exc.backtrace.join("\n\t")}"
   end
-
-  def remove_wd(str)
-    @wd ||= Dir.getwd
-
-    if str.start_with?(@wd)
-      str[(@wd.length + 1)..-1]
-    else
-      str
-    end
-  end
-
-  def filtered_backtrace(exc, count: 20)
-    lines = exc.backtrace.map do |line|
-      next "...\n" if line =~ /\.rvm\b/
-
-      "#{remove_wd(line)}\n"
-    end
-
-    s = lines[0, count].join("")
-    s.gsub(/(\.\.\.\n)+/, "   ... (lines removed) ...\n")
-  end
 end

data/lib/simple/httpd/base_controller/json.rb

@@ -12,42 +12,13 @@ class Simple::Httpd::BaseController
 
   configure :development, :test do
     begin
-      @@neatjson = true
       require "neatjson"
     rescue LoadError
-      @@neatjson = false
+      :nop
     end
 
     def generate_json(result)
-      if @@neatjson
-        JSON.neat_generate(result)
-      else
-        JSON.pretty_generate(result)
-      end
-    end
-  end
-
-  public
-
-  def parsed_body
-    return @parsed_body if defined? @parsed_body
-
-    @parsed_body = parse_body
-  rescue RuntimeError => e
-    raise ArgumentError, e.to_s
-  end
-
-  private
-
-  def parse_body
-    case request.media_type
-    when "application/json"
-      request.body.rewind
-      body = request.body.read
-      body == "" ? {} : JSON.parse(body)
-    else
-      # parses form data
-      request.POST
+      JSON.respond_to?(:neat_generate) ? JSON.neat_generate(result) : JSON.pretty_generate(result)
     end
   end
 end

data/lib/simple/httpd/base_controller/request.rb

@@ -0,0 +1,23 @@
+class Simple::Httpd::BaseController
+  def parsed_body
+    return @parsed_body if defined? @parsed_body
+
+    @parsed_body = parse_body
+  rescue RuntimeError => e
+    raise ArgumentError, e.to_s
+  end
+
+  private
+
+  def parse_body
+    case request.media_type
+    when "application/json"
+      request.body.rewind
+      body = request.body.read
+      body == "" ? {} : JSON.parse(body)
+    else
+      # parses form data
+      request.POST
+    end
+  end
+end

data/lib/simple/httpd/base_controller/result.rb

@@ -0,0 +1,19 @@
+class ::Simple::Httpd::BaseController
+  private
+
+  # encodes the result, according to its payload.
+  #
+  # This function is used by the service integration code, but
+  # is potentially useful outside.
+  def encode_result(result)
+    case result
+    when Array, Hash
+      json(result)
+    when String
+      content_type :text
+      result
+    else
+      result
+    end
+  end
+end