Merge pull request ruby-grape#93 from dblock/frontier-routes-2

frontier: restored api routes functionality

Author: Michael Bleigh

lib/grape/api.rb

@@ -324,7 +324,7 @@ def middleware
 
       # An array of API routes.
       def routes
-        @routes ||= []
+        @routes ||= prepare_routes
       end
 
       def versions
@@ -333,6 +333,14 @@ def versions
 
       protected
 
+      def prepare_routes
+        routes = []
+        endpoints.each do |endpoint|
+          routes.concat(endpoint.routes)
+        end
+        routes
+      end
+
       # Execute first the provided block, then each of the
       # block passed in. Allows for simple 'before' setups
       # of settings stack pushes.
@@ -364,7 +372,6 @@ def initialize
       self.class.endpoints.each do |endpoint|
         endpoint.mount_in(@route_set)
       end
-
       @route_set.freeze
     end
 

lib/grape/endpoint.rb

@@ -25,36 +25,47 @@ def initialize(settings, options = {}, &block)
 
       options[:route_options] ||= {}
     end
+    
+    def routes
+      @routes ||= prepare_routes
+    end
 
     def mount_in(route_set)
       if options[:app] && options[:app].respond_to?(:endpoints)
         options[:app].endpoints.each{|e| e.mount_in(route_set)}
       else
-        options[:method].each do |method|
-          options[:path].each do |path|
-            prepared_path = prepare_path(path)
-            path = compile_path(prepared_path, !options[:app])
-            regex = Rack::Mount::RegexpWithNamedGroups.new(path)
-            path_params = regex.named_captures.map { |nc| nc[0] } - [ 'version', 'format' ]
-            path_params |= (options[:route_options][:params] || [])
-            request_method = (method.to_s.upcase unless method == :any)
-
-            # routes << Route.new(route_options.merge({
-            #   :prefix => prefix,
-            #   :version => settings[:version] ? settings[:version].join('|') : nil,
-            #   :namespace => namespace,
-            #   :method => request_method,
-            #   :path => prepared_path,
-            #   :params => path_params})
-            # )
-
-            route_set.add_route(self,
-              :path_info => path,
-              :request_method => request_method
-            )
-          end
+        routes.each do |route|
+          route_set.add_route(self,
+            :path_info => route.route_compiled,
+            :request_method => route.route_method
+          )
+        end
+      end
+    end
+    
+    def prepare_routes
+      routes = []
+      options[:method].each do |method|
+        options[:path].each do |path|
+          prepared_path = prepare_path(path)
+          path = compile_path(prepared_path, !options[:app])
+          regex = Rack::Mount::RegexpWithNamedGroups.new(path)
+          path_params = regex.named_captures.map { |nc| nc[0] } - [ 'version', 'format' ]
+          path_params |= (options[:route_options][:params] || [])
+          request_method = (method.to_s.upcase unless method == :any)
+          routes << Route.new(options[:route_options].clone.merge({
+            :prefix => settings[:root_prefix],
+            :version => settings[:version] ? settings[:version].join('|') : nil,
+            :namespace => namespace,
+            :method => request_method,
+            :path => prepared_path,
+            :params => path_params,
+            :compiled => path,
+            })
+          )
         end
       end
+      routes
     end
 
     def prepare_path(path)

spec/grape/api_spec.rb

@@ -699,84 +699,84 @@ def hello
     end
   end
 
