grape 1.8.0 → 3.3.5

data/lib/grape/exceptions/too_many_multipart_files.rb

@@ -1,11 +0,0 @@
-# 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_options.rb

@@ -1,11 +0,0 @@
-# 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/extensions/active_support/hash_with_indifferent_access.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module ActiveSupport
-      module HashWithIndifferentAccess
-        module ParamBuilder
-          extend ::ActiveSupport::Concern
-
-          included do
-            namespace_inheritable(:build_params_with, Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder)
-          end
-
-          def params_builder
-            Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
-          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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module Hash
-      module ParamBuilder
-        extend ::ActiveSupport::Concern
-
-        included do
-          namespace_inheritable(:build_params_with, Grape::Extensions::Hash::ParamBuilder)
-        end
-
-        def build_params
-          rack_params.deep_dup.tap do |params|
-            params.deep_merge!(grape_routing_args) if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
-            params.deep_symbolize_keys!
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module Hashie
-      module Mash
-        module ParamBuilder
-          extend ::ActiveSupport::Concern
-          included do
-            namespace_inheritable(:build_params_with, Grape::Extensions::Hashie::Mash::ParamBuilder)
-          end
-
-          def params_builder
-            Grape::Extensions::Hashie::Mash::ParamBuilder
-          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/http/headers.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape/util/lazy_object'
-
-module Grape
-  module Http
-    module Headers
-      # https://github.com/rack/rack/blob/master/lib/rack.rb
-      HTTP_VERSION    = 'HTTP_VERSION'
-      PATH_INFO       = 'PATH_INFO'
-      REQUEST_METHOD  = 'REQUEST_METHOD'
-      QUERY_STRING    = 'QUERY_STRING'
-      CONTENT_TYPE    = 'Content-Type'
-
-      GET     = 'GET'
-      POST    = 'POST'
-      PUT     = 'PUT'
-      PATCH   = 'PATCH'
-      DELETE  = 'DELETE'
-      HEAD    = 'HEAD'
-      OPTIONS = 'OPTIONS'
-
-      SUPPORTED_METHODS = [GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS].freeze
-      SUPPORTED_METHODS_WITHOUT_OPTIONS = Grape::Util::LazyObject.new { [GET, POST, PUT, PATCH, DELETE, HEAD].freeze }
-
-      HTTP_ACCEPT_VERSION    = 'HTTP_ACCEPT_VERSION'
-      X_CASCADE              = 'X-Cascade'
-      HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'
-      HTTP_ACCEPT            = 'HTTP_ACCEPT'
-
-      FORMAT                 = 'format'
-
-      HTTP_HEADERS = Grape::Util::LazyObject.new do
-        common_http_headers = %w[
-          Version
-          Host
-          Connection
-          Cache-Control
-          Dnt
-          Upgrade-Insecure-Requests
-          User-Agent
-          Sec-Fetch-Dest
-          Accept
-          Sec-Fetch-Site
-          Sec-Fetch-Mode
-          Sec-Fetch-User
-          Accept-Encoding
-          Accept-Language
-          Cookie
-        ].freeze
-        common_http_headers.each_with_object({}) do |header, response|
-          response["HTTP_#{header.upcase.tr('-', '_')}"] = header
-        end.freeze
-      end
-
-      def self.find_supported_method(route_method)
-        Grape::Http::Headers::SUPPORTED_METHODS.detect { |supported_method| supported_method.casecmp(route_method).zero? }
-      end
-    end
-  end
-end

data/lib/grape/middleware/globals.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'grape/middleware/base'
-
-module Grape
-  module Middleware
-    class Globals < Base
-      def before
-        request = Grape::Request.new(@env, build_params_with: @options[:build_params_with])
-        @env[Grape::Env::GRAPE_REQUEST] = request
-        @env[Grape::Env::GRAPE_REQUEST_HEADERS] = request.headers
-        @env[Grape::Env::GRAPE_REQUEST_PARAMS] = request.params if @env[Grape::Env::RACK_INPUT]
-      end
-    end
-  end
-end

