RubyGems - toycol - Versions diffs - 0.0.1 → 0.2.2 - Mend

toycol 0.0.1 → 0.2.2

Files changed (38) hide show

checksums.yaml +4 -4
data/.github/ISSUE_TEMPLATE/bug_report.md +29 -0
data/.github/dependabot.yml +9 -0
data/.github/workflows/main.yml +4 -1
data/.gitignore +1 -0
data/.rubocop.yml +26 -1
data/CHANGELOG.md +1 -1
data/README.md +2 -4
data/examples/duck/Gemfile +5 -0
data/examples/duck/Protocolfile.duck +23 -0
data/examples/duck/config_duck.ru +59 -0
data/examples/rubylike/Gemfile +5 -0
data/examples/rubylike/Protocolfile.rubylike +18 -0
data/examples/rubylike/config_rubylike.ru +27 -0
data/examples/safe_ruby/Gemfile +6 -0
data/examples/safe_ruby/Protocolfile.safe_ruby +47 -0
data/examples/safe_ruby/config_safe_ruby.ru +55 -0
data/examples/safe_ruby_with_sinatra/Gemfile +10 -0
data/examples/safe_ruby_with_sinatra/Protocolfile.safe_ruby_with_sinatra +44 -0
data/examples/safe_ruby_with_sinatra/app.rb +28 -0
data/examples/safe_ruby_with_sinatra/post.rb +34 -0
data/examples/safe_ruby_with_sinatra/views/index.erb +32 -0
data/examples/unsafe_ruby/Gemfile +5 -0
data/examples/unsafe_ruby/Protocolfile.unsafe_ruby +15 -0
data/examples/unsafe_ruby/config_unsafe_ruby.ru +24 -0
data/exe/toycol +6 -0
data/lib/rack/handler/toycol.rb +65 -0
data/lib/toycol.rb +20 -1
data/lib/toycol/client.rb +38 -0
data/lib/toycol/command.rb +132 -0
data/lib/toycol/const.rb +102 -0
data/lib/toycol/helper.rb +27 -0
data/lib/toycol/protocol.rb +126 -0
data/lib/toycol/proxy.rb +116 -0
data/lib/toycol/server.rb +124 -0
data/lib/toycol/version.rb +1 -1
data/toycol.gemspec +3 -7
metadata +48 -5

data/examples/safe_ruby_with_sinatra/app.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require "sinatra/base"
+require "sinatra/reloader"
+require "toycol"
+require_relative "post"
+Toycol::Protocol.use(:safe_ruby_with_sinatra)
+class App < Sinatra::Base
+  set :server, :toycol
+  set :port, 9292
+  get "/posts" do
+    @posts = params[:user_id] ? Post.where(user_id: params[:user_id]) : Post.all
+    erb :index
+  end
+  post "/posts" do
+    Post.new(user_id: params[:user_id], body: params[:body])
+    @posts = Post.all
+    erb :index
+  end
+  run! if app_file == $PROGRAM_NAME
+end

data/examples/safe_ruby_with_sinatra/post.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+class Post
+  @posts ||= []
+  class << self
+    def all
+      @posts
+    end
+    def where(user_id: nil)
+      @posts.select do |post|
+        post.user_id == Integer(user_id) if user_id
+      end
+    end
+    def insert(record)
+      @posts << record
+    end
+  end
+  attr_reader :user_id, :body
+  def initialize(user_id:, body:)
+    @user_id = Integer(user_id)
+    @body    = body
+    self.class.insert self
+  end
+end
+# Initial records
+Post.new(user_id: 1, body: "I love Ruby!")
+Post.new(user_id: 2, body: "I love RubyKaigi!")

data/examples/safe_ruby_with_sinatra/views/index.erb ADDED Viewed

@@ -0,0 +1,32 @@
+<html>
+  <head>
+    <meta charset="UTF-8">
+  </head>
+  <body>
+    <h1>This app is running on Safe Ruby protocol</h1>
+    <div>
+      <ul>
+        <% @posts.each do |post| %>
+          <li><%= "User<#{post.user_id}> #{post.body}" %></li>
+        <% end %>
+      </ul>
+    </div>
+    <div>
+      <form action='/posts' method='post'>
+        <div>
+          <label>User ID</label>
+          <input type="number" name="user_id">
+        </div>
+        <div>
+          <label>Content</label>
+          <input type="text" name="body">
+        </div>
+        <div>
+          <input type="submit" value="Post">
+        </div>
+      </form>
+  </body>
+</html>

data/examples/unsafe_ruby/Gemfile ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+gem "toycol", path: "../../"

data/examples/unsafe_ruby/Protocolfile.unsafe_ruby ADDED Viewed

