RubyGems - ronin-web-server - Versions diffs - 0.1.0.beta1 - Mend

ronin-web-server 0.1.0.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (40) hide show

checksums.yaml +7 -0
data/.document +5 -0
data/.github/workflows/ruby.yml +41 -0
data/.gitignore +13 -0
data/.rspec +1 -0
data/.rubocop.yml +154 -0
data/.ruby-version +1 -0
data/.yardopts +1 -0
data/COPYING.txt +165 -0
data/ChangeLog.md +38 -0
data/Gemfile +35 -0
data/README.md +177 -0
data/Rakefile +34 -0
data/gemspec.yml +31 -0
data/lib/ronin/web/server/app.rb +33 -0
data/lib/ronin/web/server/base.rb +214 -0
data/lib/ronin/web/server/conditions.rb +443 -0
data/lib/ronin/web/server/helpers.rb +67 -0
data/lib/ronin/web/server/request.rb +78 -0
data/lib/ronin/web/server/response.rb +36 -0
data/lib/ronin/web/server/reverse_proxy/request.rb +230 -0
data/lib/ronin/web/server/reverse_proxy/response.rb +35 -0
data/lib/ronin/web/server/reverse_proxy.rb +265 -0
data/lib/ronin/web/server/routing.rb +261 -0
data/lib/ronin/web/server/version.rb +28 -0
data/lib/ronin/web/server.rb +62 -0
data/ronin-web-server.gemspec +59 -0
data/spec/base_spec.rb +73 -0
data/spec/classes/public1/static1.txt +1 -0
data/spec/classes/public2/static2.txt +1 -0
data/spec/classes/sub_app.rb +13 -0
data/spec/classes/test_app.rb +20 -0
data/spec/helpers/rack_app.rb +24 -0
data/spec/request_spec.rb +58 -0
data/spec/response_spec.rb +8 -0
data/spec/reverse_proxy/request_spec.rb +200 -0
data/spec/reverse_proxy/response_spec.rb +8 -0
data/spec/reverse_proxy_spec.rb +223 -0
data/spec/spec_helper.rb +9 -0
metadata +180 -0

data/lib/ronin/web/server/routing.rb ADDED Viewed

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+#
+# ronin-web-server - A custom Ruby web server based on Sinatra.
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web-server is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-web-server is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-web-server.  If not, see <https://www.gnu.org/licenses/>.
+#
+require 'rack/file'
+require 'rack/directory'
+module Ronin
+  module Web
+    module Server
+      #
+      # Adds additional routing class methods to {Base}.
+      #
+      # @api semipublic
+      #
+      module Routing
+        #
+        # Adds {ClassMethods} to the class.
+        #
+        # @param [Class] base
+        #   The application base class that is including {Routing}.
+        #
+        # @api private
+        #
+        def self.included(base)
+          base.extend ClassMethods
+        end
+        #
+        # Class methods to be added to the application base class.
+        #
+        module ClassMethods
+          #
+          # Route any type of request for a given URL pattern.
+          #
+          # @param [String] path
+          #   The URL pattern to handle requests for.
+          #
+          # @param [Hash{Symbol => Object}] conditions
+          #   Additional routing conditions.
+          #
+          # @yield []
+          #   The block that will handle the request.
+          #
+          # @example
+          #   any '/submit' do
+          #     puts request.inspect
+          #   end
+          #
+          # @api public
+          #
+          def any(path,conditions={},&block)
+            get(path,conditions,&block)
+            post(path,conditions,&block)
+            put(path,conditions,&block)
+            patch(path,conditions,&block)
+            delete(path,conditions,&block)
+            options(path,conditions,&block)
+          end
+          #
+          # Sets the default route.
+          #
+          # @yield []
+          #   The block that will handle all other requests.
+          #
+          # @example
+          #   default do
+          #     status 200
+          #     content_type :html
+          #
+          #     %{
+          #     <html>
+          #       <body>
+          #         <center><h1>YOU LOSE THE GAME</h1></center>
+          #       </body>
+          #     </html>
+          #     }
+          #   end
+          #
+          # @api public
+          #
+          def default(&block)
+            not_found(&block)
+            return self
+          end
+          #
+          # Enables Basic-Auth authentication for the entire app.
+          #
+          # @param [String] auth_user
+          #   The desired username.
+          #
+          # @param [String] auth_password
+          #   The desired password
+          #
+          # @param [String] realm
+          #   The "realm" message to display in the Basic-Auth dialog.
+          #
+          # @example
+          #   basic_auth 'admin', 's3cr3t'
+          #
+          # @api public
+          #
+          def basic_auth(auth_user,auth_password, realm: 'Restricted')
+            use Rack::Auth::Basic, realm do |user,password|
+              user == auth_user && passwrd == auth_password
+            end
+          end
+          #
+          # Sets up a 302 Redirect at the given path.
+          #
+          # @param [String] path
+          #   The path  the web server will respond to.
+          #
+          # @param [String] url
+          #   The URL to redirect to.
+          #
+          # @example
+          #   redirect '/path', 'https://example.com/'
+          #
+          # @api public
+          #
+          def redirect(path,url)
+            get(path) { redirect(url) }
+          end
+          #
+          # Hosts the contents of a file.
+          #
+          # @param [String, Regexp] remote_path
+          #   The path the web server will host the file at.
+          #
+          # @param [String] local_path
+          #   The path to the local file.
+          #
+          # @param [Hash{Symbol => Object}] conditions
+          #   Additional routing conditions.
+          #
+          # @example
+          #   file '/robots.txt', '/path/to/my_robots.txt'
+          #
+          # @api public
+          #
+          def file(remote_path,local_path,conditions={})
+            get(remote_path,conditions) { send_file(local_path) }
+          end
+          #
+          # Hosts the contents of the directory.
+          #
+          # @param [String] remote_path
+          #   The path the web server will host the directory at.
+          #
+          # @param [String] local_path
+          #   The path to the local directory.
+          #
+          # @param [Hash{Symbol => Object}] conditions
+          #   Additional routing conditions.
+          #
+          # @example
+          #   directory '/download/', '/tmp/files/'
+          #
+          # @api public
+          #
+          def directory(remote_path,local_path,conditions={})
+            dir = Rack::File.new(local_path)
+            get("#{remote_path}/*",conditions) do |sub_path|
+              response = dir.call(env.merge('PATH_INFO' => "/#{sub_path}"))
+              if response[0] == 200 then response
+              else                       pass
+              end
+            end
+          end
+          #
+          # Hosts the static contents within a given directory.
+          #
+          # @param [String] path
+          #   The path to a directory to serve static content from.
+          #
+          # @param [Hash{Symbol => Object}] conditions
+          #   Additional routing conditions.
+          #
+          # @example
+          #   public_dir 'path/to/another/public'
+          #
+          # @api public
+          #
+          def public_dir(path,conditions={})
+            directory('',path,conditions)
+          end
+          #
+          # Routes all requests for a given virtual host to another
+          # Rack application.
+          #
+          # @param [Regexp, String] host
+          #   The host name to match against.
+          #
+          # @param [#call] app
+          #   The Rack application to route the requests to.
+          #
+          # @param [Hash] conditions
+          #   Additional routing conditions.
+          #
+          # @api public
+          #
+          def vhost(host,app,conditions={})
+            any('*',conditions.merge(host: host)) do
+              app.call(env)
+            end
+          end
+          #
+          # Routes all requests within a given directory into another
+          # Rack application.
+          #
+          # @param [String] dir
+          #   The directory that requests for will be routed from.
+          #
+          # @param [#call] app
+          #   The Rack application to route requests to.
+          #
+          # @param [Hash{Symbol => Object}] conditions
+          #   Additional routing conditions.
+          #
+          # @example
+          #   mount '/subapp/', SubApp
+          #
+          # @api public
+          #
+          def mount(dir,app,conditions={})
+            any("#{dir}/?*",conditions) do |sub_path|
+              app.call(env.merge('PATH_INFO' => "/#{sub_path}"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/web/server/version.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+#
+# ronin-web-server - A custom Ruby web server based on Sinatra.
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web-server is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-web-server is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-web-server.  If not, see <https://www.gnu.org/licenses/>.
+#
+module Ronin
+  module Web
+    module Server
+      # ronin-web-server version
+      VERSION = '0.1.0.beta1'
+    end
+  end
+end

data/lib/ronin/web/server.rb ADDED Viewed

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+#
+# ronin-web-server - A custom Ruby web server based on Sinatra.
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-web-server is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-web-server is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-web-server.  If not, see <https://www.gnu.org/licenses/>.
+#
+require 'ronin/web/server/base'
+require 'ronin/web/server/app'
+module Ronin
+  module Web
+    #
+    # Returns the Ronin Web Server.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @yield [server]
+    #   If a block is given, it will be passed the current web server.
+    #
+    # @yieldparam [Server::App]
+    #   The current web server class.
+    #
+    # @return [Server::App]
+    #   The current web server class.
+    #
+    # @example
+    #   Web.server do
+    #     get '/hello' do
+    #       'world'
+    #     end
+    #   end
+    #
+    # @see Server::Base.run!
+    #
+    # @api public
+    #
+    def self.server(options={},&block)
+      unless @server
+        @server = Server::App
+        @server.run!(options.merge(background: true))
+      end
+      @server.class_eval(&block) if block
+      return @server
+    end
+  end
+end

data/ronin-web-server.gemspec ADDED Viewed

@@ -0,0 +1,59 @@
+require 'yaml'
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+                  require 'ronin/web/server/version'
+                  Ronin::Web::Server::VERSION
+                end
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+  gem.files  = `git ls-files`.split($/)
+  gem.files  = glob[gemspec['files']] if gemspec['files']
+  gem.files += Array(gemspec['generated_files'])
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || 'spec/{**/}*_spec.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+  split = lambda { |string| string.split(/,\s*/) }
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/spec/base_spec.rb ADDED Viewed

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'ronin/web/server/base'
+require 'classes/test_app'
+require 'helpers/rack_app'
+describe Ronin::Web::Server::Base do
+  include Helpers::Web::RackApp
+  before(:all) do
+    self.app = TestApp
+  end
+  it "should still bind blocks to paths" do
+    get '/tests/get'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('block tested')
+  end
+  it "should bind a block to a path for all request types" do
+    post '/tests/any'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('any tested')
+  end
+  it "should have a default response" do
+    get '/totally/non/existant/path'
+    expect(last_response).not_to be_ok
+    expect(last_response.body).to be_empty
+  end
+  it "should allow for defining custom responses" do
+    TestApp.default do
+      halt 404, 'nothing to see here'
+    end
+    get '/whats/here'
+    expect(last_response).not_to be_ok
+    expect(last_response.body).to eq('nothing to see here')
+  end
+  it "should map paths to sub-apps" do
+    get '/tests/subapp/'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('SubApp')
+  end
+  it "should not modify the path_info as it maps paths to sub-apps" do
+    get '/tests/subapp/hello'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('SubApp greets you')
+  end
+  it "should host static content from public directories" do
+    get '/static1.txt'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("Static file1.\n")
+  end
+  it "should host static content from multiple public directories" do
+    get '/static2.txt'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("Static file2.\n")
+  end
+end

data/spec/classes/public1/static1.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ Static file1.

data/spec/classes/public2/static2.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ Static file2.

data/spec/classes/sub_app.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'ronin/web/server/base'
+class SubApp < Ronin::Web::Server::Base
+  get '/hello' do
+    'SubApp greets you'
+  end
+  get '/' do
+    'SubApp'
+  end
+end

data/spec/classes/test_app.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'ronin/web/server/base'
+require 'classes/sub_app'
+class TestApp < Ronin::Web::Server::Base
+  get '/tests/get' do
+    'block tested'
+  end
+  any '/tests/any' do
+    'any tested'
+  end
+  mount '/tests/subapp', SubApp
+  public_dir File.join(File.dirname(__FILE__),'public1')
+  public_dir File.join(File.dirname(__FILE__),'public2')
+end

data/spec/helpers/rack_app.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'rack/test'
+module Helpers
+  module Web
+    module RackApp
+      include Rack::Test::Methods
+      attr_reader :app
+      def app=(server)
+        @app = server
+        @app.set :environment, :test
+      end
+      def get_host(path,host,params={},headers={})
+        get(path,params,headers.merge('HTTP_HOST' => host))
+      end
+      def post_host(path,host,params={},headers={})
+        post(path,params,headers.merge('HTTP_HOST' => host))
+      end
+    end
+  end
+end

data/spec/request_spec.rb ADDED Viewed

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'ronin/web/server/request'
+describe Ronin::Web::Server::Request do
+  it "must provide the same methods as Sinatra::Request" do
+    expect(described_class).to be < Sinatra::Request
+  end
+  let(:env) { {} }
+  subject { described_class.new(env) }
+  describe "#ip_with_port" do
+    let(:ip) { '127.0.0.1' }
+    context "when REMOTE_PORT is set" do
+      let(:port) { 8000 }
+      let(:env) do
+        {'REMOTE_ADDR' => ip, 'REMOTE_PORT' => port}
+      end
+      it "must return REMOTE_ADDR:REMOTE_PORT" do
+        expect(subject.ip_with_port).to eq("#{ip}:#{port}")
+      end
+    end
+    context "when REMOTE_PORT is not set" do
+      let(:env) do
+        {'REMOTE_ADDR' => ip}
+      end
+      it "must return the REMOTE_ADDR" do
+        expect(subject.ip_with_port).to eq(ip)
+      end
+    end
+  end
+  describe "#headers" do
+    let(:header1) { 'header1 value' }
+    let(:header2) { 'header2 value' }
+    let(:env) do
+      {
+        'HTTP_HEADER1' => header1,
+        'FOO_BAR'      => 'foo',
+        'HTTP_HEADER2' => header2
+      }
+    end
+    it "must return a Hash of all HTTP_* headers" do
+      expect(subject.headers).to eq(
+        {
+          'Header1' => header1,
+          'Header2' => header2
+        }
+      )
+    end
+  end
+end

data/spec/response_spec.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'ronin/web/server/response'
+describe Ronin::Web::Server::Response do
+  it "must provide the same methods as Sinatra::Response" do
+    expect(described_class).to be < Sinatra::Response
+  end
+end