grape 0.6.0 → 0.6.1

data/lib/grape/middleware/versioner.rb

@@ -9,7 +9,7 @@
 module Grape
   module Middleware
     module Versioner
-      extend self
+      module_function
 
       # @param strategy [Symbol] :path, :header or :param
       # @return a middleware class based on strategy

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

@@ -24,21 +24,21 @@ module Grape
           if strict?
             # If no Accept-Version header:
             if potential_version.empty?
-              throw :error, :status => 406, :headers => error_headers, :message => 'Accept-Version header must be set.'
+              throw :error, status: 406, headers: error_headers, message: 'Accept-Version header must be set.'
             end
           end
 
           unless potential_version.empty?
             # If the requested version is not supported:
-            if !versions.any? { |v| v.to_s == potential_version }
-              throw :error, :status => 406, :headers => error_headers, :message => 'The requested version is not supported.'
+            unless versions.any? { |v| v.to_s == potential_version }
+              throw :error, status: 406, headers: error_headers, message: 'The requested version is not supported.'
             end
 
             env['api.version'] = potential_version
           end
         end
 
-      private
+        private
 
         def versions
           options[:versions] || []
@@ -52,9 +52,11 @@ module Grape
         # 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] : 
+          if options[:version_options] && options[:version_options].has_key?(:cascade)
+            !!options[:version_options][:cascade]
+          else
             true
+          end
         end
 
         def error_headers

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

@@ -29,15 +29,15 @@ module Grape
           if strict?
             # If no Accept header:
             if header.qvalues.empty?
-              throw :error, :status => 406, :headers => error_headers, :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,_|
-              Rack::Accept::Header.parse_media_type(media_type).find{|s| s == '*'}
+            header.qvalues.reject! do |media_type, _|
+              Rack::Accept::Header.parse_media_type(media_type).find { |s| s == '*' }
             end
             # If all Accept headers included a range:
             if header.qvalues.empty?
-              throw :error, :status => 406, :headers => error_headers, :message => 'Accept header must not contain ranges ("*").'
+              throw :error, status: 406, headers: error_headers, message: 'Accept header must not contain ranges ("*").'
             end
           end
 
@@ -55,19 +55,19 @@ module Grape
             end
           # If none of the available content types are acceptable:
           elsif strict?
-            throw :error, :status => 406, :headers => error_headers, :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 => error_headers, :message => 'API vendor or version not found.'
+          elsif header.values.all? { |header_value| has_vendor?(header_value) || has_version?(header_value) }
+            throw :error, status: 406, headers: error_headers, message: 'API vendor or version not found.'
           end
         end
 
-      private
+        private
 
         def available_media_types
           available_media_types = []
 
-          content_types.each do |extension,media_type|
+          content_types.each do |extension, media_type|
             versions.reverse.each do |version|
               available_media_types += ["application/vnd.#{vendor}-#{version}+#{extension}", "application/vnd.#{vendor}-#{version}"]
             end
@@ -76,7 +76,7 @@ module Grape
 
           available_media_types << "application/vnd.#{vendor}"
 
-          content_types.each do |_,media_type|
+          content_types.each do |_, media_type|
             available_media_types << media_type
           end
 
@@ -99,9 +99,11 @@ module Grape
         # 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] :
+          if options[:version_options] && options[:version_options].has_key?(:cascade)
+            !!options[:version_options][:cascade]
+          else
             true
+          end
         end
 
         def error_headers
@@ -111,14 +113,14 @@ module Grape
         # @param [String] media_type a content type
         # @return [Boolean] whether the content type sets a vendor
         def has_vendor?(media_type)
-          type, subtype = Rack::Accept::Header.parse_media_type media_type
+          _, subtype = Rack::Accept::Header.parse_media_type media_type
           subtype[/\Avnd\.[a-z0-9*.]+/]
         end
 
         # @param [String] media_type a content type
         # @return [Boolean] whether the content type sets an API version
         def has_version?(media_type)
-          type, subtype = Rack::Accept::Header.parse_media_type media_type
+          _, subtype = Rack::Accept::Header.parse_media_type media_type
           subtype[/\Avnd\.[a-z0-9*.]+-[a-z0-9*\-.]+/]
         end
 

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

@@ -4,24 +4,24 @@ module Grape
   module Middleware
     module Versioner
       # This middleware sets various version related rack environment variables
-      # based on the request parameters and removes that parameter from the 
+      # based on the request parameters and removes that parameter from the
       # request parameters for subsequent middleware and API.
       # If the version substring does not match any potential initialized
       # versions, a 404 error is thrown.
       # If the version substring is not passed the version (highest mounted)
       # version will be used.
-      # 
+      #
       # Example: For a uri path
       #   /resource?apiver=v1
-      # 
+      #
       # The following rack env variables are set and path is rewritten to
       # '/resource':
-      # 
+      #
       #   env['api.version'] => 'v1'
       class Param < Base
         def default_options
           {
-            :parameter => "apiver"
+            parameter: "apiver"
           }
         end
 
@@ -30,8 +30,8 @@ module Grape
           potential_version = request.params[paramkey]
 
           unless potential_version.nil?
-            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'}
+            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
             env['rack.request.query_hash'].delete(paramkey)

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

@@ -7,19 +7,19 @@ module Grape
       # based on the uri path and removes the version substring from the uri
       # path. If the version substring does not match any potential initialized
       # versions, a 404 error is thrown.
-      # 
+      #
       # Example: For a uri path
       #   /v1/resource
-      # 
+      #
       # The following rack env variables are set and path is rewritten to
       # '/resource':
-      # 
+      #
       #   env['api.version'] => 'v1'
-      # 
+      #
       class Path < Base
         def default_options
           {
-            :pattern => /.*/i
+            pattern: /.*/i
           }
         end
 
@@ -34,11 +34,9 @@ module Grape
           pieces = path.split('/')
           potential_version = pieces[1]
           if potential_version =~ options[:pattern]
-            if options[:versions] && ! options[:versions].find { |v| v.to_s == potential_version }
-              throw :error, :status => 404, :message => "404 API Version Not Found"
+            if options[:versions] && !options[:versions].find { |v| v.to_s == potential_version }
+              throw :error, status: 404, message: "404 API Version Not Found"
             end
-
-            truncated_path = "/#{pieces[2..-1].join('/')}"
             env['api.version'] = potential_version
           end
         end

data/lib/grape/parser/base.rb

@@ -5,8 +5,9 @@ module Grape
       class << self
 
         PARSERS = {
-          :json => Grape::Parser::Json,
-          :xml => Grape::Parser::Xml
+          json: Grape::Parser::Json,
+          jsonapi: Grape::Parser::Json,
+          xml: Grape::Parser::Xml
         }
 
         def parsers(options)

data/lib/grape/path.rb

@@ -62,7 +62,7 @@ module Grape
       parts << raw_path.to_s
       parts.flatten.reject { |part| part == '/' }
     end
-    
+
     def split_setting(key, delimiter)
       return if settings[key].nil?
       settings[key].to_s.split("/")

data/lib/grape/route.rb

@@ -2,24 +2,26 @@ module Grape
 
   # A compiled route for inspection.
   class Route
-  
+
     def initialize(options = {})
       @options = options || {}
     end
-    
+
     def method_missing(method_id, *arguments)
-      if match = /route_([_a-zA-Z]\w*)/.match(method_id.to_s)
+      match = /route_([_a-zA-Z]\w*)/.match(method_id.to_s)
+      if match
         @options[match.captures.last.to_sym]
       else
         super
       end
     end
-    
+
     def to_s
       "version=#{route_version}, method=#{route_method}, path=#{route_path}"
     end
 
     private
+
     def to_ary
       nil
     end

data/lib/grape/util/content_types.rb

@@ -5,10 +5,11 @@ module Grape
       :xml,  'application/xml',
       :serializable_hash, 'application/json',
       :json, 'application/json',
+      :jsonapi, 'application/vnd.api+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

data/lib/grape/util/deep_merge.rb

@@ -3,18 +3,18 @@ class Hash
   # activesupport/lib/active_support/core_ext/hash/deep_merge.rb
   # Returns a new hash with +self+ and +other_hash+ merged recursively.
   #
-  #     h1 = {:x => {:y => [4,5,6]}, :z => [7,8,9]}
-  #     h2 = {:x => {:y => [7,8,9]}, :z => "xyz"}
+  #     h1 = {x: {y: [4,5,6]}, z: [7,8,9]}
+  #     h2 = {x: {y: [7,8,9]}, z: "xyz"}
   #
-  #     h1.deep_merge(h2) #=> { :x => {:y => [7, 8, 9]}, :z => "xyz" }
-  #     h2.deep_merge(h1) #=> { :x => {:y => [4, 5, 6]}, :z => [7, 8, 9] }
+  #     h1.deep_merge(h2) #=> { x: {y: [7, 8, 9]}, z: "xyz" }
+  #     h2.deep_merge(h1) #=> { x: {y: [4, 5, 6]}, z: [7, 8, 9] }
   def deep_merge(other_hash)
     dup.deep_merge!(other_hash)
   end
 
   # Same as +deep_merge+, but modifies +self+.
   def deep_merge!(other_hash)
-    other_hash.each_pair do |k,v|
+    other_hash.each_pair do |k, v|
       tv = self[k]
       self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
     end

data/lib/grape/util/hash_stack.rb

@@ -84,7 +84,7 @@ module Grape
 
       # Prepend another HashStack's to self
       def prepend(hash_stack)
-        @stack.unshift *hash_stack.stack
+        @stack.unshift(*hash_stack.stack)
         self
       end
 
@@ -100,7 +100,7 @@ module Grape
       # @param key [Symbol] The key to gather
       # @return [Array]
       def gather(key)
-        stack.map{|s| s[key] }.flatten.compact.uniq
+        stack.map { |s| s[key] }.flatten.compact.uniq
       end
 
       def to_s

data/lib/grape/validations.rb

@@ -45,14 +45,14 @@ module Grape
         end
       end
 
-    private
+      private
 
       def self.convert_to_short_name(klass)
-        ret = klass.name.gsub(/::/, '/').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
+        ret = klass.name.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr("-", "_")
+          .downcase
         File.basename(ret, '_validator')
       end
     end
@@ -72,7 +72,7 @@ module Grape
     class Validator
       def self.inherited(klass)
         short_name = convert_to_short_name(klass)
-        Validations::register_validator(short_name, klass)
+        Validations.register_validator(short_name, klass)
       end
     end
 
@@ -110,10 +110,8 @@ module Grape
       def requires(*attrs, &block)
         return new_scope(attrs, &block) if block_given?
 
-        validations = {:presence => true}
-        if attrs.last.is_a?(Hash)
-          validations.merge!(attrs.pop)
-        end
+        validations = { presence: true }
+        validations.merge!(attrs.pop) if attrs.last.is_a?(Hash)
 
         push_declared_params(attrs)
         validates(attrs, validations)
@@ -123,9 +121,7 @@ module Grape
         return new_scope(attrs, true, &block) if block_given?
 
         validations = {}
-        if attrs.last.is_a?(Hash)
-          validations.merge!(attrs.pop)
-        end
+        validations.merge!(attrs.pop) if attrs.last.is_a?(Hash)
 
         push_declared_params(attrs)
         validates(attrs, validations)
@@ -146,15 +142,15 @@ module Grape
         name.to_s
       end
 
-    protected
+      protected
 
       def push_declared_params(attrs)
         @declared_params.concat attrs
       end
 
-    private
+      private
 
-      def new_scope(attrs, optional=false, &block)
+      def new_scope(attrs, optional = false, &block)
         raise ArgumentError unless attrs.size == 1
         ParamsScope.new(api: @api, element: attrs.first, parent: self, optional: optional, &block)
       end
@@ -170,26 +166,34 @@ module Grape
       end
 
       def validates(attrs, validations)
-        doc_attrs = { :required => validations.keys.include?(:presence) }
+        doc_attrs = { required: validations.keys.include?(:presence) }
 
         # special case (type = coerce)
-        if validations[:type]
-          validations[:coerce] = validations.delete(:type)
-        end
+        validations[:coerce] = validations.delete(:type) if validations.key?(:type)
 
-        if coerce_type = validations[:coerce]
-          doc_attrs[:type] = coerce_type.to_s
-        end
+        coerce_type = validations[:coerce]
+        doc_attrs[:type] = coerce_type.to_s if coerce_type
+
+        desc = validations.delete(:desc)
+        doc_attrs[:desc] = desc if desc
+
+        default = validations[:default]
+        doc_attrs[:default] = default if default
+
+        values = validations[:values]
+        doc_attrs[:values] = values if values
 
-        if desc = validations.delete(:desc)
-          doc_attrs[:desc] = desc
+        # default value should be present in values array, if both exist
+        if default && values && !values.include?(default)
+          raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values)
         end
 
-        if default = validations[:default]
-          doc_attrs[:default] = default
+        # type should be compatible with values array, if both exist
+        if coerce_type && values && values.any? { |v| !v.instance_of?(coerce_type) }
+          raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values)
         end
 
-        full_attrs = attrs.collect{ |name| { :name => name, :full_name => full_name(name)} }
+        full_attrs = attrs.collect { |name| { name: name, full_name: full_name(name) } }
         @api.document_attribute(full_attrs, doc_attrs)
 
         # Validate for presence before any other validators
@@ -212,7 +216,7 @@ module Grape
       end
 
       def validate(type, options, attrs, doc_attrs)
-        validator_class = Validations::validators[type.to_s]
+        validator_class = Validations.validators[type.to_s]
 
         if validator_class
           (@api.settings.peek[:validations] ||= []) << validator_class.new(attrs, options, doc_attrs[:required], self)