oaf 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTc3ZjQwMGU4N2M5MDkyZGNhN2JkY2YxNWYwN2Q3MWUyNzRkZWI4OA==
+    Y2M2YmMyNGY2Zjg4MmU2MWJjN2Y3ZDc0MzhjMDMxZmEyZjRkY2RkNw==
   data.tar.gz: !binary |-
-    NTg3YWZjMTYwYjcyMmI1NDU3M2QxOGI5YmM0MjliOTcwNDk3Nzg0NQ==
+    ZjY4YTM5NjdiYzg3YzA0NTk4NmFjMzdiOGMzYzYwYmZjZWM0NWJkMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MGM5M2IzOTMwZDhkNTUyZDBiMTE1YjFiYjM2Y2ExNmVhZTQwNDBjZjQxNGU5
-    NDUzNWNmZmQwMzFmZTI0NDc3NjdlY2FhNDNlNWFhNzFhZmI5Zjc5NzkxZmE5
-    M2U3YmE5ZWZkMjNmYTBiZThkMjRkMDE2OWVjMWU0OWVkNDk3MzY=
+    OWQ0NzRhMGJiYjYxNGQxNmJmNjFmZTBiMDRhODc4NmU0ZDFjNGQyZTExZDI2
+    ZjJhMDkyM2NkMGRhZmU0NzZmYWY2M2IwYjM1NzI2YmQ3NWJkMzc1MzJiMjk5
+    NzQwYmJiMjMyN2I0NzJlOWRkMDU3ZjRiYmRhZDA4MDk3NGNjYWE=
   data.tar.gz: !binary |-
-    MGY5ODIwOGIzM2I4MGM0NDkwZTBiZWVmNjU3NTFjNjg2ZDRkYTU1MGM1ZWMy
-    ODE3ZDA3YmY5ZGQwMmY2ODAwMTQzNWFiYWQwMTVmM2ZjNDkyYjQ0NGI5MmU4
-    ZDZkZWFmMTRkOGEwNDY5NmYyNjVjODk3NWIwYzFlNmVhODE3ZTk=
+    YWVmMzQ5NWE1M2FiYzQ4YmQyM2E3YjdjMjkyOWZiMDkxMDJiMDA1NGI2YWU1
+    NTg0ODdlZGU0NTQ1NTljNjU5MGE2NjMwZGY0MTNjOTY4NDdkZmZiYjJmYjYx
+    MGVkMDZkMTg0MTlhMWYxZTUzMWI3YjMxMDJhY2M1ODM0MTdjZjM=

data/bin/oaf

@@ -61,4 +61,4 @@ else
   exit 1
 end
 
-Oaf::HTTP::Server.serve options[:path], options[:port]
+Oaf::HTTPServer.serve options[:path], options[:port]

data/lib/oaf.rb

@@ -22,5 +22,5 @@
 
 require 'oaf/version'
 require 'oaf/util'
-require 'oaf/http/handler'
-require 'oaf/http/server'
+require 'oaf/httphandler'
+require 'oaf/httpserver'

data/lib/oaf/{http/handler.rb → httphandler.rb}

@@ -21,16 +21,16 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'oaf/util'
-require 'oaf/http/server'
+require 'oaf/httpserver'
 require 'webrick'
 
-module Oaf::HTTP
+module Oaf
 
   # Provides all required handlers to WEBrick for serving all basic HTTP
   # methods. WEBrick handles GET, POST, HEAD, and OPTIONS out of the box,
   # but to mock most RESTful applications we are going to want PUT and
   # DELETE undoubtedly.
-  class Handler < WEBrick::HTTPServlet::AbstractServlet
+  class HTTPHandler < WEBrick::HTTPServlet::AbstractServlet
 
     # Remove the predefined WEBrick methods. WEBrick comes with some defaults
     # for GET, POST, OPTIONS, and HEAD, but let's use our own instead.
@@ -64,12 +64,12 @@ module Oaf::HTTP
     def process_request req, res
       req_headers = req.header
       req_query = req.query
-      req_body = Oaf::HTTP::Server.get_request_body req
+      req_body = Oaf::HTTPServer.get_request_body req
       file = Oaf::Util.get_request_file @path, req.path, req.request_method
       out = Oaf::Util.get_output(file, req.path, req_headers, req_body,
                                  req_query)
-      res_headers, res_status, res_body = Oaf::HTTP::Server.parse_response out
-      Oaf::HTTP::Server.set_response! res, res_headers, res_body, res_status
+      res_headers, res_status, res_body = Oaf::HTTPServer.parse_response out
+      Oaf::HTTPServer.set_response! res, res_headers, res_body, res_status
     end
 
     # A magic respond_to? implementation to trick WEBrick into thinking that any

