grape 0.6.0 → 0.6.1

data/lib/grape/exceptions/invalid_with_option_for_represent.rb

@@ -4,12 +4,9 @@ module Grape
     class InvalidWithOptionForRepresent < Base
 
       def initialize
-        super(:message => compose_message("invalid_with_option_for_represent"))
+        super(message: compose_message("invalid_with_option_for_represent"))
       end
 
     end
-
   end
-
 end
-

data/lib/grape/exceptions/missing_mime_type.rb

@@ -4,7 +4,7 @@ module Grape
     class MissingMimeType < Base
 
       def initialize(new_format)
-        super(:message => compose_message("missing_mime_type", :new_format => new_format))
+        super(message: compose_message("missing_mime_type", new_format: new_format))
       end
 
     end

data/lib/grape/exceptions/missing_option.rb

@@ -4,7 +4,7 @@ module Grape
     class MissingOption < Base
 
       def initialize(option)
-        super(:message => compose_message("missing_option", :option => option))
+        super(message: compose_message("missing_option", option: option))
       end
 
     end

data/lib/grape/exceptions/missing_vendor_option.rb

@@ -4,7 +4,7 @@ module Grape
     class MissingVendorOption < Base
 
       def initialize
-        super(:message => compose_message("missing_vendor_option"))
+        super(message: compose_message("missing_vendor_option"))
       end
 
     end

data/lib/grape/exceptions/unknown_options.rb

@@ -4,7 +4,7 @@ module Grape
     class UnknownOptions < Base
 
       def initialize(options)
-        super(:message => compose_message("unknown_options", :options => options))
+        super(message: compose_message("unknown_options", options: options))
       end
 
     end

data/lib/grape/exceptions/unknown_validator.rb

@@ -4,7 +4,7 @@ module Grape
     class UnknownValidator < Base
 
       def initialize(validator_type)
-        super(:message => compose_message("unknown_validator", :validator_type => validator_type))
+        super(message: compose_message("unknown_validator", validator_type: validator_type))
       end
 
     end

data/lib/grape/exceptions/validation.rb

@@ -14,8 +14,8 @@ module Grape
 
       # remove all the unnecessary stuff from Grape::Exceptions::Base like status
       # and headers when converting a validation error to json or string
-      def as_json(*a)
-        self.to_s
+      def as_json(*args)
+        to_s
       end
 
       def to_s

data/lib/grape/exceptions/validation_errors.rb

@@ -31,7 +31,7 @@ module Grape
       end
 
       def full_message(attribute, error)
-        I18n.t(:"grape.errors.format", {
+        I18n.t("grape.errors.format".to_sym, {
           default:  "%{attribute} %{message}",
           attribute: translate_attribute(attribute),
           message:   error.message

data/lib/grape/formatter/base.rb

@@ -5,10 +5,11 @@ module Grape
       class << self
 
         FORMATTERS = {
-          :json => Grape::Formatter::Json,
-          :serializable_hash => Grape::Formatter::SerializableHash,
-          :txt => Grape::Formatter::Txt,
-          :xml => Grape::Formatter::Xml
+          json: Grape::Formatter::Json,
+          jsonapi: Grape::Formatter::Json,
+          serializable_hash: Grape::Formatter::SerializableHash,
+          txt: Grape::Formatter::Txt,
+          xml: Grape::Formatter::Xml
         }
 
         def formatters(options)

data/lib/grape/formatter/serializable_hash.rb

@@ -13,18 +13,19 @@ module Grape
         private
 
           def serializable?(object)
-           object.respond_to?(:serializable_hash) ||
-             object.kind_of?(Array) && !object.map {|o| o.respond_to? :serializable_hash }.include?(false) ||
-             object.kind_of?(Hash)
+            object.respond_to?(:serializable_hash) || object.kind_of?(Array) && !object.map { |o| o.respond_to? :serializable_hash }.include?(false) || object.kind_of?(Hash)
           end
 
           def serialize(object)
             if object.respond_to? :serializable_hash
               object.serializable_hash
-            elsif object.kind_of?(Array) && !object.map {|o| o.respond_to? :serializable_hash }.include?(false)
-              object.map {|o| o.serializable_hash }
+            elsif object.kind_of?(Array) && !object.map { |o| o.respond_to? :serializable_hash }.include?(false)
+              object.map { |o| o.serializable_hash }
             elsif object.kind_of?(Hash)
-              object.inject({}) { |h,(k,v)| h[k] = serialize(v); h }
+              object.inject({}) do |h, (k, v)|
+                h[k] = serialize(v)
+                h
+              end
             else
               object
             end

data/lib/grape/http/request.rb

@@ -15,13 +15,13 @@ module Grape
     end
 
     def headers
-      @env['grape.request.headers'] ||= @env.dup.inject({}) { |h, (k, v)|
+      @env['grape.request.headers'] ||= @env.dup.inject({}) do |h, (k, v)|
         if k.to_s.start_with? 'HTTP_'
           k = k[5..-1].gsub('_', '-').downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }
           h[k] = v
         end
         h
-      }
+      end
     end
 
   end

data/lib/grape/locale/en.yml

@@ -6,6 +6,7 @@ en:
         coerce: 'is invalid'
         presence: 'is missing'
         regexp: 'is invalid'
+        values: 'does not have a valid value'
         missing_vendor_option:
           problem: 'missing :vendor option.'
           summary: 'when version using header, you must specify :vendor option. '
@@ -26,3 +27,4 @@ en:
           resolution: 'available strategy for :using is :path, :header, :param'
         unknown_validator: 'unknown validator: %{validator_type}'
         unknown_options: 'unknown options: %{options}'
+        incompatible_option_values: '%{option1}: %{value1} is incompatible with %{option2}: %{value2}'

data/lib/grape/middleware/auth/base.rb

@@ -12,16 +12,16 @@ module Grape
         end
 
         def base_request
-          raise NotImplementedError.new("You must implement base_request.")
+          raise NotImplementedError, "You must implement base_request."
         end
 
         def credentials
-          base_request.provided?? base_request.credentials : [nil, nil]
+          base_request.provided? ? base_request.credentials : [nil, nil]
         end
 
         def before
           unless authenticator.call(*credentials)
-            throw :error, :status => 401, :message => "API Authorization Failed."
+            throw :error, status: 401, message: "API Authorization Failed."
           end
         end
       end

data/lib/grape/middleware/auth/basic.rb

@@ -10,4 +10,4 @@ module Grape
       end
     end
   end
-end
+end

data/lib/grape/middleware/auth/oauth2.rb

@@ -3,14 +3,14 @@ module Grape::Middleware::Auth
   class OAuth2 < Grape::Middleware::Base
     def default_options
       {
-        :token_class => 'AccessToken',
-        :realm => 'OAuth API',
-        :parameter => %w(bearer_token oauth_token),
-        :accepted_headers => %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION),
-        :header => [/Bearer (.*)/i, /OAuth (.*)/i]
+        token_class: 'AccessToken',
+        realm: 'OAuth API',
+        parameter: %w(bearer_token oauth_token),
+        accepted_headers: %w(HTTP_AUTHORIZATION X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION REDIRECT_X_HTTP_AUTHORIZATION),
+        header: [/Bearer (.*)/i, /OAuth (.*)/i]
       }
     end
-    
+
     def before
       verify_token(token_parameter || token_header)
     end
@@ -25,9 +25,7 @@ module Grape::Middleware::Auth
     def token_header
       return false unless authorization_header
       Array(options[:header]).each do |regexp|
-        if authorization_header =~ regexp
-          return $1
-        end
+        return $1 if authorization_header =~ regexp
       end
       nil
     end
@@ -38,13 +36,14 @@ module Grape::Middleware::Auth
       end
       nil
     end
-    
+
     def token_class
-      @klass ||= eval(options[:token_class])
+      @klass ||= eval(options[:token_class]) # rubocop:disable Eval
     end
-    
+
     def verify_token(token)
-      if token = token_class.verify(token)
+      token = token_class.verify(token)
+      if token
         if token.respond_to?(:expired?) && token.expired?
           error_out(401, 'expired_token')
         else
@@ -58,15 +57,14 @@ module Grape::Middleware::Auth
         error_out(401, 'invalid_token')
       end
     end
-    
+
     def error_out(status, error)
       throw :error,
-        :message => error,
-        :status => status,
-        :headers => {
-          'WWW-Authenticate' => "OAuth realm='#{options[:realm]}', error='#{error}'"
-        }
+            message: error,
+            status: status,
+            headers: {
+              'WWW-Authenticate' => "OAuth realm='#{options[:realm]}', error='#{error}'"
+            }
     end
   end
 end
-    

data/lib/grape/middleware/base.rb

@@ -34,7 +34,7 @@ module Grape
       def after; end
 
       def request
-        Grape::Request.new(self.env)
+        Grape::Request.new(env)
       end
 
       def response

data/lib/grape/middleware/error.rb

@@ -6,15 +6,15 @@ module Grape
 
       def default_options
         {
-          :default_status => 403, # default status returned on error
-          :default_message => "",
-          :format => :txt,
-          :formatters => {},
-          :error_formatters => {},
-          :rescue_all => false, # true to rescue all exceptions
-          :rescue_options => { :backtrace => false }, # true to display backtrace
-          :rescue_handlers => {}, # rescue handler blocks
-          :rescued_errors => []
+          default_status: 403, # default status returned on error
+          default_message: "",
+          format: :txt,
+          formatters: {},
+          error_formatters: {},
+          rescue_all: false, # true to rescue all exceptions
+          rescue_options: { backtrace: false }, # true to display backtrace
+          rescue_handlers: {}, # rescue handler blocks
+          rescued_errors: []
         }
       end
 
@@ -22,13 +22,13 @@ module Grape
         @env = env
 
         begin
-          error_response(catch(:error){
+          error_response(catch(:error) do
             return @app.call(@env)
-          })
-        rescue Exception => e
+          end)
+        rescue StandardError => e
           is_rescuable = rescuable?(e.class)
           if e.is_a?(Grape::Exceptions::Base) && !is_rescuable
-            handler = lambda {|e| error_response(e) }
+            handler = lambda { |arg| error_response(arg) }
           else
             raise unless is_rescuable
             handler = options[:rescue_handlers][e.class] || options[:rescue_handlers][:all]
@@ -44,33 +44,33 @@ module Grape
 
       def exec_handler(e, &handler)
         if handler.lambda? && handler.arity == 0
-          self.instance_exec(&handler)
+          instance_exec(&handler)
         else
-          self.instance_exec(e, &handler)
+          instance_exec(e, &handler)
         end
       end
 
       def handle_error(e)
-        error_response({ :message => e.message, :backtrace => e.backtrace })
+        error_response(message: e.message, backtrace: e.backtrace)
       end
 
       def error_response(error = {})
         status = error[:status] || options[:default_status]
         message = error[:message] || options[:default_message]
-        headers = {'Content-Type' => content_type}
+        headers = { 'Content-Type' => content_type }
         headers.merge!(error[:headers]) if error[:headers].is_a?(Hash)
         backtrace = error[:backtrace] || []
         rack_response(format_message(message, backtrace), status, headers)
       end
 
       def rack_response(message, status = options[:default_status], headers = { 'Content-Type' => content_type })
-        Rack::Response.new([ message ], status, headers).finish
+        Rack::Response.new([message], status, headers).finish
       end
 
       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/filter.rb

@@ -3,14 +3,14 @@ module Grape
     # This is a simple middleware for adding before and after filters
     # to Grape APIs. It is used like so:
     #
-    #     use Grape::Middleware::Filter, :before => lambda{ do_something }, :after => lambda{ do_something }
+    #     use Grape::Middleware::Filter, before: lambda { do_something }, after: lambda { do_something }
     class Filter < Base
       def before
-        app.instance_eval &options[:before] if options[:before]
+        app.instance_eval(&options[:before]) if options[:before]
       end
 
       def after
-        app.instance_eval &options[:after] if options[:after]
+        app.instance_eval(&options[:after]) if options[:after]
       end
     end
   end

data/lib/grape/middleware/formatter.rb

@@ -6,14 +6,17 @@ module Grape
 
       def default_options
         {
-          :default_format => :txt,
-          :formatters => {},
-          :parsers => {}
+          default_format: :txt,
+          formatters: {},
+          parsers: {}
         }
       end
 
       def headers
-        env.dup.inject({}){|h,(k,v)| h[k.to_s.downcase[5..-1]] = v if k.to_s.downcase.start_with?('http_'); h}
+        env.dup.inject({}) do |h, (k, v)|
+          h[k.to_s.downcase[5..-1]] = v if k.to_s.downcase.start_with?('http_')
+          h
+        end
       end
 
       def before
@@ -31,7 +34,7 @@ module Grape
             formatter.call body, env
           end
         rescue Grape::Exceptions::InvalidFormatter => e
-          throw :error, :status => 500, :message => e.message
+          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
@@ -42,8 +45,8 @@ module Grape
         # store read input in env['api.request.input']
         def read_body_input
           if (request.post? || request.put? || request.patch? || request.delete?) &&
-            (! request.form_data? || ! request.media_type) &&
-            (! request.parseable_data?) &&
+            (!request.form_data? || !request.media_type) &&
+            (!request.parseable_data?) &&
             (request.content_length.to_i > 0 || request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')
 
             if (input = env['rack.input'])
@@ -68,19 +71,21 @@ module Grape
               begin
                 body = (env['api.request.body'] = parser.call(body, env))
                 if body.is_a?(Hash)
-                  env['rack.request.form_hash'] = env['rack.request.form_hash'] ?
-                    env['rack.request.form_hash'].merge(body) :
-                    body
+                  if env['rack.request.form_hash']
+                    env['rack.request.form_hash'] = env['rack.request.form_hash'].merge(body)
+                  else
+                    env['rack.request.form_hash'] = body
+                  end
                   env['rack.request.form_input'] = env['rack.input']
                 end
-              rescue Exception => e
-                throw :error, :status => 400, :message => e.message
+              rescue StandardError => e
+                throw :error, status: 400, message: e.message
               end
             else
               env['api.request.body'] = body
             end
           else
-            throw :error, :status => 406, :message => "The requested content-type '#{request.media_type}' is not supported."
+            throw :error, status: 406, message: "The requested content-type '#{request.media_type}' is not supported."
           end
         end
 
@@ -89,7 +94,7 @@ module Grape
           if content_type_for(fmt)
             env['api.format'] = fmt
           else
-            throw :error, :status => 406, :message => "The requested format '#{fmt}' is not supported."
+            throw :error, status: 406, message: "The requested format '#{fmt}' is not supported."
           end
         end
 
@@ -113,15 +118,15 @@ module Grape
 
         def format_from_header
           mime_array.each do |t|
-            if mime_types.key?(t)
-              return mime_types[t]
-            end
+            return mime_types[t] if mime_types.key?(t)
           end
           nil
         end
 
         def mime_array
-          accept = headers['accept'] or return []
+          accept = headers['accept']
+          return [] unless accept
+
           accept_into_mime_and_quality = %r(
             (
               \w+/[\w+.-]+)     # eg application/vnd.example.myformat+xml
@@ -129,12 +134,13 @@ module Grape
              (?:;[^,]*?)?       # optionally multiple formats in a row
              ;\s*q=([\d.]+)     # optional "quality" preference (eg q=0.5)
             )?
-          )x  # x = extended regular expression with comments etc
-          vendor_prefix_pattern = %r(vnd\.[^+]+\+)
+          )x
+
+          vendor_prefix_pattern = /vnd\.[^+]+\+/
 
-          accept.scan(accept_into_mime_and_quality).
-            sort_by { |_, quality_preference| -quality_preference.to_f }.
-            map {|mime, _| mime.sub(vendor_prefix_pattern, '') }
+          accept.scan(accept_into_mime_and_quality)
+            .sort_by { |_, quality_preference| -quality_preference.to_f }
+            .map { |mime, _| mime.sub(vendor_prefix_pattern, '') }
         end
 
     end