data/lib/grape/middleware/helpers.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Middleware
-    # Common methods for all types of Grape middleware
-    module Helpers
-      def context
-        env[Grape::Env::API_ENDPOINT]
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'English'
-module Rack
-  module Accept
-    module Header
-      ALLOWED_CHARACTERS = %r{^([a-z*]+)/([a-z0-9*&\^\-_#{$ERROR_INFO}.+]+)(?:;([a-z0-9=;]+))?$}.freeze
-      class << self
-        # Corrected version of https://github.com/mjackson/rack-accept/blob/master/lib/rack/accept/header.rb#L40-L44
-        def parse_media_type(media_type)
-          # see http://tools.ietf.org/html/rfc6838#section-4.2 for allowed characters in media type names
-          m = media_type&.match(ALLOWED_CHARACTERS)
-          m ? [m[1], m[2], m[3] || ''] : []
-        end
-      end
-    end
-
-    class MediaType
-      def parse_media_type(media_type)
-        Header.parse_media_type(media_type)
-      end
-    end
-  end
-end

data/lib/grape/router/attribute_translator.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  class Router
-    # this could be an OpenStruct, but doesn't work in Ruby 2.3.0, see https://bugs.ruby-lang.org/issues/12251
-    class AttributeTranslator
-      attr_reader :attributes
-
-      ROUTE_ATTRIBUTES = %i[
-        prefix
-        version
-        settings
-        format
-        description
-        http_codes
-        headers
-        entity
-        details
-        requirements
-        request_method
-        namespace
-      ].freeze
-
-      ROUTER_ATTRIBUTES = %i[pattern index].freeze
-
-      def initialize(**attributes)
-        @attributes = attributes
-      end
-
-      (ROUTER_ATTRIBUTES + ROUTE_ATTRIBUTES).each do |attr|
-        define_method attr do
-          attributes[attr]
-        end
-      end
-
-      def to_h
-        attributes
-      end
-
-      def method_missing(method_name, *args)
-        if setter?(method_name[-1])
-          attributes[method_name[0..]] = *args
-        else
-          attributes[method_name]
-        end
-      end
-
-      def respond_to_missing?(method_name, _include_private = false)
-        if setter?(method_name[-1])
-          true
-        else
-          @attributes.key?(method_name)
-        end
-      end
-
-      private
-
-      def setter?(method_name)
-        method_name[-1] == '='
-      end
-    end
-  end
-end

data/lib/grape/types/invalid_value.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# only exists to make it shorter for external use
-module Grape
-  module Types
-    InvalidValue = Class.new(Grape::Validations::Types::InvalidValue)
-  end
-end

data/lib/grape/util/json.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Grape
-  if Object.const_defined? :MultiJson
-    Json = ::MultiJson
-  else
-    Json = ::JSON
-    Json::ParseError = Json::ParserError
-  end
-end

data/lib/grape/util/lazy_block.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    class LazyBlock
-      def initialize(&new_block)
-        @block = new_block
-      end
-
-      def evaluate_from(configuration)
-        @block.call(configuration)
-      end
-
-      def evaluate
-        @block.call({})
-      end
-
-      def lazy?
-        true
-      end
-
-      def to_s
-        evaluate.to_s
-      end
-    end
-  end
-end

data/lib/grape/util/lazy_object.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-# Based on https://github.com/HornsAndHooves/lazy_object
-
-module Grape
-  module Util
-    class LazyObject < BasicObject
-      attr_reader :callable
-
-      def initialize(&callable)
-        @callable = callable
-      end
-
-      def __target_object__
-        @__target_object__ ||= callable.call
-      end
-
-      def ==(other)
-        __target_object__ == other
-      end
-
-      def !=(other)
-        __target_object__ != other
-      end
-
-      def !
-        !__target_object__
-      end
-
-      def method_missing(method_name, *args, &block)
-        if __target_object__.respond_to?(method_name)
-          __target_object__.send(method_name, *args, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to_missing?(method_name, include_priv = false)
-        __target_object__.respond_to?(method_name, include_priv)
-      end
-    end
-  end
-end

data/lib/grape/util/lazy_value.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    class LazyValue
-      attr_reader :access_keys
-
-      def initialize(value, access_keys = [])
-        @value = value
-        @access_keys = access_keys
-      end
-
-      def evaluate_from(configuration)
-        matching_lazy_value = configuration.fetch(@access_keys)
-        matching_lazy_value.evaluate
-      end
-
-      def evaluate
-        @value
-      end
-
-      def lazy?
-        true
-      end
-
-      def reached_by(parent_access_keys, access_key)
-        @access_keys = parent_access_keys + [access_key]
-        self
-      end
-
-      def to_s
-        evaluate.to_s
-      end
-    end
-
-    class LazyValueEnumerable < LazyValue
-      def [](key)
-        if @value_hash[key].nil?
-          LazyValue.new(nil).reached_by(access_keys, key)
-        else
-          @value_hash[key].reached_by(access_keys, key)
-        end
-      end
-
-      def fetch(access_keys)
-        fetched_keys = access_keys.dup
-        value = self[fetched_keys.shift]
-        fetched_keys.any? ? value.fetch(fetched_keys) : value
-      end
-
-      def []=(key, value)
-        @value_hash[key] = case value
-                           when Hash
-                             LazyValueHash.new(value)
-                           when Array
-                             LazyValueArray.new(value)
-                           else
-                             LazyValue.new(value)
-                           end
-      end
-    end
-
-    class LazyValueArray < LazyValueEnumerable
-      def initialize(array)
-        super
-        @value_hash = []
-        array.each_with_index do |value, index|
-          self[index] = value
-        end
-      end
-
-      def evaluate
-        @value_hash.map(&:evaluate)
-      end
-    end
-
-    class LazyValueHash < LazyValueEnumerable
-      def initialize(hash)
-        super
-        @value_hash = ActiveSupport::HashWithIndifferentAccess.new
-        hash.each do |key, value|
-          self[key] = value
-        end
-      end
-
-      def evaluate
-        @value_hash.transform_values(&:evaluate)
-      end
-    end
-  end
-end

data/lib/grape/util/registrable.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Registrable
-      def default_elements
-        @default_elements ||= {}
-      end
-
-      def register(format, element)
-        default_elements[format] = element unless default_elements[format]
-      end
-    end
-  end
-end

data/lib/grape/util/strict_hash_configuration.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module StrictHashConfiguration
-      extend ActiveSupport::Concern
-
-      module DSL
-        extend ActiveSupport::Concern
-
-        module ClassMethods
-          def settings
-            config_context.to_hash
-          end
-
-          def configure(&block)
-            config_context.instance_exec(&block)
-          end
-        end
-      end
-
-      class SettingsContainer
-        def initialize
-          @settings = {}
-          @contexts = {}
-        end
-
-        def to_hash
-          @settings.to_hash
-        end
-      end
-
-      def self.config_class(*args)
-        new_config_class = Class.new(SettingsContainer)
-
-        args.each do |setting_name|
-          if setting_name.respond_to? :values
-            nested_settings_methods(setting_name, new_config_class)
-          else
-            simple_settings_methods(setting_name, new_config_class)
-          end
-        end
-
-        new_config_class
-      end
-
-      def self.simple_settings_methods(setting_name, new_config_class)
-        setting_name_sym = setting_name.to_sym
-        new_config_class.class_eval do
-          define_method setting_name do |new_value|
-            @settings[setting_name_sym] = new_value
-          end
-        end
-      end
-
-      def self.nested_settings_methods(setting_name, new_config_class)
-        new_config_class.class_eval do
-          setting_name.each_pair do |key, value|
-            define_method "#{key}_context" do
-              @contexts[key] ||= Grape::Util::StrictHashConfiguration.config_class(*value).new
-            end
-
-            define_method key do |&block|
-              send("#{key}_context").instance_exec(&block)
-            end
-          end
-
-          define_method :to_hash do
-            @settings.to_hash.merge(
-              setting_name.each_key.with_object({}) do |k, merge_hash|
-                merge_hash[k] = send("#{k}_context").to_hash
-              end
-            )
-          end
-        end
-      end
-
-      def self.module(*args)
-        new_module = Module.new do
-          extend ActiveSupport::Concern
-          include DSL
-        end
-
-        new_module.tap do |mod|
-          class_mod = create_class_mod(args)
-
-          mod.const_set(:ClassMethods, class_mod)
-        end
-      end
-
-      def self.create_class_mod(args)
-        new_module = Module.new do
-          def config_context
-            @config_context ||= config_class.new
-          end
-        end
-
-        new_module.tap do |class_mod|
-          new_config_class = config_class(*args)
-
-          class_mod.send(:define_method, :config_class) do
-            @config_class ||= new_config_class
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grape/util/xml.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  if Object.const_defined? :MultiXml
-    Xml = ::MultiXml
-  else
-    Xml = ::ActiveSupport::XmlMini
-    Xml::ParseError = StandardError
-  end
-end

data/lib/grape/validations/attributes_doc.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    class ParamsScope
-      # Documents parameters of an endpoint. If documentation isn't needed (for instance, it is an
-      # internal API), the class only cleans up attributes to avoid junk in RAM.
-      class AttributesDoc
-        attr_accessor :type, :values
-
-        # @param api [Grape::API::Instance]
-        # @param scope [Validations::ParamsScope]
-        def initialize(api, scope)
-          @api = api
-          @scope = scope
-          @type = type
-        end
-
-        def extract_details(validations)
-          details[:required] = validations.key?(:presence)
-
-          desc = validations.delete(:desc) || validations.delete(:description)
-
-          details[:desc] = desc if desc
-
-          documentation = validations.delete(:documentation)
-
-          details[:documentation] = documentation if documentation
-
-          details[:default] = validations[:default] if validations.key?(:default)
-        end
-
-        def document(attrs)
-          return if @api.namespace_inheritable(:do_not_document)
-
-          details[:type] = type.to_s if type
-          details[:values] = values if values
-
-          documented_attrs = attrs.each_with_object({}) do |name, memo|
-            memo[@scope.full_name(name)] = details
-          end
-
-          @api.namespace_stackable(:params, documented_attrs)
-        end
-
-        def required
-          details[:required]
-        end
-
-        protected
-
-        def details
-          @details ||= {}
-        end
-      end
-    end
-  end
-end