data/lib/oaf/httpserver.rb

@@ -0,0 +1,106 @@
+# oaf - Care-free web app prototyping using files and scripts
+# Copyright 2013 Ryan Uber <ru@ryanuber.com>
+#
+# 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.
+
+require 'oaf/util'
+require 'oaf/httphandler'
+require 'webrick'
+
+module Oaf::HTTPServer
+  extend self
+
+  # Given output from a script, parse HTTP response details and return them
+  # as a hash, including body, status, and headers.
+  #
+  # == Parameters:
+  # output::
+  #   The output text data returned by a script.
+  #
+  # == Returns:
+  # A hash containing the HTTP response details (body, status, and headers).
+  #
+  def parse_response output
+    has_meta = false
+    headers = {'content-type' => 'text/plain'}
+    status = 200
+    headers, status, meta_size = Oaf::Util.parse_http_meta output
+    lines = output.split("\n")
+    body = lines.take(lines.length - meta_size).join("\n")+"\n"
+    [headers, status, body]
+  end
+
+  # Safely retrieves the request body, and assumes an empty string if it
+  # cannot be retrieved. This helps get around a nasty exception in WEBrick.
+  #
+  # == Parameters:
+  # req::
+  #   A WEBrick::HTTPRequest object
+  #
+  # == Returns:
+  # A string containing the request body
+  #
+  def get_request_body req
+    if ['POST', 'PUT'].member? req.request_method
+      begin
+        result = req.body
+      rescue WEBrick::HTTPStatus::LengthRequired
+        result = ''  # needs to be in rescue for coverage
+      end
+    end
+    result
+  end
+
+  # Consume HTTP response details and set them into a response object.
+  #
+  # == Parameters:
+  # res::
+  #   A WEBrick::HTTPResponse object
+  # headers::
+  #   A hash containing HTTP response headers
+  # body::
+  #   A string containing the HTTP response body
+  # status::
+  #   An integer indicating the response status
+  #
+  def set_response! res, headers, body, status
+    headers.each do |name, value|
+      res.header[name] = value
+    end
+    res.body = body
+    res.status = status
+  end
+
+  # Invokes the Webrick web server library to handle incoming requests, and
+  # routes them to the appropriate scripts if they exist on the filesystem.
+  #
+  # == Parameters:
+  # path::
+  #   The path in which to search for files
+  # port::
+  #   The TCP port to listen on
+  #
+  def serve path, port
+    server = WEBrick::HTTPServer.new :Port => port
+    server.mount '/', Oaf::HTTPHandler, path
+    trap 'INT' do server.shutdown end
+    server.start
+  end
+end

data/lib/oaf/util.rb

@@ -20,285 +20,281 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-module Oaf
+module Oaf::Util
+  extend self
 
-  module Util
-    extend Oaf
-    extend self
-
-    # Determines if a line of output looks anything like an HTTP header
-    # declaration.
-    #
-    # == Parameters:
-    # line::
-    #   A line of text to examine
-    #
-    # == Returns:
-    # A boolean, true if it can be read as a header string, else false.
-    #
-    def is_http_header? line
-      line.split(':').length == 2
-    end
+  # Determines if a line of output looks anything like an HTTP header
+  # declaration.
+  #
+  # == Parameters:
+  # line::
+  #   A line of text to examine
+  #
+  # == Returns:
+  # A boolean, true if it can be read as a header string, else false.
+  #
+  def is_http_header? line
+    line.split(':').length == 2
+  end
 
-    # Retrieves a hash in the form `name` => `value` from a string that
-    # describes an HTTP response header.
-    #
-    # == Parameters:
-    # line::
-    #   A line of text to parse
-    #
-    # == Returns
-    # A hash in the form `name` => `value`, or `nil`
-    #
-    def get_http_header line
-      return nil if not is_http_header? line
-      parts = line.split(':')
-      {parts[0].strip => parts[1].strip}
-    end
+  # Retrieves a hash in the form `name` => `value` from a string that
+  # describes an HTTP response header.
+  #
+  # == Parameters:
+  # line::
+  #   A line of text to parse
+  #
+  # == Returns
+  # A hash in the form `name` => `value`, or `nil`
+  #
+  def get_http_header line
+    return nil if not is_http_header? line
+    parts = line.split(':')
+    {parts[0].strip => parts[1].strip}
+  end
 
