grape 0.2.4 → 0.2.5

data/CHANGELOG.markdown

@@ -1,3 +1,13 @@
+0.2.5 (01/10/2013)
+==================
+
+* Added support for custom parsers via `parser`, in addition to built-in multipart, JSON and XML parsers - [@dblock](http://github.com/dblock).
+* Removed `body_params`, data sent via a POST or PUT with a supported content-type is merged into `params` - [@dblock](http://github.com/dblock).
+* Setting `format` will automatically remove other content-types by calling `content_type` - [@dblock](http://github.com/dblock).
+* Setting `content_type` will prevent any input data other than the matching content-type or any Rack-supported form and parseable media types (`application/x-www-form-urlencoded`, `multipart/form-data`, `multipart/related` and `multipart/mixed`) from being parsed - [@dblock](http://github.com/dblock).
+* [#305](https://github.com/intridea/grape/issues/305): Fix: presenting arrays of objects via `represent` or when auto-detecting an `Entity` constant in the objects being presented - [@brandonweiss](https://github.com/brandonweiss).
+* [#306](https://github.com/intridea/grape/issues/306): Added i18n support for validation error messages - [@niedhui](https://github.com/niedhui).
+
 0.2.4 (01/06/2013)
 ==================
 

data/Gemfile

@@ -13,5 +13,4 @@ group :development, :test do
   gem 'rspec'
   gem 'rack-test', "~> 0.6.2", :require => "rack/test"
   gem 'github-markup'
-  gem 'redcarpet'
 end

data/README.markdown

@@ -10,6 +10,11 @@ content negotiation, versioning and much more.
 
 [![Build Status](https://travis-ci.org/intridea/grape.png?branch=master)](http://travis-ci.org/intridea/grape)
 
+## Stable Release
+
+You're reading the documentation for the next release of Grape, which should be 0.2.5.
+The current stable release is [0.2.4](https://github.com/intridea/grape/blob/v0.2.4/README.markdown).
+
 ## Project Tracking
 
 * [Grape Google Group](http://groups.google.com/group/ruby-grape)
@@ -215,8 +220,8 @@ end
 
 ## Parameters
 
-Request parameters are available through the `params` hash object. This includes `GET` and `POST` parameters,
-along with any named parameters you specify in your route strings.
+Request parameters are available through the `params` hash object. This includes `GET`, `POST`
+and `PUT` parameters, along with any named parameters you specify in your route strings.
 
 ```ruby
 get :public_timeline do
@@ -224,7 +229,8 @@ get :public_timeline do
 end
 ```
 
-Parameters are also populated from the request body on POST and PUT for JSON and XML content-types.
+Parameters are automatically populated from the request body on POST and PUT for form input, JSON and
+XML content-types.
 
 The request:
 
@@ -638,7 +644,7 @@ end
 
 ## API Formats
 
-By default, Grape supports _XML_, _JSON_, and _TXT_ content-types. The default format is `:txt`. 
+By default, Grape supports _XML_, _JSON_, and _TXT_ content-types. The default format is `:txt`.
 
 Serialization takes place automatically. For example, you do not have to call `to_json` in each JSON API implementation.
 
@@ -646,21 +652,23 @@ Your API can declare which types to support by using `content_type`. Response fo
 is determined by the request's extension, an explicit `format` parameter in the query
 string, or `Accept` header.
 
-The following API will only respond to the JSON content-type. All other requests will
-fail with an HTTP 406 error code.
+The following API will only respond to the JSON content-type and will not parse any other input than `application/json`,
+'application/x-www-form-urlencoded', 'multipart/form-data', 'multipart/related' and 'multipart/mixed'. All other requests
+will fail with an HTTP 406 error code.
 
 ```ruby
 class Twitter::API < Grape::API
   format :json
-  content_type :json, "application/json"
 end
 ```
 
-If you combine `format` with `rescue_from :all`, errors will be rendered using the same format. If you do not want this behavior, set the default error formatter with `default_error_formatter`.
+If you combine `format` with `rescue_from :all`, errors will be rendered using the same format.
+If you do not want this behavior, set the default error formatter with `default_error_formatter`.
 
 ```ruby
 class Twitter::API < Grape::API
   format :json
+  content_type :txt, "text/plain"
   default_error_formatter :txt
 end
 ```
@@ -696,7 +704,7 @@ Built-in formats are the following.
 * `:txt`: use object's `to_txt` when available, otherwise `to_s`
 * `:serializable_hash`: use object's `serializable_hash` when available, otherwise fallback to `:json`
 
-Use `default_format` to set the fallback format when the format could not be determined from the `Accept` header. 
+Use `default_format` to set the fallback format when the format could not be determined from the `Accept` header.
 See below for the order for choosing the API format.
 
 ```ruby
@@ -728,6 +736,42 @@ class API < Grape::API
 end
 ```
 
+## API Data Formats
+
+Grape accepts and parses input data sent with the POST and PUT methods as described in the Parameters
+section above. It also supports custom data formats. You must declare additional content-types via
+`content_type` and optionally supply a parser via `parser` unless a parser is already available within
+Grape to enable a custom format. Such a parser can be a function or a class.
+
+Without a parser, data is available "as-is" and can be read with `env['rack.input'].read`.
+
+The following example is a trivial parser that will assign any input with the "text/custom" content-type
+to `:value`. The parameter will be available via `params[:value]` inside the API call.
+
+```ruby
+module CustomParser
+  def self.call(object, env)
+    { :value => object.to_s }
+  end
+end
+```
+
+```ruby
+content_type :txt, "text/plain"
+content_type :custom, "text/custom"
+parser :custom, CustomParser
+
+put "value" do
+  params[:value]
+end
+```
+
+You can invoke the above API as follows.
+
+```
+curl -X PUT -d 'data' 'http://localhost:9292/value' -H Content-Type:text/custom -v
+```
+
 ## Reusable Responses with Entities
 
 Entities are a reusable means for converting Ruby objects to API responses.
@@ -817,10 +861,10 @@ module API
     desc 'Statuses index', {
       :object_fields => API::Entities::Status.documentation
     }
-    get '/statues' do
+    get '/statuses' do
       statuses = Status.all
       type = current_user.admin? ? :full : :default
-      present statues, with: API::Entities::Status, :type => type
+      present statuses, with: API::Entities::Status, :type => type
     end
   end
 end
@@ -927,9 +971,9 @@ class MyAPI < Grape::API
 end
 ```
 
-The current endpoint responding to the request is `self` within the API block 
-or `env['api.endpoint']` elsewhere. The endpoint has some interesting properties, 
-such as `source` which gives you access to the original code block of the API 
+The current endpoint responding to the request is `self` within the API block
+or `env['api.endpoint']` elsewhere. The endpoint has some interesting properties,
+such as `source` which gives you access to the original code block of the API
 implementation. This can be particularly useful for building a logger middleware.
 
 ```ruby
@@ -956,7 +1000,7 @@ For instance when you're API needs to get part of an URL, for instance:
 
 ```ruby
 class TwitterAPI < Grape::API
-  namespace :statues do
+  namespace :statuses do
     get '/(*:status)', :anchor => false do
 
     end

data/lib/grape/api.rb

@@ -3,6 +3,7 @@ require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
 require 'logger'
 require 'grape/util/deep_merge'
+require 'grape/util/content_types'
 
 module Grape
   # The API class is the primary entry point for
@@ -129,7 +130,12 @@ module Grape
       def format(new_format = nil)
         if new_format
           set(:format, new_format.to_sym)
+          # define the default error formatters
           set(:default_error_formatter, Grape::ErrorFormatter::Base.formatter_for(new_format, {}))
+          # define a single mime type
+          mime_type = content_types[new_format.to_sym]
+          raise "missing mime type for #{new_format}" unless mime_type
+          settings.imbue(:content_types, new_format.to_sym => mime_type)
         else
           settings[:format]
         end
@@ -140,6 +146,11 @@ module Grape
         settings.imbue(:formatters, content_type.to_sym => new_formatter)
       end
 
+      # Specify a custom parser for a content-type.
+      def parser(content_type, new_parser)
+        settings.imbue(:parsers, content_type.to_sym => new_parser)
+      end
+
       # Specify a default error formatter.
       def default_error_formatter(new_formatter = nil)
         new_formatter ? set(:default_error_formatter, new_formatter) : settings[:default_error_formatter]
@@ -155,6 +166,11 @@ module Grape
         settings.imbue(:content_types, key.to_sym => val)
       end
 
+      # All available content types.
+      def content_types
+        Grape::ContentTypes.content_types_for(settings[:content_types])
+      end
+
       # Specify the default status code for errors.
       def default_error_status(new_status = nil)
         new_status ? set(:default_error_status, new_status) : settings[:default_error_status]
@@ -283,7 +299,6 @@ module Grape
           if app.respond_to?(:inherit_settings)
             app.inherit_settings(settings.clone)
           end
-
           endpoints << Grape::Endpoint.new(settings.clone,
             :method => :any,
             :path => path,

data/lib/grape/endpoint.rb

@@ -159,8 +159,7 @@ module Grape
     def params
       @params ||= Hashie::Mash.new.
         deep_merge(request.params).
-        deep_merge(env['rack.routing_args'] || {}).
-        deep_merge(self.body_params)
+        deep_merge(env['rack.routing_args'] || {})
     end
 
     # A filtering method that will return a hash
@@ -185,23 +184,6 @@ module Grape
       }
     end
 
-    # Pull out request body params if the content type matches and we're on a POST or PUT
-    def body_params
-      if ['POST', 'PUT'].include?(request.request_method.to_s.upcase) && request.content_length.to_i > 0
-        return @body_params ||=
-          case env['CONTENT_TYPE']
-          when 'application/json'
-            MultiJson.load(request.body.read)
-          when 'application/xml'
-            MultiXml.parse(request.body.read)
-          else
-            {}
-          end
-      end
-
-      {}
-    end
-
     # The API version as specified in the URL.
     def version; env['api.version'] end
 
@@ -314,11 +296,14 @@ module Grape
     def present(object, options = {})
       entity_class = options.delete(:with)
 
-      object.class.ancestors.each do |potential|
+      # auto-detect the entity from the first object in the collection
+      object_instance = object.is_a?(Array) ? object.first : object
+
+      object_instance.class.ancestors.each do |potential|
         entity_class ||= (settings[:representations] || {})[potential]
       end
 
-      entity_class ||= object.class.const_get(:Entity) if object.class.const_defined?(:Entity)
+      entity_class ||= object_instance.class.const_get(:Entity) if object_instance.class.const_defined?(:Entity)
 
       root = options.delete(:root)
 
@@ -410,7 +395,8 @@ module Grape
         :format => settings[:format],
         :default_format => settings[:default_format] || :txt,
         :content_types => settings[:content_types],
-        :formatters => settings[:formatters]
+        :formatters => settings[:formatters],
+        :parsers => settings[:parsers]
 
       aggregate_setting(:middleware).each do |m|
         m = m.dup

data/lib/grape/locale/en.yml

@@ -0,0 +1,7 @@
+en:
+  grape:
+    errors:
+      messages:
+        coerce: 'invalid parameter: %{attribute}'
+        presence: 'missing parameter: %{attribute}'
+        regexp: 'invalid parameter: %{attribute}'

data/lib/grape/middleware/base.rb

@@ -1,21 +1,11 @@
-require 'active_support/ordered_hash'
 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
-      # Content types are listed in order of preference.
-      CONTENT_TYPES = ActiveSupport::OrderedHash[
-        :xml,  'application/xml',
-        :serializable_hash, 'application/json',
-        :json, 'application/json',
-        :atom, 'application/atom+xml',
-        :rss,  'application/rss+xml',
-        :txt,  'text/plain',
-      ]
-
       attr_reader :app, :env, :options
 
       # @param [Rack Application] app The standard argument for a Rack middleware.
@@ -61,7 +51,7 @@ module Grape
       end
 
       def content_types
-        options[:content_types] || CONTENT_TYPES
+        ContentTypes.content_types_for(options[:content_types])
       end
 
       def content_type

data/lib/grape/middleware/formatter.rb

@@ -17,71 +17,99 @@ module Grape
       end
 
       def before
-        fmt = format_from_extension || format_from_params || options[:format] || format_from_header || options[:default_format]
-        if content_type_for(fmt)
-          if !env['rack.input'].nil? and (body = env['rack.input'].read).strip.length != 0
-            parser = Grape::Parser::Base.parser_for fmt, options
-            unless parser.nil?
+        negotiate_content_type
+        read_body_input
+      end
+
+      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
+        end
+        headers['Content-Type'] = content_type_for(env['api.format']) unless headers['Content-Type']
+        Rack::Response.new(bodymap, status, headers).to_a
+      end
+
+      private
+
+        def read_body_input
+          request_method = request.request_method.to_s.upcase
+          if [ 'POST', 'PUT' ].include?(request_method) && (! request.form_data?) && (request.content_length.to_i > 0)
+            if env['rack.input'] && (body = env['rack.input'].read).strip.length > 0
               begin
-                body = parser.call body, env
-                env['rack.request.form_hash'] = !env['rack.request.form_hash'].nil? ? env['rack.request.form_hash'].merge(body) : body
-                env['rack.request.form_input'] = env['rack.input']
-              rescue
-                # It's possible that it's just regular POST content -- just back off
+                fmt = mime_types[format_from_content_type]
+                if content_type_for(fmt)
+                  parser = Grape::Parser::Base.parser_for fmt, options
+                  unless parser.nil?
+                    begin
+                      body = parser.call body, env
+                      env['rack.request.form_hash'] = env['rack.request.form_hash'] ? env['rack.request.form_hash'].merge(body) : body
+                      env['rack.request.form_input'] = env['rack.input']
+                    rescue
+                      # It's possible that it's just regular POST content -- just back off
+                    end
+                  end
+                else
+                  throw :error, :status => 406, :message => 'The requested content-type is not supported.'
+                end
+              ensure
+                env['rack.input'].rewind
               end
             end
-            env['rack.input'].rewind
           end
-          env['api.format'] = fmt
-        else
-          throw :error, :status => 406, :message => 'The requested format is not supported.'
         end
-      end
 
-      def format_from_extension
-        parts = request.path.split('.')
+        def negotiate_content_type
+          fmt = format_from_extension || format_from_params || options[:format] || format_from_header || options[:default_format]
+          if content_type_for(fmt)
+            env['api.format'] = fmt
+          else
+            throw :error, :status => 406, :message => 'The requested format is not supported.'
+          end
+        end
 
-        if parts.size > 1
-          extension = parts.last
+        def format_from_content_type
+          fmt = env['CONTENT_TYPE']
           # avoid symbol memory leak on an unknown format
-          return extension.to_sym if content_type_for(extension)
+          return fmt.to_sym if content_type_for(fmt)
+          fmt
         end
-        nil
-      end
 
-      def format_from_params
-        fmt = Rack::Utils.parse_nested_query(env['QUERY_STRING'])["format"]
-        # avoid symbol memory leak on an unknown format
-        return fmt.to_sym if content_type_for(fmt)
-        fmt
-      end
+        def format_from_extension
+          parts = request.path.split('.')
 
-      def format_from_header
-        mime_array.each do |t|
-          if mime_types.key?(t)
-            return mime_types[t]
+          if parts.size > 1
+            extension = parts.last
+            # avoid symbol memory leak on an unknown format
+            return extension.to_sym if content_type_for(extension)
           end
+          nil
         end
-        nil
-      end
 
-      def mime_array
-        accept = headers['accept'] or return []
+        def format_from_params
+          fmt = Rack::Utils.parse_nested_query(env['QUERY_STRING'])["format"]
+          # avoid symbol memory leak on an unknown format
+          return fmt.to_sym if content_type_for(fmt)
+          fmt
+        end
 
-        accept.gsub(/\b/,'').scan(%r((\w+/[\w+.-]+)(?:(?:;[^,]*?)?;\s*q=([\d.]+))?)).sort_by { |_, q| -q.to_f }.map {|mime, _|
-          mime.sub(%r(vnd\.[^+]+\+), '')
-        }
-      end
+        def format_from_header
+          mime_array.each do |t|
+            if mime_types.key?(t)
+              return mime_types[t]
+            end
+          end
+          nil
+        end
 
-      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
+        def mime_array
+          accept = headers['accept'] or return []
+
+          accept.gsub(/\b/,'').scan(%r((\w+/[\w+.-]+)(?:(?:;[^,]*?)?;\s*q=([\d.]+))?)).sort_by { |_, q| -q.to_f }.map {|mime, _|
+            mime.sub(%r(vnd\.[^+]+\+), '')
+          }
         end
-        headers['Content-Type'] = content_type_for(env['api.format']) unless headers['Content-Type']
-        Rack::Response.new(bodymap, status, headers).to_a
-      end
 
     end
   end

data/lib/grape/util/content_types.rb

@@ -0,0 +1,19 @@
+require 'active_support/ordered_hash'
+
+module Grape
+  module ContentTypes
+    # Content types are listed in order of preference.
+    CONTENT_TYPES = ActiveSupport::OrderedHash[
+      :xml,  'application/xml',
+      :serializable_hash, 'application/json',
+      :json, 'application/json',
+      :atom, 'application/atom+xml',
+      :rss,  'application/rss+xml',
+      :txt,  'text/plain',
+    ]
+
+    def self.content_types_for(from_settings)
+      from_settings || Grape::ContentTypes::CONTENT_TYPES
+    end
+  end
+end

data/lib/grape/validations.rb

@@ -1,12 +1,14 @@
 require 'virtus'
+require 'i18n'
 
+I18n.load_path << File.expand_path('../locale/en.yml', __FILE__)
 module Grape
-    
+
   module Validations
-    
+
     ##
     # All validators must inherit from this class.
-    # 
+    #
     class Validator
       attr_reader :attrs
 
@@ -30,6 +32,11 @@ module Grape
         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)
@@ -60,17 +67,17 @@ module Grape
         Validations::register_validator(short_name, klass)
       end
     end
-    
+
     class << self
       attr_accessor :validators
     end
-    
+
     self.validators = {}
-    
+
     def self.register_validator(short_name, klass)
       validators[short_name] = klass
     end
-    
+
     class ParamsScope
       attr_accessor :element, :parent
 
@@ -80,17 +87,17 @@ module Grape
         @api = api
         instance_eval(&block)
       end
-      
+
       def requires(*attrs)
         validations = {:presence => true}
         if attrs.last.is_a?(Hash)
           validations.merge!(attrs.pop)
         end
-        
+
         push_declared_params(attrs)
         validates(attrs, validations)
       end
-      
+
       def optional(*attrs)
         validations = {}
         if attrs.last.is_a?(Hash)
@@ -119,16 +126,16 @@ module Grape
     private
       def validates(attrs, validations)
         doc_attrs = { :required => validations.keys.include?(:presence) }
-        
+
         # special case (type = coerce)
         if validations[:type]
           validations[:coerce] = validations.delete(:type)
         end
-        
+
         if coerce_type = validations[:coerce]
           doc_attrs[:type] = coerce_type.to_s
         end
-        
+
         if desc = validations.delete(:desc)
           doc_attrs[:desc] = desc
         end
@@ -169,18 +176,18 @@ module Grape
         @api.settings[:declared_params] += attrs
       end
     end
-    
+
     # This module is mixed into the API Class.
     module ClassMethods
       def reset_validations!
         settings.peek[:declared_params] = []
         settings.peek[:validations] = []
       end
-      
+
       def params(&block)
         ParamsScope.new(self, nil, nil, &block)
       end
-      
+
       def document_attribute(names, opts)
         @last_description ||= {}
         @last_description[:params] ||= {}
@@ -189,9 +196,9 @@ module Grape
           @last_description[:params][name[:full_name].to_s].merge!(opts)
         end
       end
-      
+
     end
-    
+
   end
 end
 

data/lib/grape/validations/coerce.rb

@@ -3,28 +3,28 @@ module Grape
   class API
     Boolean = Virtus::Attribute::Boolean
   end
-  
+
   module Validations
-    
+
     class CoerceValidator < SingleOptionValidator
       def validate_param!(attr_name, params)
         new_value = coerce_value(@option, params[attr_name])
         if valid_type?(new_value)
           params[attr_name] = new_value
         else
-          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => "invalid parameter: #{attr_name}"
+          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => i18n_message(:coerce, attr_name)
         end
       end
-  
+
       class InvalidValue; end
     private
-    
+
       def _valid_array_type?(type, values)
         values.all? do |val|
           _valid_single_type?(type, val)
         end
       end
-      
+
       def _valid_single_type?(klass, val)
         # allow nil, to ignore when a parameter is absent
         return true if val.nil?
@@ -36,7 +36,7 @@ module Grape
           val.is_a?(klass)
         end
       end
-      
+
       def valid_type?(val)
         if @option.is_a?(Array)
           _valid_array_type?(@option[0], val)
@@ -44,18 +44,18 @@ module Grape
           _valid_single_type?(@option, val)
         end
       end
-      
+
       def coerce_value(type, val)
         converter = Virtus::Attribute.build(:a, type)
         converter.coerce(val)
-      
+
       # not the prettiest but some invalid coercion can currently trigger
       # errors in Virtus (see coerce_spec.rb)
       rescue
         InvalidValue.new
       end
-      
+
     end
-    
+
   end
 end

data/lib/grape/validations/presence.rb

@@ -3,7 +3,7 @@ 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 => "missing parameter: #{attr_name}"
+          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => i18n_message(:presence, attr_name)
         end
       end
     end

data/lib/grape/validations/regexp.rb

@@ -1,10 +1,10 @@
 module Grape
   module Validations
-    
+
     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 => "invalid parameter: #{attr_name}"
+          raise Grape::Exceptions::ValidationError, :status => 400, :param => attr_name, :message => i18n_message(:regexp, attr_name)
         end
       end
     end

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/spec/grape/api_spec.rb

@@ -1078,6 +1078,44 @@ describe Grape::API do
     end
   end
 
+  describe '.parser' do
+    context 'lambda parser' do
+      before :each do
+        subject.content_type :txt, "text/plain"
+        subject.content_type :custom, "text/custom"
+        subject.parser :custom, lambda { |object, env| { object.to_sym => object.to_s.reverse } }
+        subject.put :simple do
+          params[:simple]
+        end
+      end
+      it 'uses parser' do
+        put '/simple', "simple", "CONTENT_TYPE" => "text/custom"
+        last_response.status.should == 200
+        last_response.body.should eql "elpmis"
+      end
+    end
+    context 'custom parser class' do
+      module CustomParser
+        def self.call(object, env)
+          { object.to_sym => object.to_s.reverse }
+        end
+      end
+      before :each do
+        subject.content_type :txt, "text/plain"
+        subject.content_type :custom, "text/custom"
+        subject.parser :custom, CustomParser
+        subject.put :simple do
+          params[:simple]
+        end
+      end
+      it 'uses custom parser' do
+        put '/simple', "simple", "CONTENT_TYPE" => "text/custom"
+        last_response.status.should == 200
+        last_response.body.should eql "elpmis"
+      end
+    end
+  end
+
   describe '.default_error_status' do
     it 'allows setting default_error_status' do
       subject.rescue_from :all
@@ -1270,10 +1308,10 @@ describe Grape::API do
       subject.routes.map { |route|
         { :description => route.route_description, :params => route.route_params }
       }.should eq [
-        { :description => "method", 
-          :params => { 
-            "ns_param" => { :required => true, :desc => "namespace parameter" }, 
-            "method_param" => { :required => false, :desc => "method parameter" } 
+        { :description => "method",
+          :params => {
+            "ns_param" => { :required => true, :desc => "namespace parameter" },
+            "method_param" => { :required => false, :desc => "method parameter" }
           }
         }
       ]
@@ -1301,13 +1339,13 @@ describe Grape::API do
       subject.routes.map { |route|
         { :description => route.route_description, :params => route.route_params }
       }.should eq [
-        { :description => "method", 
-          :params => { 
-            "ns_param" => { :required => true, :desc => "ns param 2" }, 
-            "ns1_param" => { :required => true, :desc => "ns1 param" }, 
-            "ns2_param" => { :required => true, :desc => "ns2 param" }, 
-            "method_param" => { :required => false, :desc => "method param" } 
-          } 
+        { :description => "method",
+          :params => {
+            "ns_param" => { :required => true, :desc => "ns param 2" },
+            "ns1_param" => { :required => true, :desc => "ns1 param" },
+            "ns2_param" => { :required => true, :desc => "ns2 param" },
+            "method_param" => { :required => false, :desc => "method param" }
+          }
         }
       ]
     end
@@ -1325,12 +1363,12 @@ describe Grape::API do
       end
       subject.get "method" do ; end
 
-      subject.routes.map { |route| 
+      subject.routes.map { |route|
         route.route_params
       }.should eq [{
         "group1[param1]" => { :required => false, :desc => "group1 param1 desc" },
         "group1[param2]" => { :required => true, :desc => "group1 param2 desc" },
-        "group2[param1]" => { :required => false, :desc => "group2 param1 desc" }, 
+        "group2[param1]" => { :required => false, :desc => "group2 param1 desc" },
         "group2[param2]" => { :required => true, :desc => "group2 param2 desc" }
       }]
     end
@@ -1346,11 +1384,11 @@ describe Grape::API do
       subject.routes.map { |route|
         { :description => route.route_description, :params => route.route_params }
       }.should eq [
-        { :description => "nesting", 
-          :params => { 
-            "root_param" => { :required => true, :desc => "root param" }, 
-            "nested[nested_param]" => { :required => true, :desc => "nested param" } 
-          } 
+        { :description => "nesting",
+          :params => {
+            "root_param" => { :required => true, :desc => "root param" },
+            "nested[nested_param]" => { :required => true, :desc => "nested param" }
+          }
         }
       ]
     end
@@ -1550,6 +1588,7 @@ describe Grape::API do
     context ':txt' do
       before(:each) do
         subject.format :txt
+        subject.content_type :json, "application/json"
         subject.get '/meaning_of_life' do
           { :meaning_of_life => 42 }
         end
@@ -1567,9 +1606,30 @@ describe Grape::API do
         last_response.body.should == { :meaning_of_life => 42 }.to_s
       end
     end
+    context ':txt only' do
+      before(:each) do
+        subject.format :txt
+        subject.get '/meaning_of_life' do
+          { :meaning_of_life => 42 }
+        end
+      end
+      it 'forces txt without an extension' do
+        get '/meaning_of_life'
+        last_response.body.should == { :meaning_of_life => 42 }.to_s
+      end
+      it 'forces txt with the wrong extension' do
+        get '/meaning_of_life.json'
+        last_response.body.should == { :meaning_of_life => 42 }.to_s
+      end
+      it 'forces txt from a non-accepting header' do
+        get '/meaning_of_life', {}, { 'HTTP_ACCEPT' => 'application/json' }
+        last_response.body.should == { :meaning_of_life => 42 }.to_s
+      end
+    end
     context ':json' do
       before(:each) do
         subject.format :json
+        subject.content_type :txt, "text/plain"
         subject.get '/meaning_of_life' do
           { :meaning_of_life => 42 }
         end

data/spec/grape/endpoint_spec.rb

@@ -7,11 +7,11 @@ describe Grape::Endpoint do
   describe '#initialize' do
     it 'takes a settings stack, options, and a block' do
       p = Proc.new {}
-      expect { 
+      expect {
         Grape::Endpoint.new(Grape::Util::HashStack.new, {
           :path => '/',
           :method => :get
-        }, &p) 
+        }, &p)
       }.not_to raise_error
     end
   end
@@ -246,7 +246,6 @@ describe Grape::Endpoint do
         subject.post '/request_body' do
           params[:user]
         end
-
         subject.put '/request_body' do
           params[:user]
         end
@@ -274,18 +273,24 @@ describe Grape::Endpoint do
 
       it 'does not include parameters not defined by the body' do
         subject.post '/omitted_params' do
-          body_params[:version].should == nil
+          params[:version].should == nil
+          params[:user].should == 'Bob'
         end
-        post '/omitted_params', MultiJson.dump(:user => 'Blah'), {'CONTENT_TYPE' => 'application/json'}
+        post '/omitted_params', MultiJson.dump(:user => 'Bob'), {'CONTENT_TYPE' => 'application/json'}
       end
+    end
 
-      it 'should return an equivalent hash on subsequenst calls' do
-        subject.post '/two_times' do
-          body_params.should == body_params
-        end
-        post '/two_times', MultiJson.dump(:user => 'Bobby T.'), {'CONTENT_TYPE' => 'application/json'}
+    it "responds with a 406 for an unsupported content-type" do
+      subject.format :json
+      # subject.content_type :json, "application/json"
+      subject.put '/request_body' do
+        params[:user]
       end
+      put '/request_body', '<user>Bobby T.</user>', {'CONTENT_TYPE' => 'application/xml'}
+      last_response.status.should == 406
+      last_response.body.should == '{"error":"The requested content-type is not supported."}'
     end
+
   end
 
   describe '#error!' do
@@ -437,6 +442,20 @@ describe Grape::Endpoint do
       last_response.body.should == 'Hiya'
     end
 
+    it 'pulls a representation from the class options if the presented object is a collection of objects' do
+      entity = Class.new(Grape::Entity)
+      entity.stub!(:represent).and_return("Hiya")
+
+      class TestObject; end
+
+      subject.represent TestObject, :with => entity
+      subject.get '/example' do
+        present [TestObject.new]
+      end
+      get '/example'
+      last_response.body.should == "Hiya"
+    end
+
     it 'pulls a representation from the class ancestor if it exists' do
       entity = Class.new(Grape::Entity)
       entity.stub!(:represent).and_return("Hiya")
@@ -465,6 +484,20 @@ describe Grape::Endpoint do
       last_response.body.should == 'Auto-detect!'
     end
 
+    it 'automatically uses Klass::Entity based on the first object in the collection being presented' do
+      some_model = Class.new
+      entity = Class.new(Grape::Entity)
+      entity.stub!(:represent).and_return("Auto-detect!")
+
+      some_model.const_set :Entity, entity
+
+      subject.get '/example' do
+        present [some_model.new]
+      end
+      get '/example'
+      last_response.body.should == 'Auto-detect!'
+    end
+
     it 'adds a root key to the output if one is given' do
       subject.get '/example' do
         present({:abc => 'def'}, :root => :root)
@@ -606,5 +639,5 @@ describe Grape::Endpoint do
       last_response.body.should == "http://example.org/api/v1/url"
     end
   end
-  
+
 end

data/spec/grape/middleware/formatter_spec.rb

@@ -149,16 +149,37 @@ describe Grape::Middleware::Formatter do
 
   context 'Input' do
     it 'parses the body from a POST/PUT and put the contents into rack.request.form_hash' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json', 'rack.input' => StringIO.new('{"is_boolean":true,"string":"thing"}')})
+      io = StringIO.new('{"is_boolean":true,"string":"thing"}')
+      subject.call({
+        'PATH_INFO' => '/info',
+        'REQUEST_METHOD' => 'POST',
+        'CONTENT_TYPE' => 'application/json',
+        'rack.input' => io,
+        'CONTENT_LENGTH' => io.length
+      })
       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 POST/PUT and put the contents into rack.request.from_hash' do
-      subject.call({'PATH_INFO' => '/info.xml', 'HTTP_ACCEPT' => 'application/xml', 'rack.input' => StringIO.new('<thing><name>Test</name></thing>')})
+      io = StringIO.new('<thing><name>Test</name></thing>')
+      subject.call({
+        'PATH_INFO' => '/info.xml',
+        'REQUEST_METHOD' => 'POST',
+        'CONTENT_TYPE' => 'application/xml',
+        'rack.input' => io,
+        'CONTENT_LENGTH' => io.length
+      })
       subject.env['rack.request.form_hash']['thing']['name'].should == 'Test'
     end
     it 'is able to fail gracefully if the body is regular POST content' do
-      subject.call({'PATH_INFO' => '/info', 'HTTP_ACCEPT' => 'application/json', 'rack.input' => StringIO.new('name=Other+Test+Thing')})
+      io = StringIO.new('name=Other+Test+Thing')
+      subject.call({
+        'PATH_INFO' => '/info',
+        'REQUEST_METHOD' => 'POST',
+        'CONTENT_TYPE' => 'application/json',
+        'rack.input' => io,
+        'CONTENT_LENGTH' => io.length
+      })
       subject.env['rack.request.form_hash'].should be_nil
     end
   end

data/spec/grape/validations/coerce_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe Grape::Validations::CoerceValidator do
@@ -5,11 +6,23 @@ describe Grape::Validations::CoerceValidator do
   def app; subject end
 
   describe 'coerce' do
+    it "i18n error on malformed input" do
+      I18n.load_path << File.expand_path('../zh-CN.yml',__FILE__)
+      I18n.locale = :'zh-CN'
+      subject.params { requires :age, :type => Integer }
+      subject.get '/single' do 'int works'; end
+
+      get '/single', :age => '43a'
+      last_response.status.should == 400
+      last_response.body.should == '年龄格式不正确'
+      I18n.locale = :en
+
+    end
     it 'error on malformed input' do
       subject.params { requires :int, :type => Integer }
       subject.get '/single' do 'int works'; end
 
-      get '/single', :int => '43a' 
+      get '/single', :int => '43a'
       last_response.status.should == 400
       last_response.body.should == 'invalid parameter: int'
 
@@ -89,7 +102,7 @@ describe Grape::Validations::CoerceValidator do
         get '/bool', { :bool => 1 }
         last_response.status.should == 200
         last_response.body.should == 'TrueClass'
-        
+
         get '/bool', { :bool => 0 }
         last_response.status.should == 200
         last_response.body.should == 'FalseClass'

data/spec/grape/validations/presence_spec.rb

@@ -64,15 +64,21 @@ describe Grape::Validations::PresenceValidator do
   end
 
   it 'validates id' do
-    post('/')
+    post '/'
     last_response.status.should == 400
     last_response.body.should == '{"error":"missing parameter: id"}'
 
-    post('/', {}, 'rack.input' => StringIO.new('{"id" : "a56b"}'))
+    io = StringIO.new('{"id" : "a56b"}')
+    post '/', {}, 'rack.input' => io,
+      'CONTENT_TYPE' => 'application/json',
+      'CONTENT_LENGTH' => io.length
     last_response.body.should == '{"error":"invalid parameter: id"}'
     last_response.status.should == 400
 
-    post('/', {}, 'rack.input' => StringIO.new('{"id" : 56}'))
+    io = StringIO.new('{"id" : 56}')
+    post '/', {}, 'rack.input' => io,
+      'CONTENT_TYPE' => 'application/json',
+      'CONTENT_LENGTH' => io.length
     last_response.body.should == '{"ret":56}'
     last_response.status.should == 201
   end

data/spec/grape/validations/zh-CN.yml

@@ -0,0 +1,9 @@
+zh-CN:
+  grape:
+    errors:
+      attributes:
+        age: 年龄
+      messages:
+        coerce: '%{attribute}格式不正确'
+        presence: '请填写{attribute}'
+        regexp: '%{attribute}格式不正确'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-06 00:00:00.000000000 Z
+date: 2013-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -285,6 +285,7 @@ files:
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
+- lib/grape/locale/en.yml
 - lib/grape/middleware/auth/basic.rb
 - lib/grape/middleware/auth/digest.rb
 - lib/grape/middleware/auth/oauth2.rb
@@ -300,6 +301,7 @@ files:
 - lib/grape/parser/json.rb
 - lib/grape/parser/xml.rb
 - lib/grape/route.rb
+- lib/grape/util/content_types.rb
 - lib/grape/util/deep_merge.rb
 - lib/grape/util/hash_stack.rb
 - lib/grape/validations.rb
@@ -325,6 +327,7 @@ files:
 - spec/grape/validations/coerce_spec.rb
 - spec/grape/validations/presence_spec.rb
 - spec/grape/validations/regexp_spec.rb
+- spec/grape/validations/zh-CN.yml
 - spec/grape/validations_spec.rb
 - spec/shared/versioning_examples.rb
 - spec/spec_helper.rb
@@ -345,7 +348,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -130218097
+      hash: 3430639806354577699
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -354,12 +357,36 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -130218097
+      hash: 3430639806354577699
 requirements: []
 rubyforge_project: grape
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple Ruby framework for building REST-like APIs.
-test_files: []
+test_files:
+- spec/grape/api_spec.rb
+- spec/grape/endpoint_spec.rb
+- spec/grape/entity_spec.rb
+- spec/grape/middleware/auth/basic_spec.rb
+- spec/grape/middleware/auth/digest_spec.rb
+- spec/grape/middleware/auth/oauth2_spec.rb
+- spec/grape/middleware/base_spec.rb
+- spec/grape/middleware/error_spec.rb
+- spec/grape/middleware/exception_spec.rb
+- spec/grape/middleware/formatter_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/presence_spec.rb
+- spec/grape/validations/regexp_spec.rb
+- spec/grape/validations/zh-CN.yml
+- spec/grape/validations_spec.rb
+- spec/shared/versioning_examples.rb
+- spec/spec_helper.rb
+- spec/support/basic_auth_encode_helpers.rb
+- spec/support/versioned_helpers.rb
 has_rdoc: