grape 0.0.0.alpha.2 → 0.1.0

data/spec/grape/endpoint_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Grape::Endpoint do
+  subject { Class.new(Grape::API) }
+  before { subject.default_format :txt }
+  def app; subject end
+  
+  describe '#status' do
+    it 'should be callable from within a block' do
+      subject.get('/home') do
+        status 206
+        "Hello"
+      end
+      
+      get '/home'
+      last_response.status.should == 206
+      last_response.body.should == "Hello"
+    end
+  end
+  
+  describe '#header' do
+    it 'should be callable from within a block' do
+      subject.get('/hey') do
+        header 'X-Awesome', 'true'
+        "Awesome"
+      end
+      
+      get '/hey'
+      last_response.headers['X-Awesome'].should == 'true'
+    end
+  end
+  
+  describe '#params' do
+    it 'should be available to the caller' do
+      subject.get('/hey') do
+        params[:howdy]
+      end
+      
+      get '/hey?howdy=hey'
+      last_response.body.should == 'hey'
+    end
+    
+    it 'should parse from path segments' do
+      subject.get('/hey/:id') do
+        params[:id]
+      end
+      
+      get '/hey/12'
+      last_response.body.should == '12'
+    end
+  end
+  
+  describe '#error!' do
+    it 'should accept a message' do
+      subject.get('/hey') do
+        error! "This is not valid."
+        "This is valid."
+      end
+      
+      get '/hey'
+      last_response.status.should == 403
+      last_response.body.should == "This is not valid."
+    end
+    
+    it 'should accept a code' do
+      subject.get('/hey') do
+        error! "Unauthorized.", 401
+      end
+      
+      get '/hey'
+      last_response.status.should == 401
+      last_response.body.should == "Unauthorized."
+    end
+  end
+end

data/spec/grape/middleware/auth/basic_spec.rb

@@ -0,0 +1,31 @@
+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
+  
+  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_basic('admin','admin')
+    last_response.status.should == 200
+  end
+  
+  it 'should throw a 401 is wrong auth is given' do
+    get '/whatever', {}, 'HTTP_AUTHORIZATION' => encode_basic('admin','wrong')
+    last_response.status.should == 401
+  end
+end

data/spec/grape/middleware/formatter_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Formatter do
-  subject{ Grape::Middleware::Formatter.new(app)}
+  subject{ Grape::Middleware::Formatter.new(app, :default_format => :json)}
   before{ subject.stub!(:dup).and_return(subject) }
   
   let(:app){ lambda{|env| [200, {}, [@body]]} }
@@ -10,7 +10,30 @@ describe Grape::Middleware::Formatter do
     it 'should look at the bodies for possibly serializable data' do
       @body = {"abc" => "def"}
       status, headers, bodies = *subject.call({'PATH_INFO' => '/somewhere'})
-      bodies.first.should == ActiveSupport::JSON.encode(@body)
+      bodies.each{|b| b.should == MultiJson.encode(@body) }
+    end
+    
+    it 'should call #to_json first if it is available' do
+      @body = "string"
+      @body.instance_eval do
+        def to_json
+          "\"bar\""
+        end
+      end
+      
+      subject.call({'PATH_INFO' => '/somewhere'}).last.each{|b| b.should == '"bar"'}
+    end
+    
+    it 'should serialize the #serializable_hash if that is available' do
+      class SimpleExample
+        def serializable_hash
+          {:abc => 'def'}
+        end
+      end
+      
+      @body = SimpleExample.new
+      
+      subject.call({'PATH_INFO' => '/somewhere'}).last.each{|b| b.should == '{"abc":"def"}'}
     end
   end
   
@@ -32,4 +55,33 @@ describe Grape::Middleware::Formatter do
       err.should == {:status => 406, :message => "The requested format is not supported."}
     end
   end
+  
+  context 'Accept header detection' do
+    it 'should detect from the Accept header' do
+      subject.call({'PATH_INFO' => '/info', 'Accept' => 'application/xml'})
+      subject.env['api.format'].should == :xml
+    end
+    
+    it 'should look for case-indifferent headers' do
+      subject.call({'PATH_INFO' => '/info', 'accept' => 'application/xml'})
+      subject.env['api.format'].should == :xml
+    end
+    
+    it 'should use quality rankings to determine formats' do
+      subject.call({'PATH_INFO' => '/info', 'Accept' => 'application/json; q=0.3,application/xml; q=1.0'})
+      subject.env['api.format'].should == :xml
+      subject.call({'PATH_INFO' => '/info', 'Accept' => 'application/json; q=1.0,application/xml; q=0.3'})
+      subject.env['api.format'].should == :json
+    end
+    
+    it 'should handle quality rankings mixed with nothing' do
+      subject.call({'PATH_INFO' => '/info', 'Accept' => 'application/json,application/xml; q=1.0'})
+      subject.env['api.format'].should == :xml
+    end
+    
+    it 'should properly parse headers with other attributes' do
+      subject.call({'PATH_INFO' => '/info', 'Accept' => 'application/json; abc=2.3; q=1.0,application/xml; q=0.7'})
+      subject.env['api.format'].should == :json
+    end
+  end
 end

data/spec/grape/middleware/prefixer_spec.rb

