oaf 0.1.17 → 0.2.1

data/README.md

@@ -55,8 +55,7 @@ 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`
+Files must carry the extension of the HTTP method used to invoke them.
 
 ### Headers and Status
 You can indicate HTTP headers and status using stdout from your script.
@@ -71,12 +70,36 @@ content-type: text/plain
 EOF
 ```
 
-Separated by 3 dashes on a line of their own (`\n---\n`), the very last block
+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 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.
+### 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 prefixes for environment variables are as follows:
+
+* Headers: `oaf_header_`
+* Query parameters: `oaf_query_`
+* Request body: `oaf_request_body`
+
+Below is a quick example of a shell script which makes use of the request data:
+```bash
+#!/bin/bash
+if [ -n "$oaf_header_accept" ]; then
+    echo "You passed the Accept header: $oaf_header_accept"
+fi
+if [ -n "$oaf_query_myparam" ]; then
+    echo "You passed the 'myparam' value: $oaf_query_myparam"
+fi
+if [ -n "$oaf_request_body" ]; then
+    echo "You passed the request body: $oaf_request_body"
+fi
+```
+
+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

data/lib/oaf/http.rb

@@ -54,7 +54,6 @@ module Oaf
     # == Parameters:
     # path::
     #   The path in which to search for files
-    #
     # port::
     #   The TCP port to listen on
     #
@@ -62,24 +61,23 @@ module Oaf
       server = WEBrick::HTTPServer.new :Port => port
       server.mount_proc '/' do |req, res|
         req_body = ''
-        req_headers = Oaf::Util.format_hash req.header
+        req_headers = req.header
+        req_query = req.query
         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_headers, req_body
-        headers, status, body = Oaf::HTTP.parse_response out
-        headers.each do |name, value|
+        out = Oaf::Util.get_output file, req_headers, req_body, req_query
+        res_headers, res_status, res_body = Oaf::HTTP.parse_response out
+        res_headers.each do |name, value|
           res.header[name] = value
         end
-        res.status = status
-        res.body = body
+        res.status = res_status
+        res.body = res_body
       end
       trap 'INT' do server.shutdown end
       server.start

data/lib/oaf/util.rb

@@ -21,6 +21,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'open3'
+require 'json'
 
 module Oaf
 
@@ -85,23 +86,79 @@ module Oaf
         .concat((500..505).to_a).include? code.to_i
     end
 
-    # Format a hash in preparation for passing it to an executable program as
-    # an argument on the command line.
+    # 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:
     # headers::
-    #   A hash in the form `name` => `value` containing pairs of headers.
+    #   A hash of request headers
+    # query::
+    #   A hash of query parameters
+    # body::
+    #   A string containing the request body
+    #
+    # == Returns:
+    # A flat hash containing namespaced environment parameters
+    #
+    def prepare_environment headers, query, body
+      result = Hash.new
+      headers.each do |name, value|
+        name = Oaf::Util.prepare_key name
+        result["oaf_header_#{name}"] = Oaf::Util.flatten value
+      end
+      query.each do |name, value|
+        name = Oaf::Util.prepare_key name
+        result["oaf_query_#{name}"] = Oaf::Util.flatten value
+      end
+      result["oaf_request_body"] = Oaf::Util.flatten body
+      result
+    end
+
+    # Replace characters that would not be suitable for an environment variable
+    # name. Currently this only replaces dashes with underscores. If the need
+    # arises, more can be added here later.
+    #
+    # == Parameters:
+    # key::
+    #   The key to sanitize
     #
     # == Returns:
-    #   A comma-delimited, colon-separated list of header names and values. The
-    #   return value of this function should be parsed according to RFC2616.
+    # A string with the prepared value
     #
-    def format_hash hash
+    def prepare_key key
+      key.gsub('-', '_').downcase
+    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 = ''
-      hash.each do |name, value|
-        result += "#{name}:#{value},"
+      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 = ''
       end
-      result.sub!(/,$/, '')
+      result
     end
 
     # Given an array of text lines, iterate over each of them and determine if
@@ -187,8 +244,8 @@ module Oaf
     # == Returns:
     # A string of stderr concatenated to stdout.
     #
-    def run_buffered command
-      stdin, stdout, stderr = Open3.popen3 "#{command} 2>&1"
+    def run_buffered env, command
+      stdin, stdout, stderr = Open3.popen3 env, "#{command} 2>&1"
       stdout.read
     end
 
@@ -202,15 +259,18 @@ module Oaf
     #   The HTTP request headers to pass
     # body::
     #   The HTTP request body to pass
+    # query::
+    #   The HTTP query parameters to pass
     #
     # == Returns:
     # The result from the file, or a default result if the file is not found.
     #
-    def get_output file, headers, body
+    def get_output file, headers=[], body=[], query=[]
       if file.nil?
         out = Oaf::Util.get_default_response
       elsif File.executable? file
-        out = Oaf::Util.run_buffered "#{file} '#{headers}' '#{body}'"
+        env = Oaf::Util.prepare_environment headers, query, body
+        out = Oaf::Util.run_buffered env, file
       else
         out = File.open(file).read
       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.1.17'
+  VERSION = '0.2.1'
 end

data/oaf.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.8'
 
   s.add_runtime_dependency 'bundler'
+  s.add_runtime_dependency 'json'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/spec/oaf/util_spec.rb

@@ -80,23 +80,45 @@ module Oaf
     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_hash headers
-      result.should eq('x-powered-by:oaf')
+  describe "Argument Sanitizers" do
+    it "should replace dashes with underscores in key names" do
+      result = Oaf::Util.prepare_key 'x-powered-by'
+      result.should eq('x_powered_by')
     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_hash headers
-      result.should eq('x-powered-by:oaf,content-type:text/plain')
+    it "should convert all letters to lowercase in key names" do
+      result = Oaf::Util.prepare_key 'X-Powered-By'
+      result.should eq('x_powered_by')
     end
 
-    it "should return nil if no headers present" do
-      headers = []
-      result = Oaf::Util.format_hash headers
-      result.should be_nil
+    it "should flatten a hash into a string" do
+      result = Oaf::Util.flatten({'item1' => 'value1'})
+      result.should eq('item1value1')
+    end
+
+    it "should flatten hashes recursively into a string" do
+      result = Oaf::Util.flatten({'one' => {'two' => {'three' => 'four'}}})
+      result.should eq('onetwothreefour')
+    end
+
+    it "should flatten an array of multiple values" do
+      result = Oaf::Util.flatten(['one', 'two'])
+      result.should eq('onetwo')
+    end
+
+    it "should flatten arrays of multiple values recursively" do
+      result = Oaf::Util.flatten(['one', ['two', 'three', ['four']]])
+      result.should eq('onetwothreefour')
+    end
+
+    it "should not modify strings" do
+      result = Oaf::Util.flatten 'oaf'
+      result.should eq('oaf')
+    end
+
+    it "should flatten unknown object types into empty strings" do
+      result = Oaf::Util.flatten true
+      result.should eq('')
     end
   end
 
@@ -194,32 +216,47 @@ module Oaf
       @f3.chmod 0755
       @f3.write "#!/bin/bash\necho 'test1'\necho 'test2' 1>&2\n"
       @f3.close
+
+      @f4 = Tempfile.new 'oaf'
+      @f4.chmod 0755
+      @f4.write "#!/bin/bash\necho \"$oaf_header_x_powered_by\"\n" +
+                "echo \"$oaf_query_myparam\"\necho \"$oaf_request_body\"\n"
+      @f4.close
     end
 
     after(:all) do
       @f1.delete
       @f2.delete
       @f3.delete
+      @f4.delete
     end
 
     it "should execute a file if it is executable" do
-      result = Oaf::Util.get_output @f1.path, nil, nil
+      result = Oaf::Util.get_output @f1.path
       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 = Oaf::Util.get_output @f2.path
       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 = Oaf::Util.get_output nil
       result.should eq(Oaf::Util.get_default_response)
     end
 
     it "should catch stderr output instead of dumping it" do
-      result = Oaf::Util.get_output @f3.path, nil, nil
+      result = Oaf::Util.get_output @f3.path
       result.should eq("test1\ntest2\n")
     end
+
+    it "should register environment variables for headers, query, and body" do
+      headers = {'x-powered-by' => 'oaf'}
+      query = {'myparam' => 'myval'}
+      body = 'Test Body'
+      result = Oaf::Util.get_output @f4.path, headers, body, query
+      result.should eq("oaf\nmyval\nTest Body\n")
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 require 'simplecov'
 require 'coveralls'
 Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start do
   add_filter '/spec/'
 end

metadata

@@ -1,85 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: oaf
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.2.1
+  prerelease: 
 platform: ruby
 authors:
 - Ryan Uber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &13011880 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *13011880
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &12995680 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12995680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &12995140 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *12995140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &12994440 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *12994440
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &12993820 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *12993820
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &12993160 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *12993160
 description: Care-free web app prototyping using files and scripts
 email:
 - ru@ryanuber.com
@@ -106,26 +103,27 @@ files:
 homepage: https://github.com/ryanuber/oaf
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.8'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Web app prototyping
 test_files:
 - spec/oaf/http_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OGM5OWUzYzJlZjlhMDRhYzc2YmVmM2I4YTEyZjkwMzMxMDZkMTc0OQ==
-  data.tar.gz: !binary |-
-    YmE3ZDZlNWE2NjgxYjE0N2E1NjdmOTAzZWU5NDRmOGE5OWUxMWY2MA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NGU0MjkzNzYyNmYwMjY1MGQ2Y2FkZDdhMDIwNTM5NDMwOWE5YTE1YzA4MWQ4
-    ODEwNGJhZjJiNjA1MmFlYTk0NzEwNTkxOWM2ODBjNWZjOWRhZmVlZDU5YWI4
-    YzI1YTI4M2M5ZjMzYjI3MGZiNWYzNGMyOTM5MzgxNzE4OGFmMDk=
-  data.tar.gz: !binary |-
-    ZTUxODJhMmEzNjE4YmJhMzg1NmIyMWJhM2E4OGI1YjAzNDNhMmRkYmJkYTVl
-    M2JjNGYxMzBlNDE2OTI5OGM2NzljNzMzYTk4ZmEzYWJlOWM2OTA0N2I3YzEx
-    YTMyNTNmYmUzNjczZTJiY2Q3YjE0YmMyODkwZWJmZmFlNzFkZWY=