grape 0.2.6 → 0.3.0

data/lib/grape/exceptions/unknown_options.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Grape
+  module Exceptions
+    class UnknownOptions < Base
+
+      def initialize(options)
+        super(:message => compose_message("unknown_options", :options => options))
+      end
+
+    end
+
+  end
+
+end

data/lib/grape/exceptions/unknown_validator.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+module Grape
+  module Exceptions
+    class UnknownValidator < Base
+
+      def initialize(validator_type)
+        super(:message => compose_message("unknown_validator", :validator_type => validator_type))
+      end
+
+    end
+  end
+end

data/lib/grape/exceptions/{validation_error.rb → validation.rb}

@@ -2,11 +2,13 @@ require 'grape/exceptions/base'
 
 module Grape
   module Exceptions
-    class ValidationError < Grape::Exceptions::Base
+    class Validation < Grape::Exceptions::Base
       attr_accessor :param
 
       def initialize(args = {})
         @param = args[:param].to_s if args.has_key? :param
+        attribute = translate_attribute(@param)
+        args[:message] = translate_message(args[:message_key], :attribute => attribute)
         super
       end
     end

data/lib/grape/formatter/xml.rb

@@ -4,7 +4,8 @@ module Grape
       class << self
 
         def call(object, env)
-          object.respond_to?(:to_xml) ? object.to_xml : object.to_s
+          return object.to_xml if object.respond_to?(:to_xml)
+          raise Grape::Exceptions::InvalidFormatter.new(object.class, 'xml')
         end
 
       end

data/lib/grape/locale/en.yml

@@ -5,3 +5,23 @@ en:
         coerce: 'invalid parameter: %{attribute}'
         presence: 'missing parameter: %{attribute}'
         regexp: 'invalid parameter: %{attribute}'
+        missing_vendor_option:
+          problem: 'missing :vendor option.'
+          summary: 'when version using header, you must specify :verdor option. '
+          resolution: "eg: version 'v1', :using => :header, :vendor => 'twitter'"
+        missing_mime_type:
+          problem: 'missing mime type for %{new_format}'
+          resolution:
+            "you can choose exist mime type from Grape::ContentTypes::CONTENT_TYPES
+            or add your own with content_type :%{new_format}, 'application/%{new_format}'
+            "
+        invalid_with_option_for_represent:
+          problem: 'You must specify an entity class in the :with option.'
+          resolution: 'eg: represent User, :with => Entity::User'
+        missing_option: 'You must specify :%{option} options.'
+        invalid_formatter: 'cannot convert %{klass} to %{to_format}'
+        invalid_versioner_option:
+          problem: 'Unknown :using for versioner: %{strategy}'
+          resolution: 'available strategy for :using is :path, :header, :param'
+        unknown_validator: 'unknown validator: %{validator_type}'
+        unknown_options: 'unknown options: %{options}'

data/lib/grape/middleware/base.rb

@@ -1,8 +1,3 @@
-require 'active_support/core_ext/hash/indifferent_access'
-require 'grape/util/content_types'
-require 'multi_json'
-require 'multi_xml'
-
 module Grape
   module Middleware
     class Base

data/lib/grape/middleware/error.rb

@@ -1,5 +1,4 @@
 require 'grape/middleware/base'
-require 'multi_json'
 
 module Grape
   module Middleware
@@ -62,7 +61,7 @@ module Grape
       def format_message(message, backtrace)
         format = env['api.format'] || options[:format]
         formatter = Grape::ErrorFormatter::Base.formatter_for(format, options)
-        throw :error, :status => 406, :message => "The requested format #{format} is not supported." unless formatter
+        throw :error, :status => 406, :message => "The requested format '#{format}' is not supported." unless formatter
         formatter.call(message, backtrace, options, env)
       end
 

data/lib/grape/middleware/formatter.rb

@@ -24,8 +24,12 @@ module Grape
       def after
         status, headers, bodies = *@app_response
         formatter = Grape::Formatter::Base.formatter_for env['api.format'], options
-        bodymap = bodies.collect do |body|
-          formatter.call body, env
+        begin
+          bodymap = bodies.collect do |body|
+            formatter.call body, env
+          end
+        rescue Exception => e
+          throw :error, :status => 500, :message => e.message
         end
         headers['Content-Type'] = content_type_for(env['api.format']) unless headers['Content-Type']
         Rack::Response.new(bodymap, status, headers).to_a
@@ -34,7 +38,7 @@ module Grape
       private
 
         def read_body_input
-          if (request.post? || request.put?) && (! request.form_data?) && (! request.parseable_data?) && (request.content_length.to_i > 0)
+          if (request.post? || request.put? || request.patch?) && (! request.form_data?) && (! request.parseable_data?) && (request.content_length.to_i > 0)
             if env['rack.input'] && (body = env['rack.input'].read).length > 0
               begin
                 fmt = mime_types[request.media_type] if request.media_type
