Added base middleware and prefixer middleware.

Michael Bleigh · Michael Bleigh · commit 1cd901f6ef66 · 2010-08-02T09:23:05.000-05:00
diff --git a/.rspec b/.rspec
@@ -0,0 +1,2 @@
+--color
+--format=nested
diff --git a/.rvmrc b/.rvmrc
@@ -0,0 +1 @@
+rvm use ree@rails3 --passenger
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,9 @@
+gem 'rack'
+gem 'rack-mount'
+gem 'rack-jsonp'
+
+group :test do
+  gem 'rspec', '>= 2.0.0.beta.19'
+  gem 'rack-test'
+  gem 'cucumber', '>= 0.8.5'
+end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,40 @@
+GEM
+  specs:
+    builder (2.1.2)
+    cucumber (0.8.5)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.1.4)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    diff-lcs (1.1.2)
+    gherkin (2.1.5)
+      trollop (~> 1.16.2)
+    json_pure (1.4.3)
+    rack (1.2.1)
+    rack-jsonp (1.0.0)
+    rack-mount (0.6.9)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber (>= 0.8.5)
+  rack
+  rack-jsonp
+  rack-mount
+  rack-test
+  rspec (>= 2.0.0.beta.19)
diff --git a/README.rdoc b/README.rdoc
@@ -1,17 +1,29 @@
-= grape
+= Grape
 
-Description goes here.
+Grape is a REST-like API micro-framework for Ruby. It is built to complement existing web application frameworks such as Rails and Sinatra by providing a simple DSL to easily provide APIs. It has built-in support for common conventions such as multiple formats, subdomain/prefix restriction, and versioning.
 
+    class Twitter < Grape::Base
+      # Set this API to work only on a specified subdomain
+      subdomain 'api'
+      
+      # Use a path prefix.
+      path_prefix 'api'
+      
+      version 'v2'
+      
+      version 'v1' do
+        
+      end
+    end
+    
 == Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2010 Michael Bleigh. See LICENSE for details.
+Copyright (c) 2010 Michael Bleigh and Intridea, Inc. See LICENSE for details.
diff --git a/Rakefile b/Rakefile
@@ -19,31 +19,17 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
 end
 
 task :spec => :check_dependencies
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
-
 task :default => :spec
 
 require 'rake/rdoctask'
diff --git a/autotest/discover.rb b/autotest/discover.rb
@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }
diff --git a/features/grape.feature b/features/grape.feature
diff --git a/features/step_definitions/grape_steps.rb b/features/step_definitions/grape_steps.rb
diff --git a/features/support/env.rb b/features/support/env.rb
diff --git a/lib/grape.rb b/lib/grape.rb
@@ -0,0 +1,5 @@
+require 'rack'
+require 'rack/builder'
+
+require 'grape/middleware/base'
+require 'grape/middleware/prefixer'
diff --git a/lib/grape/middleware/base.rb b/lib/grape/middleware/base.rb
@@ -0,0 +1,34 @@
+module Grape
+  module Middleware
+    class Base
+      attr_reader :app, :env, :options
+      
+      def initialize(app, options = {})
+        @app = app
+        @options = options
+      end
+      
+      def call(env)
+        dup.call!(env)
+      end
+      
+      def call!(env)
+        @env = env
+        before
+        @app_response = @app.call(@env)
+        after || @app_response
+      end
+      
+      def before; end
+      def after; end
+      
+      def request
+        Rack::Request.new(env)
+      end
+      
+      def response
+        Rack::Response.new(@app_response)
+      end
+    end
+  end
+end
diff --git a/lib/grape/middleware/prefixer.rb b/lib/grape/middleware/prefixer.rb
@@ -0,0 +1,20 @@
+require 'grape/middleware/base'
+
+module Grape
+  module Middleware
+    class Prefixer < Base
+      def prefix
+        prefix = options[:prefix] || ""
+        prefix.insert(0, '/') unless prefix.index('/') == 0
+        prefix
+      end
+      
+      def before
+        if env['PATH_INFO'].index(prefix) == 0
+          env['PATH_INFO'].gsub!(prefix, '')
+          env['PATH_INFO'].insert(0, '/') unless env['PATH_INFO'].index('/') == 0
+        end
+      end
+    end
+  end
+end
diff --git a/spec/grape/middleware/base_spec.rb b/spec/grape/middleware/base_spec.rb
@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Grape::Middleware::Base do
+  subject { Grape::Middleware::Base.new(blank_app) }  
+  let(:blank_app) { lambda{|env| [200, {}, 'Hi there.']} }
+  
+  before do
+    # Keep it one object for testing.
+    subject.stub!(:dup).and_return(subject)
+  end
+  
+  it 'should have the app as an accessor' do
+    subject.app.should == blank_app
+  end
+  
+  it 'should be able to access the request' do
+    subject.call({})
+    subject.request.should be_kind_of(Rack::Request)
+  end
+  
+  it 'should call through to the app' do
+    subject.call({}).should == [200, {}, 'Hi there.']
+  end
+  
+  context 'callbacks' do
+    it 'should call #before' do
+      subject.should_receive(:before)
+    end
+  
+    it 'should call #after' do
+      subject.should_receive(:after)
+    end
+    
+    after{ subject.call!({}) }
+  end
+  
+  it 'should be able to access the response' do
+    subject.call({})
+    subject.response.should be_kind_of(Rack::Response)
+  end
+  
+  it 'should persist options passed at initialization' do
+    Grape::Middleware::Base.new(blank_app, {:abc => true}).options[:abc].should be_true
+  end
+end
diff --git a/spec/grape/middleware/prefixer_spec.rb b/spec/grape/middleware/prefixer_spec.rb
@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Grape::Middleware::Prefixer do
+  let(:app){ lambda{|env| [200, {}, env['PATH_INFO']]} }
+  subject{ Grape::Middleware::Prefixer.new(app, @options || {}) }
+
+  it 'should lop off a prefix (without a slash)' do
+    @options = {:prefix => 'monkey'}
+    subject.call('PATH_INFO' => '/monkey/beeswax').last.should == '/beeswax'
+  end
+  
+  it 'should lop off a prefix (with a slash)' do
+    @options = {:prefix => '/banana'}
+    subject.call('PATH_INFO' => '/banana/peel').last.should == '/peel'
+  end
+  
+  it 'should not lop off non-prefixes' do
+    @options = {:prefix => '/monkey'}
+    subject.call('PATH_INFO' => '/banana/peel').last.should == '/banana/peel'
+  end
+  
+  it 'should pass through unaltered if there is no prefix' do
+    subject.call('PATH_INFO' => '/awesome').last.should == '/awesome'
+  end
+end
diff --git a/spec/grape_spec.rb b/spec/grape_spec.rb
@@ -1,7 +1 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Grape" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end
+require 'spec_helper'
diff --git a/spec/spec.opts b/spec/spec.opts
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -1,9 +1,15 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'grape'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
+require 'rubygems'
+require 'bundler'
+Bundler.setup :test
+
+require 'rspec'
+require 'rack/test'
+
+RSpec.configure do |config|
   
 end
