grape 0.2.2 → 0.2.3

data/spec/grape/endpoint_spec.rb

@@ -293,7 +293,7 @@ describe Grape::Endpoint do
       last_response.body.should == '{"dude":"rad"}'
     end
   end
-  
+
   describe "#redirect" do
     it "should redirect to a url with status 302" do
       subject.get('/hey') do
@@ -354,6 +354,32 @@ describe Grape::Endpoint do
     last_response.body.should == 'yo'
   end
 
+  it 'should allow explicit return calls' do
+    subject.get('/home') do
+      return "Hello"
+    end
+
+    get '/home'
+    last_response.status.should == 200
+    last_response.body.should == "Hello"
+  end
+
+  describe ".generate_api_method" do
+    it "should raise NameError if the method name is already in use" do
+      expect {
+        Grape::Endpoint.generate_api_method("version", &proc{})
+      }.to raise_error(NameError)
+    end
+    it "should raise ArgumentError if a block is not given" do
+      expect {
+        Grape::Endpoint.generate_api_method("GET without a block method")
+      }.to raise_error(ArgumentError)
+    end
+    it "should return a Proc" do
+      Grape::Endpoint.generate_api_method("GET test for a proc", &proc{}).should be_a Proc
+    end
+  end
+
   describe '#present' do
     it 'should just set the object as the body if no options are provided' do
       subject.get '/example' do

data/spec/grape/entity_spec.rb

@@ -26,7 +26,7 @@ describe Grape::Entity do
         end
 
         it 'should make sure that :format_with as a proc can not be used with a block' do
-          expect { subject.expose :name, :format_with => Proc.new {} do |object,options| end }.to raise_error(ArgumentError)
+          expect { subject.expose :name, :format_with => Proc.new {} do |_| end }.to raise_error(ArgumentError)
         end
       end
 
@@ -38,7 +38,7 @@ describe Grape::Entity do
         end
 
         it 'should set the :proc option in the exposure options' do
-          block = lambda{|obj,opts| true }
+          block = lambda{|_| true }
           subject.expose :name, &block
           subject.exposures[:name][:proc].should == block
         end
@@ -60,10 +60,10 @@ describe Grape::Entity do
           child_class.exposures.should eq(subject.exposures)
         end
 
-        it 'should return descendant exposures as a priotity' do
+        it 'should return descendant exposures as a priority' do
           subject.expose :name, :email
           child_class = Class.new(subject)
-          child_class.expose :name do |n|
+          child_class.expose :name do |_|
             'foo'
           end
 
@@ -263,48 +263,48 @@ describe Grape::Entity do
       end
 
       it 'should not throw an exception when an attribute is not found on the object' do
-        fresh_class.expose :name, :non_existant_attribute
+        fresh_class.expose :name, :nonexistent_attribute
         expect{ fresh_class.new(model).serializable_hash }.not_to raise_error
       end
 
       it "should not expose attributes that don't exist on the object" do
-        fresh_class.expose :email, :non_existant_attribute, :name
+        fresh_class.expose :email, :nonexistent_attribute, :name
 
         res = fresh_class.new(model).serializable_hash
         res.should have_key :email
-        res.should_not have_key :non_existant_attribute
+        res.should_not have_key :nonexistent_attribute
         res.should have_key :name
       end
 
       it "should not expose attributes that don't exist on the object, even with criteria" do
         fresh_class.expose :email
-        fresh_class.expose :non_existant_attribute, :if => lambda { false }
-        fresh_class.expose :non_existant_attribute2, :if => lambda { true }
+        fresh_class.expose :nonexistent_attribute, :if => lambda { false }
+        fresh_class.expose :nonexistent_attribute2, :if => lambda { true }
 
         res = fresh_class.new(model).serializable_hash
         res.should have_key :email
-        res.should_not have_key :non_existant_attribute
-        res.should_not have_key :non_existant_attribute2
+        res.should_not have_key :nonexistent_attribute
+        res.should_not have_key :nonexistent_attribute2
       end
 
       it "should expose attributes that don't exist on the object only when they are generated by a block" do
-        fresh_class.expose :non_existant_attribute do |model, options|
+        fresh_class.expose :nonexistent_attribute do |model, _|
           "well, I do exist after all"
         end
         res = fresh_class.new(model).serializable_hash
-        res.should have_key :non_existant_attribute
+        res.should have_key :nonexistent_attribute
       end
 
       it "should not expose attributes that are generated by a block but have not passed criteria" do
-        fresh_class.expose :non_existant_attribute, :proc => lambda {|model, options|
+        fresh_class.expose :nonexistent_attribute, :proc => lambda {|model, _|
           "I exist, but it is not yet my time to shine"
-        }, :if => lambda { |model, options| false }
+        }, :if => lambda { |model, _| false }
         res = fresh_class.new(model).serializable_hash
-        res.should_not have_key :non_existant_attribute
+        res.should_not have_key :nonexistent_attribute
       end
-      
+
       context "#serializable_hash" do
-      
+
         module EntitySpec
           class EmbeddedExample
             def serializable_hash(opts = {})
@@ -350,7 +350,7 @@ describe Grape::Entity do
         fresh_class.class_eval do
           expose :name, :email
           expose :friends, :using => self
-          expose :computed do |object, options|
+          expose :computed do |_, options|
             options[:awesome]
           end
 
@@ -503,7 +503,7 @@ describe Grape::Entity do
       end
 
       it 'should only pass through proc :if exposure if it returns truthy value' do
-        exposure_options = {:if => lambda{|obj,opts| opts[:true]}}
+        exposure_options = {:if => lambda{|_,opts| opts[:true]}}
 
         subject.send(:conditions_met?, exposure_options, :true => false).should be_false
         subject.send(:conditions_met?, exposure_options, :true => true).should be_true
@@ -521,7 +521,7 @@ describe Grape::Entity do
       end
 
       it 'should only pass through proc :unless exposure if it returns falsy value' do
-        exposure_options = {:unless => lambda{|object,options| options[:true] == true}}
+        exposure_options = {:unless => lambda{|_,options| options[:true] == true}}
 
         subject.send(:conditions_met?, exposure_options, :true => false).should be_true
         subject.send(:conditions_met?, exposure_options, :true => true).should be_false

data/spec/grape/middleware/base_spec.rb

@@ -1,63 +1,63 @@
 require 'spec_helper'
 
 describe Grape::Middleware::Base do
-  subject { Grape::Middleware::Base.new(blank_app) }  
-  let(:blank_app) { lambda{|env| [200, {}, 'Hi there.']} }
-  
+  subject { Grape::Middleware::Base.new(  blank_app) }
+  let(:blank_app) { lambda{|_| [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
-  
+
   context 'options' do
     it 'should persist options passed at initialization' do
       Grape::Middleware::Base.new(blank_app, {:abc => true}).options[:abc].should be_true
     end
-    
+
     context 'defaults' do
       class ExampleWare < Grape::Middleware::Base
         def default_options
           {:monkey => true}
         end
       end
-      
+
       it 'should persist the default options' do
         ExampleWare.new(blank_app).options[:monkey].should be_true
       end
-      
+
       it 'should override default options when provided' do
         ExampleWare.new(blank_app, :monkey => false).options[:monkey].should be_false
       end
     end
   end
-end
+end

data/spec/grape/middleware/exception_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
+require 'active_support/core_ext/hash'
 
 describe Grape::Middleware::Error do
-  
+
   # raises a text exception
   class ExceptionApp
     class << self
@@ -10,7 +11,7 @@ describe Grape::Middleware::Error do
       end
     end
   end
-  
+
   # raises a hash error
   class ErrorHashApp
     class << self
@@ -22,9 +23,9 @@ describe Grape::Middleware::Error do
       end
     end
   end
-  
+
   # raises an error!
-  class AccessDeniedApp    
+  class AccessDeniedApp
     class << self
       def error!(message, status=403)
         throw :error, :message => message, :status => status
@@ -44,11 +45,11 @@ describe Grape::Middleware::Error do
       end
     end
   end
-  
+
   def app
     @app
   end
- 
+
   it 'should not trap errors by default' do
     @app ||= Rack::Builder.app do
       use Grape::Middleware::Error
@@ -84,7 +85,7 @@ describe Grape::Middleware::Error do
       get '/'
       last_response.status.should == 500
     end
-       
+
     it 'should be possible to return errors in json format' do
       @app ||= Rack::Builder.app do
         use Grape::Middleware::Error, :rescue_all => true, :format => :json
@@ -104,28 +105,49 @@ describe Grape::Middleware::Error do
        '{"detail":"missing widget","error":"rain!"}'].should be_include(last_response.body)
     end
 
+    it 'should be possible to return errors in xml format' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true, :format => :xml
+        run ExceptionApp
+      end
+      get '/'
+      last_response.body.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <message>rain!</message>\n</error>\n"
+    end
+
+    it 'should be possible to return hash errors in xml format' do
+      @app ||= Rack::Builder.app do
+        use Grape::Middleware::Error, :rescue_all => true, :format => :xml
+        run ErrorHashApp
+      end
+      get '/'
+      ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <detail>missing widget</detail>\n  <error>rain!</error>\n</error>\n",
+       "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<error>\n  <error>rain!</error>\n  <detail>missing widget</detail>\n</error>\n"].should be_include(last_response.body)
+    end
+
     it 'should be possible to specify a custom formatter' do
       @app ||= Rack::Builder.app do
-        use Grape::Middleware::Error, 
+        use Grape::Middleware::Error,
           :rescue_all => true,
-          :format => :custom, 
-          :formatters => { 
-            :custom => lambda { |message, backtrace| { :custom_formatter => message }.inspect }  
+          :format => :custom,
+          :error_formatters => {
+            :custom => lambda { |message, backtrace, options, env|
+              { :custom_formatter => message }.inspect
+            }
           }
         run ExceptionApp
       end
       get '/'
       last_response.body.should == '{:custom_formatter=>"rain!"}'
     end
-    
+
     it 'should not trap regular error! codes' do
       @app ||= Rack::Builder.app do
         use Grape::Middleware::Error
         run AccessDeniedApp
       end
       get '/'
-      last_response.status.should == 401    
-    end 
+      last_response.status.should == 401
+    end
 
     it 'should respond to custom Grape exceptions appropriately' do
       @app ||= Rack::Builder.app do
@@ -137,6 +159,6 @@ describe Grape::Middleware::Error do
       last_response.status.should == 400
       last_response.body.should == 'failed validation'
     end
-    
-  end 
+
+  end
 end

data/spec/grape/middleware/formatter_spec.rb

@@ -13,7 +13,7 @@ describe Grape::Middleware::Formatter do
       bodies.each{|b| b.should == MultiJson.dump(@body) }
     end
 
-    it 'should call #to_json first if it is available' do
+    it 'should call #to_json since default format is json' do
       @body = ['foo']
       @body.instance_eval do
         def to_json
@@ -24,42 +24,6 @@ describe Grape::Middleware::Formatter do
       subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'}).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, SimpleExample.new]
-
-      subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '[{"abc":"def"},{"abc":"def"}]'}
-    end
-
-    it 'should serialize multiple objects that respond to #serializable_hash' do
-      class SimpleExample
-        def serializable_hash
-          {:abc => 'def'}
-        end
-      end
-
-      @body = SimpleExample.new
-
-      subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '{"abc":"def"}'}
-    end
-
-    it 'should serialize objects that respond to #serializable_hash if there is a root element' do
-      class SimpleExample
-        def serializable_hash
-          {:abc => 'def'}
-        end
-      end
-
-      @body = {"root" => SimpleExample.new}
-
-      subject.call({'PATH_INFO' => '/somewhere', 'HTTP_ACCEPT' => 'application/json'}).last.each{|b| b.should == '{"root":{"abc":"def"}}'}
-    end
-
     it 'should call #to_xml if the content type is xml' do
       @body = "string"
       @body.instance_eval do
@@ -80,7 +44,7 @@ describe Grape::Middleware::Formatter do
       subject.env['api.format'].should == :json
     end
 
-    it 'should use the format parameter if one is provided' do 
+    it 'should use the format parameter if one is provided' do
       subject.call({'PATH_INFO' => '/somewhere','QUERY_STRING' => 'format=json'})
       subject.env['api.format'].should == :json
       subject.call({'PATH_INFO' => '/somewhere','QUERY_STRING' => 'format=xml'})
@@ -156,6 +120,7 @@ describe Grape::Middleware::Formatter do
       headers['Content-type'].should == 'text/plain'
     end
     it 'should be set for custom' do
+      subject.options[:content_types] = {}
       subject.options[:content_types][:custom] = 'application/x-custom'
       _, headers, _ = subject.call({'PATH_INFO' => '/info.custom'})
       headers['Content-type'].should == 'application/x-custom'
@@ -164,8 +129,9 @@ describe Grape::Middleware::Formatter do
 
   context 'Format' do
     it 'should use custom formatter' do
+      subject.options[:content_types] = {}
       subject.options[:content_types][:custom] = "don't care"
-      subject.options[:formatters][:custom] = lambda { |obj| 'CUSTOM FORMAT' }
+      subject.options[:formatters][:custom] = lambda { |obj, env| 'CUSTOM FORMAT' }
       _, _, body = subject.call({'PATH_INFO' => '/info.custom'})
       body.body.should == ['CUSTOM FORMAT']
     end
@@ -175,7 +141,7 @@ describe Grape::Middleware::Formatter do
       body.body.should == ['["blah"]']
     end
     it 'should use custom json formatter' do
-      subject.options[:formatters][:json] = lambda { |obj| 'CUSTOM JSON FORMAT' }
+      subject.options[:formatters][:json] = lambda { |obj, env| 'CUSTOM JSON FORMAT' }
       _, _, body = subject.call({'PATH_INFO' => '/info.json'})
       body.body.should == ['CUSTOM JSON FORMAT']
     end

data/spec/grape/validations/presence_spec.rb

@@ -19,7 +19,7 @@ describe Grape::Validations::PresenceValidator do
         post do
           {:ret => params[:id]}
         end
-        
+
         params do
           requires :name, :company
         end
@@ -52,7 +52,7 @@ describe Grape::Validations::PresenceValidator do
       end
     end
   end
-  
+
   def app
     ValidationsSpec::PresenceValidatorSpec::API
   end
@@ -62,30 +62,30 @@ describe Grape::Validations::PresenceValidator do
     last_response.status.should == 200
     last_response.body.should == "All the bacon"
   end
-  
+
   it 'validates id' do
     post('/')
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: id"
-    
+    last_response.body.should == '{"error":"missing parameter: id"}'
+
     post('/', {}, 'rack.input' => StringIO.new('{"id" : "a56b"}'))
-    last_response.body.should == 'invalid parameter: id'
+    last_response.body.should == '{"error":"invalid parameter: id"}'
     last_response.status.should == 400
-    
+
     post('/', {}, 'rack.input' => StringIO.new('{"id" : 56}'))
     last_response.body.should == '{"ret":56}'
     last_response.status.should == 201
   end
-  
+
   it 'validates name, company' do
     get('/')
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: name"
-    
+    last_response.body.should == '{"error":"missing parameter: name"}'
+
     get('/', :name => "Bob")
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: company"
-    
+    last_response.body.should == '{"error":"missing parameter: company"}'
+
     get('/', :name => "Bob", :company => "TestCorp")
     last_response.status.should == 200
     last_response.body.should == "Hello"
@@ -94,11 +94,11 @@ describe Grape::Validations::PresenceValidator do
   it 'validates nested parameters' do
     get('/nested')
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: first_name"
+    last_response.body.should == '{"error":"missing parameter: first_name"}'
 
     get('/nested', :user => {:first_name => "Billy"})
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: last_name"
+    last_response.body.should == '{"error":"missing parameter: last_name"}'
 
     get('/nested', :user => {:first_name => "Billy", :last_name => "Bob"})
     last_response.status.should == 200
@@ -108,27 +108,27 @@ describe Grape::Validations::PresenceValidator do
   it 'validates triple nested parameters' do
     get('/nested_triple')
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: admin_name"
+    last_response.body.should == '{"error":"missing parameter: admin_name"}'
 
     get('/nested_triple', :user => {:first_name => "Billy"})
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: admin_name"
+    last_response.body.should == '{"error":"missing parameter: admin_name"}'
 
     get('/nested_triple', :admin => {:super => {:first_name => "Billy"}})
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: admin_name"
+    last_response.body.should == '{"error":"missing parameter: admin_name"}'
 
     get('/nested_triple', :super => {:user => {:first_name => "Billy", :last_name => "Bob"}})
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: admin_name"
+    last_response.body.should == '{"error":"missing parameter: admin_name"}'
 
     get('/nested_triple', :admin => {:super => {:user => {:first_name => "Billy"}}})
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: admin_name"
+    last_response.body.should == '{"error":"missing parameter: admin_name"}'
 
     get('/nested_triple', :admin => { :admin_name => 'admin', :super => {:user => {:first_name => "Billy"}}})
     last_response.status.should == 400
-    last_response.body.should == "missing parameter: last_name"
+    last_response.body.should == '{"error":"missing parameter: last_name"}'
 
     get('/nested_triple', :admin => { :admin_name => 'admin', :super => {:user => {:first_name => "Billy", :last_name => "Bob"}}})
     last_response.status.should == 200