RubyGems - tiny_ruby_server - Versions diffs - 0.1 - Mend

tiny_ruby_server 0.1

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 (17) hide show

checksums.yaml +7 -0
data/.gitignore +2 -0
data/Gemfile +3 -0
data/README.md +13 -0
data/lib/server.rb +36 -0
data/lib/time_server_local.rb +14 -0
data/lib/tiny_ruby_server.rb +61 -0
data/lib/tiny_ruby_server/version.rb +3 -0
data/public/SeaSerpent.png +0 -0
data/public/Vinh_Long_small.jpg +0 -0
data/public/goldstar.gif +0 -0
data/public/index.html +11 -0
data/public/ruby_reflections.png +0 -0
data/public/sockeyes_in_stream.jpg +0 -0
data/test/file_server.rb +47 -0
data/tiny_ruby_server.gemspec +18 -0
metadata +58 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b41e06e5d2a0614dc1d97de394ba4a925a5ed0e
+  data.tar.gz: 8ac6127db498dbb191aaaa4c0dd3944951f1c680
+SHA512:
+  metadata.gz: 3ee1ba0e6780c4e7fbd5b0b4168319847d2ab657dc36f86c8afec2a8f07561c60531a78106aa44539dd09b50a6944de8de689c088d17a3e6eac4d200ce1d1e89
+  data.tar.gz: c0e3f26350627154db3e09b005feffa6f8da11d303f457739a39e0c527c62eb92011e126810946c7f4b3bcb15836afbc39c5bd6e36dbb1a863c48f986b2bc5f6

data/.gitignore ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ .ruby-gemset
2	+ .ruby-version

data/Gemfile ADDED Viewed

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec

data/README.md ADDED Viewed

@@ -0,0 +1,13 @@
+### Demo of Simple Ruby Web Server to View Files
+#### Usage:
+* Run with ruby, `ruby ./test/file_server.rb`
+* Navigate to a file, e.g.  http://5678:SeaSerpent.jpg
+#### Features
+* Will only serve files in `public` directory
+* Incorporates security features implemented in `Rack::File` to ensure only authorized files are accessed.
+* Uses `IO.copy_stream(file, socket)`
+* Will continue to serve files until killed.

data/lib/server.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'socket'
+server = TCPServer.new('localhost', 5678)
+# infinite loop to process one incoming connection at a time
+loop do
+  # wait for client to connect, then reurn a TCPSocket
+  # that can be used in a similar fashion to other Ruby
+  # I/O objects.
+  socket = server.accept
+  # read the first line of request (Request Line)
+  request = socket.gets
+  # Log request to console for debugging
+  STDERR.puts request
+  response = "Welcome to jetWhidbey World.\n"
+  # Include the Content-Type and Content-Length headers
+  # to let the client know the size and type of data
+  # contained in the response. Note that  HTTP is whitespacce sensitive
+  # and expects each header line to end with CRLF (i.e. "\r\n")
+  socket.print "HTTP/1.1 200 OK\r\n" +
+               "Content-Type: text/plain\r\n" +
+               "Content-Length: #{response.bytesize}\r\n" +
+               "Connection: close\r\n"
+  # Print a blank line to separate the header from the respnse body,
+  # as required by the protocol.
+  socket.print "\r\n"
+  # Print the actual response body, which is just "Welcome to jetWhidbey World.\n"
+  socket.print response
+end

data/lib/time_server_local.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require 'socket'
+port = (ARGV[0] || 5678).to_i
+server = TCPServer.new('localhost', port)
+loop do
+  while (session = server.accept)
+    puts "Request: #{session.gets}"
+    session.print "HTTP/1.1 200/OK\r\nContent-type: text/html\r\n\r\n"
+    session.print "<html><body><h1>#{Time.now}</h1></body></html>\r\n"
+    session.close
+  end
+end

