grape 1.3.0 → 1.5.0

data/spec/integration/eager_load/eager_load_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'grape'
+
+describe Grape do
+  it 'eager_load!' do
+    require 'grape/eager_load'
+    expect { Grape.eager_load! }.to_not raise_error
+  end
+
+  it 'compile!' do
+    expect { Class.new(Grape::API).compile! }.to_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -14,25 +14,18 @@ Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
   require file
 end
 
+eager_load!
+
 # The default value for this setting is true in a standard Rails app,
 # so it should be set to true here as well to reflect that.
 I18n.enforce_available_locales = true
 
-module Chunks
-  def read_chunks(body)
-    buffer = []
-    body.each { |chunk| buffer << chunk }
-
-    buffer
-  end
-end
-
 RSpec.configure do |config|
-  config.include Chunks
   config.include Rack::Test::Methods
   config.include Spec::Support::Helpers
   config.raise_errors_for_deprecations!
   config.filter_run_when_matching :focus
+  config.warnings = true
 
   config.before(:each) { Grape::Util::InheritableSetting.reset_global! }
 

data/spec/support/chunks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Chunks
+  def read_chunks(body)
+    buffer = []
+    body.each { |chunk| buffer << chunk }
+
+    buffer
+  end
+end
+
+RSpec.configure do |config|
+  config.include Chunks
+end

data/spec/support/eager_load.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Grape uses autoload https://api.rubyonrails.org/classes/ActiveSupport/Autoload.html.
+# When a class/module get added to the list, ActiveSupport doesn't check whether it really exists.
+# This method loads all classes/modules defined via autoload to be sure only existing
+# classes/modules were listed.
+def eager_load!(scope = Grape)
+  # get modules
+  scope.constants.each do |const_name|
+    const = scope.const_get(const_name)
+
+    next unless const.respond_to?(:eager_load!)
+
+    const.eager_load!
+
+    # check its modules, they might need to be loaded as well.
+    eager_load!(const)
+  end
+end

data/spec/support/versioned_helpers.rb

@@ -6,7 +6,7 @@ module Spec
     module Helpers
       # Returns the path with options[:version] prefixed if options[:using] is :path.
       # Returns normal path otherwise.
-      def versioned_path(options = {})
+      def versioned_path(**options)
         case options[:using]
         when :path
           File.join('/', options[:prefix] || '', options[:version], options[:path])
@@ -43,13 +43,11 @@ module Spec
         end
       end
 
-      def versioned_get(path, version_name, version_options = {})
+      def versioned_get(path, version_name, **version_options)
         path    = versioned_path(version_options.merge(version: version_name, path: path))
         headers = versioned_headers(**version_options.merge(version: version_name))
         params = {}
-        if version_options[:using] == :param
-          params = { version_options[:parameter] => version_name }
-        end
+        params = { version_options[:parameter] => version_name } if version_options[:using] == :param
         get path, params, headers
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,6 +113,7 @@ files:
 - lib/grape/api/helpers.rb
 - lib/grape/api/instance.rb
 - lib/grape/config.rb
+- lib/grape/content_types.rb
 - lib/grape/cookies.rb
 - lib/grape/dsl/api.rb
 - lib/grape/dsl/callbacks.rb
@@ -196,17 +197,18 @@ files:
 - lib/grape/router/attribute_translator.rb
 - lib/grape/router/pattern.rb
 - lib/grape/router/route.rb
-- lib/grape/serve_file/file_body.rb
-- lib/grape/serve_file/file_response.rb
-- lib/grape/serve_file/sendfile_response.rb
+- lib/grape/serve_stream/file_body.rb
+- lib/grape/serve_stream/sendfile_response.rb
+- lib/grape/serve_stream/stream_response.rb
 - lib/grape/util/base_inheritable.rb
-- lib/grape/util/content_types.rb
+- lib/grape/util/cache.rb
 - lib/grape/util/endpoint_configuration.rb
 - lib/grape/util/env.rb
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
 - lib/grape/util/json.rb
 - lib/grape/util/lazy_block.rb
+- lib/grape/util/lazy_object.rb
 - lib/grape/util/lazy_value.rb
 - lib/grape/util/registrable.rb
 - lib/grape/util/reverse_stackable_values.rb
@@ -280,6 +282,7 @@ files:
 - spec/grape/dsl/routing_spec.rb
 - spec/grape/dsl/settings_spec.rb
 - spec/grape/dsl/validations_spec.rb
+- spec/grape/endpoint/declared_spec.rb
 - spec/grape/endpoint_spec.rb
 - spec/grape/entity_spec.rb
 - spec/grape/exceptions/base_spec.rb
@@ -330,6 +333,9 @@ files:
 - spec/grape/validations/multiple_attributes_iterator_spec.rb
 - spec/grape/validations/params_scope_spec.rb
 - spec/grape/validations/single_attribute_iterator_spec.rb
+- spec/grape/validations/types/array_coercer_spec.rb
+- spec/grape/validations/types/primitive_coercer_spec.rb
+- spec/grape/validations/types/set_coercer_spec.rb
 - spec/grape/validations/types_spec.rb
 - spec/grape/validations/validators/all_or_none_spec.rb
 - spec/grape/validations/validators/allow_blank_spec.rb
@@ -345,12 +351,15 @@ files:
 - spec/grape/validations/validators/values_spec.rb
 - spec/grape/validations/validators/zh-CN.yml
 - spec/grape/validations_spec.rb
+- spec/integration/eager_load/eager_load_spec.rb
 - spec/integration/multi_json/json_spec.rb
 - spec/integration/multi_xml/xml_spec.rb
 - spec/shared/versioning_examples.rb
 - spec/spec_helper.rb
 - spec/support/basic_auth_encode_helpers.rb
+- spec/support/chunks.rb
 - spec/support/content_type_helpers.rb
+- spec/support/eager_load.rb
 - spec/support/endpoint_faker.rb
 - spec/support/file_streamer.rb
 - spec/support/integer_helpers.rb
@@ -360,10 +369,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.3.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/1.3.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.3.0
-post_install_message: 
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.5.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/1.5.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.5.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -378,116 +387,123 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files:
+- spec/spec_helper.rb
+- spec/integration/eager_load/eager_load_spec.rb
+- spec/integration/multi_xml/xml_spec.rb
+- spec/integration/multi_json/json_spec.rb
 - spec/shared/versioning_examples.rb
-- spec/support/versioned_helpers.rb
-- spec/support/content_type_helpers.rb
 - spec/support/basic_auth_encode_helpers.rb
-- spec/support/file_streamer.rb
 - spec/support/endpoint_faker.rb
+- spec/support/chunks.rb
+- spec/support/file_streamer.rb
+- spec/support/versioned_helpers.rb
+- spec/support/content_type_helpers.rb
+- spec/support/eager_load.rb
 - spec/support/integer_helpers.rb
-- spec/grape/api/namespace_parameters_in_route_spec.rb
-- spec/grape/api/routes_with_requirements_spec.rb
-- spec/grape/api/nested_helpers_spec.rb
-- spec/grape/api/required_parameters_in_route_spec.rb
-- spec/grape/api/shared_helpers_exactly_one_of_spec.rb
-- spec/grape/api/parameters_modification_spec.rb
-- spec/grape/api/optional_parameters_in_route_spec.rb
-- spec/grape/api/inherited_helpers_spec.rb
-- spec/grape/api/required_parameters_with_invalid_method_spec.rb
-- spec/grape/api/custom_validations_spec.rb
-- spec/grape/api/defines_boolean_in_params_spec.rb
-- spec/grape/api/shared_helpers_spec.rb
-- spec/grape/api/invalid_format_spec.rb
-- spec/grape/api/deeply_included_options_spec.rb
-- spec/grape/api/instance_spec.rb
-- spec/grape/api/patch_method_helpers_spec.rb
-- spec/grape/api/recognize_path_spec.rb
-- spec/grape/api_remount_spec.rb
-- spec/grape/validations/types_spec.rb
-- spec/grape/validations/attributes_iterator_spec.rb
-- spec/grape/validations/validators/regexp_spec.rb
-- spec/grape/validations/validators/default_spec.rb
-- spec/grape/validations/validators/values_spec.rb
-- spec/grape/validations/validators/same_as_spec.rb
-- spec/grape/validations/validators/mutual_exclusion_spec.rb
-- spec/grape/validations/validators/except_values_spec.rb
-- spec/grape/validations/validators/exactly_one_of_spec.rb
-- spec/grape/validations/validators/allow_blank_spec.rb
-- spec/grape/validations/validators/coerce_spec.rb
-- spec/grape/validations/validators/presence_spec.rb
-- spec/grape/validations/validators/at_least_one_of_spec.rb
-- spec/grape/validations/validators/zh-CN.yml
-- spec/grape/validations/validators/all_or_none_spec.rb
-- spec/grape/validations/params_scope_spec.rb
-- spec/grape/validations/multiple_attributes_iterator_spec.rb
-- spec/grape/validations/instance_behaivour_spec.rb
-- spec/grape/validations/single_attribute_iterator_spec.rb
+- spec/grape/middleware/error_spec.rb
+- spec/grape/middleware/globals_spec.rb
+- spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/auth/strategies_spec.rb
+- spec/grape/middleware/auth/dsl_spec.rb
+- spec/grape/middleware/auth/base_spec.rb
+- spec/grape/middleware/stack_spec.rb
+- spec/grape/middleware/exception_spec.rb
+- spec/grape/middleware/versioner_spec.rb
+- spec/grape/middleware/versioner/accept_version_header_spec.rb
+- spec/grape/middleware/versioner/header_spec.rb
+- spec/grape/middleware/versioner/path_spec.rb
+- spec/grape/middleware/versioner/param_spec.rb
+- spec/grape/middleware/base_spec.rb
 - spec/grape/config_spec.rb
-- spec/grape/parser_spec.rb
-- spec/grape/exceptions/body_parse_errors_spec.rb
-- spec/grape/exceptions/missing_option_spec.rb
-- spec/grape/exceptions/invalid_accept_header_spec.rb
-- spec/grape/exceptions/validation_spec.rb
-- spec/grape/exceptions/unknown_validator_spec.rb
-- spec/grape/exceptions/validation_errors_spec.rb
-- spec/grape/exceptions/invalid_response_spec.rb
-- spec/grape/exceptions/unknown_options_spec.rb
-- spec/grape/exceptions/invalid_formatter_spec.rb
-- spec/grape/exceptions/invalid_versioner_option_spec.rb
-- spec/grape/exceptions/missing_mime_type_spec.rb
-- spec/grape/exceptions/base_spec.rb
-- spec/grape/path_spec.rb
+- spec/grape/loading_spec.rb
+- spec/grape/endpoint_spec.rb
+- spec/grape/api_spec.rb
+- spec/grape/util/reverse_stackable_values_spec.rb
 - spec/grape/util/stackable_values_spec.rb
-- spec/grape/util/strict_hash_configuration_spec.rb
 - spec/grape/util/inheritable_setting_spec.rb
-- spec/grape/util/reverse_stackable_values_spec.rb
+- spec/grape/util/strict_hash_configuration_spec.rb
 - spec/grape/util/inheritable_values_spec.rb
-- spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
-- spec/grape/extensions/param_builders/hash_spec.rb
-- spec/grape/extensions/param_builders/hashie/mash_spec.rb
 - spec/grape/integration/rack_spec.rb
 - spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/global_namespace_function_spec.rb
-- spec/grape/presenters/presenter_spec.rb
-- spec/grape/endpoint_spec.rb
-- spec/grape/api_spec.rb
-- spec/grape/middleware/exception_spec.rb
-- spec/grape/middleware/versioner/param_spec.rb
-- spec/grape/middleware/versioner/header_spec.rb
-- spec/grape/middleware/versioner/path_spec.rb
-- spec/grape/middleware/versioner/accept_version_header_spec.rb
-- spec/grape/middleware/globals_spec.rb
-- spec/grape/middleware/stack_spec.rb
-- spec/grape/middleware/formatter_spec.rb
-- spec/grape/middleware/error_spec.rb
-- spec/grape/middleware/auth/dsl_spec.rb
-- spec/grape/middleware/auth/strategies_spec.rb
-- spec/grape/middleware/auth/base_spec.rb
-- spec/grape/middleware/versioner_spec.rb
-- spec/grape/middleware/base_spec.rb
+- spec/grape/validations_spec.rb
 - spec/grape/entity_spec.rb
-- spec/grape/dsl/settings_spec.rb
-- spec/grape/dsl/callbacks_spec.rb
-- spec/grape/dsl/middleware_spec.rb
-- spec/grape/dsl/inside_route_spec.rb
+- spec/grape/exceptions/validation_spec.rb
+- spec/grape/exceptions/invalid_accept_header_spec.rb
+- spec/grape/exceptions/missing_option_spec.rb
+- spec/grape/exceptions/invalid_response_spec.rb
+- spec/grape/exceptions/body_parse_errors_spec.rb
+- spec/grape/exceptions/invalid_formatter_spec.rb
+- spec/grape/exceptions/missing_mime_type_spec.rb
+- spec/grape/exceptions/unknown_options_spec.rb
+- spec/grape/exceptions/validation_errors_spec.rb
+- spec/grape/exceptions/unknown_validator_spec.rb
+- spec/grape/exceptions/invalid_versioner_option_spec.rb
+- spec/grape/exceptions/base_spec.rb
+- spec/grape/presenters/presenter_spec.rb
+- spec/grape/validations/single_attribute_iterator_spec.rb
+- spec/grape/validations/attributes_iterator_spec.rb
+- spec/grape/validations/types/primitive_coercer_spec.rb
+- spec/grape/validations/types/set_coercer_spec.rb
+- spec/grape/validations/types/array_coercer_spec.rb
+- spec/grape/validations/params_scope_spec.rb
+- spec/grape/validations/instance_behaivour_spec.rb
+- spec/grape/validations/multiple_attributes_iterator_spec.rb
+- spec/grape/validations/types_spec.rb
+- spec/grape/validations/validators/regexp_spec.rb
+- spec/grape/validations/validators/mutual_exclusion_spec.rb
+- spec/grape/validations/validators/exactly_one_of_spec.rb
+- spec/grape/validations/validators/except_values_spec.rb
+- spec/grape/validations/validators/presence_spec.rb
+- spec/grape/validations/validators/all_or_none_spec.rb
+- spec/grape/validations/validators/allow_blank_spec.rb
+- spec/grape/validations/validators/same_as_spec.rb
+- spec/grape/validations/validators/default_spec.rb
+- spec/grape/validations/validators/values_spec.rb
+- spec/grape/validations/validators/at_least_one_of_spec.rb
+- spec/grape/validations/validators/coerce_spec.rb
+- spec/grape/validations/validators/zh-CN.yml
+- spec/grape/extensions/param_builders/hashie/mash_spec.rb
+- spec/grape/extensions/param_builders/hash_spec.rb
+- spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
+- spec/grape/parser_spec.rb
+- spec/grape/request_spec.rb
+- spec/grape/endpoint/declared_spec.rb
+- spec/grape/api/parameters_modification_spec.rb
+- spec/grape/api/patch_method_helpers_spec.rb
+- spec/grape/api/required_parameters_with_invalid_method_spec.rb
+- spec/grape/api/nested_helpers_spec.rb
+- spec/grape/api/defines_boolean_in_params_spec.rb
+- spec/grape/api/invalid_format_spec.rb
+- spec/grape/api/required_parameters_in_route_spec.rb
+- spec/grape/api/instance_spec.rb
+- spec/grape/api/namespace_parameters_in_route_spec.rb
+- spec/grape/api/recognize_path_spec.rb
+- spec/grape/api/shared_helpers_exactly_one_of_spec.rb
+- spec/grape/api/inherited_helpers_spec.rb
+- spec/grape/api/shared_helpers_spec.rb
+- spec/grape/api/deeply_included_options_spec.rb
+- spec/grape/api/routes_with_requirements_spec.rb
+- spec/grape/api/custom_validations_spec.rb
+- spec/grape/api/optional_parameters_in_route_spec.rb
+- spec/grape/api_remount_spec.rb
+- spec/grape/named_api_spec.rb
+- spec/grape/dsl/request_response_spec.rb
+- spec/grape/dsl/desc_spec.rb
+- spec/grape/dsl/logger_spec.rb
 - spec/grape/dsl/configuration_spec.rb
+- spec/grape/dsl/validations_spec.rb
 - spec/grape/dsl/parameters_spec.rb
-- spec/grape/dsl/logger_spec.rb
 - spec/grape/dsl/helpers_spec.rb
-- spec/grape/dsl/request_response_spec.rb
-- spec/grape/dsl/routing_spec.rb
+- spec/grape/dsl/middleware_spec.rb
 - spec/grape/dsl/headers_spec.rb
-- spec/grape/dsl/validations_spec.rb
-- spec/grape/dsl/desc_spec.rb
-- spec/grape/validations_spec.rb
-- spec/grape/named_api_spec.rb
-- spec/grape/loading_spec.rb
-- spec/grape/request_spec.rb
-- spec/integration/multi_xml/xml_spec.rb
-- spec/integration/multi_json/json_spec.rb
-- spec/spec_helper.rb
+- spec/grape/dsl/callbacks_spec.rb
+- spec/grape/dsl/settings_spec.rb
+- spec/grape/dsl/routing_spec.rb
+- spec/grape/dsl/inside_route_spec.rb
+- spec/grape/path_spec.rb

data/lib/grape/util/content_types.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module ContentTypes
-    # Content types are listed in order of preference.
-    CONTENT_TYPES = { # rubocop:disable Style/MutableConstant
-      xml: 'application/xml',
-      serializable_hash: 'application/json',
-      json: 'application/json',
-      binary: 'application/octet-stream',
-      txt: 'text/plain'
-    }
-
-    def self.content_types_for_settings(settings)
-      return if settings.blank?
-
-      settings.each_with_object({}) { |value, result| result.merge!(value) }
-    end
-
-    def self.content_types_for(from_settings)
-      if from_settings.present?
-        from_settings
-      else
-        Grape::ContentTypes::CONTENT_TYPES
-      end
-    end
-  end
-end