Merge pull request ruby-grape#126 from dblock/frontier-route

Frontier: added access to `route` from within an API

Author: Michael Bleigh

README.markdown

@@ -278,7 +278,7 @@ class TwitterAPI < Grape::API
     api.version
   end
 
-  desc "Reverses a string.", { :params =>  
+  desc "Reverses a string.", { :params =>
     { "s" => { :desc => "string to reverse", :type => "string" }}
   }
   get "reverse" do
@@ -313,6 +313,17 @@ StringAPI::routes[0].route_params # yields an array [ "string", "token" ]
 StringAPI::routes[0].route_optional_params # yields an array [ "limit" ]
 ```
 
+It's possible to retrieve the information about the current route from within an API call with `route`.
+
+```ruby
+class MyAPI < Grape::API
+  desc "Returns a description of a parameter.", { :params => { "id" => "a required id" } }
+  get "params/:id" do
+    route.route_params[params[:id]] # returns "a required id"
+  end
+end
+```
+
 ## Anchoring
 
 Grape by default anchors all request paths, which means that the request URL

lib/grape/endpoint.rb

@@ -35,10 +35,10 @@ def mount_in(route_set)
         options[:app].endpoints.each{|e| e.mount_in(route_set)}
       else
         routes.each do |route|
-          route_set.add_route(self,
+          route_set.add_route(self, {
             :path_info => route.route_compiled,
-            :request_method => route.route_method
-          )
+            :request_method => route.route_method,
+          }, { :route_info => route })
         end
       end
     end
@@ -210,6 +210,18 @@ def present(object, options = {})
       representation = { root => representation } if root
       body representation
     end
+    
+    # Returns route information for the current request.
+    #
+    # @example
+    #
+    #   desc "Returns the route description."
+    #   get '/' do
+    #     route.route_description
+    #   end
+    def route
+      env["rack.routing_args"][:route_info]
+    end
 
     protected
 

lib/grape/route.rb

@@ -16,7 +16,7 @@ def method_missing(method_id, *arguments)
     end
 
     def to_s
-      "Version: #{route_version} #{route_method} #{route_path}"
+      "version=#{route_version}, method=#{route_method}, path=#{route_path}"
     end
 
   end

spec/grape/api_spec.rb

@@ -1017,4 +1017,43 @@ class CommunicationError < RuntimeError; end
       subject.instance.should be_nil
     end
   end
+  
+  describe ".route" do
+    context "plain" do
+      before(:each) do
+        subject.get '/' do
+          route.route_path
+        end
+        subject.get '/path' do
+          route.route_path
+        end
+      end
+      it 'should provide access to route info' do
+        get '/'
+        last_response.body.should == "/(.:format)"
+        get '/path'
+        last_response.body.should == "/path(.:format)"
+      end
+    end
+    context "with desc" do    
+      before(:each) do
+        subject.desc 'returns description'
+        subject.get '/description' do
+          route.route_description
+        end
+        subject.desc 'returns parameters', { :params => { "x" => "y" }}
+        subject.get '/params/:id' do
+          route.route_params[params[:id]]
+        end
+      end
+      it 'should return route description' do
+        get '/description'
+        last_response.body.should == "returns description"
+      end
+      it 'should return route parameters' do
+        get '/params/x'
+        last_response.body.should == "y"
+      end
+    end
+  end
 end