-    # Retrieves the numeric value from a line of text as an HTTP status code.
-    #
-    # == Parameters:
-    # line::
-    #   A line of text to parse
-    #
-    # == Returns:
-    # An integer if valid, else `nil`.
-    #
-    def get_http_status line
-      is_http_status?(line) ? line.to_i : nil
-    end
+  # Retrieves the numeric value from a line of text as an HTTP status code.
+  #
+  # == Parameters:
+  # line::
+  #   A line of text to parse
+  #
+  # == Returns:
+  # An integer if valid, else `nil`.
+  #
+  def get_http_status line
+    is_http_status?(line) ? line.to_i : nil
+  end
 
-    # Determines if an HTTP status code is valid per RFC2616
-    #
-    # == Parameters:
-    # code::
-    #   A number to validate
-    #
-    # == Returns
-    # A boolean, true if valid, else false.
-    #
-    def is_http_status? code
-      (200..206).to_a.concat((300..307).to_a).concat((400..417).to_a) \
-        .concat((500..505).to_a).include? code.to_i
-    end
+  # Determines if an HTTP status code is valid per RFC2616
+  #
+  # == Parameters:
+  # code::
+  #   A number to validate
+  #
+  # == Returns
+  # A boolean, true if valid, else false.
+  #
+  def is_http_status? code
+    (200..206).to_a.concat((300..307).to_a).concat((400..417).to_a) \
+      .concat((500..505).to_a).include? code.to_i
+  end
 
-    # Convert various pieces of data about the request into a single hash, which
-    # can then be passed on as environment data to a script.
-    #
-    # == Parameters:
-    # req_path::
-    #   A string with the HTTP request path
-    # headers::
-    #   A hash of request headers
-    # params::
-    #   A hash of request parameters
-    # body::
-    #   A string containing the request body
-    #
-    # == Returns:
-    # A flat hash containing namespaced environment parameters
-    #
-    def prepare_environment req_path, headers, params, body
-      result = Hash.new
-      {'header' => headers, 'param' => params}.each do |prefix, data|
-        data.each do |name, value|
-          result.merge! Oaf::Util.environment_item prefix, name, value
-        end
+  # Convert various pieces of data about the request into a single hash, which
+  # can then be passed on as environment data to a script.
+  #
+  # == Parameters:
+  # req_path::
+  #   A string with the HTTP request path
+  # headers::
+  #   A hash of request headers
+  # params::
+  #   A hash of request parameters
+  # body::
+  #   A string containing the request body
+  #
+  # == Returns:
+  # A flat hash containing namespaced environment parameters
+  #
+  def prepare_environment req_path, headers, params, body
+    result = Hash.new
+    {'header' => headers, 'param' => params}.each do |prefix, data|
+      data.each do |name, value|
+        result.merge! Oaf::Util.environment_item prefix, name, value
       end
-      result.merge! Oaf::Util.environment_item 'request', 'path', req_path
-      result.merge Oaf::Util.environment_item 'request', 'body', body
     end
+    result.merge! Oaf::Util.environment_item 'request', 'path', req_path
+    result.merge Oaf::Util.environment_item 'request', 'body', body
+  end
 
-    # Prepares a key for placement in the execution environment. This includes
-    # namespacing variables and converting characters to predictable and
-    # easy-to-use names.
-    #
-    # == Parameters:
-    # prefix::
-    #   A prefix for the key. This helps with separation.
-    # key::
-    #   The key to sanitize
-    #
-    # == Returns:
-    # A string with the prepared value
-    #
-    def prepare_key prefix, key
-      "oaf_#{prefix}_#{key.gsub('-', '_').downcase}"
-    end
+  # Prepares a key for placement in the execution environment. This includes
+  # namespacing variables and converting characters to predictable and
+  # easy-to-use names.
+  #
+  # == Parameters:
+  # prefix::
+  #   A prefix for the key. This helps with separation.
+  # key::
+  #   The key to sanitize
+  #
+  # == Returns:
+  # A string with the prepared value
+  #
+  def prepare_key prefix, key
+    "oaf_#{prefix}_#{key.gsub('-', '_').downcase}"
+  end
 
-    # Formats a single environment item into a hash, which can be merged into a
-    # collective environment mapping later on.
-    #
-    # == Parameters:
-    # prefix::
-    #   The prefix for the type of item being added.
-    # key::
-    #   The key name of the environment property
-    # value::
-    #   The value for the environment property
-    #
-    # == Returns:
-    # A hash with prepared values ready to merge into an environment hash
-    #
-    def environment_item prefix, key, value
-      {Oaf::Util.prepare_key(prefix, key) => Oaf::Util.flatten(value)}
-    end
+  # Formats a single environment item into a hash, which can be merged into a
+  # collective environment mapping later on.
+  #
+  # == Parameters:
+  # prefix::
+  #   The prefix for the type of item being added.
+  # key::
+  #   The key name of the environment property
+  # value::
+  #   The value for the environment property
+  #
+  # == Returns:
+  # A hash with prepared values ready to merge into an environment hash
+  #
+  def environment_item prefix, key, value
+    {Oaf::Util.prepare_key(prefix, key) => Oaf::Util.flatten(value)}
+  end
 