@@ -0,0 +1,15 @@
+Toycol::Protocol.define(:ruby) do |message|
+  using Module.new {
+    refine String do
+      def get
+        Toycol::Protocol.request.path do |message|
+          /['"](?<path>.+)['"]/.match(message)[:path]
+        end
+        Toycol::Protocol.request.http_method { |_| "GET" }
+      end
+    end
+  }
+  instance_eval message
+end

data/examples/unsafe_ruby/config_unsafe_ruby.ru ADDED Viewed

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require "rack"
+require "toycol"
+Toycol::Protocol.use(:ruby)
+class App
+  def call(env)
+    case env["REQUEST_METHOD"]
+    when "GET"
+      case env["PATH_INFO"]
+      when "/posts"
+        [
+          200,
+          { "Content-Type" => "text/html" },
+          ["I love Ruby!\n", "I've successfully accessed using instance_eval!\n"]
+        ]
+      end
+    end
+  end
+end
+run App.new

data/exe/toycol ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require_relative "../lib/toycol"
+Toycol::Command.run(ARGV)

data/lib/rack/handler/toycol.rb ADDED Viewed

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require "rack"
+require "rack/handler"
+module Rack
+  module Handler
+    class Toycol
+      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?
+            raise LoadError, "Puma is not installed in your environment."
+          when nil
+            puma_requireable? ? "puma" : "build_in"
+          else
+            "build_in"
+          end
+        rescue LoadError
+          Process.kill(:INT, Process.ppid)
+          abort
+        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
+    register :toycol, Toycol
+  end
+end

data/lib/toycol.rb CHANGED Viewed

@@ -1,8 +1,27 @@
 # frozen_string_literal: true
+require "fileutils"
+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/command"
 require_relative "toycol/version"
 module Toycol
   class Error < StandardError; end
-  # Your code goes here...
+  class UnauthorizedMethodError < Error; end
+  class UnauthorizedRequestError < Error; end
+  class UndefinedRequestMethodError < Error; end
+  class UnknownStatusCodeError < Error; end
 end

data/lib/toycol/client.rb ADDED Viewed

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "socket"
+module Toycol
+  class Client
+    @port = 9292
+    CHUNK_SIZE = 1024 * 16
+    class << self
+      attr_writer :port
+      def execute!(request_message, &block)
+        socket = TCPSocket.new("localhost", @port)
+        socket.write(request_message)
+        puts "[Toycol] Sent request message: #{request_message}\n---"
+        response_message = []
+        response_message << socket.readpartial(CHUNK_SIZE) until socket.eof?
+        response_message = response_message.join
+        block ||= default_proc
+        block.call(response_message)
+      ensure
+        socket.close
+      end
+      private
+      def default_proc
+        proc do |message|
+          puts "[Toycol] Received response message:\n\n"
+          puts message
+        end
+      end
+    end
+  end
+end

data/lib/toycol/command.rb ADDED Viewed

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+require "optparse"
+require_relative "./client"
+module Toycol
+  class Command
+    class Options
+      class << self
+        def parse!(argv)
+          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]) && argv.first != "-h"
+            sub_command_option_parser[options[:command]].parse!(argv)
+          rescue OptionParser::MissingArgument, OptionParser::InvalidOption, ArgumentError => e
+            abort e.message
+          end
+          options
+        end
+        def create_option_parser
+          OptionParser.new do |opt|
+            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_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", "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 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
+        def client_command_help_messages
+          [
+            { 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
+    def self.run(argv)
+      new(argv).execute
+    end
+    def initialize(argv)
+      @argv = argv
+    end
+    def execute
+      options = Options.parse!(@argv)
+      command = options.delete(:command)
+      case command
+      when "client", "c"
+        ::Toycol::Client.execute!(options[:request_message])
+      when "server", "s"
+        ARGV.push("-q", "-s", "toycol")
+        Rack::Server.start
+      end
+    end
+  end
+end

data/lib/toycol/const.rb ADDED Viewed

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+module Toycol
+  # For HTTP Protocol
+  DEFAULT_HTTP_REQUEST_METHODS = %w[
+    GET
+    HEAD
+    POST
+    OPTIONS
+    PUT
+    DELETE
+    TRACE
+    PATCH
+    LINK
+    UNLINK
+  ].freeze
+  DEFAULT_HTTP_STATUS_CODES = {
+    100 => "Continue",
+    101 => "Switching Protocols",
+    102 => "Processing",
+    200 => "OK",
+    201 => "Created",
+    202 => "Accepted",
+    203 => "Non-Authoritative Information",
+    204 => "No Content",
+    205 => "Reset Content",
+    206 => "Partial Content",
+    207 => "Multi-Status",
+    208 => "Already Reported",
+    226 => "IM Used",
+    300 => "Multiple Choices",
+    301 => "Moved Permanently",
+    302 => "Found",
+    303 => "See Other",
+    304 => "Not Modified",
+    305 => "Use Proxy",
+    307 => "Temporary Redirect",
+    308 => "Permanent Redirect",
+    400 => "Bad Request",
+    401 => "Unauthorized",
+    402 => "Payment Required",
+    403 => "Forbidden",
+    404 => "Not Found",
+    405 => "Method Not Allowed",
+    406 => "Not Acceptable",
+    407 => "Proxy Authentication Required",
+    408 => "Request Timeout",
+    409 => "Conflict",
+    410 => "Gone",
+    411 => "Length Required",
+    412 => "Precondition Failed",
+    413 => "Payload Too Large",
+    414 => "URI Too Long",
+    415 => "Unsupported Media Type",
+    416 => "Range Not Satisfiable",
+    417 => "Expectation Failed",
+    418 => "I'm A Teapot",
+    421 => "Misdirected Request",
+    422 => "Unprocessable Entity",
+    423 => "Locked",
+    424 => "Failed Dependency",
+    426 => "Upgrade Required",
+    428 => "Precondition Required",
+    429 => "Too Many Requests",
+    431 => "Request Header Fields Too Large",
+    451 => "Unavailable For Legal Reasons",
+    500 => "Internal Server Error",
+    501 => "Not Implemented",
+    502 => "Bad Gateway",
+    503 => "Service Unavailable",
+    504 => "Gateway Timeout",
+    505 => "HTTP Version Not Supported",
+    506 => "Variant Also Negotiates",
+    507 => "Insufficient Storage",
+    508 => "Loop Detected",
+    510 => "Not Extended",
+    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