Class: HttpRouter

Inherits:
Object
  • Object
show all
Defined in:
lib/http_router/version.rb,
lib/http_router.rb,
lib/http_router/node.rb,
lib/http_router/path.rb,
lib/http_router/route.rb,
lib/http_router/request.rb,
lib/http_router/response.rb,
lib/http_router/node/glob.rb,
lib/http_router/node/regex.rb,
lib/http_router/regex_route.rb,
lib/http_router/node/request.rb,
lib/http_router/node/variable.rb,
lib/http_router/node/arbitrary.rb,
lib/http_router/node/free_regex.rb,
lib/http_router/node/glob_regex.rb,
lib/http_router/optional_compiler.rb,
lib/http_router/node/spanning_regex.rb

Overview

:nodoc

Defined Under Namespace

Classes: Node, OptionalCompiler, Path, RegexRoute, Request, Response, Route

Constant Summary collapse

UngeneratableRouteException =

Raised when a Route is not able to be generated.

Class.new(RuntimeError)
InvalidRouteException =

Raised when a Route is generated that isn’t valid.

Class.new(RuntimeError)
MissingParameterException =

Raised when a Route is not able to be generated due to a missing parameter.

Class.new(RuntimeError)
VERSION = 
'0.6.5'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &blk) ⇒ HttpRouter

Creates a new HttpRouter. Can be called with either HttpRouter.new(proc{|env| ... }, { .. options .. }) or with the first argument omitted. If there is a proc first, then it’s used as the default app in the case of a non-match. Supported options are

  • :default_app – Default application used if there is a non-match on #call. Defaults to 404 generator.

  • :ignore_trailing_slash – Ignore a trailing / when attempting to match. Defaults to true.

  • :redirect_trailing_slash – On trailing /, redirect to the same path without the /. Defaults to false.



30
31
32
33
34
35
36
37
38
 
# File 'lib/http_router.rb', line 30

def initialize(*args, &blk)
  default_app, options = args.first.is_a?(Hash) ? [nil, args.first] : [args.first, args[1]]
  @options = options
  @default_app = default_app || options && options[:default_app] || proc{|env| ::Rack::Response.new("Not Found", 404).finish }
  @ignore_trailing_slash = options && options.key?(:ignore_trailing_slash) ? options[:ignore_trailing_slash] : true
  @redirect_trailing_slash = options && options.key?(:redirect_trailing_slash) ? options[:redirect_trailing_slash] : false
  reset!
  instance_eval(&blk) if blk
end

Instance Attribute Details

#default_app ⇒ Object

Returns the value of attribute default_app.



14
15
16
 
# File 'lib/http_router.rb', line 14

def default_app
  @default_app
end

#known_methods ⇒ Object (readonly)

Returns the value of attribute known_methods.



13
14
15
 
# File 'lib/http_router.rb', line 13

def known_methods
  @known_methods
end

#named_routes ⇒ Object (readonly)

Returns the value of attribute named_routes.



13
14
15
 
# File 'lib/http_router.rb', line 13

def named_routes
  @named_routes
end

#root ⇒ Object (readonly)

Returns the value of attribute root.



13
14
15
 
# File 'lib/http_router.rb', line 13

def root
  @root
end

#routes ⇒ Object (readonly)

Returns the value of attribute routes.



13
14
15
 
# File 'lib/http_router.rb', line 13

def routes
  @routes
end

#url_mount ⇒ Object

Returns the value of attribute url_mount.



14
15
16
 
# File 'lib/http_router.rb', line 14

def url_mount
  @url_mount
end

Instance Method Details

#add(path, opts = {}, &app) ⇒ Object

Adds a path to be recognized.

To assign a part of the path to a specific variable, use :variable_name within the route. For example, add('/path/:id') would match /path/test, with the variable :id having the value "test".

You can receive mulitple parts into a single variable by using the glob syntax. For example, add('/path/*id') would match /path/123/456/789, with the variable :id having the value ["123", "456", "789"].

As well, paths can end with two optional parts, * and /?. If it ends with a *, it will match partially, returning the part of the path unmatched in the PATH_INFO value of the env. The part matched to will be returned in the SCRIPT_NAME. If it ends with /?, then a trailing / on the path will be optionally matched for that specific route. As trailing /‘s are ignored by default, you probably don’t actually want to use this option that frequently.

Routes can also contain optional parts. There are surrounded with ( )‘s. If you need to match on a bracket in the route itself, you can escape the parentheses with a backslash.

The second argument, options, is an optional hash that can modify the route in further ways. See HttpRouter::Route#with_options for details. Typically, you want to add further options to the route by calling additional methods on it. See HttpRouter::Route for further details.

Returns the route object.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/http_router.rb', line 55

def add(path, opts = {}, &app)
  route = case path
  when Regexp
    RegexRoute.new(self, path, opts)
  else
    Route.new(self, path, opts)
  end
  add_route(route)
  route.to(app) if app
  route
end

#add_route(route) ⇒ Object 



67
68
69
 
# File 'lib/http_router.rb', line 67

def add_route(route)
  @routes << route
end

#call(env, perform_call = true) ⇒ Object

