Storing additional information.

Author: dblock

README.markdown

@@ -85,7 +85,7 @@ you simply use the `rescue_from` method inside your API declaration:
 
 ## Inspecting an API
 
-Grape exposes arrays of API versions and compiled routes. Each route contains a prefix, version, namespace, method and path.
+Grape exposes arrays of API versions and compiled routes. Each route contains a `route_prefix`, `route_version`, `route_namespace`, `route_method`, `route_path` and `route_params`.
 
     class TwitterAPI < Grape::API      
 
@@ -107,16 +107,16 @@ Grape exposes arrays of API versions and compiled routes. Each route contains a
     TwitterAPI::routes # yields an array of Grape::Route objects
     TwitterAPI::routes[0].route_version # yields 'v1'
 
-Grape also supports storing additional options with the route information. This can be useful for generating documentation. 
-The optional hash that follows the API path may contain any number of keys and values are accessible via `route_[name]`.
+Grape also supports storing additional parameters with the route information. This can be useful for generating documentation. The optional hash that follows the API path may contain any number of keys and its values are also accessible via a dynamically-generated `route_[name]` function.
 
-    class StringAPI < Grape::API      
-      get :split, { :params => [ :string, :token ] } do 
-        params[:string].split(params[:token])
+    class StringAPI < Grape::API
+      get "split/:string", { :params => [ "token" ], :optional_params => [ "limit" ] } do 
+        params[:string].split(params[:token], (params[:limit] || 0))
       end
     end
 
-    StringAPI::routes[0].route_params # yields an array [ :string, :token ]
+    StringAPI::routes[0].route_params # yields an array [ "string", "token" ]
+    StringAPI::routes[0].route_optional_params # yields an array [ "limit" ]
 
 ## Note on Patches/Pull Requests
 

lib/grape/api.rb

@@ -193,20 +193,24 @@ def route(methods, paths = ['/'], route_options = {}, &block)
         endpoint_options = {}
         endpoint_options[:version] = /#{version.join('|')}/ if version
 
+        route_options ||= {}
+        
         methods.each do |method|
           paths.each do |path|
 
             compiled_path = compile_path(path)
             path = Rack::Mount::Strexp.compile(compiled_path, endpoint_options, %w( / . ? ), true)
+            path_params = path.named_captures.map { |nc| nc[0] } - [ 'version', 'format' ]
+            path_params |= (route_options[:params] || [])            
             request_method = (method.to_s.upcase unless method == :any)
 
-            routes << Route.new({
+            routes << Route.new(route_options.merge({
               :prefix => prefix, 
               :version => version ? version.join('|') : nil, 
               :namespace => namespace, 
               :method => request_method, 
-              :path => compiled_path}
-              .merge(route_options || {}))
+              :path => compiled_path,
+              :params => path_params}))
 
             route_set.add_route(endpoint, 
               :path_info => path, 

spec/grape/api_spec.rb

@@ -674,17 +674,22 @@ class TwitterAPI < Grape::API
     end
     describe "api structure with additional parameters" do
       before(:each) do
-        subject.get :split, { :params => [ :string, :token ] } do 
-          params[:string].split(params[:token])
+        subject.get 'split/:string', { :params => [ "token" ], :optional_params => [ "limit" ] } do 
+          params[:string].split(params[:token], (params[:limit] || 0).to_i)
         end
       end
       it "should split a string" do
-        get "/split", :string => "a,b,c", :token => ','
+        get "/split/a,b,c", :token => ','
         last_response.body.should == '["a", "b", "c"]'
       end
+      it "should split a string with limit" do
+        get "/split/a,b,c", :token => ',', :limit => '2'
+        last_response.body.should == '["a", "b,c"]'
+      end
       it "should set route_params" do
         subject.routes.size.should == 1
-        subject.routes[0].route_params.should == [ :string, :token ]
+        subject.routes[0].route_params.should == [ "string", "token" ]
+        subject.routes[0].route_optional_params.should == [ "limit" ]
       end
     end
   end