Contents

class Roda
  module RodaPlugins
    # The header_matchers plugin adds hash matchers for matching on less-common
    # HTTP headers.
    #
    #   plugin :header_matchers
    #
    # It adds a +:header+ matcher for matching on arbitrary headers, which matches
    # if the header is present:
    #
    #   r.on :header=>'X-App-Token' do
    #   end
    #
    # It adds a +:host+ matcher for matching by the host of the request:
    #
    #   r.on :host=>'foo.example.com' do
    #   end
    #
    # It adds a +:user_agent+ matcher for matching on a user agent patterns, which
    # yields the regexp captures to the block:
    #
    #   r.on :user_agent=>/Chrome\/([.\d]+)/ do |chrome_version|
    #   end
    #
    # It adds an +:accept+ matcher for matching based on the Accept header:
    #
    #   r.on :accept=>'text/csv' do
    #   end
    #
    # Note that the accept matcher is very simple and cannot handle wildcards,
    # priorities, or anything but a simple comma separated list of mime types.
    module HeaderMatchers
      module RequestMethods
        private

        # Match if the given mimetype is one of the accepted mimetypes.
        def match_accept(mimetype)
          if @env["HTTP_ACCEPT"].to_s.split(',').any?{|s| s.strip == mimetype}
            response["Content-Type"] = mimetype
          end
        end

        # Match if the given uppercase key is present inside the environment.
        def match_header(key)
          @env[key.upcase.tr("-","_")]
        end

        # Match if the host of the request is the same as the hostname.
        def match_host(hostname)
          hostname === host
        end

        # Match the submitted user agent to the given pattern, capturing any
        # regexp match groups.
        def match_user_agent(pattern)
          if (user_agent = @env["HTTP_USER_AGENT"]) && user_agent.to_s =~ pattern
            @captures.concat($~[1..-1])
          end
        end
      end
    end

    register_plugin(:header_matchers, HeaderMatchers)
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
roda-1.2.0	lib/roda/plugins/header_matchers.rb