oaf 0.2.5 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDdjZDY1YTk1N2I0Yzg4MWRjMDU0NjQyYjRlOWRmZTlmZTgzNjI1ZA==
+    MTc3ZjQwMGU4N2M5MDkyZGNhN2JkY2YxNWYwN2Q3MWUyNzRkZWI4OA==
   data.tar.gz: !binary |-
-    NjVlYTk0ZGJiYjc1NDQ3ZGI3ZWFiODQxMjhkYmQ1MjdmYjI0MmJjZA==
+    NTg3YWZjMTYwYjcyMmI1NDU3M2QxOGI5YmM0MjliOTcwNDk3Nzg0NQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZGE5YWRiYmIyZjllYTY5NWE1N2RiZjFkZDBmYjM5MmJmNjBiZWYzMjA5Zjc4
-    NzYyYThkNmUzMmI4OTJhYTY2NmMyYTMyMDZkYjY3MGMxNGFjYzc5ZDIxYTVh
-    ZTJlNTYzMTExNDY3YTk1MmVlMGE2MjdlOWU5NTZlNjg4ZWM1YzI=
+    MGM5M2IzOTMwZDhkNTUyZDBiMTE1YjFiYjM2Y2ExNmVhZTQwNDBjZjQxNGU5
+    NDUzNWNmZmQwMzFmZTI0NDc3NjdlY2FhNDNlNWFhNzFhZmI5Zjc5NzkxZmE5
+    M2U3YmE5ZWZkMjNmYTBiZThkMjRkMDE2OWVjMWU0OWVkNDk3MzY=
   data.tar.gz: !binary |-
-    ZTk3YWQ0M2E0MzhlOTg2MDk0YWFjZDE1MTI0MjBlZGYwZmMzZDE2ZjdjZTli
-    YjE1NGNkMDY2MmRjMjBlNWQzNmQ0Mzg2YTA5ZGVhZmMzMGYzZjlkMjI5N2Jk
-    Yjg3MmEzNTQ1YjM5N2UxYjVhOWVkMDBiZWY2ZjhiMTIyNDIyMGQ=
+    MGY5ODIwOGIzM2I4MGM0NDkwZTBiZWVmNjU3NTFjNjg2ZDRkYTU1MGM1ZWMy
+    ODE3ZDA3YmY5ZGQwMmY2ODAwMTQzNWFiYWQwMTVmM2ZjNDkyYjQ0NGI5MmU4
+    ZDZkZWFmMTRkOGEwNDY5NmYyNjVjODk3NWIwYzFlNmVhODE3ZTk=

data/.travis.yml

@@ -1,3 +1,6 @@
+branches:
+  only:
+    - master
 language: ruby
 rvm:
   - 1.9.3

data/README.md

@@ -6,8 +6,9 @@ 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)
+[![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
@@ -21,31 +22,47 @@ 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
@@ -75,26 +92,24 @@ 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 prefixes for environment variables are as follows:
+prefix. The environment variables are as follows:
 
-* Headers: `oaf_header_`
-* Query parameters: `oaf_query_`
+* 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:
-```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
+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
@@ -103,6 +118,7 @@ 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.
@@ -112,6 +128,7 @@ 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

data/lib/oaf/http/handler.rb

@@ -66,7 +66,8 @@ module Oaf::HTTP
       req_query = req.query
       req_body = Oaf::HTTP::Server.get_request_body req
       file = Oaf::Util.get_request_file @path, req.path, req.request_method
-      out = Oaf::Util.get_output file, req_headers, req_body, req_query
+      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
     end

data/lib/oaf/util.rb

@@ -87,23 +87,26 @@ module Oaf
     # 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
-    # query::
-    #   A hash of query parameters
+    # params::
+    #   A hash of request parameters
     # body::
     #   A string containing the request body
     #
     # == Returns:
     # A flat hash containing namespaced environment parameters
     #
-    def prepare_environment headers, query, body
+    def prepare_environment req_path, headers, params, body
       result = Hash.new
-      {'header' => headers, 'query' => query}.each do |prefix, data|
+      {'header' => headers, 'param' => params}.each do |prefix, data|
         data.each do |name, value|
           result.merge! Oaf::Util.environment_item prefix, name, value
         end
       end
+      result.merge! Oaf::Util.environment_item 'request', 'path', req_path
       result.merge Oaf::Util.environment_item 'request', 'body', body
     end
 
@@ -222,16 +225,16 @@ module Oaf
     # == Parameters:
     # root::
     #   The root path to search within.
-    # uri::
-    #   The URI of the request
+    # 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, uri, method
-      file = File.join root, "#{uri}.#{method}"
+    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
@@ -272,23 +275,25 @@ module Oaf
     # 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
-    # query::
-    #   The HTTP query parameters 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, headers=[], body=[], query=[]
+    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 headers, query, body
+        env = Oaf::Util.prepare_environment req_path, headers, params, body
         out = Oaf::Util.run_buffered env, file
       else
         out = File.open(file).read

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.2.5'
+  VERSION = '0.3.0'
 end

data/spec/oaf/util_spec.rb

@@ -220,7 +220,8 @@ module Oaf
       @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"
+                "echo \"$oaf_param_myparam\"\necho \"$oaf_request_body\"\n" +
+                "echo \"$oaf_request_path\""
       @f4.close
     end
 
@@ -253,10 +254,12 @@ module Oaf
 
     it "should register environment variables for headers, query, and body" do
       headers = {'x-powered-by' => 'oaf'}
-      query = {'myparam' => 'myval'}
+      params = {'myparam' => 'myval'}
       body = 'Test Body'
-      result = Oaf::Util.get_output @f4.path, headers, body, query
-      result.should eq("oaf\nmyval\nTest Body\n")
+      path = '/test/path'
+      result = Oaf::Util.get_output @f4.path, path, headers, body, params
+      result.should eq("#{headers['x-powered-by']}\n#{params['myparam']}\n" +
+                       "#{body}\n#{path}\n")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oaf
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryan Uber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler