toycol 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9cd0de8dd5ec5a48e22a49c8198492a96162c9ff922a07c897e3af7cdfe779a
-  data.tar.gz: 938b7f68fef82731d61c1937c2ed53753c1bbb301c49434cc6d538edb6f862f9
+  metadata.gz: 94c69c1ed2726e69431304ff3c4fb727581b7893160d5dbe085731f4d85dfce2
+  data.tar.gz: 94fc2c13fbd5149a47669a521dfa40377e1edf890a92b33468bf534c6d34ed45
 SHA512:
-  metadata.gz: 53e62c64e3f418da9e0f7068482531bab41466e6d73d560e8bf74ae900cf2587a61d810365eea15f01f194592c70b563320ffe93f170810e4fa6f443f3a73837
-  data.tar.gz: 112910c06cdb28e5f8690fd18373a2d418a466b075cc0ff793816aed2475acb1ccf5657ae8cfb7b3c321cefc1bde44e5a34fd9b9024f3c20d14047938adf6121
+  metadata.gz: c5c3d01ea2c3b41491e3d365b781d92677ef027ce9fefa1d45b3ab360e947416035c39d5c9d32dd29ae01c309dfa27338097e5a63dfcd248aa9647b45784bb28
+  data.tar.gz: d09afa0497d2b40fcc0b404a19ceee343b9f132a434cbf80feef1cac3bbef060397bccc15503beb507be6e0b03d33b6d5f5cdbe96c5499a093b3a8a27dbd8f24

data/lib/rack/handler/toycol.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require "rack"
 require "rack/handler"
 
 module Rack
   module Handler
     class Toycol
+      extend ::Toycol::Helper
+
       class << self
         attr_writer :preferred_background_server, :host, :port
 
@@ -27,20 +28,20 @@ module Rack
         def select_background_server
           case @preferred_background_server
           when "puma"
-            return "puma" if puma_requireable?
+            return "puma" if try_require_puma_handler
 
             raise LoadError, "Puma is not installed in your environment."
           when nil
-            puma_requireable? ? "puma" : "build_in"
+            try_require_puma_handler ? "puma" : "builtin"
           else
-            "build_in"
+            "builtin"
           end
         rescue LoadError
           Process.kill(:INT, Process.ppid)
           abort
         end
 
-        def puma_requireable?
+        def try_require_puma_handler
           require "rack/handler/puma"
           true
         rescue LoadError
@@ -50,10 +51,10 @@ module Rack
         def run_background_server
           case select_background_server
           when "puma"
-            puts "Toycol starts Puma in single mode, listening on unix://#{::Toycol::UNIX_SOCKET_PATH}"
+            logger "Start 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}"
+            logger "Start built-in server, listening on unix://#{::Toycol::UNIX_SOCKET_PATH}"
             ::Toycol::Server.run(@app, **{ Path: ::Toycol::UNIX_SOCKET_PATH, Port: @port })
           end
         end

data/lib/toycol.rb

@@ -1,27 +1,33 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require "optparse"
+require "rack"
+require "socket"
+require "stringio"
 
 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 }
-
+require_relative "toycol/client"
+require_relative "toycol/template_generator"
 require_relative "toycol/command"
 require_relative "toycol/version"
 
+require_relative "rack/handler/toycol"
+
 module Toycol
   class Error < StandardError; end
 
-  class UnauthorizedMethodError < Error; end
+  class UnauthorizeError < Error; end
 
-  class UnauthorizedRequestError < Error; end
+  class UndefinementError < Error; end
 
-  class UndefinedRequestMethodError < Error; end
+  class DuplicateProtocolError < Error; end
 
-  class UnknownStatusCodeError < Error; end
+  class HTTPError < Error; end
 end
+
+Dir["#{FileUtils.pwd}/Protocolfile*"].sort.each { |f| load f }

data/lib/toycol/client.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-require "socket"
-
 module Toycol
   class Client