@@ -50,7 +54,7 @@ module Grape
                     end
                   end
                 else
-                  throw :error, :status => 406, :message => 'The requested content-type is not supported.'
+                  throw :error, :status => 406, :message => "The requested content-type '#{request.media_type}' is not supported."
                 end
               ensure
                 env['rack.input'].rewind
@@ -64,7 +68,7 @@ module Grape
           if content_type_for(fmt)
             env['api.format'] = fmt
           else
-            throw :error, :status => 406, :message => 'The requested format is not supported.'
+            throw :error, :status => 406, :message => "The requested format '#{fmt}' is not supported."
           end
         end
 

data/lib/grape/middleware/versioner.rb

@@ -22,7 +22,7 @@ module Grape
         when :param
           Param
         else
-          raise ArgumentError.new("Unknown :using for versioner: #{strategy}")
+          raise Grape::Exceptions::InvalidVersionerOption.new(strategy)
         end
       end
     end

data/lib/grape/middleware/versioner/header.rb

@@ -1,5 +1,4 @@
 require 'grape/middleware/base'
-require 'rack/accept'
 
 module Grape
   module Middleware
@@ -30,7 +29,7 @@ module Grape
           if strict?
             # If no Accept header:
             if header.qvalues.empty?
-              throw :error, :status => 406, :headers => {'X-Cascade' => 'pass'}, :message => 'Accept header must be set'
+              throw :error, :status => 406, :headers => error_headers, :message => 'Accept header must be set.'
             end
             # Remove any acceptable content types with ranges.
             header.qvalues.reject! do |media_type,_|
@@ -38,7 +37,7 @@ module Grape
             end
             # If all Accept headers included a range:
             if header.qvalues.empty?
-              throw :error, :status => 406, :headers => {'X-Cascade' => 'pass'}, :message => 'Accept header must not contain ranges ("*")'
+              throw :error, :status => 406, :headers => error_headers, :message => 'Accept header must not contain ranges ("*").'
             end
           end
 
@@ -56,10 +55,10 @@ module Grape
             end
           # If none of the available content types are acceptable:
           elsif strict?
-            throw :error, :status => 406, :headers => {'X-Cascade' => 'pass'}, :message => '406 Not Acceptable'
+            throw :error, :status => 406, :headers => error_headers, :message => '406 Not Acceptable'
           # If all acceptable content types specify a vendor or version that doesn't exist:
-          elsif header.values.all?{|media_type| has_vendor?(media_type) || has_version?(media_type)}
-            throw :error, :status => 406, :headers => {'X-Cascade' => 'pass'}, :message => 'API vendor or version not found'
+          elsif header.values.all?{ |media_type| has_vendor?(media_type) || has_version?(media_type)}
+            throw :error, :status => 406, :headers => error_headers, :message => 'API vendor or version not found.'
           end
         end
 
@@ -96,6 +95,17 @@ module Grape
           options[:version_options] && options[:version_options][:strict]
         end
 
+        # By default those errors contain an `X-Cascade` header set to `pass`, which allows nesting and stacking
+        # of routes (see [Rack::Mount](https://github.com/josh/rack-mount) for more information). To prevent
+        # this behavior, and not add the `X-Cascade` header, one can set the `:cascade` option to `false`.
+        def cascade?
+          options[:version_options] && (options[:version_options].has_key?(:cascade) ? options[:version_options][:cascade] : true)
+        end
+
+        def error_headers
+          cascade? ? { 'X-Cascade' => 'pass' } : {}
+        end
+
         # @param [String] media_type a content type
         # @return [Boolean] whether the content type sets a vendor
         def has_vendor?(media_type)

data/lib/grape/middleware/versioner/param.rb

@@ -30,7 +30,7 @@ module Grape
           potential_version = request.params[paramkey]
 
           unless potential_version.nil?
-            if options[:versions] && !options[:versions].include?(potential_version)
+            if options[:versions] && ! options[:versions].find { |v| v.to_s == potential_version }
               throw :error, :status => 404, :message => "404 API Version Not Found", :headers => {'X-Cascade' => 'pass'}
             end
             env['api.version'] = potential_version

data/lib/grape/middleware/versioner/path.rb

@@ -34,7 +34,7 @@ module Grape
           pieces = path.split('/')
           potential_version = pieces[1]
           if potential_version =~ options[:pattern]
-            if options[:versions] && !options[:versions].include?(potential_version)
+            if options[:versions] && ! options[:versions].find { |v| v.to_s == potential_version }
               throw :error, :status => 404, :message => "404 API Version Not Found"
             end
 

data/lib/grape/util/content_types.rb

@@ -1,5 +1,3 @@
-require 'active_support/ordered_hash'
-
 module Grape
   module ContentTypes
     # Content types are listed in order of preference.

data/lib/grape/validations.rb

@@ -1,7 +1,3 @@
-require 'virtus'
-require 'i18n'
-
-I18n.load_path << File.expand_path('../locale/en.yml', __FILE__)
 module Grape
 
   module Validations
@@ -18,25 +14,22 @@ module Grape
         @scope = scope
 
         if options.is_a?(Hash) && !options.empty?
-          raise "unknown options: #{options.keys}"
+          raise Grape::Exceptions.UnknownOptions.new(options.keys)
         end
       end
 
       def validate!(params)
         params = @scope.params(params)
 
-        @attrs.each do |attr_name|
-          if @required || params.has_key?(attr_name)
-            validate_param!(attr_name, params)
+        (params.is_a?(Array) ? params : [params]).each do |resource_params|
+          @attrs.each do |attr_name|
+            if @required || resource_params.has_key?(attr_name)
+              validate_param!(attr_name, resource_params)
+            end
           end
         end
       end
 
-      def i18n_message(type, attribute)
-        i18n_attr = I18n.t("grape.errors.attributes.#{attribute}", :default => attribute.to_s)
-        I18n.t("grape.errors.messages.#{type}", :attribute => i18n_attr)
-      end
-
     private
 
       def self.convert_to_short_name(klass)
@@ -167,7 +160,7 @@ module Grape
         if validator_class
           (@api.settings.peek[:validations] ||= []) << validator_class.new(attrs, options, doc_attrs[:required], self)
         else
-          raise "unknown validator: #{type}"
+          raise Grape::Exceptions::UnknownValidator.new(type)
         end
       end
 

data/lib/grape/validations/coerce.rb

@@ -12,7 +12,8 @@ module Grape
         if valid_type?(new_value)
           params[attr_name] = new_value
         else
-          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => i18n_message(:coerce, attr_name)
+          raise Grape::Exceptions::Validation, :status => 400,
+            :param => @scope.full_name(attr_name), :message_key => :coerce
         end
       end
 

data/lib/grape/validations/presence.rb

@@ -3,7 +3,8 @@ module Grape
     class PresenceValidator < Validator
       def validate_param!(attr_name, params)
         unless params.has_key?(attr_name)
-          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => i18n_message(:presence, attr_name)
+          raise Grape::Exceptions::Validation, :status => 400,
+            :param => @scope.full_name(attr_name), :message_key => :presence
         end
       end
     end

data/lib/grape/validations/regexp.rb

@@ -4,7 +4,8 @@ module Grape
     class RegexpValidator < SingleOptionValidator
       def validate_param!(attr_name, params)
         if params[attr_name] && !( params[attr_name].to_s =~ @option )
-          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => i18n_message(:regexp, attr_name)
+          raise Grape::Exceptions::Validation, :status => 400,
+            :param => @scope.full_name(attr_name), :message_key => :regexp
         end
       end
     end

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.2.6'
+  VERSION = '0.3.0'
 end

data/spec/grape/api_spec.rb

@@ -100,7 +100,7 @@ describe Grape::API do
 
   describe '.represent' do
     it 'requires a :with option' do
-      expect{ subject.represent Object, {} }.to raise_error(ArgumentError)
+      expect{ subject.represent Object, {} }.to raise_error(Grape::Exceptions::InvalidWithOptionForRepresent)
     end
 
     it 'adds the association to the :representations setting' do
@@ -108,6 +108,7 @@ describe Grape::API do
       subject.represent Object, :with => klass
       subject.settings[:representations][Object].should == klass
     end
+
   end
 
   describe '.namespace' do
@@ -359,7 +360,7 @@ describe Grape::API do
         send(verb, '/example')
         last_response.body.should eql verb == 'head' ? '' : verb
         # Call it with a method other than the properly constrained one.
-        send(used_verb = verbs[(verbs.index(verb) + 1) % verbs.size], '/example')
+        send(used_verb = verbs[(verbs.index(verb) + 2) % verbs.size], '/example')
         last_response.status.should eql used_verb == 'options' ? 204 :405
       end
     end
@@ -391,18 +392,70 @@ describe Grape::API do
         "example"
       end
       put '/example'
-      last_response.headers['Allow'].should eql 'OPTIONS, GET, POST'
+      last_response.headers['Allow'].should eql 'OPTIONS, GET, POST, HEAD'
     end
 
     it 'adds an OPTIONS route that returns a 204 and an Allow header' do
       subject.get 'example' do
         "example"
       end
+      options '/example'
+      last_response.status.should eql 204
+      last_response.body.should eql ''
+      last_response.headers['Allow'].should eql 'OPTIONS, GET, HEAD'
+    end
+
+    it 'allows HEAD on a GET request' do
+      subject.get 'example' do
+        "example"
+      end
+      head '/example'
+      last_response.status.should eql 200
+      last_response.body.should eql ''
+    end
+
+    it 'overwrites the default HEAD request' do
+      subject.head 'example' do
+        error! 'nothing to see here', 400
+      end
+      subject.get 'example' do
+        "example"
+      end
+      head '/example'
+      last_response.status.should eql 400
+    end
+  end
+
+  context "do_not_route_head!" do
+    before :each do
+      subject.do_not_route_head!
+      subject.get 'example' do
+        "example"
+      end
+    end
+    it 'options does not contain HEAD' do
       options '/example'
       last_response.status.should eql 204
       last_response.body.should eql ''
       last_response.headers['Allow'].should eql 'OPTIONS, GET'
     end
+    it 'does not allow HEAD on a GET request' do
+      head '/example'
+      last_response.status.should eql 405
+    end
+  end
+
+  context "do_not_route_options!" do
+    before :each do
+      subject.do_not_route_options!
+      subject.get 'example' do
+        "example"
+      end
+    end
+    it 'options does not exist' do
+      options '/example'
+      last_response.status.should eql 405
+    end
   end
 
   describe 'filters' do
@@ -1013,7 +1066,7 @@ describe Grape::API do
       end
       get '/excel.json'
       last_response.status.should == 406
-      last_response.body.should == "The requested format is not supported."
+      last_response.body.should == "The requested format 'txt' is not supported."
     end
   end
 
@@ -1116,7 +1169,7 @@ describe Grape::API do
         last_response.body.should eql "elpmis"
       end
     end
-    context "muti_xml" do
+    context "multi_xml" do
       it "doesn't parse yaml" do
         subject.put :yaml do
           params[:tag]
@@ -1512,6 +1565,34 @@ describe Grape::API do
         subject.routes.first.route_path.should =~ /\/cool\/awesome/
         subject.routes.last.route_path.should =~ /\/cool\/sauce/
       end
+
+      it 'mounts on a path' do
+        subject.namespace :cool do
+          app = Class.new(Grape::API)
+          app.get '/awesome' do
+            "sauce"
+          end
+          mount app => '/mounted'
+        end
+        get "/mounted/cool/awesome"
+        last_response.status.should == 200
+        last_response.body.should == "sauce"
+      end
+
+      it 'mounts on a nested path' do
+        app1 = Class.new(Grape::API)
+        app2 = Class.new(Grape::API)
+        app2.get '/nice' do
+          "play"
+        end
+        # note that the reverse won't work, mount from outside-in
+        subject.mount app1 => '/app1'
+        app1.mount app2 => '/app2'
+        get "/app1/app2/nice"
+        last_response.status.should == 200
+        last_response.body.should == "play"
+      end
+
     end
   end
 
@@ -1690,6 +1771,55 @@ describe Grape::API do
         last_response.body.should == '[{"abc":"def"},{"abc":"def"}]'
       end
     end
+    context ":xml" do
+      before(:each) do
+        subject.format :xml
+      end
+      it 'string' do
+        subject.get "/example" do
+          "example"
+        end
+        get '/example'
+        last_response.status.should == 500
+        last_response.body.should == <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<error>
+  <message>cannot convert String to xml</message>
+</error>
+XML
+      end
+      it 'hash' do
+        subject.get "/example" do
+          ActiveSupport::OrderedHash[
+            :example1, "example1",
+            :example2, "example2"
+          ]
+        end
+        get '/example'
+        last_response.status.should == 200
+        last_response.body.should == <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <example1>example1</example1>
+  <example2>example2</example2>
+</hash>
+XML
+      end
+      it 'array' do
+        subject.get "/example" do
+          [ "example1", "example2" ]
+        end
+        get '/example'
+        last_response.status.should == 200
+        last_response.body.should == <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<strings type="array">
+  <string>example1</string>
+  <string>example2</string>
+</strings>
+XML
+      end
+    end
   end
 
   context "catch-all" do
@@ -1725,4 +1855,19 @@ describe Grape::API do
     end
   end
 
+  context "cascading" do
+    it "cascades" do
+      subject.version 'v1', :using => :path, :cascade => true
+      get "/v1/hello"
+      last_response.status.should == 404
+      last_response.headers["X-Cascade"].should == "pass"
+    end
+
+    it "does not cascade" do
+      subject.version 'v2', :using => :path, :cascade => false
+      get "/v2/hello"
+      last_response.status.should == 404
+      last_response.headers.keys.should_not include "X-Cascade"
+    end
+  end
 end