webmachine 0.3.0 → 0.4.0

data/lib/webmachine/configuration.rb

@@ -10,21 +10,31 @@ module Webmachine
   # @attr [Hash] adapter_options adapter-specific options, defaults to {}
   Configuration = Struct.new(:ip, :port, :adapter, :adapter_options)
 
-  class << self
-    # @return [Configuration] the current configuration
-    attr_accessor :configuration
+  # @return [Configuration] the default configuration
+  def Configuration.default
+    new("0.0.0.0", 8080, :WEBrick, {})
   end
 
-  # Sets configuration for the web server via the passed
-  # block. Returns Webmachine so you can chain it with
-  # Webmachine.run.
-  # @yield [config] a block in which to set configuration values
-  # @yieldparam [Configuration] config the Configuration instance
-  # @return [Webmachine]
-  def self.configure
-    @configuration ||= Configuration.new("0.0.0.0", 8080, :WEBrick, {})
-    yield @configuration if block_given?
+  # Yields the current configuration to the passed block.
+  # @yield [config] a block that will modify the configuration
+  # @yieldparam [Configuration] config the adapter configuration
+  # @return self
+  # @see Application#configure
+  def self.configure(&block)
+    application.configure(&block)
     self
   end
-end
-  
+
+  # @return [Configuration] the current configuration
+  # @see Application#configuration
+  def self.configuration
+    application.configuration
+  end
+
+  # Sets the current configuration
+  # @param [Configuration] configuration the new config
+  # @see Application#configuration=
+  def self.configuration=(configuration)
+    application.configuration = configuration
+  end
+end # Webmachine

data/lib/webmachine/decision/conneg.rb

@@ -226,15 +226,14 @@ module Webmachine
         # {MediaType} items instead of Strings.
         # @see PriorityList#add_header_val
         def add_header_val(c)
-          begin
-            mt = MediaType.parse(c)
-            q = mt.params.delete('q') || 1.0
-            add(q.to_f, mt)
-          rescue ArgumentError
-            raise MalformedRequest, t('invalid_media_type', :type => c)
-          end
+          mt = MediaType.parse(c)
+          q = mt.params.delete('q') || 1.0
+          add(q.to_f, mt)
+        rescue ArgumentError
+          raise MalformedRequest, t('invalid_media_type', :type => c)
         end
       end
-    end
-  end
-end
+
+    end # module Conneg
+  end # module Decision
+end # module Webmachine

data/lib/webmachine/decision/flow.rb

@@ -131,7 +131,7 @@ module Webmachine
 
       # OPTIONS?
       def b3
-        if request.method == "OPTIONS"
+        if request.options?
           response.headers.merge!(resource.options)
           200
         else
@@ -254,14 +254,12 @@ module Webmachine
 
       # If-Unmodified-Since is valid date?
       def h11
-        begin
-          date = Time.httpdate(request.if_unmodified_since)
-          metadata['If-Unmodified-Since'] = date
-        rescue ArgumentError
-          :i12
-        else
-          :h12
-        end
+        date = Time.httpdate(request.if_unmodified_since)
+        metadata['If-Unmodified-Since'] = date
+      rescue ArgumentError
+        :i12
+      else
+        :h12
       end
 
       # Last-Modified > I-UM-S?
@@ -284,7 +282,7 @@ module Webmachine
 
       # PUT?
       def i7
-        request.method == "PUT" ? :i4 : :k7
+        request.put? ? :i4 : :k7
       end
 
       # If-none-match exists?
@@ -299,7 +297,7 @@ module Webmachine
 
       # GET or HEAD?
       def j18
-        %w{GET HEAD}.include?(request.method) ? 304 : 412
+        (request.get? || request.head?) ? 304 : 412
       end
 
       # Moved permanently?
@@ -341,7 +339,7 @@ module Webmachine
 
       # POST?
       def l7
-        request.method == "POST" ? :m7 : 404
+        request.post? ? :m7 : 404
       end
 
       # If-Modified-Since exists?
@@ -351,14 +349,12 @@ module Webmachine
 
       # IMS is valid date?
       def l14
-        begin
-          date = Time.httpdate(request.if_modified_since)
-          metadata['If-Modified-Since'] = date
-        rescue ArgumentError
-          :m16
-        else
-          :l15
-        end
+        date = Time.httpdate(request.if_modified_since)
+        metadata['If-Modified-Since'] = date
+      rescue ArgumentError
+        :m16
+      else
+        :l15
       end
 
       # IMS > Now?
@@ -373,7 +369,7 @@ module Webmachine
 
       # POST?
       def m5
-        request.method == "POST" ? :n5 : 410
+        request.post? ? :n5 : 410
       end
 
       # Server allows POST to missing resource?
@@ -383,7 +379,7 @@ module Webmachine
 
       # DELETE?
       def m16
-        request.method == "DELETE" ? :m20 : :n16
+        request.delete? ? :m20 : :n16
       end
 
       # DELETE enacted immediately? (Also where DELETE is forced.)
@@ -439,7 +435,7 @@ module Webmachine
 
       # POST?
       def n16
-        request.method == "POST" ? :n11 : :o16
+        request.post? ? :n11 : :o16
       end
 
       # Conflict?
@@ -454,13 +450,13 @@ module Webmachine
 
       # PUT?
       def o16
-        request.method == "PUT" ? :o14 : :o18
+        request.put? ? :o14 : :o18
       end
 
       # Multiple representations?
       # Also where body generation for GET and HEAD is done.
       def o18
-        if request.method =~ /^(GET|HEAD)$/
+        if request.get? || request.head?
           add_caching_headers
           content_type = metadata['Content-Type']
           handler = resource.content_types_provided.find {|ct, _| content_type.type_matches?(MediaType.parse(ct)) }.last
@@ -501,6 +497,7 @@ module Webmachine
       def p11
         !response.headers["Location"] ? :o20 : 201
       end
-    end
-  end
-end
+
+    end # module Flow
+  end # module Decision
+end # module Webmachine

data/lib/webmachine/decision/fsm.rb

@@ -20,27 +20,25 @@ module Webmachine
 
       # Processes the request, iteratively invoking the decision methods in {Flow}.
       def run
-        begin
-          state = Flow::START
-          loop do
-            response.trace << state
-            result = send(state)
-            case result
-            when Fixnum # Response code
-              respond(result)
-              break
-            when Symbol # Next state
-              state = result
-            else # You bwoke it
-              raise InvalidResource, t('fsm_broke', :state => state, :result => result.inspect)
-            end
+        state = Flow::START
+        loop do
+          response.trace << state
+          result = send(state)
+          case result
+          when Fixnum # Response code
+            respond(result)
+            break
+          when Symbol # Next state
+            state = result
+          else # You bwoke it
+            raise InvalidResource, t('fsm_broke', :state => state, :result => result.inspect)
           end
-        rescue MalformedRequest => malformed
-          Webmachine.render_error(400, request, response, :message => malformed.message)
-          respond(400)
-        rescue => e # Handle all exceptions without crashing the server
-          error_response(e, state)
         end
+      rescue MalformedRequest => malformed
+        Webmachine.render_error(400, request, response, :message => malformed.message)
+        respond(400)
+      rescue => e # Handle all exceptions without crashing the server
+        error_response(e, state)
       end
 
       private
@@ -66,6 +64,7 @@ module Webmachine
         Webmachine.render_error(500, request, response)
         respond(500)
       end
-    end
-  end
-end
+
+    end # class FSM
+  end # module Decision
+end # module Webmachine

data/lib/webmachine/decision/helpers.rb

@@ -99,6 +99,6 @@ module Webmachine
           response.headers['Last-Modified'] = modified.httpdate
         end
       end
-    end
-  end
-end
+    end # module Helpers
+  end # module Decision
+end # module Webmachine

data/lib/webmachine/dispatcher.rb

@@ -1,23 +1,31 @@
+require 'forwardable'
 require 'webmachine/decision'
 require 'webmachine/dispatcher/route'
 
 module Webmachine
   # Handles dispatching incoming requests to the proper registered
   # resources and initializing the decision logic.
-  module Dispatcher
-    extend self
-    @routes = []
+  class Dispatcher
+    # @return [Array<Route>] the list of routes that will be
+    #   dispatched to
+    # @see #add_route
+    attr_reader :routes
+
+    # Initialize a Dispatcher instance
+    def initialize
+      @routes = []
+    end
 
     # Adds a route to the dispatch list. Routes will be matched in the
     # order they are added.
     # @see Route#new
-    def add_route(*args)
-      route = Route.new(*args)
+    def add_route(*args, &block)
+      route = Route.new(*args, &block)
       @routes << route
       route
     end
     alias :add :add_route
-    
+
     # Dispatches a request to the appropriate {Resource} in the
     # dispatch list. If a matching resource is not found, a "404 Not
     # Found" will be rendered.
@@ -37,7 +45,7 @@ module Webmachine
     # Resets, removing all routes. Useful for testing or reloading the
     # application.
     def reset
-      @routes = []
+      @routes.clear
     end
   end
 
@@ -45,9 +53,9 @@ module Webmachine
   # {Webmachine::Dispatcher} for use in adding a number of routes at
   # once.
   # @return [Webmachine] self
