grape 2.3.0 → 3.0.0

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michael Bleigh
 bindir: bin
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -95,14 +109,11 @@ files:
 - grape.png
 - lib/grape.rb
 - lib/grape/api.rb
-- lib/grape/api/helpers.rb
 - lib/grape/api/instance.rb
 - lib/grape/content_types.rb
 - lib/grape/cookies.rb
 - lib/grape/dry_types.rb
-- lib/grape/dsl/api.rb
 - lib/grape/dsl/callbacks.rb
-- lib/grape/dsl/configuration.rb
 - lib/grape/dsl/desc.rb
 - lib/grape/dsl/headers.rb
 - lib/grape/dsl/helpers.rb
@@ -119,16 +130,17 @@ files:
 - lib/grape/error_formatter.rb
 - lib/grape/error_formatter/base.rb
 - lib/grape/error_formatter/json.rb
-- lib/grape/error_formatter/jsonapi.rb
 - lib/grape/error_formatter/serializable_hash.rb
 - lib/grape/error_formatter/txt.rb
 - lib/grape/error_formatter/xml.rb
 - lib/grape/exceptions/base.rb
+- lib/grape/exceptions/conflicting_types.rb
 - lib/grape/exceptions/empty_message_body.rb
 - lib/grape/exceptions/incompatible_option_values.rb
 - lib/grape/exceptions/invalid_accept_header.rb
 - lib/grape/exceptions/invalid_formatter.rb
 - lib/grape/exceptions/invalid_message_body.rb
+- lib/grape/exceptions/invalid_parameters.rb
 - lib/grape/exceptions/invalid_response.rb
 - lib/grape/exceptions/invalid_version_header.rb
 - lib/grape/exceptions/invalid_versioner_option.rb
@@ -138,9 +150,12 @@ files:
 - lib/grape/exceptions/missing_mime_type.rb
 - lib/grape/exceptions/missing_option.rb
 - lib/grape/exceptions/missing_vendor_option.rb
+- lib/grape/exceptions/too_deep_parameters.rb
 - lib/grape/exceptions/too_many_multipart_files.rb
+- lib/grape/exceptions/unknown_auth_strategy.rb
 - lib/grape/exceptions/unknown_options.rb
 - lib/grape/exceptions/unknown_parameter.rb
+- lib/grape/exceptions/unknown_params_builder.rb
 - lib/grape/exceptions/unknown_validator.rb
 - lib/grape/exceptions/unsupported_group_type.rb
 - lib/grape/exceptions/validation.rb
@@ -155,7 +170,6 @@ files:
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
-- lib/grape/http/headers.rb
 - lib/grape/json.rb
 - lib/grape/locale/en.yml
 - lib/grape/middleware/auth/base.rb
@@ -167,7 +181,6 @@ files:
 - lib/grape/middleware/filter.rb
 - lib/grape/middleware/formatter.rb
 - lib/grape/middleware/globals.rb
-- lib/grape/middleware/helpers.rb
 - lib/grape/middleware/stack.rb
 - lib/grape/middleware/versioner.rb
 - lib/grape/middleware/versioner/accept_version_header.rb
@@ -176,10 +189,14 @@ files:
 - lib/grape/middleware/versioner/param.rb
 - lib/grape/middleware/versioner/path.rb
 - lib/grape/namespace.rb
+- lib/grape/params_builder.rb
+- lib/grape/params_builder/base.rb
+- lib/grape/params_builder/hash.rb
+- lib/grape/params_builder/hash_with_indifferent_access.rb
+- lib/grape/params_builder/hashie_mash.rb
 - lib/grape/parser.rb
 - lib/grape/parser/base.rb
 - lib/grape/parser/json.rb
-- lib/grape/parser/jsonapi.rb
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
 - lib/grape/presenters/presenter.rb
@@ -193,7 +210,7 @@ files:
 - lib/grape/serve_stream/file_body.rb
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
-- lib/grape/types/invalid_value.rb
+- lib/grape/util/api_description.rb
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
 - lib/grape/util/endpoint_configuration.rb
@@ -201,7 +218,6 @@ files:
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
 - lib/grape/util/lazy/block.rb
-- lib/grape/util/lazy/object.rb
 - lib/grape/util/lazy/value.rb
 - lib/grape/util/lazy/value_array.rb
 - lib/grape/util/lazy/value_enumerable.rb
@@ -210,12 +226,11 @@ files:
 - lib/grape/util/registry.rb
 - lib/grape/util/reverse_stackable_values.rb
 - lib/grape/util/stackable_values.rb
-- lib/grape/util/strict_hash_configuration.rb
 - lib/grape/validations.rb
-- lib/grape/validations/attributes_doc.rb
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/contract_scope.rb
 - lib/grape/validations/multiple_attributes_iterator.rb
+- lib/grape/validations/params_documentation.rb
 - lib/grape/validations/params_scope.rb
 - lib/grape/validations/single_attribute_iterator.rb
 - lib/grape/validations/types.rb
@@ -255,9 +270,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.3.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.3.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.3.0
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v3.0.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/3.0.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v3.0.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -266,14 +281,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files: []

data/lib/grape/api/helpers.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  class API
-    module Helpers
-      include Grape::DSL::Helpers::BaseHelper
-    end
-  end
-end

data/lib/grape/dsl/api.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module DSL
-    module API
-      extend ActiveSupport::Concern
-
-      include Grape::Middleware::Auth::DSL
-
-      include Grape::DSL::Validations
-      include Grape::DSL::Callbacks
-      include Grape::DSL::Configuration
-      include Grape::DSL::Helpers
-      include Grape::DSL::Middleware
-      include Grape::DSL::RequestResponse
-      include Grape::DSL::Routing
-    end
-  end
-end

data/lib/grape/dsl/configuration.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module DSL
-    module Configuration
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        include Grape::DSL::Settings
-        include Grape::DSL::Logger
-        include Grape::DSL::Desc
-      end
-    end
-  end
-end

data/lib/grape/error_formatter/jsonapi.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module ErrorFormatter
-    class Jsonapi < Json; end
-  end
-end

data/lib/grape/http/headers.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Http
-    module Headers
-      HTTP_ACCEPT_VERSION = 'HTTP_ACCEPT_VERSION'
-      HTTP_ACCEPT = 'HTTP_ACCEPT'
-      HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'
-      HTTP_VERSION = 'HTTP_VERSION'
-
-      ALLOW = 'Allow'
-      LOCATION = 'Location'
-      X_CASCADE = 'X-Cascade'
-      TRANSFER_ENCODING = 'Transfer-Encoding'
-
-      SUPPORTED_METHODS = [
-        Rack::GET,
-        Rack::POST,
-        Rack::PUT,
-        Rack::PATCH,
-        Rack::DELETE,
-        Rack::HEAD,
-        Rack::OPTIONS
-      ].freeze
-
-      SUPPORTED_METHODS_WITHOUT_OPTIONS = (SUPPORTED_METHODS - [Rack::OPTIONS]).freeze
-
-      HTTP_HEADERS = Grape::Util::Lazy::Object.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/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/parser/jsonapi.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Parser
-    class Jsonapi < Json; 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/lazy/object.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# Based on https://github.com/HornsAndHooves/lazy_object
-
-module Grape
-  module Util
-    module Lazy
-      class Object < 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
-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/validations/attributes_doc.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Validations
-    # 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)
-
-        details[:min_length] = validations[:length][:min] if validations.key?(:length) && validations[:length].key?(:min)
-        details[:max_length] = validations[:length][:max] if validations.key?(:length) && validations[:length].key?(:max)
-      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