@@ -22,4 +22,9 @@ describe Grape::Middleware::Prefixer do
   it 'should pass through unaltered if there is no prefix' do
     subject.call('PATH_INFO' => '/awesome').last.should == '/awesome'
   end
+  
+  it 'should only remove the first instance of the prefix' do
+    @options = {:prefix => 'api'}
+    subject.call('PATH_INFO' => '/api/v1/api/awesome').last.should == '/v1/api/awesome'
+  end
 end

data/spec/grape/middleware/versioner_spec.rb

@@ -26,4 +26,15 @@ describe Grape::Middleware::Versioner do
       subject.call('PATH_INFO' => '/awesome/radical').last.should be_nil
     end
   end
+  
+  context 'with specified versions' do
+    before{ @options = {:versions => ['v1', 'v2']}}
+    it 'should throw an error if a non-allowed version is specified' do
+      catch(:error){subject.call('PATH_INFO' => '/v3/awesome')}[:status].should == 404
+    end
+    
+    it 'should allow versions that have been specified' do
+      subject.call('PATH_INFO' => '/v1/asoasd').last.should == 'v1'
+    end
+  end
 end

data/spec/grape/middleware_stack_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Grape::MiddlewareStack do
+  subject { Grape::MiddlewareStack.new }
+  
+  it 'should be able to add middlewares' do
+    subject.use Grape::Middleware::Error
+    subject.stack.first.should == [Grape::Middleware::Error]
+  end
+  
+  context 'class uniqueness' do
+    it 'should not increase the stack size when doubling up on a use' do
+      2.times{ subject.use Grape::Middleware::Error }
+      subject.stack.size.should == 1
+    end
+    
+    it 'should increase the stack size when a novel class is added' do
+      subject.use Grape::Middleware::Error
+      subject.use Grape::Middleware::Prefixer
+      subject.use Grape::Middleware::Error
+      subject.stack.should == [[Grape::Middleware::Error], [Grape::Middleware::Prefixer]]
+    end
+  end
+  
+  describe '#run' do
+    class ExampleMiddleware
+      def initialize(app, say = 'what')
+        @app = app
+        @say = say
+      end
+
+      def call(env)
+        (env['say'] ||= []) << @say
+        @app.call(env)
+      end
+    end
+    
+    before do
+      subject.use ExampleMiddleware
+      subject.use ExampleMiddleware, 'yo'
+    end
+    
+    it 'should call the middlewares in the stack' do
+      subject.to_app(lambda{|env| env['say'].should == ['yo']}).call({})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,6 +10,11 @@ Bundler.setup :default, :test
 require 'rspec'
 require 'rack/test'
 
+require 'base64'
+def encode_basic(username, password)
+  "Basic " + Base64.encode64("#{username}:#{password}")
+end
+
 RSpec.configure do |config|
   config.include Rack::Test::Methods
 end

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grape
 version: !ruby/object:Gem::Version 
-  hash: -3702664360
-  prerelease: true
+  hash: 27
+  prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  - alpha
-  - 2
-  version: 0.0.0.alpha.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -17,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 -05:00
+date: 2010-11-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,12 +39,14 @@ dependencies:
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 29
         segments: 
         - 0
-        version: "0"
+        - 6
+        - 13
+        version: 0.6.13
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -65,23 +65,21 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-  name: activesupport
+  name: json
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
-        - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "0"
   requirement: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
-  name: rake
+  type: :runtime
+  name: multi_json
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -94,8 +92,8 @@ dependencies:
   requirement: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
-  name: jeweler
+  type: :runtime
+  name: multi_xml
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -106,6 +104,34 @@ dependencies:
         - 0
         version: "0"
   requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
 description: A Ruby framework for rapid API development with great conventions.
 email: michael@intridea.com
 executables: []
@@ -129,18 +155,26 @@ files:
 - autotest/discover.rb
 - grape.gemspec
 - lib/grape.rb
+- lib/grape/api.rb
+- lib/grape/endpoint.rb
+- lib/grape/middleware/auth/basic.rb
 - lib/grape/middleware/auth/oauth2.rb
 - lib/grape/middleware/base.rb
 - lib/grape/middleware/error.rb
 - lib/grape/middleware/formatter.rb
 - lib/grape/middleware/prefixer.rb
 - lib/grape/middleware/versioner.rb
+- lib/grape/middleware_stack.rb
+- spec/grape/api_spec.rb
+- spec/grape/endpoint_spec.rb
+- spec/grape/middleware/auth/basic_spec.rb
 - spec/grape/middleware/auth/oauth2_spec.rb
 - spec/grape/middleware/base_spec.rb
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner_spec.rb
+- spec/grape/middleware_stack_spec.rb
 - spec/grape_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -164,14 +198,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -180,11 +212,15 @@ signing_key:
 specification_version: 3
 summary: A Ruby framework for rapid API development.
 test_files: 
+- spec/grape/api_spec.rb
+- spec/grape/endpoint_spec.rb
+- spec/grape/middleware/auth/basic_spec.rb
 - spec/grape/middleware/auth/oauth2_spec.rb
 - spec/grape/middleware/base_spec.rb
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner_spec.rb
+- spec/grape/middleware_stack_spec.rb
 - spec/grape_spec.rb
 - spec/spec_helper.rb