oaf 0.1.12

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+ruby:
+  - "1.9.3"

data/Gemfile

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

data/LICENSE

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

@@ -0,0 +1,106 @@
+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)
+
+`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!
+```
+
+### 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. Some
+examples: `hello.GET`, `hello.POST`, `hello.PUT`, `hello.DELETE`
+
+### 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 (`\n---\n`), the very last block
+of output can contain headers and response status.
+
+### Getting request headers and body
+The headers and body of the HTTP request will be passed to the script as
+arguments. The headers will be passed as $1, and the body as $2.
+
+### 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

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

data/bin/oaf

@@ -0,0 +1,64 @@
+#!/usr/bin/ruby
+# 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 'optparse'
+require 'oaf'
+
+options = {:port => 9000}
+
+begin
+  OptionParser.new do |opts|
+    opts.banner = [
+      'oaf - Care-free web app prototyping using files and scripts',
+      '', 'SYNOPSIS:', '  oaf [options] [path]', '', 'OPTIONS:'].join "\n"
+    opts.on('-p', '--port PORT', 'Listening port. Default=9000') do |v|
+      if not v.to_i.to_s == v.to_s
+        puts "Port number must be an integer"
+        exit 1
+      end
+      options[:port] = v.to_s
+    end
+    opts.on('--version', 'Show the version number') do
+      puts Oaf::VERSION
+      exit 0
+    end
+    opts.on_tail('-h', '--help', 'Show this message') do
+      puts opts
+      exit 0
+    end
+  end.parse!
+rescue OptionParser::InvalidOption => e
+  puts e.message
+  exit 1
+end
+
+if ARGV.length == 0
+  options[:path] = Dir.pwd
+elsif ARGV.length == 1
+  options[:path] = File.expand_path ARGV[0]
+else
+  puts "Unknown arguments: #{ARGV[1..ARGV.length].join(' ')}"
+  exit 1
+end
+
+Oaf::HTTP.serve options[:path], options[:port]

data/lib/oaf.rb

@@ -0,0 +1,25 @@
+# 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/version'
+require 'oaf/util'
+require 'oaf/http'

data/lib/oaf/http.rb

@@ -0,0 +1,88 @@
+# 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 'webrick'
+
+module Oaf
+
+  module HTTP
+    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
+
+    # 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_proc '/' do |req, res|
+        req_body = ''
+        req_headers = Oaf::Util.format_request_headers req.header
+        if ['POST', 'PUT'].member? req.request_method
+          begin
+            req_body = req.body
+          rescue WEBrick::HTTPStatus::LengthRequired
+            true  # without this, coverage is not collected.
+          end
+        else
+          req_body = req.query
+        end
+        file = Oaf::Util.get_request_file path, req.path, req.request_method
+        out = Oaf::Util.get_output file, req.header, req_body
+        headers, status, body = Oaf::HTTP.parse_response out
+        headers.each do |name, value|
+          res.header[name] = value
+        end
+        res.status = status
+        res.body = body
+      end
+      trap 'INT' do server.shutdown end
+      server.start
+    end
+  end
+end

data/lib/oaf/util.rb

@@ -0,0 +1,200 @@
+# 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.
+
+module Oaf
+
+  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
+
+    # 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
+
+    # 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
+
+    # Format a hash of request headers in preparation for passing it to an
+    # executable program as an argument.
+    #
+    # == Parameters:
+    # headers::
+    #   A hash in the form `name` => `value` containing pairs of headers.
+    #
+    # == Returns:
+    #   A comma-delimited, colon-separated list of header names and values. The
+    #   return value of this function should be parsed according to RFC2616.
+    #
+    def format_request_headers headers
+      result = ''
+      headers.each do |name, value|
+        result += "#{name}:#{value},"
+      end
+      result.sub!(/,$/, '')
+    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
+      if text.to_s != ''
+        parts = text.split /^---$/
+        meta = parts.last.split "\n"
+        for part in meta
+          if Oaf::Util.is_http_header? part
+            header, value = Oaf::Util.get_http_header part
+            headers.merge! header => value
+          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
+      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
+
+    # 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.
+    # uri::
+    #   The URI of the request
+    # 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, uri, method
+      file = File.join root, "#{uri}.#{method}"
+      if not File.exist? file
+        Dir.glob(File.join(File.dirname(file), "_*_.#{method}")).each do |f|
+          file = f
+          break
+        end
+      end
+      File.exist?(file) ? file : nil
+    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:
+    # file::
+    #   The path to the file to use for output
+    # headers::
+    #   The HTTP request headers to pass
+    # body::
+    #   The HTTP request body to pass
+    #
+    # == Returns:
+    # The result from the file, or a default result if the file is not found.
+    #
+    def get_output file, headers, body
+      if file.nil?
+        out = Oaf::Util.get_default_response
+      elsif File.executable? file
+        out = %x(#{file} "#{headers}" "#{body}")
+      else
+        out = File.open(file).read
+      end
+      out
+    end
+  end
+end

data/lib/oaf/version.rb

@@ -0,0 +1,25 @@
+# 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.
+
+module Oaf
+  VERSION = '0.1.12'
+end

data/oaf.gemspec

@@ -0,0 +1,27 @@
+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.9'
+
+  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

data/spec/oaf/http_spec.rb

@@ -0,0 +1,122 @@
+# 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 'spec_helper'
+
+module Oaf
+  describe "Returning HTTP Responses" do
+    it "should return safe defaults if output is empty" do
+      headers, status, body = Oaf::HTTP.parse_response ''
+      headers.should eq({})
+      status.should eq(200)
+      body.should eq("\n")
+    end
+
+    it "should return safe defaults when only body is present" do
+      text = "This is a test\n"
+      headers, status, body = Oaf::HTTP.parse_response text
+      headers.should eq({})
+      status.should eq(200)
+      body.should eq("This is a test\n")
+    end
+
+    it "should return headers correctly" do
+      text = "---\nx-powered-by: oaf"
+      headers, status, body = Oaf::HTTP.parse_response text
+      headers.should eq({'x-powered-by' => 'oaf'})
+    end
+
+    it "should return status correctly" do
+      text = "---\n201"
+      headers, status, body = Oaf::HTTP.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.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.parse_response text
+      body.should eq("This is a test\n")
+    end
+  end
+
+  describe "Running an HTTP Server" do
+    before(:all) do
+      require 'webrick-mocks'
+      @tempdir1 = Dir.mktmpdir
+      @f1 = Tempfile.new ['oaf', '.GET'], @tempdir1
+      @f1.write "This is a test.\n---\n201\nx-powered-by: oaf"
+      @f1.close
+      @f1request = File.basename(@f1.path).sub!(/\.GET$/, '')
+
+      @f2 = Tempfile.new ['oaf', '.PUT'], @tempdir1
+      @f2.write "Containable Test\n---\n202\nx-powered-by: oaf"
+      @f2.close
+      @f2request = File.basename(@f2.path).sub!(/\.PUT$/, '')
+    end
+
+    after(:all) do
+      @f1.delete
+      @f2.delete
+      Dir.delete @tempdir1
+    end
+
+    before(:each) do
+      @webrick = double()
+      @webrick.should_receive(:start).once.and_return(true)
+      WEBrick::HTTPServer.stub(:new).and_return(@webrick)
+    end
+
+    it "should start an HTTP server" do
+      @webrick.should_receive(:mount_proc).with('/').once \
+        .and_yield(Oaf::FakeReq.new, Oaf::FakeRes.new)
+      Oaf::HTTP.serve '/tmp', 9000
+    end
+
+    it "should parse the request properly" do
+      req = Oaf::FakeReq.new :path => @f1request
+      res = Oaf::FakeRes.new
+      @webrick.should_receive(:mount_proc).with('/').once \
+        .and_yield(req, res)
+      Oaf::HTTP.serve @tempdir1, 9000
+      res.body.should eq("This is a test.\n")
+      res.status.should eq(201)
+      res.header.should eq('x-powered-by' => 'oaf')
+    end
+
+    it "should accept containable methods properly" do
+      req = Oaf::FakeReq.new({:path => @f2request, :method => 'PUT'})
+      res = Oaf::FakeRes.new
+      @webrick.should_receive(:mount_proc).with('/').once \
+        .and_yield(req, res)
+      Oaf::HTTP.serve(@tempdir1, 9000)
+      res.body.should eq("Containable Test\n")
+      res.status.should eq(202)
+      res.header.should eq('x-powered-by' => 'oaf')
+    end
+  end
+end

data/spec/oaf/util_spec.rb

@@ -0,0 +1,208 @@
+# 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 'spec_helper'
+
+module Oaf
+  describe "Header Lines" do
+    it "should detect a valid header line" do
+      result = Oaf::Util.is_http_header? 'x-powered-by: oaf'
+      result.should be_true
+    end
+
+    it "should detect an invalid header line" do
+      result = Oaf::Util.is_http_header? 'invalid header line'
+      result.should be_false
+    end
+
+    it "should parse a name and value from a header line" do
+      result = Oaf::Util.get_http_header 'x-powered-by: oaf'
+      result.should eq(['x-powered-by', 'oaf'])
+    end
+
+    it  "should detect an invalid header line during header parsing" do
+      result = Oaf::Util.get_http_header 'invalid header line'
+      result.should be_nil
+    end
+  end
+
+  describe "Status Lines" do
+    it "should detect all valid HTTP status codes" do
+      [200, 201, 202, 203, 204, 205, 206,
+       300, 301, 302, 303, 304, 305, 306, 307,
+       400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411,
+       412, 413, 414, 415, 416, 417,
+       500, 501, 502, 503, 504, 505].each do  |status|
+        result = Oaf::Util.is_http_status? status
+        result.should be_true
+      end
+    end
+
+    it "should be able to validate a string http status line" do
+      result = Oaf::Util.is_http_status? '200'
+      result.should be_true
+    end
+
+    it "should detect an invalid http status code" do
+      result1 = Oaf::Util.is_http_status? 199
+      result2 = Oaf::Util.is_http_status? 'not a status'
+      result1.should be_false
+      result2.should be_false
+    end
+
+    it "should retrieve an http status code" do
+      result = Oaf::Util.get_http_status '200'
+      result.should eq(200)
+    end
+
+    it "should detect an invalid status code during parsing" do
+      result = Oaf::Util.get_http_status 'not a status'
+      result.should be_nil
+    end
+  end
+
+  describe "Format Request Headers" do
+    it "should return a single key/value for just one header" do
+      headers = [['x-powered-by', 'oaf']]
+      result = Oaf::Util.format_request_headers headers
+      result.should eq('x-powered-by:oaf')
+    end
+
+    it "should return a comma-delimited list for multiple headers" do
+      headers = [['x-powered-by', 'oaf'], ['content-type', 'text/plain']]
+      result = Oaf::Util.format_request_headers headers
+      result.should eq('x-powered-by:oaf,content-type:text/plain')
+    end
+
+    it "should return nil if no headers present" do
+      headers = []
+      result = Oaf::Util.format_request_headers headers
+      result.should be_nil
+    end
+  end
+
+  describe "Parse Request Metadata From Output" do
+    it "should find headers in request metadata" do
+      text = ['---', 'x-powered-by: oaf', '201'].join "\n"
+      headers, status, size = Oaf::Util.parse_http_meta text
+      headers.should eq('x-powered-by' => 'oaf')
+    end
+
+    it "should return the number of lines the metadata consumes" do
+      text = ['---', 'x-powered-by: oaf', '200'].join "\n"
+      headers, status, size = Oaf::Util.parse_http_meta text
+      size.should eq(3)
+    end
+
+    it "should assume 200 as the default return code" do
+      text = ['---', 'x-powered-by: oaf'].join "\n"
+      headers, status, size = Oaf::Util.parse_http_meta text
+      status.should eq(200)
+    end
+
+    it "should assume meta size 0 if no metadata is present" do
+      text = 'this response uses default metadata'
+      headers, status, size = Oaf::Util.parse_http_meta text
+      size.should eq(0)
+    end
+
+    it "should return safe defaults if the response is empty" do
+      text = ''
+      headers, status, size = Oaf::Util.parse_http_meta text
+      headers.should eq({})
+      status.should eq(200)
+      size.should eq(0)
+    end
+  end
+
+  describe "Determine File Paths" do
+    before(:all) do
+      @tempdir1 = Dir.mktmpdir
+      @tempdir2 = Dir.mktmpdir
+
+      @f1 = Tempfile.new ['oaf', '.GET'], @tempdir1
+      @f1.write "This is a test.\n"
+      @f1.close
+      @f1request = File.basename(@f1.path).sub!(/\.GET$/, '')
+
+      @f2 = Tempfile.new ['_', '_.GET'], @tempdir1
+      @f2.write "This is a default file.\n"
+      @f2.close
+    end
+
+    after(:all) do
+      @f1.delete
+      @f2.delete
+      Dir.delete @tempdir1
+      Dir.delete @tempdir2
+    end
+
+    it "should find existing files correctly" do
+      result = Oaf::Util.get_request_file @tempdir1, @f1request, 'GET'
+      result.should eq(@f1.path)
+    end
+
+    it "should return the fall-through file if request file doesn't exist" do
+      result = Oaf::Util.get_request_file @tempdir1, 'nonexistent', 'GET'
+      result.should eq(@f2.path)
+    end
+
+    it "should return nil if neither the requested or default file exist" do
+      result = Oaf::Util.get_request_file @tempdir2, 'nonexistent', 'GET'
+      result.should be_nil
+    end
+  end
+
+  describe "Executing and Reading Files" do
+    before(:all) do
+      @f1 = Tempfile.new 'oaf'
+      @f1.chmod 0755
+      @f1.write "#!/bin/bash\necho 'This is a test'"
+      @f1.close
+
+      @f2 = Tempfile.new 'oaf'
+      @f2.chmod 0644
+      @f2.write "This is a test\n"
+      @f2.close
+    end
+
+    after(:all) do
+      @f1.delete
+      @f2.delete
+    end
+
+    it "should execute a file if it is executable" do
+      result = Oaf::Util.get_output @f1.path, nil, nil
+      result.should eq("This is a test\n")
+    end
+
+    it "should read file contents if it is not executable" do
+      result = Oaf::Util.get_output @f2.path, nil, nil
+      result.should eq("This is a test\n")
+    end
+
+    it "should assume safe defaults if the file doesnt exist" do
+      result = Oaf::Util.get_output nil, nil, nil
+      result.should eq(Oaf::Util.get_default_response)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+require 'oaf'
+require 'ostruct'
+require 'tempfile'

data/spec/webrick-mocks.rb

@@ -0,0 +1,46 @@
+require 'webrick'
+
+module Oaf
+  class FakeReq
+
+    attr_accessor :path, :request_method, :header, :query
+    attr_writer :body
+
+    @body = @path = @request_method = @query = nil
+    @header = Hash.new
+
+    def initialize opts={}
+      @body = opts[:body] ? opts[:body] : nil
+      @path, @query = opts[:path] ? opts[:path].split('?') : ['/']
+      @request_method = opts[:method] ? opts[:method] : 'GET'
+      @header = opts[:header] ? opts[:header] : Hash.new
+    end
+
+    def body
+      if ['POST', 'PUT'].member? @request_method
+        # Mock a webrick bug
+        raise WEBrick::HTTPStatus::LengthRequired
+      end
+      @body
+    end
+  end
+
+  class FakeRes
+
+    attr_accessor :body, :status
+    attr_reader :header
+
+    def initialize
+      @body = @status = nil
+      @header = Hash.new
+    end
+
+    def [](field)
+      @header[field]
+    end
+
+    def []=(field, value)
+      @header[field] = value
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: oaf
+version: !ruby/object:Gem::Version
+  version: 0.1.12
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Uber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &21830760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21830760
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &21829320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21829320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &21828360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21828360
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &21825800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21825800
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: &21825300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21825300
+description: Care-free web app prototyping using files and scripts
+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.rb
+- lib/oaf/util.rb
+- lib/oaf/version.rb
+- oaf.gemspec
+- spec/oaf/http_spec.rb
+- spec/oaf/util_spec.rb
+- spec/spec_helper.rb
+- spec/webrick-mocks.rb
+homepage: https://github.com/ryanuber/oaf
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Web app prototyping
+test_files:
+- spec/oaf/http_spec.rb
+- spec/oaf/util_spec.rb
+- spec/spec_helper.rb
+- spec/webrick-mocks.rb