+    extend Helper
+
     @port = 9292
+    @host = "localhost"
     CHUNK_SIZE = 1024 * 16
 
     class << self
-      attr_writer :port
+      attr_writer :port, :host
 
       def execute!(request_message, &block)
-        socket = TCPSocket.new("localhost", @port)
+        socket = TCPSocket.new(@host, @port)
         socket.write(request_message)
-        puts "[Toycol] Sent request message: #{request_message}\n---"
+        logger "Sent request message: #{request_message}\n---"
 
         response_message = []
         response_message << socket.readpartial(CHUNK_SIZE) until socket.eof?
@@ -29,7 +30,7 @@ module Toycol
 
       def default_proc
         proc do |message|
-          puts "[Toycol] Received response message:\n\n"
+          logger "Received response message:\n\n"
           puts message
         end
       end

data/lib/toycol/command.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require "optparse"
-require_relative "./client"
-require_relative "./template_generator"
-
 module Toycol
   class Command
     class Options
@@ -81,8 +77,13 @@ module Toycol
 
         def client_option_parser
           OptionParser.new do |opt|
-            opt.on("-p PORT_NUMBER", "--port PORT_NUMBER", "listen on PORT (default: 9292)") do |port|
-              ::Toycol::Client.port = port
+            opt.banner = "Usage: #{opt.program_name} client [-h|--help] REQUEST_MESSAGE [arg...]"
+            opt.on("-o HOST", "--host HOST", "connect to HOST (default: localhost)") do |host|
+              Client.host = host
+            end
+
+            opt.on("-p PORT_NUMBER", "--port PORT_NUMBER", "connect to PORT (default: 9292)") do |port|
+              Client.port = port
             end
 
             opt.on_head("-h", "--help", "Show this message") { help_command(opt) }
@@ -91,6 +92,7 @@ module Toycol
 
         def server_option_parser
           OptionParser.new do |opt|
+            opt.banner = "Usage: #{opt.program_name} server [-h|--help] APPLICATION_PATH [arg...]"
             opt.on("-o HOST", "--host HOST", "bind to HOST (default: localhost)") do |host|
               ::Rack::Handler::Toycol.host = host
             end
@@ -99,7 +101,7 @@ module Toycol
               ::Rack::Handler::Toycol.port = port
             end
 
-            opt.on("-u SERVER_NAME", "--use SERVER_NAME", "switch using SERVER(puma/build_in)") do |server_name|
+            opt.on("-u SERVER_NAME", "--use SERVER_NAME", "switch using SERVER(puma/builtin)") do |server_name|
               ::Rack::Handler::Toycol.preferred_background_server = server_name
             end
 
@@ -138,13 +140,13 @@ module Toycol
 
       case command
       when "client", "c"
-        ::Toycol::Client.execute!(options[:request_message])
+        Client.execute!(options[:request_message])
       when "server", "s"
         ARGV.push("-q", "-s", "toycol")
         Rack::Server.start
       when "generate", "g"
         type = options[:template_type] || "all"
-        ::Toycol::TemplateGenerator.generate!(type: type, name: options[:protocol_name])
+        TemplateGenerator.generate!(type: type, name: options[:protocol_name])
       end
     end
   end

data/lib/toycol/helper.rb

@@ -2,6 +2,10 @@
 
 module Toycol
   module Helper
+    def logger(message)
+      puts "[Toycol] #{message}"
+    end
+
     private
 
     def safe_execution!(&block)
@@ -10,8 +14,8 @@ module Toycol
 
     def safe_executionable_tp
       @safe_executionable_tp ||= TracePoint.new(:script_compiled) do |tp|
