Adding namespacing and HTTP Basic authentication.

Author: Michael Bleigh

README.rdoc

@@ -30,6 +30,9 @@ Grape is a REST-like API micro-framework for Ruby. It is built to complement exi
       end
     end
 
+    # Rack endpoint
+    Twitter::API.statuses.timelines.get(:public_timeline)
+    
     class Twitter::API::User < Grape::Resource::ActiveRecord
       represents ::User
 

lib/grape/api.rb

@@ -22,6 +22,10 @@ def settings
         @settings.inject({}){|f,h| f.merge!(h); f}
       end
 
+      def settings_stack
+        @settings
+      end
+      
       def set(key, value)
         @settings.last[key.to_sym] = value
       end
@@ -52,6 +56,7 @@ def compile_path(path)
         parts = []
         parts << prefix if prefix
         parts << version if version
+        parts << namespace if namespace
         parts << path
         Rack::Mount::Utils.normalize_path(parts.join('/'))
       end
@@ -61,18 +66,35 @@ def route(method, path_info, &block)
       end
 
       def build_endpoint(&block)
-        builder = Rack::Builder.new
-        builder.use Grape::Middleware::Error
-        builder.use Grape::Middleware::Prefixer, :prefix => prefix if prefix        
-        builder.use Grape::Middleware::Versioner if version
-        builder.use Grape::Middleware::Formatter, :default_format => default_format || :json
-        builder.run Grape::Endpoint.new(&block)
-        builder.to_app
+        b = Rack::Builder.new
+        b.use Grape::Middleware::Error
+        b.use Grape::Middleware::Prefixer, :prefix => prefix if prefix        
+        b.use Grape::Middleware::Versioner if version
+        b.use Grape::Middleware::Formatter, :default_format => default_format || :json
+        b.run Grape::Endpoint.new(&block)
+        b.to_app
       end
 
       def get(path_info, &block); route('GET', path_info, &block) end
       def post(path_info, &block); route('POST', path_info, &block) end
       def put(path_info, &block); route('PUT', path_info, &block) end
+      def head(path_info, &block); route('HEAD', path_info, &block) end
+      def delete(path_info, &block); route('DELETE', path_info, &block) end
+      
+      def namespace(space = nil, &block)
+        if space
+          settings_stack << {}
+          set(:namespace, space.to_s)
+          instance_eval &block
+          settings_stack.pop
+        else
+          Rack::Mount::Utils.normalize_path(settings_stack.map{|s| s[:namespace]}.join('/'))
+        end
+      end
+      
+      alias_method :group, :namespace
+      alias_method :resource, :namespace
+      alias_method :resources, :namespace
 
       def inherited(subclass)
         subclass.reset!

lib/grape/middleware/auth/basic.rb

@@ -0,0 +1,30 @@
+require 'rack/auth/basic'
+
+module Grape
+  module Middleware
+    module Auth
+      class Basic < Grape::Middleware::Base
+        attr_reader :authenticator
+        
+        def initialize(app, options = {}, &authenticator)
+          super(app, options)
+          @authenticator = authenticator
+        end
+        
+        def basic_request
+          Rack::Auth::Basic::Request.new(env)
+        end
+        
+        def credentials
+          basic_request.provided?? basic_request.credentials : [nil, nil]
+        end
+        
+        def before
+          unless authenticator.call(*credentials)
+            throw :error, :status => 401, :message => "API Authorization Failed."
+          end
+        end
+      end
+    end
+  end
+end

spec/grape/api_spec.rb

@@ -43,4 +43,47 @@ def app; subject end
       last_response.body.should == "Version: v1"
     end
   end
+  
+  describe '.namespace' do
+    it 'should be retrievable and converted to a path' do
+      subject.namespace :awesome do
+        namespace.should == '/awesome'
+      end
+    end
+    
+    it 'should come after the prefix and version' do
+      subject.prefix :rad
+      subject.version :v1
+      
+      subject.namespace :awesome do
+        compile_path('hello').should == '/rad/v1/awesome/hello'
+      end
+    end
+    
+    it 'should cancel itself after the block is over' do
+      subject.namespace :awesome do
+        namespace.should == '/awesome'
+      end
+      
+      subject.namespace.should == '/'
+    end
+    
+    it 'should be stackable' do
+      subject.namespace :awesome do
+        namespace :rad do
+          namespace.should == '/awesome/rad'
+        end
+        namespace.should == '/awesome'
+      end
+      subject.namespace.should == '/'
+    end
+    
+    %w(group resource resources).each do |als|
+      it "`.#{als}` should be an alias" do
+        subject.send(als, :awesome) do
+          namespace.should == "/awesome"
+        end
+      end
+    end
+  end
 end

spec/grape/middleware/auth/basic_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+require 'base64'
+
+describe Grape::Middleware::Auth::Basic do
+  def app
+    Rack::Builder.new do |b|
+      b.use Grape::Middleware::Error
+      b.use(Grape::Middleware::Auth::Basic) do |u,p| 
+        u && p && u == p
+      end
+      b.run lambda{|env| [200, {}, "Hello there."]}
+    end
+  end
+  
+  def encode(username, password)
+    "Basic " + Base64.encode64("#{username}:#{password}")
+  end
+  
+  it 'should throw a 401 if no auth is given' do
+    @proc = lambda{ false }
+    get '/whatever'
+    last_response.status.should == 401
+  end
+  
+  it 'should authenticate if given valid creds' do
+    get '/whatever', {}, 'HTTP_AUTHORIZATION' => encode('admin','admin')
+    last_response.status.should == 200
+  end
+  
+  it 'should throw a 401 is wrong auth is given' do
+    get '/whatever', {}, 'HTTP_AUTHORIZATION' => encode('admin','wrong')
+    last_response.status.should == 401
+  end
+end