Rack compatible #call. If matching route is found, and dest value responds to #call, processing will pass to the matched route. Otherwise, the default application will be called. The router will be available in the env under the key router. And parameters matched will be available under the key router.params.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/http_router.rb', line 103

def call(env, perform_call = true)
  rack_request = Rack::Request.new(env)
  if redirect_trailing_slash? && (rack_request.head? || rack_request.get?) && rack_request.path_info[-1] == ?/
    response = ::Rack::Response.new
    response.redirect(request.path_info[0, request.path_info.size - 1], 302)
    response.finish
  else
    request = Request.new(rack_request.path_info, rack_request, perform_call)
    response = catch(:success) { @root[request] }
    if !response
      supported_methods = (@known_methods - [env['REQUEST_METHOD']]).select do |m| 
        test_env = Rack::Request.new(rack_request.env.clone)
        test_env.env['REQUEST_METHOD'] = m
        test_env.env['HTTP_ROUTER_405_TESTING_ACCEPTANCE'] = true
        test_request = Request.new(test_env.path_info, test_env, 405)
        catch(:success) { @root[test_request] }
      end
      supported_methods.empty? ? @default_app.call(env) : [405, {'Allow' => supported_methods.sort.join(", ")}, []]
    elsif response
      response
    else
      @default_app.call(env)
    end
  end
end

#clone(klass = self.class) ⇒ Object

Creates a deep-copy of the router.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/http_router.rb', line 176

def clone(klass = self.class)
  cloned_router = klass.new(@options)
  @routes.each do |route|
    new_route = route.clone(cloned_router)
    cloned_router.add_route(new_route)
    new_route.name(route.named) if route.named
    begin
      new_route.to route.dest.clone
    rescue
      new_route.to route.dest
    end
  end
  cloned_router
end

#default(app) ⇒ Object

Assigns the default application.



139
140
141
 
# File 'lib/http_router.rb', line 139

def default(app)
  @default_app = app
end

#delete(path, opts = {}, &app) ⇒ Object

Adds a path that only responds to the request method DELETE.

Returns the route object.



89
 
# File 'lib/http_router.rb', line 89

def delete(path, opts = {}, &app); add_with_request_method(path, :delete, opts, &app); end

#get(path, opts = {}, &app) ⇒ Object

Adds a path that only responds to the request method GET.

Returns the route object.



74
 
# File 'lib/http_router.rb', line 74

def get(path, opts = {}, &app);    add_with_request_method(path, :get, opts, &app);    end

#head(path, opts = {}, &app) ⇒ Object

Adds a path that only responds to the request method HEAD.

Returns the route object.



84
 
# File 'lib/http_router.rb', line 84

def head(path, opts = {}, &app);   add_with_request_method(path, :head, opts, &app);   end

#ignore_trailing_slash? ⇒ Boolean

Ignore trailing slash feature enabled? See #initialize for details.

Returns:

  • (Boolean) 


166
167
168
 
# File 'lib/http_router.rb', line 166

def ignore_trailing_slash?
  @ignore_trailing_slash
end

#post(path, opts = {}, &app) ⇒ Object

Adds a path that only responds to the request method POST.

Returns the route object.



79
 
# File 'lib/http_router.rb', line 79

def post(path, opts = {}, &app);   add_with_request_method(path, :post, opts, &app);   end

#put(path, opts = {}, &app) ⇒ Object

Adds a path that only responds to the request method PUT.

Returns the route object.



94
 
# File 'lib/http_router.rb', line 94

def put(path, opts = {}, &app);    add_with_request_method(path, :put, opts, &app);    end

#recognize(env) ⇒ Object 



96
97
98
 
# File 'lib/http_router.rb', line 96

def recognize(env)
  call(env, false)
end

#redirect_trailing_slash? ⇒ Boolean

Redirect trailing slash feature enabled? See #initialize for details.

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/http_router.rb', line 171

def redirect_trailing_slash?
  @redirect_trailing_slash
end

#reset! ⇒ Object

Resets the router to a clean state.



130
131
132
133
134
135
136
 
# File 'lib/http_router.rb', line 130

def reset!
  @root = Node.new(self)
  @default_app = Proc.new{ |env| Rack::Response.new("Your request couldn't be found", 404).finish }
  @routes = []
  @named_routes = {}
  @known_methods = ['GET', "POST", "PUT", "DELETE"]
end

#url(route, *args) ⇒ Object

Generate a URL for a specified route. This will accept a list of variable values plus any other variable names named as a hash. This first value must be either the Route object or the name of the route.

Example:

router = HttpRouter.new
router.add('/:foo.:format).name(:test).compile
router.url(:test, 123, 'html')
# ==> "/123.html"
router.url(:test, 123, :format => 'html')
# ==> "/123.html"
router.url(:test, :foo => 123, :format => 'html')
# ==> "/123.html"
router.url(:test, :foo => 123, :format => 'html', :fun => 'inthesun')
# ==> "/123.html?fun=inthesun"



157
158
159
160
161
162
163
 
# File 'lib/http_router.rb', line 157

def url(route, *args)
  case route
  when Symbol then @named_routes.key?(route) ? @named_routes[route].url(*args) : raise(UngeneratableRouteException)
  when Route  then route.url(*args)
  else raise UngeneratableRouteException
  end
end