-  # @see Webmachine::Dispatcher.add_route
+  # @see Webmachine::Dispatcher#add_route
   def self.routes(&block)
-    Dispatcher.module_eval(&block)
+    application.routes(&block)
     self
   end
-end
+end # module Webmachine

data/lib/webmachine/dispatcher/route.rb

@@ -2,7 +2,7 @@ require 'webmachine/resource'
 require 'webmachine/translation'
 
 module Webmachine
-  module Dispatcher
+  class Dispatcher
     # Pairs URIs with {Resource} classes in the {Dispatcher}. To
     # create routes, use {Dispatcher#add_route}.
     class Route
@@ -14,24 +14,60 @@ module Webmachine
       #   used to define this route (see #initialize).
       attr_reader :path_spec
 
+      # @return [Array<Proc>] the list of guard blocks used to define this
+      #   route (see #initialize).
+      attr_reader :guards
+
       # When used in a path specification, will match all remaining
       # segments
       MATCH_ALL = '*'.freeze
 
       # Creates a new Route that will associate a pattern to a
       # {Resource}.
-      # @param [Array<String|Symbol>] path_spec a list of path
-      #   segments (String) and identifiers (Symbol) to bind.
-      #   Strings will be simply matched for equality. Symbols in
-      #   the path spec will be extracted into {Request#path_info} for use
-      #   inside your {Resource}. The special segment {MATCH_ALL} will match
-      #   all remaining segments.
-      # @param [Class] resource the {Resource} to dispatch to
-      # @param [Hash] bindings additional information to add to
-      #   {Request#path_info} when this route matches
+      #
+      # @example Standard route
+      #   Route.new(["*"], MyResource)
+      #
+      # @example Guarded route
+      #   Route.new ["/notes"],
+      #     ->(request) { request.method == "POST" },
+      #     Resources::Note
+      #   Route.new ["/notes"], Resources::NoteList
+      #   Route.new ["/notes", :id], Resources::Note
+      #   Route.new ["/notes"], Resources::Note do |req|
+      #     req.query['foo']
+      #   end
+      #
+      # @overload initialize(path_spec, *guards, resource, bindings = {}, &block)
+      #   @param [Array<String|Symbol>] path_spec a list of path
+      #     segments (String) and identifiers (Symbol) to bind.
+      #     Strings will be simply matched for equality. Symbols in
+      #     the path spec will be extracted into {Request#path_info} for use
+      #     inside your {Resource}. The special segment {MATCH_ALL} will match
+      #     all remaining segments.
+      #   @param [Proc] guards optional guard blocks called with the request.
+      #   @param [Class] resource the {Resource} to dispatch to
+      #   @param [Hash] bindings additional information to add to
+      #     {Request#path_info} when this route matches
+      #   @yield [req] an optional guard block
+      #   @yieldparam [Request] req the request object
       # @see Dispatcher#add_route
-      def initialize(path_spec, resource, bindings={})
-        @path_spec, @resource, @bindings = path_spec, resource, bindings
+      def initialize(path_spec, *args)
+        if args.last.is_a? Hash
+          bindings = args.pop
+        else
+          bindings = {}
+        end
+
+        resource = args.pop
+        guards = args
+        guards << Proc.new if block_given?
+
+        @path_spec = path_spec
+        @guards    = guards
+        @resource  = resource
+        @bindings  =  bindings
+
         raise ArgumentError, t('not_resource_class', :class => resource.name) unless resource < Resource
       end
 
@@ -40,7 +76,7 @@ module Webmachine
       # @param [Reqeust] request the request object
       def match?(request)
         tokens = request.uri.path.match(/^\/(.*)/)[1].split('/')
-        bind(tokens, {})
+        bind(tokens, {}) && guards.all? { |guard| guard.call(request) }
       end
 
       # Decorates the request with information about the dispatch
@@ -75,7 +111,7 @@ module Webmachine
             return false
           when Symbol === spec.first
             bindings[spec.first] = tokens.first
-          when spec.first == tokens.first            
+          when spec.first == tokens.first
           else
             return false
           end
@@ -84,6 +120,7 @@ module Webmachine
           depth += 1
         end
       end
-    end
-  end
-end
+
+    end # class Route
+  end # module Dispatcher
+end # module Webmachine

data/lib/webmachine/errors.rb

@@ -35,4 +35,4 @@ module Webmachine
   # the case where a request header is improperly formed. Raising this
   # exception will result in a 400 response.
   class MalformedRequest < Error; end
-end
+end # module Webmachine

data/lib/webmachine/headers.rb

@@ -36,5 +36,5 @@ module Webmachine
     def transform_key(key)
       key.to_s.downcase
     end
-  end
-end
+  end # class Headers
+end # module Webmachine