grape 0.4.1 → 0.5.0

data/spec/grape/middleware/formatter_spec.rb

@@ -36,6 +36,29 @@ describe Grape::Middleware::Formatter do
     end
   end
 
+  context 'error handling' do
+    let(:formatter) { stub(:formatter) }
+    before do
+      Grape::Formatter::Base.stub(:formatter_for) { formatter }
+    end
+
+    it 'rescues formatter-specific exceptions' do
+      formatter.stub(:call) { raise Grape::Exceptions::InvalidFormatter.new(String, 'xml') }
+
+      expect {
+        catch(:error){subject.call({'PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json'})}
+      }.to_not raise_error
+    end
+
+    it 'does not rescue other exceptions' do
+      formatter.stub(:call) { raise StandardError }
+
+      expect {
+        catch(:error){subject.call({'PATH_INFO' => '/somewhere.xml', 'HTTP_ACCEPT' => 'application/json'})}
+      }.to raise_error
+    end
+  end
+
   context 'detection' do
 
     it 'uses the extension if one is provided' do
@@ -166,6 +189,31 @@ describe Grape::Middleware::Formatter do
           end
         end
       end
+      it "parses the chunked body from #{method} and copies values into rack.request.from_hash" do
+        io = StringIO.new('{"is_boolean":true,"string":"thing"}')
+        subject.call({
+          'PATH_INFO' => '/infol',
+          'REQUEST_METHOD' => method,
+          'CONTENT_TYPE' => 'application/json',
+          'rack.input' => io,
+          'HTTP_TRANSFER_ENCODING' => 'chunked'
+        })
+        subject.env['rack.request.form_hash']['is_boolean'].should be_true
+        subject.env['rack.request.form_hash']['string'].should == 'thing'
+      end
+      it "rewinds IO" do
+        io = StringIO.new('{"is_boolean":true,"string":"thing"}')
+        io.read
+        subject.call({
+          'PATH_INFO' => '/infol',
+          'REQUEST_METHOD' => method,
+          'CONTENT_TYPE' => 'application/json',
+          'rack.input' => io,
+          'HTTP_TRANSFER_ENCODING' => 'chunked'
+        })
+        subject.env['rack.request.form_hash']['is_boolean'].should be_true
+        subject.env['rack.request.form_hash']['string'].should == 'thing'
+      end
       it 'parses the body from an xml #{method} and copies values into rack.request.from_hash' do
         io = StringIO.new('<thing><name>Test</name></thing>')
         subject.call({

data/spec/grape/middleware/versioner/accept_version_header_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Grape::Middleware::Versioner::AcceptVersionHeader do
+  let(:app) { lambda{|env| [200, env, env]} }
+  subject { Grape::Middleware::Versioner::AcceptVersionHeader.new(app, @options || {}) }
+
+  before do
+    @options = {
+      :version_options => {
+        :using => :accept_version_header
+      },
+    }
+  end
+
+  context 'api.version' do
+    before do
+      @options[:versions] = ['v1']
+    end
+
+    it 'is set' do
+      status, _, env =  subject.call('HTTP_ACCEPT_VERSION' => 'v1')
+      env['api.version'].should eql 'v1'
+      status.should == 200
+    end
+
+    it 'is set if format provided' do
+      status, _, env =  subject.call('HTTP_ACCEPT_VERSION' => 'v1')
+      env['api.version'].should eql 'v1'
+      status.should == 200
+    end
+
+    it 'fails with 406 Not Acceptable if version is not supported' do
+      expect {
+        env = subject.call('HTTP_ACCEPT_VERSION' => 'v2').last
+      }.to throw_symbol(
+        :error,
+        :status => 406,
+        :headers => {'X-Cascade' => 'pass'},
+        :message => 'The requested version is not supported.'
+      )
+    end
+  end
+
+  it 'succeeds if :strict is not set' do
+    subject.call('HTTP_ACCEPT_VERSION' => '').first.should == 200
+    subject.call({}).first.should == 200
+  end
+
+  it 'succeeds if :strict is set to false' do
+    @options[:version_options][:strict] = false
+    subject.call('HTTP_ACCEPT_VERSION' => '').first.should == 200
+    subject.call({}).first.should == 200
+  end
+
+  context 'when :strict is set' do
+    before do
+      @options[:versions] = ['v1']
+      @options[:version_options][:strict] = true
+    end
+
+    it 'fails with 406 Not Acceptable if header is not set' do
+      expect {
+        env = subject.call({}).last
+      }.to throw_symbol(
+        :error,
+        :status => 406,
+        :headers => {'X-Cascade' => 'pass'},
+        :message => 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'fails with 406 Not Acceptable if header is empty' do
+      expect {
+        env = subject.call('HTTP_ACCEPT_VERSION' => '').last
+      }.to throw_symbol(
+        :error,
+        :status => 406,
+        :headers => {'X-Cascade' => 'pass'},
+        :message => 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'succeeds if proper header is set' do
+      subject.call('HTTP_ACCEPT_VERSION' => 'v1').first.should == 200
+    end
+  end
+
+  context 'when :strict and :cascade=>false are set' do
+    before do
+      @options[:versions] = ['v1']
+      @options[:version_options][:strict] = true
+      @options[:version_options][:cascade] = false
+    end
+
+    it 'fails with 406 Not Acceptable if header is not set' do
+      expect {
+        env = subject.call({}).last
+      }.to throw_symbol(
+        :error,
+        :status => 406,
+        :headers => {},
+        :message => 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'fails with 406 Not Acceptable if header is empty' do
+      expect {
+        env = subject.call('HTTP_ACCEPT_VERSION' => '').last
+      }.to throw_symbol(
+        :error,
+        :status => 406,
+        :headers => {},
+        :message => 'Accept-Version header must be set.'
+      )
+    end
+
+    it 'succeeds if proper header is set' do
+      subject.call('HTTP_ACCEPT_VERSION' => 'v1').first.should == 200
+    end
+  end
+end

data/spec/grape/middleware/versioner_spec.rb

@@ -16,4 +16,7 @@ describe Grape::Middleware::Versioner do
     klass.using(:param).should == Grape::Middleware::Versioner::Param
   end
 
-end
+  it 'recognizes :accept_version_header' do
+    klass.using(:accept_version_header).should == Grape::Middleware::Versioner::AcceptVersionHeader
+  end
+end

data/spec/grape/validations/default_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Grape::Validations::DefaultValidator do
+
+  module ValidationsSpec
+    module DefaultValidatorSpec
+      class API < Grape::API
+        default_format :json
+
+        params do
+          optional :id
+          optional :type, :default => 'default-type'
+        end
+        get '/' do
+          { :id => params[:id], :type => params[:type] }
+        end
+
+        params do
+          optional :type1, :default => 'default-type1'
+          optional :type2, :default => 'default-type2'
+        end
+        get '/user' do
+          { :type1 => params[:type1], :type2 => params[:type2] }
+        end
+
+        params do
+          requires :id
+          optional :type1, :default => 'default-type1'
+          optional :type2, :default => 'default-type2'
+        end
+
+        get '/message' do
+          { :id => params[:id], :type1 => params[:type1], :type2 => params[:type2] }
+        end
+      end
+    end
+  end
+
+  def app
+    ValidationsSpec::DefaultValidatorSpec::API
+  end
+
+  it 'set default value for optional param' do
+    get("/")
+    last_response.status.should == 200
+    last_response.body.should == { :id => nil, :type => 'default-type' }.to_json
+  end
+
+  it 'set default values for optional params' do
+    get("/user")
+    last_response.status.should == 200
+    last_response.body.should == { :type1 => 'default-type1', :type2 => 'default-type2' }.to_json
+  end
+
+  it 'set default values for missing params in the request' do
+    get("/user?type2=value2")
+    last_response.status.should == 200
+    last_response.body.should == { :type1 => 'default-type1', :type2 => 'value2' }.to_json
+  end
+
+  it 'set default values for optional params and allow to use required fields in the same time' do
+    get("/message?id=1")
+    last_response.status.should == 200
+    last_response.body.should == { :id => '1', :type1 => 'default-type1', :type2 => 'default-type2' }.to_json
+  end
+end
+

data/spec/grape/validations_spec.rb

@@ -79,6 +79,15 @@ describe Grape::Validations do
         last_response.status.should == 200
         last_response.body.should == 'required works'
       end
+
+      it 'adds to declared parameters' do
+        subject.params {
+          group :items do
+            requires :key
+          end
+        }
+        subject.settings[:declared_params].should == [:items => [:key]]
+      end
     end
 
     context 'custom validation' do

data/spec/shared/versioning_examples.rb

@@ -11,7 +11,7 @@ shared_examples_for 'versioning' do
 
   it 'adds the prefix before the API version' do
     subject.format :txt
-    subject.prefix 'api'    
+    subject.prefix 'api'
     subject.version 'v1', macro_options
     subject.get :hello do
       "Version: #{request.env['api.version']}"
@@ -106,4 +106,16 @@ shared_examples_for 'versioning' do
       end
     end
   end
+
+  it 'does not overwrite version parameter with API version' do
+    subject.format :txt
+    subject.version 'v1', macro_options
+    subject.params { requires :version }
+    subject.get :api_version_with_version_param do
+      params[:version]
+    end
+    versioned_get '/api_version_with_version_param?version=1', 'v1', macro_options
+    last_response.body.should eql '1'
+  end
+
 end

data/spec/spec_helper.rb

@@ -14,6 +14,7 @@ require 'rack/test'
 require 'pry'
 require 'base64'
 require 'cookiejar'
+require 'json'
 
 Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
   require file

data/spec/support/versioned_helpers.rb

@@ -10,6 +10,8 @@ def versioned_path(options = {})
     File.join('/', options[:prefix] || '', options[:path])
   when :header
     File.join('/', options[:prefix] || '', options[:path])
+  when :accept_version_header
+    File.join('/', options[:prefix] || '', options[:path])
   else
     raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
   end
@@ -25,6 +27,10 @@ def versioned_headers(options)
     {
       'HTTP_ACCEPT' => "application/vnd.#{options[:vendor]}-#{options[:version]}+#{options[:format]}"
     }
+  when :accept_version_header
+    {
+      'HTTP_ACCEPT_VERSION' => "#{options[:version]}"
+    }
   else
     raise ArgumentError.new("unknown versioning strategy: #{options[:using]}")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -308,6 +308,7 @@ files:
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
+- lib/grape/http/request.rb
 - lib/grape/locale/en.yml
 - lib/grape/middleware/auth/basic.rb
 - lib/grape/middleware/auth/digest.rb
@@ -317,6 +318,7 @@ files:
 - lib/grape/middleware/filter.rb
 - lib/grape/middleware/formatter.rb
 - lib/grape/middleware/versioner.rb
+- lib/grape/middleware/versioner/accept_version_header.rb
 - lib/grape/middleware/versioner/header.rb
 - lib/grape/middleware/versioner/param.rb
 - lib/grape/middleware/versioner/path.rb
@@ -330,6 +332,7 @@ files:
 - lib/grape/util/hash_stack.rb
 - lib/grape/validations.rb
 - lib/grape/validations/coerce.rb
+- lib/grape/validations/default.rb
 - lib/grape/validations/presence.rb
 - lib/grape/validations/regexp.rb
 - lib/grape/version.rb
@@ -349,12 +352,14 @@ files:
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/exception_spec.rb
 - spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/versioner/accept_version_header_spec.rb
 - spec/grape/middleware/versioner/header_spec.rb
 - spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/util/hash_stack_spec.rb
 - spec/grape/validations/coerce_spec.rb
+- spec/grape/validations/default_spec.rb
 - spec/grape/validations/presence_spec.rb
 - spec/grape/validations/regexp_spec.rb
 - spec/grape/validations/zh-CN.yml
@@ -378,7 +383,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2839578735981182036
+      hash: -683082835591277946
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -387,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2839578735981182036
+      hash: -683082835591277946
 requirements: []
 rubyforge_project: grape
 rubygems_version: 1.8.25
@@ -411,12 +416,14 @@ test_files:
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/exception_spec.rb
 - spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/versioner/accept_version_header_spec.rb
 - spec/grape/middleware/versioner/header_spec.rb
 - spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/util/hash_stack_spec.rb
 - spec/grape/validations/coerce_spec.rb
+- spec/grape/validations/default_spec.rb
 - spec/grape/validations/presence_spec.rb
 - spec/grape/validations/regexp_spec.rb
 - spec/grape/validations/zh-CN.yml