oaf 0.2.3 → 0.2.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWQyNWVmNjg3MTg0NjYwMzgyYzI1OTVhZGQ3ZDFiMWM3NzhhNzBjZQ==
+    MDU1ZjY5NGMxZTlkYzViNjQ5ZmFiYTUxZDdjZjdkYzU0ODkxZTVkMg==
   data.tar.gz: !binary |-
-    NDdiZWMxMmYzMDI3NmZhYmNkY2VhYzVhZmEzZGQ5N2ZmNjVkNzRmNA==
+    MTU4MGZlZjE5NjY1YmEwMmZiNDUzZWY3OGRkYmNiZjQ1ZTk4NmM4MA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjY1ODU1NmM0N2NjYWZhMDZmMTg3MmIxNmY5MTFiNTUxZjgzOWU4ZDk3OWQ2
-    YzliNDgxMDM2ZGRlNWY5YjI2ZWM5ZmQ3NmI3OWNhZDAyNmJmOTZiYWYwMTE0
-    NzIwNmQ2ZDgxNjVkOTdjNWI5NDNiOTI0OWUxMDEzNjkwMWI2MWE=
+    YjI5ZWVlNDM4YmEzNWZlMGM1Mzc5NjIzN2RiZTczOWQyZDk3YmIxYTA3ZDMz
+    MTMzMjlmODlmZWVhODI4YjNhMGNhMzBmZDU5OWMwODY3OWQ3NjVkMzQ2MmE3
+    OGVjN2RlNWI3NTQ1M2UzMjE0YjIzNmE0MDUwNmIwOGQwMTQ3NGI=
   data.tar.gz: !binary |-
-    OThmYWJkMTUwNDliZDYzMGFjMWM1NmI3ODUxMzIxNTIxMmQ1MTYxNWJjY2Rj
-    MjI0OTBlNDE2ZWQ4M2I3ZmVmMzE5MzU4MWZlNWUyNjllMjM3YzM4MTM4ZDA0
-    NmRhZjM0ZGFkMTIwZDZmMTI5MjA2YzliZDk1MDJhOTA3M2NiOWQ=
+    YTY4MTA0YmE3YmUxODNhNTRhMTRmMDc1ZTcwZTQ5MWU5NzkzNDU0NTViYWJm
+    YzkzZTBiY2NjNzc2OTA3NzVkZDk0NmZkODBhZjIzZGFjYzVlOWY4YTA1MzZh
+    ZGRhMDUxNWQ1NTcyZWU2MmI5YTE1ZjlhOWRhYzA3Y2U2ZTU3NmM=

data/README.md

@@ -56,6 +56,7 @@ 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.

data/bin/oaf

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

data/lib/oaf.rb

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

data/lib/oaf/http/handler.rb

@@ -0,0 +1,97 @@
+# 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/server'
+require 'webrick'
+
+module Oaf::HTTP
+
+  # 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
+
+    # Creates a new abstract server object and allows passing in the root
+    # path of the server via an argument.
+    #
+    # == Parameters:
+    # server::
+    #   A WEBrick::HTTPServer object
+    # path::
+    #   A string containing the root path
+    #
+    def initialize server, path
+      super server
+      @path = path
+    end
+
+    # Main server method. Oaf does not really differentiate between different
+    # HTTP methods, but needs to at least support passing them all.
+    #
+    # == Parameters:
+    # req::
+    #   A WEBrick::HTTPRequest object
+    # res::
+    #   A WEBrick::HTTPResponse object
+    #
+    def process_request req, res
+      req_headers = req.header
+      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
+      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
+
+    # A magic respond_to? implementation to trick WEBrick into thinking that any
+    # do_* methods are already defined. This allows method_missing to do its job
+    # once WEBrick makes its call to the method.
+    #
+    # == Parameters:
+    # method::
+    #   The name of the class method being checked
+    #
+    # == Returns:
+    # Boolean, true if the method name matches do_[A-Z]+, else super.
+    #
+    def respond_to? method
+      method.to_s =~ /^do_[A-Z]+$/ ? true : super
+    end
+
+    # A magic method to handle any and all do_* methods. This allows Oaf to
+    # claim some degree of support for any HTTP method, be it a known and
+    # commonly used method such as PUT or DELETE, or custom methods.
+    #
+    # == Parameters:
+    # method::
+    #   The name of the method being called
+    # *opt::
+    #   A list of arguments to pass along to the processing method
+    #
+    def method_missing method, *opt
+      method.to_s =~ /^do_[A-Z]+$/ ? process_request(*opt) : super
+    end
+  end
+end

data/lib/oaf/{http.rb → http/server.rb}

@@ -20,11 +20,13 @@
 # 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
+module Oaf::HTTP
 
-  module HTTP
+  module Server
     extend Oaf
     extend self
 
@@ -100,15 +102,7 @@ module Oaf
     #
     def serve path, port
       server = WEBrick::HTTPServer.new :Port => port
-      server.mount_proc '/' do |req, res|
-        req_headers = req.header
-        req_query = req.query
-        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
-        Oaf::HTTP.set_response! res, res_headers, res_body, res_status
-      end
+      server.mount '/', Oaf::HTTP::Handler, path
       trap 'INT' do server.shutdown end
       server.start
     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.2.3'
+  VERSION = '0.2.4'
 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.parse_response ''
+      headers, status, body = Oaf::HTTP::Server.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.parse_response text
+      headers, status, body = Oaf::HTTP::Server.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.parse_response text
+      headers, status, body = Oaf::HTTP::Server.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
+      headers, status, body = Oaf::HTTP::Server.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
+      headers, status, body = Oaf::HTTP::Server.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
+      headers, status, body = Oaf::HTTP::Server.parse_response text
       body.should eq("This is a test\n")
     end
   end
@@ -85,24 +85,21 @@ module Oaf
       Dir.delete @tempdir1
     end
 
-    before(:each) do
+    it "should start an HTTP server" 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
+      @webrick.should_receive(:mount) \
+        .with('/', Oaf::HTTP::Handler, '/tmp').once \
+        .and_return(true)
+      Oaf::HTTP::Server.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
+      handler = Oaf::HTTP::Handler.new Oaf::FakeServlet.new, @tempdir1
+      handler.process_request req, res
       res.body.should eq("This is a test.\n")
       res.status.should eq(201)
       res.header.should eq('x-powered-by' => 'oaf')
@@ -111,12 +108,23 @@ module Oaf
     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)
+      handler = Oaf::HTTP::Handler.new Oaf::FakeServlet.new, @tempdir1
+      handler.process_request req, res
       res.body.should eq("Containable Test\n")
       res.status.should eq(202)
       res.header.should eq('x-powered-by' => 'oaf')
     end
+
+    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
+      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
+      handler.respond_to?(:nonexistent).should be_false
+      handler.do_PUT(req, res)
+    end
   end
 end

data/spec/webrick-mocks.rb

@@ -9,7 +9,7 @@ module Oaf
     @body = @path = @request_method = @query = nil
     @header = Hash.new
 
-    def initialize opts={}
+    def initialize opts={}, *args
       @body = opts[:body] ? opts[:body] : nil
       @path, @query = opts[:path] ? opts[:path].split('?') : ['/']
       @request_method = opts[:method] ? opts[:method] : 'GET'
@@ -43,4 +43,13 @@ module Oaf
       @header[field] = value
     end
   end
+
+  class FakeServlet
+
+    def [](field)
+    end
+
+    def []=(field, value)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oaf
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Ryan Uber
@@ -95,7 +95,8 @@ files:
 - Rakefile
 - bin/oaf
 - lib/oaf.rb
-- lib/oaf/http.rb
+- lib/oaf/http/handler.rb
+- lib/oaf/http/server.rb
 - lib/oaf/util.rb
 - lib/oaf/version.rb
 - oaf.gemspec