supersimplehttp 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 827ec9cfe19d8824123b8ec013363b545507bf0cb54be321e13bb584df2063bc
+  data.tar.gz: 61bfe0e319c6c2a3f3f217aed9f4c8e210730637bddd1e8f15bba4377c483524
+SHA512:
+  metadata.gz: 197333ddc3e3dcfa12703532193f30a90b1b42831cb114cf28217bfa592fa938a70e8a3ea9a1daebdf330a4d609a84641320547732919034c34756a5c63c51ea
+  data.tar.gz: 26ad44dbecba16a998eb0006db71f94d580d3283e3a8221802702cb19e20c74edff92aca0a411c85f8881336d31cf6a7fde70a58542c8a495dc1841363096b01

data/.gitattributes

@@ -0,0 +1,2 @@
+# Autodetect text files
+* text=auto

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.1] - 2020-09-06
+
+### Added
+
+- Ability to server static files
+- Pass in function to start
+- Added index.html to example
+
+### Changed
+
+- How responses are handled (to be able to serve files)
+- Fixed Readme
+- Updated example
+- Formatted file correctly with ruby conventions
+
+## [0.1.0] - 2020-09-06
+
+### Added
+
+- Created the gem bundle
+- Created basic test
+- Created simple server
+
+### Changed
+
+- Updated example
+- Updated README
+
+[0.1.1]: https://github.com/filipwtf/supersimplehttp/releases/tag/v0.1.1s
+[0.1.0]: https://github.com/filipwtf/supersimplehttp/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/filipwtf/supersimplehttp" }
+
+# Specify your gem's dependencies in supersimplehttp.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    supersimplehttp (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (10.5.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  supersimplehttp!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Filip
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Supersimplehttp
+
+NOTE: This shouldn't be used in a real environment it's not secure
+Supper Simple HTTP is a simple HTTP server created in ruby. At it's current stage it has no real world use there are way better frameworks. I simple made this project to learn Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'supersimplehttp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install supersimplehttp
+
+## Usage
+
+You can check out the example folder
+
+Create a new ruby file:
+
+```rb
+require 'supersimplehttp'
+
+Supersimplehttp::Server.new('localhost', 5000)
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/filipwtf/supersimplehttp.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "supersimplehttp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/server.rb

@@ -0,0 +1,6 @@
+require 'supersimplehttp'
+
+port = 5000
+addr = 'localhost'
+
+server = Supersimplehttp::Server.new(addr, port) { "[Supersimplehttp] running on #{addr}:#{port}" }

data/example/tmp/web-server/index.html

@@ -0,0 +1 @@
+Hello

data/lib/http.rb

@@ -0,0 +1,148 @@
+class ResponsePreparer
+  SERVER_ROOT = "example/tmp/web-server"
+
+  def prepare_response(request)
+    if request.fetch(:path) == "/"
+      respond_with(SERVER_ROOT + "index.html")
+    else
+      respond_with(SERVER_ROOT + request.fetch(:path))
+    end
+  end
+  
+  def respond_with(path)
+    if File.exists?(path)
+      send_ok_response(File.binread(path))
+    else
+      send_file_not_found
+    end
+   end
+
+  def send_ok_response(data)
+    Response.new(code: 200, data: data)
+  end
+  
+  def send_file_not_found
+    Response.new(code: 404)
+  end
+end
+
+class Response
+  def initialize(code:, body: "")
+    @code = code
+    @response = 
+      "HTTP/1.1 #{code}\r\n" +
+      "Content-Length: #{body.size}\r\n" +
+      "\r\n" +
+      "#{body}\r\n"
+  end
+
+  def send(client)
+    client.write(@response)
+  end
+
+  def code 
+    @code
+  end
+
+end
+
+class RequestParser
+  REPLACEMENTS = [['%2e', '.'], ['%2f', '/'], ['%5c', ''], ['%255c', ''], ['.',''], [':', ':.'], ['=/', '']]
+
+  def initialize(request)
+    @request = request
+  end
+
+  def parse
+    method, path, version = @request.lines[0].split
+    path = normalize_path(path)
+
+    if path.include? '?'
+      query = path.split('?')[1]
+      path = path.split('?')[0]
+      query = parse_query(query)
+    end
+
+    headers = parse_headers(@request)
+
+    body = nil
+    if headers.has_key?(:"content-type")
+      body = @request.split(/\n\r\n/)[1]
+    end
+
+    {
+      method: method,
+      version: version,
+      path: path,
+      query: query,
+      headers: headers,
+      body: body
+    }
+  end
+
+=begin
+  splits http headers and creates key values pairs
+=end
+  def parse_headers(headers_string)
+    headers = {}
+    headers_string.lines[1..-1].each do |line|
+      return headers if line == "\r\n"
+      header, value = line.split
+      header = normalize(header)
+      headers[header] = value
+    end
+  end
+
+=begin
+  This method parses url params
+  https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams
+
+  parameter = name=Jonathan%20Smith&age=18
+  returns
+  {
+    :name=>"Jonathan Smith",
+    :age=>"18"
+  }
+
+=end
+  def parse_query(query_string)
+    params = query_string.split('&')
+    queries = {}
+    params.each do |param|
+      param, value = param.split('=')
+      param, value = remove_encoded_space(param, value)
+      param = normalize(param)
+      queries[param] = value
+    end 
+    return queries
+  end
+
+  def normalize(data)
+    data.gsub(":","").downcase.to_sym
+  end
+
+  # Remove url encoded space %20
+  def remove_encoded_space(*args)
+    index = 0;
+    args.each do |arg|
+      if arg.nil? == false
+        args[index] = arg.gsub("%20", " ")
+        index += 1
+      end
+    end
+    
+    return args
+  end
+
+  # Normalizes this URI's path. Not very clean but hopefully does the trick
+  # https://owasp.org/www-community/attacks/Path_Traversal
+  # https://docs.oracle.com/javase/7/docs/api/java/net/URI.html#normalize()
+  def normalize_path(path)
+    # Removes . any number
+    # path.gsub!(/\.+/, ".")
+    REPLACEMENTS.each do |replacement|
+      path.gsub!(replacement[0], replacement[1])
+    end
+    return path
+  end
+end

data/lib/supersimplehttp.rb

@@ -0,0 +1,33 @@
+require 'socket'
+require 'pp'
+require "supersimplehttp/version"
+require_relative 'http'
+
+module Supersimplehttp
+  class Error < StandardError; end
+  class Server
+    def initialize(addr, port, &block)
+      @server = TCPServer.new(addr, port)
+      if block
+        puts block.call()
+      end
+      run
+    end
+
+    def run
+      loop do
+        Thread.start(@server.accept) do |client|
+          request = client.readpartial(2048)
+          
+          request = RequestParser.new(request).parse
+          response = ResponsePreparer.new.prepare_response(request)
+          puts "[#{Time.now.strftime("%H:%M:%S")}] #{client.peeraddr[3]} #{request.fetch(:path)} - #{response.code}"
+          # Pretty print request
+          # STDERR.puts PP.pp(request, $>, 40)
+          response.send(client)
+          client.close 
+        end
+      end
+    end
+  end
+end

data/lib/supersimplehttp/version.rb

@@ -0,0 +1,3 @@
+module Supersimplehttp
+  VERSION = "0.1.1"
+end

data/supersimplehttp.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "supersimplehttp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "supersimplehttp"
+  spec.version       = Supersimplehttp::VERSION
+  spec.authors       = ["filipwtf"]
+  spec.email         = ["filip@egg-is-the-best.com"]
+
+  spec.summary       = "Super simple http server"
+  spec.description   = "Creates a super simple http server"
+  spec.homepage      = "https://github.com/filipwtf/supersimplehttp"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/filipwtf/supersimplehttp"
+    spec.metadata["changelog_uri"] = "https://github.com/filipwtf/supersimplehttp/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: supersimplehttp
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- filipwtf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Creates a super simple http server
+email:
+- filip@egg-is-the-best.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/server.rb
+- example/tmp/web-server/index.html
+- lib/http.rb
+- lib/supersimplehttp.rb
+- lib/supersimplehttp/version.rb
+- supersimplehttp.gemspec
+homepage: https://github.com/filipwtf/supersimplehttp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/filipwtf/supersimplehttp
+  source_code_uri: https://github.com/filipwtf/supersimplehttp
+  changelog_uri: https://github.com/filipwtf/supersimplehttp/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Super simple http server
+test_files: []