-    # Flatten a hash or array into a string. This is useful for preparing some
-    # data for passing in via the environment, because multi-dimension data
-    # structures are not supported for that.
-    #
-    # == Parameters:
-    # data::
-    #   The data to flatten
-    #
-    # == Returns:
-    # A flattened string. It will be empty if the object passed in was not
-    # flatten-able.
-    #
-    def flatten data
-      result = ''
-      if data.kind_of? Hash
-        data.each do |key, val|
-          val = Oaf::Util.flatten val if not val.kind_of? String
-          result += "#{key}#{val}"
-        end
-      elsif data.kind_of? Array
-        data.each do |item|
-          item = Oaf::Util.flatten item if not item.kind_of? String
-          result += item
-        end
-      elsif data.kind_of? String
-        result = data
-      else
-        result = ''
+  # Flatten a hash or array into a string. This is useful for preparing some
+  # data for passing in via the environment, because multi-dimension data
+  # structures are not supported for that.
+  #
+  # == Parameters:
+  # data::
+  #   The data to flatten
+  #
+  # == Returns:
+  # A flattened string. It will be empty if the object passed in was not
+  # flatten-able.
+  #
+  def flatten data
+    result = ''
+    if data.kind_of? Hash
+      data.each do |key, val|
+        val = Oaf::Util.flatten val if not val.kind_of? String
+        result += "#{key}#{val}"
+      end
+    elsif data.kind_of? Array
+      data.each do |item|
+        item = Oaf::Util.flatten item if not item.kind_of? String
+        result += item
       end
-      result
+    elsif data.kind_of? String
+      result = data
+    else
+      result = ''
     end
+    result
+  end
 
-    # Given an array of text lines, iterate over each of them and determine if
-    # they may be interpreted as headers or status. If they can, add them to
-    # the result.
-    #
-    # == Parameters:
-    # text::
-    #   Plain text data to examine
-    #
-    # == Returns:
-    # A 3-item structure containing headers, status, and the number of lines
-    # which the complete metadata (including the "---" delimiter) occupies.
-    #
-    def parse_http_meta text
-      headers = {}
-      status = 200
-      size = 0
-      parts = text.split /^---$/
-      if parts.length > 1
-        for part in parts.last.split "\n"
-          if Oaf::Util.is_http_header? part
-            headers.merge! Oaf::Util.get_http_header part
-          elsif Oaf::Util.is_http_status? part
-            status = Oaf::Util.get_http_status part
-          else next
-          end
-          size += size == 0 ? 2 : 1  # compensate for delimiter
+  # Given an array of text lines, iterate over each of them and determine if
+  # they may be interpreted as headers or status. If they can, add them to
+  # the result.
+  #
+  # == Parameters:
+  # text::
+  #   Plain text data to examine
+  #
+  # == Returns:
+  # A 3-item structure containing headers, status, and the number of lines
+  # which the complete metadata (including the "---" delimiter) occupies.
+  #
+  def parse_http_meta text
+    headers = {}
+    status = 200
+    size = 0
+    parts = text.split /^---$/
+    if parts.length > 1
+      for part in parts.last.split "\n"
+        if Oaf::Util.is_http_header? part
+          headers.merge! Oaf::Util.get_http_header part
+        elsif Oaf::Util.is_http_status? part
+          status = Oaf::Util.get_http_status part
+        else next
         end
+        size += size == 0 ? 2 : 1  # compensate for delimiter
       end
-      [headers, status, size]
     end
+    [headers, status, size]
+  end
 
-    # Return a default response string indicating that nothing could be
-    # done and no response files were found.
-    #
-    # == Returns:
-    # A string with response output for parsing.
-    #
-    def get_default_response
-      "oaf: Not Found\n---\n404"
-    end
+  # Return a default response string indicating that nothing could be
+  # done and no response files were found.
+  #
+  # == Returns:
+  # A string with response output for parsing.
+  #
+  def get_default_response
+    "oaf: Not Found\n---\n404"
+  end
 
-    # Returns the path to the file to use for the request. If the provided
-    # file path does not exist, this method will search for a file within
-    # the same directory matching the default convention "_*_".
-    #
-    # == Parameters:
-    # root::
-    #   The root path to search within.
-    # req_path::
-    #   The HTTP request path
-    # method::
-    #   The HTTP method of the request
-    #
-    # == Returns:
-    # The path to a file to use, or `nil` if none is found.
-    #
-    def get_request_file root, req_path, method
-      file = File.join root, "#{req_path}.#{method}"
-      if not File.exist? file
-        Dir.glob(File.join(File.dirname(file), "_*_.#{method}")).each do |f|
-          file = f
-          break
-        end
+  # Returns the path to the file to use for the request. If the provided
+  # file path does not exist, this method will search for a file within
+  # the same directory matching the default convention "_*_".
+  #
+  # == Parameters:
+  # root::
+  #   The root path to search within.
+  # req_path::
+  #   The HTTP request path
+  # method::
+  #   The HTTP method of the request
+  #
+  # == Returns:
+  # The path to a file to use, or `nil` if none is found.
+  #
+  def get_request_file root, req_path, method
+    file = File.join root, "#{req_path}.#{method}"
+    if not File.exist? file
+      Dir.glob(File.join(File.dirname(file), "_*_.#{method}")).each do |f|
+        file = f
+        break
       end
-      File.exist?(file) ? file : nil
     end
+    File.exist?(file) ? file : nil
+  end
 
-    # Fork a new process, in which we can safely modify the running environment
-    # and run a command, sending data back to the parent process using an IO
-    # pipe. This can be done in a single line in ruby >= 1.9, but we will do it
-    # the hard way to maintain compatibility with older rubies.
-    #
-    # == Parameters:
-    # env::
-    #   The environment data to use in the subprocess.
-    # command::
-    #   The command to execute against the server
-    #
-    # == Returns:
-    # A string of stderr concatenated to stdout.
-    #
-    def run_buffered env, command
-      out, wout = IO.pipe
-      pid = fork do
-        out.close
-        ENV.replace env
-        wout.write %x(#{command} 2>&1)
-        at_exit { exit! }
-      end
-      wout.close
-      Process.wait pid
-      out.read
+  # Fork a new process, in which we can safely modify the running environment
+  # and run a command, sending data back to the parent process using an IO
+  # pipe. This can be done in a single line in ruby >= 1.9, but we will do it
+  # the hard way to maintain compatibility with older rubies.
+  #
+  # == Parameters:
+  # env::
+  #   The environment data to use in the subprocess.
+  # command::
+  #   The command to execute against the server
+  #
+  # == Returns:
+  # A string of stderr concatenated to stdout.
+  #
+  def run_buffered env, command
+    out, wout = IO.pipe
+    pid = fork do
+      out.close
+      ENV.replace env
+      wout.write %x(#{command} 2>&1)
+      at_exit { exit! }
     end
+    wout.close
+    Process.wait pid
+    out.read
+  end
 
-    # Executes a file, or reads its contents if it is not executable, passing
-    # it the request headers and body as arguments, and returns the result.
-    #
-    # == Parameters:
-    # req_path::
-    #   The HTTP request path
-    # file::
-    #   The path to the file to use for output
-    # headers::
-    #   The HTTP request headers to pass
-    # body::
-    #   The HTTP request body to pass
-    # params::
-    #   The HTTP request parameters to pass
-    #
-    # == Returns:
-    # The result from the file, or a default result if the file is not found.
-    #
-    def get_output file, req_path=nil, headers=[], body=[], params=[]
-      if file.nil?
-        out = Oaf::Util.get_default_response
-      elsif File.executable? file
-        env = Oaf::Util.prepare_environment req_path, headers, params, body
-        out = Oaf::Util.run_buffered env, file
-      else
-        out = File.open(file).read
-      end
-      out
+  # Executes a file, or reads its contents if it is not executable, passing
+  # it the request headers and body as arguments, and returns the result.
+  #
+  # == Parameters:
+  # req_path::
+  #   The HTTP request path
+  # file::
+  #   The path to the file to use for output
+  # headers::
+  #   The HTTP request headers to pass
+  # body::
+  #   The HTTP request body to pass
+  # params::
+  #   The HTTP request parameters to pass
+  #
+  # == Returns:
+  # The result from the file, or a default result if the file is not found.
+  #
+  def get_output file, req_path=nil, headers=[], body=[], params=[]
+    if file.nil?
+      out = Oaf::Util.get_default_response
+    elsif File.executable? file
+      env = Oaf::Util.prepare_environment req_path, headers, params, body
+      out = Oaf::Util.run_buffered env, file
+    else
+      out = File.open(file).read
     end
+    out
   end
 end

data/lib/oaf/version.rb

@@ -21,5 +21,5 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Oaf
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/oaf/http_spec.rb

@@ -25,7 +25,7 @@ require 'spec_helper'
 module Oaf
   describe "Returning HTTP Responses" do
     it "should return safe defaults if output is empty" do
-      headers, status, body = Oaf::HTTP::Server.parse_response ''
+      headers, status, body = Oaf::HTTPServer.parse_response ''
       headers.should eq({})
       status.should eq(200)
       body.should eq("\n")
@@ -33,7 +33,7 @@ module Oaf
 
     it "should return safe defaults when only body is present" do
       text = "This is a test\n"
-      headers, status, body = Oaf::HTTP::Server.parse_response text
+      headers, status, body = Oaf::HTTPServer.parse_response text
       headers.should eq({})
       status.should eq(200)
       body.should eq("This is a test\n")
@@ -41,25 +41,25 @@ module Oaf
 
     it "should return headers correctly" do
       text = "---\nx-powered-by: oaf"
-      headers, status, body = Oaf::HTTP::Server.parse_response text
+      headers, status, body = Oaf::HTTPServer.parse_response text
       headers.should eq({'x-powered-by' => 'oaf'})
     end
 
     it "should return status correctly" do
       text = "---\n201"
-      headers, status, body = Oaf::HTTP::Server.parse_response text
+      headers, status, body = Oaf::HTTPServer.parse_response text
       status.should eq(201)
     end
 
     it "should return body correctly" do
       text = "This is a test\n---\n200"
-      headers, status, body = Oaf::HTTP::Server.parse_response text
+      headers, status, body = Oaf::HTTPServer.parse_response text
       body.should eq("This is a test\n")
     end
 
     it "should return body correctly when no metadata is present" do
       text = "This is a test"
-      headers, status, body = Oaf::HTTP::Server.parse_response text
+      headers, status, body = Oaf::HTTPServer.parse_response text
       body.should eq("This is a test\n")
     end
   end
@@ -90,15 +90,15 @@ module Oaf
       @webrick.should_receive(:start).once.and_return(true)
       WEBrick::HTTPServer.stub(:new).and_return(@webrick)
       @webrick.should_receive(:mount) \
-        .with('/', Oaf::HTTP::Handler, '/tmp').once \
+        .with('/', Oaf::HTTPHandler, '/tmp').once \
         .and_return(true)
-      Oaf::HTTP::Server.serve '/tmp', 9000
+      Oaf::HTTPServer.serve '/tmp', 9000
     end
 
     it "should parse the request properly" do
       req = Oaf::FakeReq.new :path => @f1request
       res = Oaf::FakeRes.new
-      handler = Oaf::HTTP::Handler.new Oaf::FakeServlet.new, @tempdir1
+      handler = Oaf::HTTPHandler.new Oaf::FakeServlet.new, @tempdir1
       handler.process_request req, res
       res.body.should eq("This is a test.\n")
       res.status.should eq(201)
@@ -108,7 +108,7 @@ module Oaf
     it "should accept containable methods properly" do
       req = Oaf::FakeReq.new({:path => @f2request, :method => 'PUT'})
       res = Oaf::FakeRes.new
-      handler = Oaf::HTTP::Handler.new Oaf::FakeServlet.new, @tempdir1
+      handler = Oaf::HTTPHandler.new Oaf::FakeServlet.new, @tempdir1
       handler.process_request req, res
       res.body.should eq("Containable Test\n")
       res.status.should eq(202)
@@ -118,8 +118,8 @@ module Oaf
     it "should respond to any HTTP method" do
       req = Oaf::FakeReq.new :path => @f1request
       res = Oaf::FakeRes.new
-      Oaf::HTTP::Handler.any_instance.stub(:process_request).and_return(true)
-      handler = Oaf::HTTP::Handler.new Oaf::FakeServlet.new, @tempdir1
+      Oaf::HTTPHandler.any_instance.stub(:process_request).and_return(true)
+      handler = Oaf::HTTPHandler.new Oaf::FakeServlet.new, @tempdir1
       handler.should_receive(:process_request).with(req, res).once
       handler.respond_to?(:do_GET).should be_true
       handler.respond_to?(:do_get).should be_false
@@ -130,8 +130,8 @@ module Oaf
     it "should call our custom methods for built-ins" do
       req = Oaf::FakeReq.new :path => @f1request
       res = Oaf::FakeRes.new
-      Oaf::HTTP::Handler.any_instance.stub(:process_request).and_return(true)
-      handler = Oaf::HTTP::Handler.new Oaf::FakeServlet.new, @tempdir1
+      Oaf::HTTPHandler.any_instance.stub(:process_request).and_return(true)
+      handler = Oaf::HTTPHandler.new Oaf::FakeServlet.new, @tempdir1
       handler.should_receive(:process_request).with(req, res).exactly(4).times
       handler.do_GET(req, res)
       handler.do_POST(req, res)

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oaf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryan Uber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-01 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,25 +67,18 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Care-free web app prototyping using files and scripts
-email:
-- ru@ryanuber.com
+email: ru@ryanuber.com
 executables:
 - oaf
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
 - bin/oaf
-- lib/oaf.rb
-- lib/oaf/http/handler.rb
-- lib/oaf/http/server.rb
+- lib/oaf/httphandler.rb
+- lib/oaf/httpserver.rb
 - lib/oaf/util.rb
 - lib/oaf/version.rb
-- oaf.gemspec
+- lib/oaf.rb
 - spec/oaf/http_spec.rb
 - spec/oaf/util_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,8 +0,0 @@
-branches:
-  only:
-    - master
-language: ruby
-rvm:
-  - 1.9.3
-  - 1.9.2
-  - 1.8.7

data/Gemfile

@@ -1,2 +0,0 @@
-source "https://rubygems.org"
-gemspec

data/LICENSE

@@ -1,20 +0,0 @@
-MIT LICENSE
-
-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

@@ -1,150 +0,0 @@
-Oaf
----
-
-Care-free web app prototyping using files and scripts
-
-[![Gem Version](https://badge.fury.io/rb/oaf.png)](http://badge.fury.io/rb/oaf)
-[![Build Status](https://travis-ci.org/ryanuber/oaf.png)](https://travis-ci.org/ryanuber/oaf)
-[![Coverage Status](https://coveralls.io/repos/ryanuber/oaf/badge.png)](https://coveralls.io/r/ryanuber/oaf)
-[![Code Climate](https://codeclimate.com/github/ryanuber/oaf.png)](https://codeclimate.com/github/ryanuber/oaf)
-
-[Documentation](http://rubydoc.info/gems/oaf/frames)
-
-`Oaf` provides stupid-easy way of creating dynamic web applications by setting
-all best practices and security considerations aside until you are sure that you
-want to invest your time doing so.
-
-`Oaf` was created as a weekend project to create a small, simple HTTP server
-program that uses script execution as its primary mechanism for generating
-responses.
-
-Example
--------
-
-Create an executable file named `hello.GET`:
-
-```
-#!/bin/bash
-echo "Hello, ${USER}!"
-```
-
-Start the server by running the `oaf` command, then make a request:
-
-```
-$ curl localhost:9000/hello
-Hello, ryanuber!
-```
-
-Installation
-------------
-
-Oaf is available on [rubygems](http://rubygems.org/gems/oaf), which means you
-can do:
-
-```
-gem install oaf
-```
-
-### Accepted files
-
-`Oaf` will run *ANY* file with the executable bit set, be it shell, Python, Ruby,
-compiled binary, or whatever else you might have.
-
-`Oaf` can also use plain text files.
-
-### How file permissions affect output
-
-* If the file in your request is executable, the output of its execution will
-  be used as the return data.
-* If the file is *NOT* executable, then the contents of the file will be used
-  as the return data.
-
-### Nested methods
-
-You can create nested methods using simple directories. Example:
-
-```
-$ ls ./examples/
-hello.GET
-
-$ curl http://localhost:8000/examples/hello
-Hello, world!
-```
-
-### HTTP Methods
-Files must carry the extension of the HTTP method used to invoke them.
-Oaf should support any HTTP method, including custom methods.
-
-### Headers and Status
-You can indicate HTTP headers and status using stdout from your script.
-
-```
-#!/bin/bash
-cat <<EOF
-Hello, world!
----
-content-type: text/plain
-200
-EOF
-```
-
-Separated by 3 dashes on a line of their own (`---`), the very last block
-of output can contain headers and response status.
-
-### Getting request headers, query parameters, and body
-
-Headers, query parameters, and request body are all passed to executables using
-the environment. To defeat overlap in variables, they are namespaced using a
-prefix. The environment variables are as follows:
-
-* Headers: `oaf_header_*`
-* Request parameters: `oaf_param_*`
-* Request body: `oaf_request_body`
-* Request path: `oaf_request_path`
-
-Below is a quick example of a shell script which makes use of the request data:
-
-```
-#!/bin/bash
-echo "You passed the Accept header: $oaf_header_accept"
-echo "You passed the 'message' value: $oaf_param_message"
-echo "You passed the request body: $oaf_request_body"
-echo "This method is located at: $oaf_request_path"
-```
-
-Headers query parameter names are converted to all-lowercase, and dashes are
-replaced with underscores. This is due to the way the environment works. For
-example, if you wanted to get at the `Content-Type` header, you could with the
-environment variable `$oaf_header_content_type`.
-
-### Catch-all methods
-
-Catch-all's can be defined by naming a file inside of a directory, beginning and
-ending with underscores (`_`). So for example, `test/_default_.GET` will match:
-`GET /test/anything`, `GET /test/blah`, etc.
-
-If you want to define a top-level method for `/test`, you would do so in the
-file at `/test.GET`.
-
-Q&A
----
-
-**Why are the headers and status at the bottom of the response?**
-Because it is much easier to echo these last. Since Oaf reads response
-data directly from stdout/stderr, it is very easy for debug or error messages
-to interfere with them. By specifying the headers and status last, we minimize
-the chances of unexpected output damaging the response, as all processing is
-already complete.
-
-**Why the name `Oaf`?**
-It's a bit of a clumsy and "oafish" approach at web application prototyping. I
-constantly find myself trying to write server parts of programs before I have
-even completed basic functionality, and sometimes even before I have a clear
-idea of what it is I want the program to do.
-
-Acknowledgements
-----------------
-
-`Oaf` is inspired by [Stubb](https://github.com/knuton/stubb). A number of ideas
-and conventions were borrowed from it. Kudos to
-[@knuton](https://github.com/knuton) for having a great idea.

data/Rakefile

@@ -1,6 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new
-
-task :default => [:spec]

data/lib/oaf/http/server.rb

@@ -1,110 +0,0 @@
-# oaf - Care-free web app prototyping using files and scripts
-# Copyright 2013 Ryan Uber <ru@ryanuber.com>
-#
-# 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.
-
-require 'oaf/util'
-require 'oaf/http/handler'
-require 'webrick'
-
-module Oaf::HTTP
-
-  module Server
-    extend Oaf
-    extend self
-
-    # Given output from a script, parse HTTP response details and return them
-    # as a hash, including body, status, and headers.
-    #
-    # == Parameters:
-    # output::
-    #   The output text data returned by a script.
-    #
-    # == Returns:
-    # A hash containing the HTTP response details (body, status, and headers).
-    #
-    def parse_response output
-      has_meta = false
-      headers = {'content-type' => 'text/plain'}
-      status = 200
-      headers, status, meta_size = Oaf::Util.parse_http_meta output
-      lines = output.split("\n")
-      body = lines.take(lines.length - meta_size).join("\n")+"\n"
-      [headers, status, body]
-    end
-
-    # Safely retrieves the request body, and assumes an empty string if it
-    # cannot be retrieved. This helps get around a nasty exception in WEBrick.
-    #
-    # == Parameters:
-    # req::
-    #   A WEBrick::HTTPRequest object
-    #
-    # == Returns:
-    # A string containing the request body
-    #
-    def get_request_body req
-      if ['POST', 'PUT'].member? req.request_method
-        begin
-          result = req.body
-        rescue WEBrick::HTTPStatus::LengthRequired
-          result = ''  # needs to be in rescue for coverage
-        end
-      end
-      result
-    end
-
-    # Consume HTTP response details and set them into a response object.
-    #
-    # == Parameters:
-    # res::
-    #   A WEBrick::HTTPResponse object
-    # headers::
-    #   A hash containing HTTP response headers
-    # body::
-    #   A string containing the HTTP response body
-    # status::
-    #   An integer indicating the response status
-    #
-    def set_response! res, headers, body, status
-      headers.each do |name, value|
-        res.header[name] = value
-      end
-      res.body = body
-      res.status = status
-    end
-
-    # Invokes the Webrick web server library to handle incoming requests, and
-    # routes them to the appropriate scripts if they exist on the filesystem.
-    #
-    # == Parameters:
-    # path::
-    #   The path in which to search for files
-    # port::
-    #   The TCP port to listen on
-    #
-    def serve path, port
-      server = WEBrick::HTTPServer.new :Port => port
-      server.mount '/', Oaf::HTTP::Handler, path
-      trap 'INT' do server.shutdown end
-      server.start
-    end
-  end
-end

data/oaf.gemspec

@@ -1,27 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'oaf/version'
-
-Gem::Specification.new do |s|
-  s.name          = 'oaf'
-  s.version       = Oaf::VERSION
-  s.summary       = 'Web app prototyping'
-  s.description   = 'Care-free web app prototyping using files and scripts'
-  s.authors       = ["Ryan Uber"]
-  s.email         = ['ru@ryanuber.com']
-  s.files         = %x(git ls-files).split($/)
-  s.homepage      = 'https://github.com/ryanuber/oaf'
-  s.license       = 'MIT'
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^spec/})
-  s.require_paths = ['lib']
-
-  s.required_ruby_version = '>= 1.8'
-
-  s.add_runtime_dependency 'bundler'
-
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'coveralls'
-end