data/lib/tiny_ruby_server.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require 'socket'
+require 'uri'
+require 'tiny_ruby_server/version'
+module TinyRubyServer
+  # File will be served from below directory
+  WEB_ROOT = './public'
+  # Map extensions to their content type
+  CONTENT_TYPE_MAPPING = {
+    'html' => 'text/html',
+    'txt' => 'text/plain',
+    'png' => 'image/png',
+    'jpg' => 'image/jpeg',
+    'gif' => 'image/gif'
+  }
+  # Treat as binary data if content type can not be found
+  DEFAULT_CONTENT_TYPE = 'application/octet-stream'
+  # Helper function to parse extension of requested file,
+  # then looks up its content type:
+  def self.content_type(path)
+    ext = File.extname(path).split(".").last
+    CONTENT_TYPE_MAPPING.fetch(ext, DEFAULT_CONTENT_TYPE)
+  end
+  # Helper function to parse the Request-Line and
+  # generate a pathe to a file on the server.
+  # The below is lifted from Rack::File
+  # The reason for this is that it is extremely easy to introduce a
+  # security vulnerablility where any file in file system can be accessed.
+  # In fact, the below was added in 2013 specifically to deal with such a
+  # security vulnerablility
+  def self.requested_file(request_line)
+    request_uri  = request_line.split(" ")[1]
+    path         = URI.unescape(URI(request_uri).path)
+    clean = []
+    # Split the path into components
+    parts = path.split("/")
+    parts.each do |part|
+      # skip any empty or current directory (".") path components
+      next if part.empty? || part == '.'
+      # If the path component goes up one directory level (".."),
+      # remove the last clean component.
+      # Otherwise, add the component to the Array of clean components
+      part == '..' ? clean.pop : clean << part
+    end
+    # return the web root joined to the clean path
+    path = File.join(WEB_ROOT, *clean)
+  end
+end

data/lib/tiny_ruby_server/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module  TinyRubyServer
+  VERSION = "0.1"
+end

data/public/SeaSerpent.png ADDED Viewed

Binary file

data/public/Vinh_Long_small.jpg ADDED Viewed

Binary file

data/public/goldstar.gif ADDED Viewed

Binary file

data/public/index.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>A Simple File Server</title>
+  </head>
+  <body>
+    <h2>Here is our simple file server.</h2>
+  </body>
+</html>

data/public/ruby_reflections.png ADDED Viewed

Binary file

data/public/sockeyes_in_stream.jpg ADDED Viewed

Binary file

data/test/file_server.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'pry'
+require 'tiny_ruby_server'
+server = TCPServer.new('localhost', 5678)
+  loop do
+    socket = server.accept
+    request_line = socket.gets
+    STDERR.puts request_line
+    if request_line
+      path = TinyRubyServer.requested_file(request_line)
+      path = File.join(path, 'index.html') if File.directory?(path)
+      # Make sure file exists and is not a directory
+      # before attempting to open it
+      if File.exist?(path) && !File.directory?(path)
+        File.open(path, "rb") do |file|
+          socket.print "HTTP/1.1 200 OK\r\n" +
+                   "Content-Type: #{TinyRubyServer.content_type(file)}\r\n" +
+                   "Content-Length: #{file.size}\r\n" +
+                   "Connection: close\r\n"
+          # print blank line necessary for specification:
+          socket.print "\r\n"
+          # Write the contents of the file to the socket
+          IO.copy_stream(file, socket)
+        end
+      else
+        msg = "File not found\n"
+        # respond with a 404 error code to indicate the file does not exist
+        socket.print "HTTP/1.1 404 Not Found\r\n" +
+                     "Content-Type: text/plain\r\n" +
+                     "Content-Length: #{msg.size}\r\n" +
+                     "Connection: close\r\n"
+        socket.print "\r\n"
+        socket.print msg
+      end
+      socket.close
+    end
+end

data/tiny_ruby_server.gemspec ADDED Viewed

@@ -0,0 +1,18 @@
+# coding: utf-8
+lib = File.expand_path(File.join(*%w[.. lib]), File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/tiny_ruby_server/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.name                = 'tiny_ruby_server'
+  gem.version             = TinyRubyServer::VERSION
+  gem.date                = '2015-04-02'
+  gem.summary             = "Tiny Ruby Server"
+  gem.description         = "A tiny, secure Ruby file server"
+  gem.authors             = ["Jerry Thompson"]
+  gem.email               = 'jerrold.r.thompson@gmail.com'
+  gem.homepage            = 'https://github.com/jetsgit/tiny_ruby_server'
+  gem.files               = `git ls-files`.split($/)
+  gem.require_paths       = ["lib"]
+end

metadata ADDED Viewed

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: tiny_ruby_server
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Jerry Thompson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies: []
+description: A tiny, secure Ruby file server
+email: jerrold.r.thompson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/server.rb
+- lib/time_server_local.rb
+- lib/tiny_ruby_server.rb
+- lib/tiny_ruby_server/version.rb
+- public/SeaSerpent.png
+- public/Vinh_Long_small.jpg
+- public/goldstar.gif
+- public/index.html
+- public/ruby_reflections.png
+- public/sockeyes_in_stream.jpg
+- test/file_server.rb
+- tiny_ruby_server.gemspec
+homepage: https://github.com/jetsgit/tiny_ruby_server
+licenses: []
+metadata: {}
+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: []
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: Tiny Ruby Server
+test_files: []
+has_rdoc: