Simple_Server_Example 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afb5f851b068675773a3e7fc0d52178d9732ee3c
-  data.tar.gz: 35de123dfb24039b4869a632c1110110680290f8
+  metadata.gz: a77ecf7f63b04e47594d3ad66ebdc67479f53588
+  data.tar.gz: 2108026442152fde83486908f3af3b900ed26d76
 SHA512:
-  metadata.gz: 886a4866d3c6cb651847b1785293a6b3cd89ad9d3c938fdb2744121035fc4ca36d702a830db77b5c1a81d87f8ef973540158f2d1a4325ea491b0fa8e776134ec
-  data.tar.gz: 8a97d67c2bca9f5e0157d5e120d84425a3f168d0801b9edf36748a0ee19f7d3e2e5ef2f917f2d7ee0709426d43dc2de981a6f25a6b72bd2b59f8acfb6c888149
+  metadata.gz: cf8d23d953bd5dd86a6ee176e331532a1eedc04ba1a9d29c2cb03d9044b596e496f7a061317a579d92cab1c73a1783ed9bd7288ee0c3cb13b7a4dd7e1f7f6c07
+  data.tar.gz: 372b3effaa156fe28626885476711398c073f194f5903f390a849472906c3007d7f451ae35c27154422be0cffad00804371e7df8eeee643e1001b85bdfd21e27

data/.gitignore

@@ -1 +1,2 @@
-.DS_Store
+.DS_Store
+log/server.log

data/.rubyversion

@@ -0,0 +1 @@
+2.1.1

data/README.md

@@ -1,6 +1,24 @@
 Super Awesome Server
 =====================================
 
+Uses Ruby 2.1.1
+
+Two ways to install this gem.
+
+First way:
+
+1. Make sure Ruby and Rubygems are installed
+
+2. In a terminal type the following to install the gem:
+	 ``` gem install Simple_Server_Example ```
+
+3. Open a new terminal and type:
+	 ``` server ```
+
+4. Open a broswer and point it to http://localhost:2345
+
+Second way:
+
 1. Download this git repo
 
 2. Inside the root of the repo, build the gem by typing:
@@ -12,6 +30,6 @@ Super Awesome Server
 4. Open a new terminal/commandline and run the server:
 	``` server ```
 
-5. Open a broswer and point it to localhost:2345
+5. Open a broswer and point it to http://localhost:2345
 
 6. Party on

data/config.yaml

@@ -0,0 +1,12 @@
+# The only two levels used so far are debug and info.
+# Will need to impliment warn, error, and fatal.
+# level: 0 #debug
+level: 1 #info
+# level: 2 #warn
+# level: 3 #error
+# level: 4 #fatal
+# level: 5 #unknown
+
+# The commented output line will default output to the stdout.
+# Uncomment the line and edit where the logs output to.
+output: 'log/server.log'

data/lib/logging.rb

@@ -0,0 +1,18 @@
+require 'logger'
+require 'yaml'
+
+class Logging
+	def self.setup
+		log = Logger.new(load_output.nil? ? $stdout : load_output)
+		log.level = set_level
+		return log
+	end
+
+	def self.load_output
+		File.open("config.yaml", "r") { |file| return YAML.load(file)['output'] }
+	end
+
+	def self.set_level
+		File.open("config.yaml", "r") { |file| return YAML.load(file)['level'] }
+	end
+end

data/lib/response.rb

@@ -1,2 +1,64 @@
+require 'socket'
+
 class Response
+  attr_reader :header, :body
+
+  def initialize(header, body)
+    @header = header
+    @body = body
+  end
+
+	RESPONSE_CODE = {
+		'200' => 'OK',
+		'404' => 'Not Found'
+	}
+
+  CONTENT_TYPE_MAPPING = {
+    'html' => 'text/html',
+    'txt'  => 'text/plain',
+    'png'  => 'image/png',
+    'jpg'  => 'image/jpg'
+  }
+
+  DEFAULT_CONTENT_TYPE = 'application/octet-stream'
+
+  NOT_FOUND = './public/404.html'
+
+	def self.build(path)
+    if File.exist?(path) && !File.directory?(path)
+      body, body_size = build_body(path)
+      header = build_header(RESPONSE_CODE.rassoc('OK').join,
+                           content_type(path),
+                           body_size)
+      Response.new(header, body)
+    else
+      body, body_size = build_body(NOT_FOUND)
+      header = build_header(RESPONSE_CODE.rassoc('Not Found').join,
+                           content_type(path),
+                           body_size)
+      Response.new(header, body)
+    end
+	end
+
+  def self.content_type(path)
+    ext = File.extname(path).split('.').last
+    CONTENT_TYPE_MAPPING.fetch(ext, DEFAULT_CONTENT_TYPE)
+  end
+
+  def self.build_header(code, type, size)
+    "HTTP/1.1 #{code}\r\n" + 
+		"Content-Type: #{type}\r\n" +
+		"Content-Length: #{size}\r\n" +
+		"Connection: close\r\n\r\n"
+  end
+
+  def self.build_body(path)
+    File.open(path, "rb") do |file|
+      return file, file.size
+    end
+  end
+
+  def stream
+    File.read(self.body)
+  end
 end

data/lib/simple_server.rb

@@ -1,27 +1,19 @@
 require 'socket'
+require_relative 'logging'
 require_relative 'request'
+require_relative 'response'
 
 class SimpleServer
-  attr_reader :server
+  attr_reader :server, :level, :output
 
   WEB_ROOT = './public'
 
-  CONTENT_TYPE_MAPPING = {
-    'html' => 'text/html',
-    'txt'  => 'text/plain',
-    'png'  => 'image/png',
-    'jpg'  => 'image/jpg'
-  }
-
-  DEFAULT_CONTENT_TYPE = 'application/octet-stream'
+  LOG = Logging.setup
+  LOG.debug("Logging is set up.")
 
   def initialize(host='localhost', port=2345)
     @server = TCPServer.new(host, port)
-  end
-
-  def content_type(path)
-    ext = File.extname(path).split('.').last
-    CONTENT_TYPE_MAPPING.fetch(ext, DEFAULT_CONTENT_TYPE)
+    LOG.debug("Server is set up.")
   end
   
   def clean_path(path)
@@ -35,42 +27,29 @@ class SimpleServer
     File.join(WEB_ROOT, *clean)
   end
 
-  def request(path, socket)
-    if File.exist?(path) && !File.directory?(path)
-      File.open(path, "rb") do |file|
-        socket.print "HTTP/1.1 200 OK\r\n" +
-                     "Content-Type: #{content_type(file)}\r\n" +
-                     "Content-Length: #{file.size}\r\n" +
-                     "Connection: close\r\n"
-        
-        socket.print "\r\n"
-        
-        IO.copy_stream(file, socket)
-      end
-    else
-      File.open('./public/404.html', "rb") do |file|
-
-        socket.print "HTTP/1.1 404 Not Found\r\n" +
-                     "Content-Type: #{content_type(file)}\r\n" +
-                     "Content-Length #{file.size}\r\n" +
-                     "Connection: close\r\n"
-        
-        socket.print "\r\n"
-        
-        IO.copy_stream(file, socket)
-      end
-    end
+  def server_info
+    puts "#{'-' * 30}\nWelcome to the Simple Server.\nPlease use CONTROL-C to exit.\n#{'-' * 30}\n\n"
   end
 
   def run
+    server_info
     begin
       loop do
         Thread.start(server.accept) do |socket|
-          request = Request.parse(socket.gets)          
-          STDERR.puts request          
-          path = clean_path(request.resource)         
-          path = File.join(path, 'index.html') if File.directory?(path)         
-          request(path, socket)         
+          LOG.debug("Accepted socket: #{socket.inspect}")
+          
+          request = Request.parse(socket.gets)
+          LOG.debug("Incoming request: #{request.inspect}")
+          
+          path = clean_path(request.resource)
+          path = File.join(path, 'index.html') if File.directory?(path)
+          LOG.debug("Requested path: #{path.inspect}")
+          
+          response = Response.build(path)
+          socket.print response.header
+          socket.print response.stream
+          LOG.info(response.header)
+          
           socket.close
         end
       end

data/simple_server.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name             = 'Simple_Server_Example'
-  s.version          = "0.0.1"
+  s.version          = "1.0.0"
   s.files            = `git ls-files`.split($/)
   s.executables      = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files       = s.files.grep(%r{^(test|spec|features)/})

data/test/test_response.rb

@@ -1 +1,24 @@
-require 'minitest/autorun'
+require './lib/response.rb'
+require 'minitest/autorun'
+
+class TestResponse < MiniTest::Test
+  def server
+    SimpleServer.new('localhost', 2346)
+  end
+
+  def request(path)
+    Net::HTTP.get_response(URI(path))
+  end
+
+  def test_content_type_mapping_html
+    assert_equal request('http://localhost:2345').response.content_type, 'text/html'
+  end
+
+  def test_content_type_mapping_for_png
+    assert_equal request('http://localhost:2345/test.png').response.content_type, 'image/png'
+  end
+
+  def test_requested_file_joins_a_resource
+    assert_equal server.clean_path('/index.html'), './public/index.html'
+  end
+end

data/test/test_server.rb

@@ -15,16 +15,8 @@ class TestSimpleServer < MiniTest::Test
     assert_equal request('http://localhost:2345').code, "200"
   end
 
-  def test_content_type_mapping_html
-    assert_equal request('http://localhost:2345').response.content_type, 'text/html'
-  end
-
-  def test_content_type_mapping_for_png
-    assert_equal request('http://localhost:2345/test.png').response.content_type, 'image/png'
-  end
-
-  def test_requested_file_joins_a_resource
-    assert_equal server.clean_path('/index.html'), './public/index.html'
+  def test_404_from_server
+    assert_equal request('http://localhost:2345/bad_request').code, "404"
   end
 
   def test_requested_file_removes_double_periods_from_resource_but_keeps_directories

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Simple_Server_Example
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Neil Northrop
@@ -19,10 +19,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubyversion"
 - README.md
 - Rakefile
 - bin/server
 - bin/test
+- config.yaml
+- lib/logging.rb
 - lib/request.rb
 - lib/response.rb
 - lib/simple_server.rb