oaf 0.2.2 → 0.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGY1M2EzN2Y0NzBjMjA1NjBhNzQzZGMxYTdhYmY0MTE5YzYxZDczNg==
+    YWQyNWVmNjg3MTg0NjYwMzgyYzI1OTVhZGQ3ZDFiMWM3NzhhNzBjZQ==
   data.tar.gz: !binary |-
-    ZmQxNzAyZjM1MmNkNjM0MzJiMjZhNWQ4NzMxNDYyNGVlYzRjYTcxZQ==
+    NDdiZWMxMmYzMDI3NmZhYmNkY2VhYzVhZmEzZGQ5N2ZmNjVkNzRmNA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmUyNWJhM2Q5YzZkN2JlZTdmNjI3MGVlOThkMzQ1MmYwYjFkY2JlMzNhNzQ4
-    OThiZDVhNDQ1MGMxZmU5ZWJjNDg3ZDhlOGMxNzdlZTVlNmI2ZDhmNzM3MjBh
-    YzdjZmUzNDI2Y2FmODdhYjM0Yzc1NDIwMzYyZmIzZmNhZTdmMTM=
+    NjY1ODU1NmM0N2NjYWZhMDZmMTg3MmIxNmY5MTFiNTUxZjgzOWU4ZDk3OWQ2
+    YzliNDgxMDM2ZGRlNWY5YjI2ZWM5ZmQ3NmI3OWNhZDAyNmJmOTZiYWYwMTE0
+    NzIwNmQ2ZDgxNjVkOTdjNWI5NDNiOTI0OWUxMDEzNjkwMWI2MWE=
   data.tar.gz: !binary |-
-    YjZlYWQ3MzlhODg5MDQ3NTI1NjgwOTQ3MmVjZmViNDQwMTUyOWE2YzIwNDky
-    ZTMwZTFkMzVjZjJjN2Q4OGM4ZDc0OTJiMmNjNmEwZTZlMDZmZjU3YTU4NGEw
-    NjY3YzQ2ZjVhNGVmYmI4ZDRlZmIxM2Y4ZjY0NzE1MzRmZDFmYTA=
+    OThmYWJkMTUwNDliZDYzMGFjMWM1NmI3ODUxMzIxNTIxMmQ1MTYxNWJjY2Rj
+    MjI0OTBlNDE2ZWQ4M2I3ZmVmMzE5MzU4MWZlNWUyNjllMjM3YzM4MTM4ZDA0
+    NmRhZjM0ZGFkMTIwZDZmMTI5MjA2YzliZDk1MDJhOTA3M2NiOWQ=

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
-ruby:
-  - "1.9.3"
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7

data/lib/oaf/http.rb

@@ -48,6 +48,47 @@ module Oaf
       [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.
     #
@@ -60,24 +101,13 @@ module Oaf
     def serve path, port
       server = WEBrick::HTTPServer.new :Port => port
       server.mount_proc '/' do |req, res|
-        req_body = ''
         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
-        end
+        req_body = Oaf::HTTP::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
         res_headers, res_status, res_body = Oaf::HTTP.parse_response out
-        res_headers.each do |name, value|
-          res.header[name] = value
-        end
-        res.status = res_status
-        res.body = res_body
+        Oaf::HTTP.set_response! res, res_headers, res_body, res_status
       end
       trap 'INT' do server.shutdown end
       server.start

data/lib/oaf/util.rb

@@ -20,8 +20,6 @@
 # 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 'open3'
-
 module Oaf
 
   module Util
@@ -55,7 +53,7 @@ module Oaf
     def get_http_header line
       return nil if not is_http_header? line
       parts = line.split(':')
-      [parts[0].strip, parts[1].strip]
+      {parts[0].strip => parts[1].strip}
     end
 
     # Retrieves the numeric value from a line of text as an HTTP status code.
@@ -101,31 +99,47 @@ module Oaf
     #
     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
+      {'header' => headers, 'query' => query}.each do |prefix, data|
+        data.each do |name, value|
+          result.merge! Oaf::Util.environment_item prefix, name, value
+        end
       end
-      result["oaf_request_body"] = Oaf::Util.flatten body
-      result
+      result.merge Oaf::Util.environment_item 'request', 'body', body
     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.
+    # 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 key
-      key.gsub('-', '_').downcase
+    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
 
     # Flatten a hash or array into a string. This is useful for preparing some
@@ -176,21 +190,16 @@ module Oaf
       headers = {}
       status = 200
       size = 0
-      if text.to_s != ''
-        parts = text.split /^---$/
-        if parts.length > 1
-          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
+      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
       end
       [headers, status, size]
@@ -232,11 +241,14 @@ module Oaf
       File.exist?(file) ? file : nil
     end
 
-    # Run a command with stdout and stderr buffered. This suppresses error
-    # messages from the server process and enables us to return them in the
-    # HTTP response instead.
+    # 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
     #
@@ -244,8 +256,16 @@ module Oaf
     # A string of stderr concatenated to stdout.
     #
     def run_buffered env, command
-      stdin, stdout, stderr = Open3.popen3 env, "#{command} 2>&1"
-      stdout.read
+      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

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.2'
+  VERSION = '0.2.3'
 end

data/spec/oaf/util_spec.rb

@@ -36,7 +36,7 @@ module Oaf
 
     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'])
+      result.should eq('x-powered-by' => 'oaf')
     end
 
     it  "should detect an invalid header line during header parsing" do
@@ -82,17 +82,17 @@ module 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')
+      result = Oaf::Util.prepare_key 'header', 'x-powered-by'
+      result.should eq('oaf_header_x_powered_by')
     end
 
     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')
+      result = Oaf::Util.prepare_key 'header', 'X-Powered-By'
+      result.should eq('oaf_header_x_powered_by')
     end
 
     it "should flatten a hash into a string" do
-      result = Oaf::Util.flatten({'item1' => 'value1'})
+      result = Oaf::Util.flatten('item1' => 'value1')
       result.should eq('item1value1')
     end
 

metadata

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