-        if tp.binding.receiver == Toycol::Protocol && tp.method_id.to_s.match?(unauthorized_methods_regex)
-          raise Toycol::UnauthorizedMethodError, <<~ERROR
+        if tp.binding.receiver == Protocol && tp.method_id.to_s.match?(unauthorized_methods_regex)
+          raise UnauthorizeError, <<~ERROR
             - Unauthorized method was called!
             You can't use methods that may cause injections in your protocol.
             Ex. Kernel.#eval, Kernel.#exec, Kernel.#require and so on.

data/lib/toycol/protocol.rb

@@ -5,23 +5,30 @@ module Toycol
   class Protocol
     @definements          = {}
     @protocol_name        = nil
-    @http_status_codes    = Toycol::DEFAULT_HTTP_STATUS_CODES.dup
-    @http_request_methods = Toycol::DEFAULT_HTTP_REQUEST_METHODS.dup
+    @http_status_codes    = DEFAULT_HTTP_STATUS_CODES.dup
+    @http_request_methods = DEFAULT_HTTP_REQUEST_METHODS.dup
     @custom_status_codes  = nil
     @additional_request_methods = nil
 
     class << self
-      # For protocol definition
-      def define(protocol_name = nil, &block)
+      attr_reader :protocol_name
+
+      # For Protocolfile to define new protocol
+      def define(protocol_name = :default, &block)
+        if @definements[protocol_name]
+          raise DuplicateProtocolError,
+                "#{protocol_name || "Anonymous"} protocol has already been defined"
+        end
+
         @definements[protocol_name] = block
       end
 
-      # For application which use the protocol
-      def use(protocol_name = nil)
+      # For application to select which protocol to use
+      def use(protocol_name = :default)
         @protocol_name = protocol_name
       end
 
-      # For server which use the protocol
+      # For proxy server to interpret protocol definitions and parse messages
       def run!(message)
         @request_message = message.chomp
 
@@ -67,52 +74,54 @@ module Toycol
         end
       end
 
-      # For server: Get the request path
+      # For proxy server: Fetch the request path
       def request_path
         request_path = request.instance_variable_get("@path").call(request_message)
 
-        raise UnauthorizedRequestError, "This request path is too long" if request_path.size >= 2048
-
-        if request_path.scan(%r{[/\w\d\-_]}).size < request_path.size
-          raise UnauthorizedRequestError,
+        if request_path.size >= 2048
+          raise UnauthorizeError,
+                "This request path is too long"
+        elsif request_path.scan(%r{[/\w\d\-_]}).size < request_path.size
+          raise UnauthorizeError,
                 "This request path contains unauthorized character"
         end
 
         request_path
       end
 
-      # For server: Get the request method
+      # For proxy server: Fetch the request method
       def request_method
         @http_request_methods.concat @additional_request_methods if @additional_request_methods
         request_method = request.instance_variable_get("@http_method").call(request_message)
 
         unless @http_request_methods.include? request_method
-          raise UndefinedRequestMethodError, "This request method is undefined"
+          raise UndefinementError,
+                "This request method is undefined"
         end
 
         request_method
       end
 
-      # For server: Get the query string
+      # For proxy server: Fetch the query string
       def query
         return unless (parse_query_block = request.instance_variable_get("@query"))
 
         parse_query_block.call(request_message)
       end
 
-      # For server: Get the input body
+      # For proxy server: Fetch the input body
       def input
         return unless (parsed_input_block = request.instance_variable_get("@input"))
 
         parsed_input_block.call(request_message)
       end
 
-      # For server: Get the message of status code
+      # For proxy server: fetch the message of status code
       def status_message(status)
         @http_status_codes.merge!(@custom_status_codes) if @custom_status_codes
 
         unless (message = @http_status_codes[status])
-          raise UnknownStatusCodeError, "Application returns unknown status code"
+          raise HTTPError, "Application returns unknown status code"
         end
 
         message

data/lib/toycol/proxy.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "socket"
-
 module Toycol
   class Proxy
     include Helper
@@ -13,15 +11,15 @@ module Toycol
       @path           = nil
       @query          = nil
       @input          = nil
-      @protocol       = ::Toycol::Protocol
+      @protocol       = Protocol
       @proxy          = TCPServer.new(@host, @port)
     end
 
     CHUNK_SIZE = 1024 * 16
 
     def start
-      puts <<~MESSAGE
-        Toycol is running on #{@host}:#{@port}
+      logger <<~MESSAGE
+        Start proxy server on #{@protocol.protocol_name} protocol, listening on #{@host}:#{@port}
         => Use Ctrl-C to stop
       MESSAGE
 
@@ -33,13 +31,13 @@ module Toycol
         while !@client.closed? && !@client.eof?
           begin
             request = @client.readpartial(CHUNK_SIZE)
-            puts "[Toycol] Received message: #{request.inspect.chomp}"
+            logger "Received message: #{request.inspect.chomp}"
 
             safe_execution! { @protocol.run!(request) }
             assign_parsed_attributes!
 
             http_request_message = build_http_request_message
-            puts "[Toycol] Message has been translated to HTTP request message: #{http_request_message.inspect}"
+            logger "Message has been translated to HTTP request message: #{http_request_message.inspect}"
             transfer_to_server(http_request_message)
           rescue StandardError => e
             puts "#{e.class} #{e.message} - closing socket."
@@ -82,15 +80,15 @@ module Toycol
     end
 
     def transfer_to_server(request_message)
-      UNIXSocket.open(Toycol::UNIX_SOCKET_PATH) do |server|
+      UNIXSocket.open(UNIX_SOCKET_PATH) do |server|
         server.write request_message
         server.close_write
-        puts "[Toycol] Successed to Send HTTP request message to server"
+        logger "Successed to Send HTTP request message to server"
 
         response_message = []
         response_message << server.readpartial(CHUNK_SIZE) until server.eof?
         response_message = response_message.join
-        puts "[Toycol] Received response message from server: #{response_message.lines.first}"
+        logger "Received response message from server: #{response_message.lines.first}"
 
         response_line  = response_message.lines.first
         status_number  = response_line[9..11]
@@ -98,18 +96,18 @@ module Toycol
 
         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}"
+          logger "Status message has been translated to custom status message: #{custom_message}"
         end
 
         @client.write response_message
         @client.close_write
-        puts "[Toycol] Finished to response to client"
+        logger "Finished to response to client"
         server.close
       end
     end
 
     def shutdown
-      puts "[Toycol] Catched SIGINT -> Stop to server"
+      logger "Caught SIGINT -> Stop to server"
       exit
     end
   end

data/lib/toycol/server.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "stringio"
-
 module Toycol
   class Server
     BACKLOG    = 1024
@@ -50,19 +48,19 @@ module Toycol
 
     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    => "0",
-        ::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"
+        PATH_INFO         => "",
+        QUERY_STRING      => "",
+        REQUEST_METHOD    => "",
+        SERVER_NAME       => "toycol_server",
+        SERVER_PORT       => @port.to_s,
+        CONTENT_LENGTH    => "0",
+        RACK_VERSION      => Rack::VERSION,
+        RACK_INPUT        => stringio(""),
+        RACK_ERRORS       => $stderr,
+        RACK_MULTITHREAD  => false,
+        RACK_MULTIPROCESS => false,
+        RACK_RUN_ONCE     => false,
+        RACK_URL_SCHEME   => "http"
       }
     end
 
@@ -71,7 +69,7 @@ module Toycol
     end
 
     def response_status_code
-      "HTTP/1.1 #{@returned_status} #{::Toycol::DEFAULT_HTTP_STATUS_CODES[@returned_status.to_i] || "CUSTOM"}\r\n"
+      "HTTP/1.1 #{@returned_status} #{DEFAULT_HTTP_STATUS_CODES[@returned_status.to_i] || "CUSTOM"}\r\n"
     end
 
     def response_headers
