toycol 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eb79d412c62ad9b86922964fa583b4fa1ed64b941c74654874b93d385d5665e
-  data.tar.gz: 8d915a6bfc7677096164b7fa773e32fad7669ff0b847eb2306be885899298362
+  metadata.gz: cfdb9a6d989ee0d0939ff53ded3c9603e08326194e6d8546e09ed0e292557022
+  data.tar.gz: d9b9779d6c2ca6c01710c6ecd1758384654aac1835ea343345ebc68a155ea8cc
 SHA512:
-  metadata.gz: c988be01719a879b367ea0da7323bc00100d4373f3516ab504e03fb92d26b3c2f0e3fe9e4411f84d139b97100d2e3342cebb4eb2e344674dadcd62ecadbf06bb
-  data.tar.gz: fc5ab9812a9f87006052c22614b6cdae7257db0919c3f95f0f30bba5e238b0787ba2c83ba08eb363089d06df41edd68ff5d048e31fb4116fc1a91bfe7823c872
+  metadata.gz: 59d599b9b4c781428193c5574d5c093492875046d57d842ca120195a548c752ab343dee372e6c2042cf82009bb7066978c520f099ba3196d0a788fe60248f8e7
+  data.tar.gz: 02033640bf6077a6125578bc6ec453c536639eb8882adbef3fd6eec6f0a2ffbedfe32dc9ef7dbb7deda6d85fafd25cdb006a9baf8e57ac4f4d87289fc38638f5

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "06:00"
+  open-pull-requests-limit: 10
+  rebase-strategy: "disabled"

data/.rubocop.yml

@@ -14,6 +14,10 @@ AllCops:
 Style/Documentation:
   Enabled: false
 
+Style/StringConcatenation:
+  Exclude:
+    - lib/toycol/server.rb
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -25,9 +29,14 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
+Layout/HashAlignment:
+  Exclude:
+    - lib/toycol/server.rb
+
 Metrics:
   Exclude:
     - lib/toycol/proxy.rb
+    - lib/toycol/server.rb
 
 Metrics/AbcSize:
   Max: 30

data/examples/safe_ruby/Gemfile

@@ -2,4 +2,5 @@
 
 source "https://rubygems.org"
 
+gem "puma"
 gem "toycol", path: "../../"

data/examples/safe_ruby_with_sinatra/Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 # git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
+gem "puma"
 gem "sinatra"
 gem "sinatra-contrib"
 gem "toycol", path: "../../"

data/lib/rack/handler/toycol.rb

@@ -1,24 +1,59 @@
 # frozen_string_literal: true
 
+require "rack"
 require "rack/handler"
-require "rack/handler/puma"
 
 module Rack
   module Handler
     class Toycol
-      def self.run(app, options = {})
-        if (child_pid = fork)
-          environment  = ENV["RACK_ENV"] || "development"
-          default_host = environment == "development" ? "localhost" : "0.0.0.0"
-
-          host = options.delete(:Host) || default_host
-          port = options.delete(:Port) || "9292"
-
-          ::Toycol::Proxy.new(host, port).start
-          Process.waitpid(child_pid)
-        else
-          puts "Toycol starts Puma in single mode, listening on unix://#{::Toycol::UNIX_SOCKET_PATH}"
-          Rack::Handler::Puma.run(app, **{ Host: ::Toycol::UNIX_SOCKET_PATH, Silent: true })
+      class << self
+        attr_writer :preferred_background_server, :host, :port
+
+        def run(app, _ = {})
+          @app = app
+          @host ||= ::Toycol::DEFAULT_HOST
+          @port ||= "9292"
+
+          if (child_pid = fork)
+            ::Toycol::Proxy.new(@host, @port).start
+            Process.waitpid(child_pid)
+          else
+            run_background_server
+          end
+        end
+
+        private
+
+        def select_background_server
+          case @preferred_background_server
+          when "puma"
+            return "puma" if puma_requireable?
+
+            puts "Puma is not installed in your environment."
+            raise LoadError
+          when nil
+            puma_requireable? ? "puma" : "build_in"
+          else
+            "build_in"
+          end
+        end
+
+        def puma_requireable?
+          require "rack/handler/puma"
+          true
+        rescue LoadError
+          false
+        end
+
+        def run_background_server
+          case select_background_server
+          when "puma"
+            puts "Toycol starts Puma in single mode, listening on unix://#{::Toycol::UNIX_SOCKET_PATH}"
+            Rack::Handler::Puma.run(@app, **{ Host: ::Toycol::UNIX_SOCKET_PATH, Silent: true })
+          else
+            puts "Toycol starts build-in server, listening on unix://#{::Toycol::UNIX_SOCKET_PATH}"
+            ::Toycol::Server.run(@app, **{ Path: ::Toycol::UNIX_SOCKET_PATH, Port: @port })
+          end
         end
       end
     end

data/lib/toycol.rb

@@ -6,6 +6,7 @@ require_relative "toycol/const"
 require_relative "toycol/helper"
 require_relative "toycol/protocol"
 require_relative "toycol/proxy"
+require_relative "toycol/server"
 require_relative "rack/handler/toycol"
 
 Dir["#{FileUtils.pwd}/Protocolfile*"].sort.each { |f| load f }

data/lib/toycol/command.rb

@@ -8,16 +8,15 @@ module Toycol
     class Options
       class << self
         def parse!(argv)
-          options            = {}
-          option_parser      = create_option_parser
-          sub_command_parser = create_sub_command_parser
+          options       = {}
+          option_parser = create_option_parser
+          sub_command_option_parser = create_sub_command_option_parser
 
           begin
             option_parser.order!(argv)
             options[:command]         = argv.shift
-            options[:request_message] = argv.shift if %w[client c].include? options[:command]
-
-            sub_command_parser[options[:command]].parse!(argv)
+            options[:request_message] = argv.shift if %w[client c].include?(options[:command]) && argv.first != "-h"
+            sub_command_option_parser[options[:command]].parse!(argv)
           rescue OptionParser::MissingArgument, OptionParser::InvalidOption, ArgumentError => e
             abort e.message
           end
@@ -27,44 +26,66 @@ module Toycol
 
         def create_option_parser
           OptionParser.new do |opt|
-            opt.banner = "Usage: #{opt.program_name} [-h|--help] [-v|--version] <command> <args>"
-            display_adding_summary(opt)
-
-            opt.on_head("-h", "--help", "Show this message") do
-              puts opt.help
-              exit
-            end
+            opt.banner = "Usage: #{opt.program_name} [-h|--help] [-v|--version] COMMAND [arg...]"
 
             opt.on_head("-v", "--version", "Show Toycol version") do
               opt.version = Toycol::VERSION
               puts opt.ver
               exit
             end
+            opt.on_head("-h", "--help", "Show this message") { help_command(opt) }
+
+            opt.separator ""
+            opt.separator "Sub commands:"
+            sub_command_summaries.each do |command|
+              opt.separator [opt.summary_indent, command[:name].ljust(31), command[:summary]].join(" ")
+            end
           end
         end
 
-        def create_sub_command_parser
+        def create_sub_command_option_parser
           sub_command_parser = Hash.new { |_k, v| raise ArgumentError, "'#{v}' is not sub command" }
           sub_command_parser["client"] = client_option_parser
           sub_command_parser["c"]      = client_option_parser
+          sub_command_parser["server"] = server_option_parser
+          sub_command_parser["s"]      = server_option_parser
           sub_command_parser
         end
 
         private
 
+        def sub_command_summaries
+          [
+            { name: "client REQUEST_MESSAGE -p PORT",  summary: "Send request message to server"    },
+            { name: "server -u SERVER_NAME",           summary: "Start proxy and background server" }
+          ]
+        end
+
         def client_option_parser
           OptionParser.new do |opt|
-            opt.on("-p=PORT_NUMBER", "--port=PORT_NUMBER", "Set port number") do |n|
-              ::Toycol::Client.port = n
+            opt.on("-p PORT_NUMBER", "--port PORT_NUMBER", "listen on PORT (default: 9292)") do |port|
+              ::Toycol::Client.port = port
             end
+
+            opt.on_head("-h", "--help", "Show this message") { help_command(opt) }
           end
         end
 
-        def display_adding_summary(opt)
-          opt.separator ""
-          opt.separator "Client command options:"
-          client_command_help_messages.each do |command|
-            opt.separator [opt.summary_indent, command[:name].ljust(31), command[:summary]].join(" ")
+        def server_option_parser
+          OptionParser.new do |opt|
+            opt.on("-o HOST", "--host HOST", "bind to HOST (default: localhost)") do |host|
+              ::Rack::Handler::Toycol.host = host
+            end
+
+            opt.on("-p PORT_NUMBER", "--port PORT_NUMBER", "listen on PORT (default: 9292)") do |port|
+              ::Rack::Handler::Toycol.port = port
+            end
+
+            opt.on("-u SERVER_NAME", "--use SERVER_NAME", "switch using SERVER(puma/build_in)") do |server_name|
+              ::Rack::Handler::Toycol.preferred_background_server = server_name
+            end
+
+            opt.on_head("-h", "--help", "Show this message") { help_command(opt) }
           end
         end
 
@@ -73,6 +94,17 @@ module Toycol
             { name: "client -p=PORT_NUMBER", summary: "Send request to server" }
           ]
         end
+
+        def server_command_help_messages
+          [
+            { name: "server -u=SERVER_NAME", summary: "Start proxy & background server" }
+          ]
+        end
+
+        def help_command(parser)
+          puts parser.help
+          exit
+        end
       end
     end
 
@@ -89,7 +121,11 @@ module Toycol
       command = options.delete(:command)
 
       case command
-      when "client", "c" then ::Toycol::Client.execute!(options[:request_message])
+      when "client", "c"
+        ::Toycol::Client.execute!(options[:request_message])
+      when "server", "s"
+        ARGV.push("-q", "-s", "toycol")
+        Rack::Server.start
       end
     end
   end

data/lib/toycol/const.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Toycol
+  # For HTTP Protocol
   DEFAULT_HTTP_REQUEST_METHODS = %w[
     GET
     HEAD
@@ -77,5 +78,25 @@ module Toycol
     511 => "Network Authentication Required"
   }.freeze
 
+  # For environment
+  ENVIRONMENT  = ENV["RACK_ENV"] || "development"
+  DEFAULT_HOST = ENVIRONMENT == "development" ? "localhost" : "0.0.0.0"
+
+  # For connection from proxy server to app server
   UNIX_SOCKET_PATH = ENV["TOYCOL_SOCKET_PATH"] || "/tmp/toycol.socket"
+
+  # Rack compartible environment
+  PATH_INFO         = "PATH_INFO"
+  QUERY_STRING      = "QUERY_STRING"
+  REQUEST_METHOD    = "REQUEST_METHOD"
+  SERVER_NAME       = "SERVER_NAME"
+  SERVER_PORT       = "SERVER_PORT"
+  CONTENT_LENGTH    = "CONTENT_LENGTH"
+  RACK_VERSION      = "rack.version"
+  RACK_INPUT        = "rack.input"
+  RACK_ERRORS       = "rack.errors"
+  RACK_MULTITHREAD  = "rack.multithread"
+  RACK_MULTIPROCESS = "rack.multiprocess"
+  RACK_RUN_ONCE     = "rack.run_once"
+  RACK_URL_SCHEME   = "rack.url_scheme"
 end

data/lib/toycol/proxy.rb

@@ -92,9 +92,11 @@ module Toycol
         response_message = response_message.join
         puts "[Toycol] Received response message from server: #{response_message.lines.first}"
 
-        _, status_code, status_message = response_message.lines.first.split
+        response_line  = response_message.lines.first
+        status_number  = response_line[9..11]
+        status_message = response_line[12..].strip
 
-        if (custom_message = @protocol.status_message(status_code.to_i)) != status_message
+        if (custom_message = @protocol.status_message(status_number.to_i)) != status_message
           response_message = response_message.sub(status_message, custom_message)
           puts "[Toycol] Status message has been translated to custom status message: #{custom_message}"
         end

data/lib/toycol/server.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module Toycol
+  class Server
+    BACKLOG    = 1024
+    CHUNK_SIZE = 1024 * 16
+
+    class << self
+      def run(app, **options)
+        new(app, **options).run
+      end
+    end
+
+    def initialize(app, **options)
+      @app  = app
+      @path = options[:Path]
+      @port = options[:Port]
+      @env  = default_env
+      @returned_status  = nil
+      @returned_headers = nil
+      @returned_body    = nil
+    end
+
+    def run
+      verify_file_path!
+      server = UNIXServer.new @path
+      server.listen BACKLOG
+
+      loop do
+        trap(:INT) { exit }
+
+        socket = server.accept
+
+        request_message = []
+        request_message << socket.readpartial(CHUNK_SIZE) until socket.eof?
+        request_message = request_message.join
+        assign_parsed_attributes!(request_message)
+
+        @returned_status, @returned_headers, @returned_body = @app.call(@env)
+
+        socket.puts response_message
+        socket.close_write
+        socket.close
+      end
+    end
+
+    private
+
+    def default_env
+      {
+        ::Toycol::PATH_INFO         => "",
+        ::Toycol::QUERY_STRING      => "",
+        ::Toycol::REQUEST_METHOD    => "",
+        ::Toycol::SERVER_NAME       => "toycol_server",
+        ::Toycol::SERVER_PORT       => @port.to_s,
+        ::Toycol::CONTENT_LENGTH    => "",
+        ::Toycol::RACK_VERSION      => Rack::VERSION,
+        ::Toycol::RACK_INPUT        => stringio(""),
+        ::Toycol::RACK_ERRORS       => $stderr,
+        ::Toycol::RACK_MULTITHREAD  => false,
+        ::Toycol::RACK_MULTIPROCESS => false,
+        ::Toycol::RACK_RUN_ONCE     => false,
+        ::Toycol::RACK_URL_SCHEME   => "http"
+      }
+    end
+
+    def response_message
+      "#{response_status_code}#{response_headers}\r\n#{response_body}"
+    end
+
+    def response_status_code
+      "HTTP/1.1 #{@returned_status} #{::Toycol::DEFAULT_HTTP_STATUS_CODES[@returned_status.to_i] || "CUSTOM"}\r\n"
+    end
+
+    def response_headers
+      @returned_headers["Content-Length"] = response_body.size unless @returned_headers["Content-Length"]
+
+      @returned_headers.map { |k, v| "#{k}: #{v}" }.join("\r\n") + "\r\n"
+    end
+
+    def response_body
+      res = []
+      @returned_body.each { |body| res << body }
+      res.join
+    end
+
+    def stringio(body = "")
+      StringIO.new(body).set_encoding("ASCII-8BIT")
+    end
+
+    def verify_file_path!
+      return unless File.exist? @path
+
+      begin
+        bound_file = UNIXSocket.new @path
+      rescue SystemCallError, IOError
+        File.unlink @path
+      else
+        bound_file.close
+        raise "[Toycol] Address already in use: #{@path}"
+      end
+    end
+
+    def assign_parsed_attributes!(request_message)
+      request_line, *request_headers, request_body = request_message.split("\r\n").reject(&:empty?)
+      request_method, request_path, = request_line.split
+      request_path, query_string    = request_path.split("?")
+
+      @env[REQUEST_METHOD] = request_method
+      @env[PATH_INFO]      = request_path
+      @env[QUERY_STRING]   = query_string || ""
+
+      request_headers.each do |request_header|
+        k, v = request_header.split(":").map(&:strip)
+        @env[k.tr("-", "_").upcase] = v
+      end
+
+      @env[RACK_INPUT] = stringio(request_body)
+    end
+  end
+end

data/lib/toycol/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Toycol
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/toycol.gemspec

@@ -24,9 +24,8 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables   << "toycol"
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "puma"
   spec.add_dependency "rack", "~> 2.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: toycol
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Misaki Shioi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: puma
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -41,10 +27,12 @@ dependencies:
 description: Toy Application Protocol framework
 email:
 - shioi.mm@gmail.com
-executables: []
+executables:
+- toycol
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -56,7 +44,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- bin/toycol
 - examples/duck/Gemfile
 - examples/duck/Protocolfile.duck
 - examples/duck/config_duck.ru
@@ -74,6 +61,7 @@ files:
 - examples/unsafe_ruby/Gemfile
 - examples/unsafe_ruby/Protocolfile.unsafe_ruby
 - examples/unsafe_ruby/config_unsafe_ruby.ru
+- exe/toycol
 - lib/rack/handler/toycol.rb
 - lib/toycol.rb
 - lib/toycol/client.rb
@@ -82,6 +70,7 @@ files:
 - lib/toycol/helper.rb
 - lib/toycol/protocol.rb
 - lib/toycol/proxy.rb
+- lib/toycol/server.rb
 - lib/toycol/version.rb
 - toycol.gemspec
 homepage: https://github.com/shioimm/toycol