-  # context "routes" do
-  #   describe "empty api structure" do
-  #     it "returns an empty array of routes" do
-  #       subject.routes.should == []
-  #     end
-  #   end
-  #   describe "single method api structure" do
-  #     before(:each) do
-  #       subject.get :ping do
-  #         'pong'
-  #       end
-  #     end
-  #     it "returns one route" do
-  #       subject.routes.size.should == 1
-  #       route = subject.routes[0]
-  #       route.route_version.should be_nil
-  #       route.route_path.should == "/ping(.:format)"
-  #       route.route_method.should == "GET"
-  #     end
-  #   end
-  #   describe "api structure with two versions and a namespace" do
-  #     class TwitterAPI < Grape::API
-  #       # version v1
-  #       version 'v1', :using => :path
-  #       get "version" do
-  #         api.version
-  #       end
-  #       # version v2
-  #       version 'v2', :using => :path
-  #       prefix 'p'
-  #       namespace "n1" do
-  #         namespace "n2" do
-  #           get "version" do
-  #             api.version
-  #           end
-  #         end
-  #       end
-  #     end
-  #     it "should return versions" do
-  #       TwitterAPI::versions.should == [ 'v1', 'v2' ]
-  #     end
-  #     it "should set route paths" do
-  #       TwitterAPI::routes.size.should >= 2
-  #       TwitterAPI::routes[0].route_path.should == "/:version/version(.:format)"
-  #       TwitterAPI::routes[1].route_path.should == "/p/:version/n1/n2/version(.:format)"
-  #     end
-  #     it "should set route versions" do
-  #       TwitterAPI::routes[0].route_version.should == 'v1'
-  #       TwitterAPI::routes[1].route_version.should == 'v2'
-  #     end
-  #     it "should set a nested namespace" do
-  #       TwitterAPI::routes[1].route_namespace.should == "/n1/n2"
-  #     end
-  #     it "should set prefix" do
-  #       TwitterAPI::routes[1].route_prefix.should == 'p'
-  #     end
-  #   end
-  #   describe "api structure with additional parameters" do
-  #     before(:each) do
-  #       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/a,b,c.json", :token => ','
-  #       last_response.body.should == '["a","b","c"]'
-  #     end
-  #     it "should split a string with limit" do
-  #       get "/split/a,b,c.json", :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_optional_params.should == [ "limit" ]
-  #     end
-  #   end
-  # end
+  context "routes" do
+    describe "empty api structure" do
+      it "returns an empty array of routes" do
+        subject.routes.should == []
+      end
+    end
+    describe "single method api structure" do
+      before(:each) do
+        subject.get :ping do
+           'pong'
+        end
+      end
+      it "returns one route" do
+         subject.routes.size.should == 1
+         route = subject.routes[0]
+         route.route_version.should be_nil
+         route.route_path.should == "/ping(.:format)"
+         route.route_method.should == "GET"
+      end
+    end
+    describe "api structure with two versions and a namespace" do
+      class TwitterAPI < Grape::API
+        # version v1
+        version 'v1', :using => :path
+        get "version" do
+           api.version
+        end
+        # version v2
+        version 'v2', :using => :path
+        prefix 'p'
+        namespace "n1" do
+          namespace "n2" do
+            get "version" do
+               api.version
+            end
+          end
+        end
+      end
+      it "should return versions" do
+         TwitterAPI::versions.should == [ 'v1', 'v2' ]
+      end
+      it "should set route paths" do
+         TwitterAPI::routes.size.should >= 2
+         TwitterAPI::routes[0].route_path.should == "/:version/version(.:format)"
+         TwitterAPI::routes[1].route_path.should == "/p/:version/n1/n2/version(.:format)"
+      end
+      it "should set route versions" do
+         TwitterAPI::routes[0].route_version.should == 'v1'
+         TwitterAPI::routes[1].route_version.should == 'v2'
+      end
+      it "should set a nested namespace" do
+         TwitterAPI::routes[1].route_namespace.should == "/n1/n2"
+      end
+      it "should set prefix" do
+         TwitterAPI::routes[1].route_prefix.should == 'p'
+      end
+    end
+    describe "api structure with additional parameters" do
+      before(:each) do
+        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/a,b,c.json", :token => ','
+         last_response.body.should == '["a","b","c"]'
+      end
+      it "should split a string with limit" do
+         get "/split/a,b,c.json", :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_optional_params.should == [ "limit" ]
+      end
+    end
+  end
 
   describe ".rescue_from klass, block" do
     it 'should rescue Exception' do