@@ -108,17 +106,17 @@ module Toycol
       request_method, request_path, = request_line.split
       request_path, query_string    = request_path.split("?")
 
-      @env[::Toycol::REQUEST_METHOD] = request_method
-      @env[::Toycol::PATH_INFO]      = request_path
-      @env[::Toycol::QUERY_STRING]   = query_string || ""
-      @env[::Toycol::CONTENT_LENGTH]
+      @env[REQUEST_METHOD] = request_method
+      @env[PATH_INFO]      = request_path
+      @env[QUERY_STRING]   = query_string || ""
+      @env[CONTENT_LENGTH]
 
       request_headers.each do |request_header|
         k, v = request_header.split(":").map(&:strip)
-        @env["::Toycol::#{k.tr("-", "_").upcase}"] = v
+        @env[k.tr("-", "_").upcase.to_s] = v
       end
 
-      @env[::Toycol::RACK_INPUT] = stringio(request_body)
+      @env[RACK_INPUT] = stringio(request_body)
     end
   end
 end

data/lib/toycol/template_generator.rb

@@ -2,9 +2,11 @@
 
 module Toycol
   class TemplateGenerator
+    include Helper
+
     class << self
       def generate!(type:, name:)
-        raise StandardError, "Unknown Type: This type of template can't be generated" unless valid? type
+        raise Error, "Unknown Type: This type of template can't be generated" unless valid? type
 
         if type == "all"
           new(name, "protocol").generate!
@@ -27,10 +29,10 @@ module Toycol
     end
 
     def generate!
-      raise StandardError, "#{filename} already exists" unless Dir.glob(filename).empty?
+      raise Error, "#{filename} already exists" unless Dir.glob(filename).empty?
 
       File.open(filename, "w") { |f| f.print template_text_for_new }
-      puts "Generate #{filename} in #{FileUtils.pwd}"
+      logger "Generate #{filename} in #{FileUtils.pwd}"
     end
 
     private
@@ -52,8 +54,8 @@ module Toycol
 
     def template_text
       case @type
-      when "protocol" then File.open("lib/toycol/templates/protocol.txt",    "r", &:read)
-      when "app"      then File.open("lib/toycol/templates/application.txt", "r", &:read)
+      when "protocol" then File.open("#{__dir__}/templates/protocol.txt",    "r", &:read)
+      when "app"      then File.open("#{__dir__}/templates/application.txt", "r", &:read)
       end
     end
   end

data/lib/toycol/templates/application.txt

@@ -1,19 +1,24 @@
 require "rack"
 require "toycol"
 
-# Specify which protocol to use
 Toycol::Protocol.use(:PROTOCOL_NAME)
 
 class App
   def call(env)
     # Define your app on request method, request path, request query etc
     # For example:
-    # case env['REQUEST_METHOD']
-    # when 'GET'
+    # case env["REQUEST_METHOD"]
+    # when "GET"
     #   [
     #     200,
-    #     { 'Content-Type' => 'text/html' },
-    #     ["Hello, This app is running by :#{name} protocol."]
+    #     { "Content-Type" => "text/html" },
+    #     ["Hello, This app is running by new protocol."]
+    #   ]
+    # when "OTHER"
+    #   [
+    #     600,
+    #     { "Content-Type" => "text/html" },
+    #     ["This is response message for additional request method"]
     #   ]
     # end
   end

data/lib/toycol/templates/protocol.txt

@@ -8,11 +8,11 @@ Toycol::Protocol.define(:PROTOCOL_NAME) do
 
   # [OPTIONAL] You can define your additional request methods:
   # For example:
-  # additional_request_methods OTHER
+  # additional_request_methods "OTHER"
 
   # [OPTIONAL] You can define your own response status code:
   # For example:
-  # define_status_codes(
+  # custom_status_codes(
   #   600 => "I'm afraid you are not a duck..."
   # )
 

data/lib/toycol/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toycol
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Misaki Shioi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-25 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack