grape 0.1.1 → 2.4.0

data/lib/grape/exceptions/base.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class Base < StandardError
+      BASE_MESSAGES_KEY = 'grape.errors.messages'
+      BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'
+      FALLBACK_LOCALE = :en
+
+      attr_reader :status, :headers
+
+      def initialize(status: nil, message: nil, headers: nil)
+        super(message)
+
+        @status  = status
+        @headers = headers
+      end
+
+      def [](index)
+        send index
+      end
+
+      protected
+
+      # TODO: translate attribute first
+      # if BASE_ATTRIBUTES_KEY.key respond to a string message, then short_message is returned
+      # if BASE_ATTRIBUTES_KEY.key respond to a Hash, means it may have problem , summary and resolution
+      def compose_message(key, **attributes)
+        short_message = translate_message(key, attributes)
+        return short_message unless short_message.is_a?(Hash)
+
+        each_steps(key, attributes).with_object(+'') do |detail_array, message|
+          message << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
+        end
+      end
+
+      def each_steps(key, attributes)
+        return enum_for(:each_steps, key, attributes) unless block_given?
+
+        yield 'Problem', translate_message(:"#{key}.problem", attributes)
+        yield 'Summary', translate_message(:"#{key}.summary", attributes)
+        yield 'Resolution', translate_message(:"#{key}.resolution", attributes)
+      end
+
+      def translate_attributes(keys, options = {})
+        keys.map do |key|
+          translate("#{BASE_ATTRIBUTES_KEY}.#{key}", options.merge(default: key.to_s))
+        end.join(', ')
+      end
+
+      def translate_message(key, options = {})
+        case key
+        when Symbol
+          translate("#{BASE_MESSAGES_KEY}.#{key}", options.merge(default: ''))
+        when Proc
+          key.call
+        else
+          key
+        end
+      end
+
+      def translate(key, options)
+        message = ::I18n.translate(key, **options)
+        message.presence || fallback_message(key, options)
+      end
+
+      def fallback_message(key, options)
+        if ::I18n.enforce_available_locales && ::I18n.available_locales.exclude?(FALLBACK_LOCALE)
+          key
+        else
+          ::I18n.translate(key, locale: FALLBACK_LOCALE, **options)
+        end
+      end
+    end
+  end
+end

data/lib/grape/exceptions/conflicting_types.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class ConflictingTypes < Base
+      def initialize
+        super(message: compose_message(:conflicting_types), status: 400)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/empty_message_body.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class EmptyMessageBody < Base
+      def initialize(body_format)
+        super(message: compose_message(:empty_message_body, body_format: body_format), status: 400)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/incompatible_option_values.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class IncompatibleOptionValues < Base
+      def initialize(option1, value1, option2, value2)
+        super(message: compose_message(:incompatible_option_values, option1: option1, value1: value1, option2: option2, value2: value2))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_accept_header.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidAcceptHeader < Base
+      def initialize(message, headers)
+        super(message: compose_message(:invalid_accept_header, message: message), status: 406, headers: headers)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_formatter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidFormatter < Base
+      def initialize(klass, to_format)
+        super(message: compose_message(:invalid_formatter, klass: klass, to_format: to_format))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_message_body.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidMessageBody < Base
+      def initialize(body_format)
+        super(message: compose_message(:invalid_message_body, body_format: body_format), status: 400)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_parameters.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidParameters < Base
+      def initialize
+        super(message: compose_message(:invalid_parameters), status: 400)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidResponse < Base
+      def initialize
+        super(message: compose_message(:invalid_response))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_version_header.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidVersionHeader < Base
+      def initialize(message, headers)
+        super(message: compose_message(:invalid_version_header, message: message), status: 406, headers: headers)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_versioner_option.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidVersionerOption < Base
+      def initialize(strategy)
+        super(message: compose_message(:invalid_versioner_option, strategy: strategy))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/invalid_with_option_for_represent.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class InvalidWithOptionForRepresent < Base
+      def initialize
+        super(message: compose_message(:invalid_with_option_for_represent))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/method_not_allowed.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class MethodNotAllowed < Base
+      def initialize(headers)
+        super(message: '405 Not Allowed', status: 405, headers: headers)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/missing_group_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class MissingGroupType < Base
+      def initialize
+        super(message: compose_message(:missing_group_type))
+      end
+    end
+  end
+end
+
+Grape::Exceptions::MissingGroupTypeError = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Grape::Exceptions::MissingGroupTypeError', 'Grape::Exceptions::MissingGroupType', Grape.deprecator)

data/lib/grape/exceptions/missing_mime_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class MissingMimeType < Base
+      def initialize(new_format)
+        super(message: compose_message(:missing_mime_type, new_format: new_format))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/missing_option.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class MissingOption < Base
+      def initialize(option)
+        super(message: compose_message(:missing_option, option: option))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/missing_vendor_option.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class MissingVendorOption < Base
+      def initialize
+        super(message: compose_message(:missing_vendor_option))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/too_deep_parameters.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class TooDeepParameters < Base
+      def initialize(limit)
+        super(message: compose_message(:too_deep_parameters, limit: limit), status: 400)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/too_many_multipart_files.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class TooManyMultipartFiles < Base
+      def initialize(limit)
+        super(message: compose_message(:too_many_multipart_files, limit: limit), status: 413)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/unknown_auth_strategy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class UnknownAuthStrategy < Base
+      def initialize(strategy:)
+        super(message: compose_message(:unknown_auth_strategy, strategy: strategy))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/unknown_options.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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_parameter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class UnknownParameter < Base
+      def initialize(param)
+        super(message: compose_message(:unknown_parameter, param: param))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/unknown_params_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class UnknownParamsBuilder < Base
+      def initialize(params_builder_type)
+        super(message: compose_message(:unknown_params_builder, params_builder_type: params_builder_type))
+      end
+    end
+  end
+end

data/lib/grape/exceptions/unknown_validator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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/unsupported_group_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class UnsupportedGroupType < Base
+      def initialize
+        super(message: compose_message(:unsupported_group_type))
+      end
+    end
+  end
+end
+
+Grape::Exceptions::UnsupportedGroupTypeError = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Grape::Exceptions::UnsupportedGroupTypeError', 'Grape::Exceptions::UnsupportedGroupType', Grape.deprecator)

data/lib/grape/exceptions/validation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class Validation < Base
+      attr_accessor :params, :message_key
+
+      def initialize(params:, message: nil, status: nil, headers: nil)
+        @params = params
+        if message
+          @message_key = message if message.is_a?(Symbol)
+          message = translate_message(message)
+        end
+
+        super(status: status, message: message, headers: headers)
+      end
+
+      # 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(*_args)
+        to_s
+      end
+    end
+  end
+end

data/lib/grape/exceptions/validation_array_errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class ValidationArrayErrors < Base
+      attr_reader :errors
+
+      def initialize(errors)
+        super()
+        @errors = errors
+      end
+    end
+  end
+end

data/lib/grape/exceptions/validation_errors.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class ValidationErrors < Base
+      ERRORS_FORMAT_KEY = 'grape.errors.format'
+      DEFAULT_ERRORS_FORMAT = '%<attributes>s %<message>s'
+
+      include Enumerable
+
+      attr_reader :errors
+
+      def initialize(errors: [], headers: {})
+        @errors = errors.group_by(&:params)
+        super(message: full_messages.join(', '), status: 400, headers: headers)
+      end
+
+      def each
+        errors.each_pair do |attribute, errors|
+          errors.each do |error|
+            yield attribute, error
+          end
+        end
+      end
+
+      def as_json(**_opts)
+        errors.map do |k, v|
+          {
+            params: k,
+            messages: v.map(&:to_s)
+          }
+        end
+      end
+
+      def to_json(*_opts)
+        as_json.to_json
+      end
+
+      def full_messages
+        messages = map do |attributes, error|
+          I18n.t(
+            ERRORS_FORMAT_KEY,
+            default: DEFAULT_ERRORS_FORMAT,
+            attributes: translate_attributes(attributes),
+            message: error.message
+          )
+        end
+        messages.uniq!
+        messages
+      end
+    end
+  end
+end

data/lib/grape/extensions/active_support/hash_with_indifferent_access.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Grape
+  module Extensions
+    module ActiveSupport
+      module HashWithIndifferentAccess
+        module ParamBuilder
+          extend ::ActiveSupport::Concern
+
+          included do
+            Grape.deprecator.warn 'This concern has been deprecated. Use `build_with` with one of the following short_name (:hash, :hash_with_indifferent_access, :hashie_mash) instead.'
+            namespace_inheritable(:build_params_with, :hash_with_indifferent_access)
+          end
+
+          def build_params
+            ::ActiveSupport::HashWithIndifferentAccess.new(rack_params).tap do |params|
+              params.deep_merge!(grape_routing_args) if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/extensions/hash.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Grape
+  module Extensions
+    module Hash
+      module ParamBuilder
+        extend ::ActiveSupport::Concern
+
+        included do
+          Grape.deprecator.warn 'This concern has been deprecated. Use `build_with` with one of the following short_name (:hash, :hash_with_indifferent_access, :hashie_mash) instead.'
+          namespace_inheritable(:build_params_with, :hash)
+        end
+
+        def build_params
+          rack_params.deep_dup.tap do |params|
+            params.deep_symbolize_keys!
+
+            if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
+              grape_routing_args.deep_symbolize_keys!
+              params.deep_merge!(grape_routing_args)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/extensions/hashie/mash.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Grape
+  module Extensions
+    module Hashie
+      module Mash
+        module ParamBuilder
+          extend ::ActiveSupport::Concern
+
+          included do
+            Grape.deprecator.warn 'This concern has been deprecated. Use `build_with` with one of the following short_name (:hash, :hash_with_indifferent_access, :hashie_mash) instead.'
+            namespace_inheritable(:build_params_with, :hashie_mash)
+          end
+
+          def build_params
+            ::Hashie::Mash.new(rack_params).tap do |params|
+              params.deep_merge!(grape_routing_args) if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/formatter/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    class Base
+      def self.call(_object, _env)
+        raise NotImplementedError
+      end
+
+      def self.inherited(klass)
+        super
+        Formatter.register(klass)
+      end
+    end
+  end
+end

data/lib/grape/formatter/json.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    class Json < Base
+      def self.call(object, _env)
+        return object.to_json if object.respond_to?(:to_json)
+
+        ::Grape::Json.dump(object)
+      end
+    end
+  end
+end

data/lib/grape/formatter/serializable_hash.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    class SerializableHash < Base
+      class << self
+        def call(object, _env)
+          return object if object.is_a?(String)
+          return ::Grape::Json.dump(serialize(object)) if serializable?(object)
+          return object.to_json if object.respond_to?(:to_json)
+
+          ::Grape::Json.dump(object)
+        end
+
+        private
+
+        def serializable?(object)
+          object.respond_to?(:serializable_hash) || array_serializable?(object) || object.is_a?(Hash)
+        end
+
+        def serialize(object)
+          if object.respond_to? :serializable_hash
+            object.serializable_hash
+          elsif array_serializable?(object)
+            object.map(&:serializable_hash)
+          elsif object.is_a?(Hash)
+            object.transform_values { |v| serialize(v) }
+          else
+            object
+          end
+        end
+
+        def array_serializable?(object)
+          object.is_a?(Array) && object.all? { |o| o.respond_to? :serializable_hash }
+        end
+      end
+    end
+  end
+end

data/lib/grape/formatter/txt.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    class Txt < Base
+      def self.call(object, _env)
+        object.respond_to?(:to_txt) ? object.to_txt : object.to_s
+      end
+    end
+  end
+end

data/lib/grape/formatter/xml.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    class Xml < Base
+      def self.call(object, _env)
+        return object.to_xml if object.respond_to?(:to_xml)
+
+        raise Grape::Exceptions::InvalidFormatter.new(object.class, 'xml')
+      end
+    end
+  end
+end

data/lib/grape/formatter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Grape
+  module Formatter
+    extend Grape::Util::Registry
+
+    module_function
+
+    DEFAULT_LAMBDA_FORMATTER = ->(obj, _env) { obj }
+
+    def formatter_for(api_format, formatters)
+      return formatters[api_format] if formatters&.key?(api_format)
+
+      registry[api_format] || DEFAULT_LAMBDA_FORMATTER
+    end
+  end
+end