grape 1.2.1 → 1.2.2

data/README.md

@@ -146,9 +146,8 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the next release of Grape, which should be **1.2.2**.
+You're reading the documentation for the stable release of Grape, **1.2.2**.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
-The current stable release is [1.2.1](https://github.com/ruby-grape/grape/blob/v1.2.1/README.md).
 
 ## Project Resources
 

data/RELEASING.md

@@ -36,7 +36,7 @@ You're reading the documentation for the stable release of Grape, 0.6.0.
 Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
 
 ```
-#### 0.6.0 (9/16/2013)
+#### 0.6.0 (2013/9/16)
 ```
 
 Remove the line with "Your contribution here.", since there will be no more contributions to this release.

data/lib/grape/api.rb

@@ -6,12 +6,16 @@ module Grape
   # should subclass this class in order to build an API.
   class API
     # Class methods that we want to call on the API rather than on the API object
-    NON_OVERRIDABLE = %I[define_singleton_method instance_variable_set inspect class is_a? ! kind_of?
-                         respond_to? respond_to_missing? const_defined? const_missing parent
-                         parent_name name equal? to_s parents anonymous?].freeze
+    NON_OVERRIDABLE = (Class.new.methods + %i[call call!]).freeze
 
     class << self
       attr_accessor :base_instance, :instances
+
+      # Rather than initializing an object of type Grape::API, create an object of type Instance
+      def new(*args, &block)
+        base_instance.new(*args, &block)
+      end
+
       # When inherited, will create a list of all instances (times the API was mounted)
       # It will listen to the setup required to mount that endpoint, and replicate it on any new instance
       def inherited(api, base_instance_parent = Grape::API::Instance)
@@ -38,6 +42,15 @@ module Grape
         end
       end
 
+      # This is the interface point between Rack and Grape; it accepts a request
+      # from Rack and ultimately returns an array of three values: the status,
+      # the headers, and the body. See [the rack specification]
+      # (http://www.rubydoc.info/github/rack/rack/master/file/SPEC) for more.
+      # NOTE: This will only be called on an API directly mounted on RACK
+      def call(*args, &block)
+        base_instance.call(*args, &block)
+      end
+
       # Allows an API to itself be inheritable:
       def make_inheritable(api)
         # When a child API inherits from a parent API.

data/lib/grape/api/instance.rb

@@ -183,7 +183,7 @@ module Grape
         # informations again.
         without_root_prefix do
           without_versioning do
-            routes_map.each do |_, config|
+            routes_map.each_value do |config|
               methods = config[:methods]
               allowed_methods = methods.dup
 

data/lib/grape/dsl/desc.rb

@@ -4,12 +4,12 @@ module Grape
       include Grape::DSL::Settings
 
       # Add a description to the next namespace or function.
-      # @option options :summary [String] summary for this endpoint
       # @param description [String] descriptive string for this endpoint
       #   or namespace
       # @param options [Hash] other properties you can set to describe the
       #   endpoint or namespace. Optional.
       # @option options :detail [String] additional detail about this endpoint
+      # @option options :summary [String] summary for this endpoint
       # @option options :params [Hash] param types and info. normally, you set
       #   these via the `params` dsl method.
       # @option options :entity [Grape::Entity] the entity returned upon a
@@ -17,6 +17,7 @@ module Grape
       # @option options :http_codes [Array[Array]] possible HTTP codes this
       #   endpoint may return, with their meanings, in a 2d array
       # @option options :named [String] a specific name to help find this route
+      # @option options :body_name [String] override the autogenerated body name param
       # @option options :headers [Hash] HTTP headers this method can accept
       # @option options :hidden [Boolean] hide the endpoint or not
       # @option options :deprecated [Boolean] deprecate the endpoint or not
@@ -24,6 +25,7 @@ module Grape
       # @option options :nickname [String] nickname of the endpoint
       # @option options :produces [Array[String]] a list of MIME types the endpoint produce
       # @option options :consumes [Array[String]] a list of MIME types the endpoint consume
+      # @option options :security [Array[Hash]] a list of security schemes
       # @option options :tags [Array[String]] a list of tags
       # @yield a block yielding an instance context with methods mapping to
       #   each of the above, except that :entity is also aliased as #success
@@ -67,13 +69,12 @@ module Grape
       end
 
       def description_field(field, value = nil)
+        description = route_setting(:description)
         if value
-          description = route_setting(:description)
           description ||= route_setting(:description, {})
           description[field] = value
-        else
-          description = route_setting(:description)
-          description[field] if description
+        elsif description
+          description[field]
         end
       end
 
@@ -93,6 +94,7 @@ module Grape
             :entity,
             :http_codes,
             :named,
+            :body_name,
             :headers,
             :hidden,
             :deprecated,
@@ -100,6 +102,7 @@ module Grape
             :nickname,
             :produces,
             :consumes,
+            :security,
             :tags
           )
 

data/lib/grape/middleware/stack.rb

@@ -96,7 +96,7 @@ module Grape
       # @param [Array] other_specs An array of middleware specifications (e.g. [[:use, klass], [:insert_before, *args]])
       def concat(other_specs)
         @others << Array(other_specs).reject { |o| o.first == :use }
-        merge_with Array(other_specs).select { |o| o.first == :use }
+        merge_with(Array(other_specs).select { |o| o.first == :use })
       end
 
       protected

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

@@ -99,7 +99,7 @@ module Grape
         def available_media_types
           available_media_types = []
 
-          content_types.each do |extension, _media_type|
+          content_types.each_key do |extension|
             versions.reverse_each do |version|
               available_media_types += [
                 "application/vnd.#{vendor}-#{version}+#{extension}",
@@ -111,7 +111,7 @@ module Grape
 
           available_media_types << "application/vnd.#{vendor}"
 
-          content_types.each do |_, media_type|
+          content_types.each_value do |media_type|
             available_media_types << media_type
           end
 

data/lib/grape/router/attribute_translator.rb

@@ -15,6 +15,8 @@ module Grape
           @attributes[m[0..-1]] = *args
         elsif m[-1] != '='
           @attributes[m]
+        else
+          super
         end
       end
 

data/lib/grape/router/route.rb

@@ -98,9 +98,9 @@ module Grape
         path, line = *location.scan(SOURCE_LOCATION_REGEXP).first
         path = File.realpath(path) if Pathname.new(path).relative?
         expected ||= name
-        warn <<-EOS
+        warn <<-WARNING
 #{path}:#{line}: The route_xxx methods such as route_#{name} have been deprecated, please use #{expected}.
-        EOS
+        WARNING
       end
     end
   end

data/lib/grape/validations/types/custom_type_coercer.rb

@@ -158,7 +158,7 @@ module Grape
         #   necessary.
         def enforce_symbolized_keys(type, method)
           # Collections have all values processed individually
-          if type == Array || type == Set
+          if [Array, Set].include?(type)
             lambda do |val|
               method.call(val).tap do |new_value|
                 new_value.map do |item|

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.2'.freeze
 end

data/spec/grape/api_spec.rb

@@ -220,6 +220,15 @@ describe Grape::API do
     end
   end
 
+  describe '.call' do
+    context 'it does not add to the app setup' do
+      it 'calls the app' do
+        expect(subject).not_to receive(:add_setup)
+        subject.call({})
+      end
+    end
+  end
+
   describe '.route_param' do
     it 'adds a parameterized route segment namespace' do
       subject.namespace :users do
@@ -3649,4 +3658,22 @@ XML
       end
     end
   end
+
+  describe 'normal class methods' do
+    subject(:grape_api) { Class.new(Grape::API) }
+
+    before do
+      stub_const('MyAPI', grape_api)
+    end
+
+    it 'can find the appropiate name' do
+      expect(grape_api.name).to eq 'MyAPI'
+    end
+
+    it 'is equal to itself' do
+      expect(grape_api.itself).to eq grape_api
+      expect(grape_api).to eq MyAPI
+      expect(grape_api.eql?(MyAPI))
+    end
+  end
 end

data/spec/grape/dsl/desc_spec.rb

@@ -28,21 +28,25 @@ module Grape
             entity: Object,
             http_codes: [[401, 'Unauthorized', 'Entities::Error']],
             named: 'My named route',
-            headers: [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                      XOptionalHeader: {
-                        description: 'Not really needed',
-                        required: false
-                      }],
+            body_name: 'My body name',
+            headers: [
+              XAuthToken: {
+                description: 'Valdates your identity',
+                required: true
+              },
+              XOptionalHeader: {
+                description: 'Not really needed',
+                required: false
+              }
+            ],
             hidden: false,
             deprecated: false,
             is_array: true,
             nickname: 'nickname',
             produces: %w[array of mime_types],
             consumes: %w[array of mime_types],
-            tags: %w[tag1 tag2]
+            tags: %w[tag1 tag2],
+            security: %w[array of security schemes]
           }
 
           subject.desc 'The description' do
@@ -52,14 +56,17 @@ module Grape
             success Object
             failure [[401, 'Unauthorized', 'Entities::Error']]
             named 'My named route'
-            headers [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                     XOptionalHeader: {
-                       description: 'Not really needed',
-                       required: false
-                     }]
+            body_name 'My body name'
+            headers [
+              XAuthToken: {
+                description: 'Valdates your identity',
+                required: true
+              },
+              XOptionalHeader: {
+                description: 'Not really needed',
+                required: false
+              }
+            ]
             hidden false
             deprecated false
             is_array true
@@ -67,6 +74,7 @@ module Grape
             produces %w[array of mime_types]
             consumes %w[array of mime_types]
             tags %w[tag1 tag2]
+            security %w[array of security schemes]
           end
 
           expect(subject.namespace_setting(:description)).to eq(expected_options)

data/spec/grape/middleware/formatter_spec.rb

@@ -247,7 +247,7 @@ describe Grape::Middleware::Formatter do
           let(:content_type) { 'application/atom+xml' }
 
           it 'returns a 415 HTTP error status' do
-            error = catch(:error) {
+            error = catch(:error) do
               subject.call(
                 'PATH_INFO' => '/info',
                 'REQUEST_METHOD' => method,
@@ -255,7 +255,7 @@ describe Grape::Middleware::Formatter do
                 'rack.input' => io,
                 'CONTENT_LENGTH' => io.length
               )
-            }
+            end
             expect(error[:status]).to eq(415)
             expect(error[:message]).to eq("The provided content-type 'application/atom+xml' is not supported.")
           end
@@ -407,7 +407,7 @@ describe Grape::Middleware::Formatter do
         parsers: { json: ->(_object, _env) { raise StandardError, 'fail' } }
       )
       io = StringIO.new('{invalid}')
-      error = catch(:error) {
+      error = catch(:error) do
         subject.call(
           'PATH_INFO' => '/info',
           'REQUEST_METHOD' => 'POST',
@@ -415,7 +415,7 @@ describe Grape::Middleware::Formatter do
           'rack.input' => io,
           'CONTENT_LENGTH' => io.length
         )
-      }
+      end
 
       expect(error[:message]).to eq 'fail'
       expect(error[:backtrace].size).to be >= 1

data/spec/grape/validations_spec.rb

@@ -1013,7 +1013,7 @@ describe Grape::Validations do
           expect(last_response.body).to eq('custom is not custom with options!')
         end
       end
-    end # end custom validation
+    end
 
     context 'named' do
       context 'can be defined' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -117,14 +117,10 @@ files:
 - benchmark/simple_with_type_coercer.rb
 - gemfiles/multi_json.gemfile
 - gemfiles/multi_xml.gemfile
-- gemfiles/rack_1.5.2.gemfile.lock
 - gemfiles/rack_edge.gemfile
 - gemfiles/rails_3.gemfile
-- gemfiles/rails_3.gemfile.lock
 - gemfiles/rails_4.gemfile
-- gemfiles/rails_4.gemfile.lock
 - gemfiles/rails_5.gemfile
-- gemfiles/rails_5.gemfile.lock
 - gemfiles/rails_edge.gemfile
 - grape.gemspec
 - grape.png
@@ -255,7 +251,9 @@ files:
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
-- pkg/grape-1.2.0.gem
+- pkg/grape-0.19.1.gem
+- pkg/grape-1.0.1.gem
+- pkg/grape-1.0.2.gem
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/inherited_helpers_spec.rb
@@ -378,110 +376,110 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files:
+- spec/spec_helper.rb
+- spec/integration/multi_xml/xml_spec.rb
+- spec/integration/multi_json/json_spec.rb
 - spec/shared/versioning_examples.rb
-- spec/grape/api/shared_helpers_exactly_one_of_spec.rb
-- spec/grape/api/custom_validations_spec.rb
-- spec/grape/api/parameters_modification_spec.rb
-- spec/grape/api/namespace_parameters_in_route_spec.rb
-- spec/grape/api/deeply_included_options_spec.rb
-- spec/grape/api/shared_helpers_spec.rb
-- spec/grape/api/required_parameters_with_invalid_method_spec.rb
-- spec/grape/api/inherited_helpers_spec.rb
-- spec/grape/api/recognize_path_spec.rb
-- spec/grape/api/required_parameters_in_route_spec.rb
-- spec/grape/api/nested_helpers_spec.rb
-- spec/grape/api/routes_with_requirements_spec.rb
-- spec/grape/api/patch_method_helpers_spec.rb
-- spec/grape/api/optional_parameters_in_route_spec.rb
-- spec/grape/api/invalid_format_spec.rb
-- spec/grape/named_api_spec.rb
-- spec/grape/exceptions/validation_spec.rb
-- spec/grape/exceptions/validation_errors_spec.rb
-- spec/grape/exceptions/missing_option_spec.rb
-- spec/grape/exceptions/unknown_options_spec.rb
-- spec/grape/exceptions/missing_mime_type_spec.rb
-- spec/grape/exceptions/base_spec.rb
-- spec/grape/exceptions/invalid_versioner_option_spec.rb
-- spec/grape/exceptions/invalid_response_spec.rb
-- spec/grape/exceptions/body_parse_errors_spec.rb
-- spec/grape/exceptions/unknown_validator_spec.rb
-- spec/grape/exceptions/invalid_formatter_spec.rb
-- spec/grape/exceptions/invalid_accept_header_spec.rb
-- spec/grape/dsl/routing_spec.rb
-- spec/grape/dsl/logger_spec.rb
-- spec/grape/dsl/request_response_spec.rb
-- spec/grape/dsl/validations_spec.rb
-- spec/grape/dsl/desc_spec.rb
-- spec/grape/dsl/headers_spec.rb
-- spec/grape/dsl/configuration_spec.rb
-- spec/grape/dsl/settings_spec.rb
-- spec/grape/dsl/callbacks_spec.rb
-- spec/grape/dsl/parameters_spec.rb
-- spec/grape/dsl/inside_route_spec.rb
-- spec/grape/dsl/middleware_spec.rb
-- spec/grape/dsl/helpers_spec.rb
-- spec/grape/endpoint_spec.rb
-- spec/grape/validations_spec.rb
-- spec/grape/entity_spec.rb
-- spec/grape/extensions/param_builders/hash_spec.rb
-- spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
-- spec/grape/extensions/param_builders/hashie/mash_spec.rb
-- spec/grape/api_remount_spec.rb
-- spec/grape/parser_spec.rb
-- spec/grape/util/inheritable_setting_spec.rb
-- spec/grape/util/reverse_stackable_values_spec.rb
-- spec/grape/util/stackable_values_spec.rb
-- spec/grape/util/inheritable_values_spec.rb
-- spec/grape/util/strict_hash_configuration_spec.rb
-- spec/grape/presenters/presenter_spec.rb
-- spec/grape/middleware/versioner/header_spec.rb
-- spec/grape/middleware/versioner/accept_version_header_spec.rb
-- spec/grape/middleware/versioner/param_spec.rb
-- spec/grape/middleware/versioner/path_spec.rb
+- spec/support/basic_auth_encode_helpers.rb
+- spec/support/endpoint_faker.rb
+- spec/support/file_streamer.rb
+- spec/support/versioned_helpers.rb
+- spec/support/content_type_helpers.rb
+- spec/support/integer_helpers.rb
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/globals_spec.rb
-- spec/grape/middleware/base_spec.rb
 - spec/grape/middleware/formatter_spec.rb
-- spec/grape/middleware/exception_spec.rb
-- spec/grape/middleware/auth/base_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/request_spec.rb
-- spec/grape/integration/global_namespace_function_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/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/inheritable_setting_spec.rb
+- spec/grape/util/strict_hash_configuration_spec.rb
+- spec/grape/util/inheritable_values_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/validations_spec.rb
+- spec/grape/entity_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/attributes_iterator_spec.rb
+- spec/grape/validations/params_scope_spec.rb
+- spec/grape/validations/instance_behaivour_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/values_spec.rb
+- spec/grape/validations/validators/except_values_spec.rb
 - spec/grape/validations/validators/presence_spec.rb
-- spec/grape/validations/validators/coerce_spec.rb
-- spec/grape/validations/validators/at_least_one_of_spec.rb
-- spec/grape/validations/validators/zh-CN.yml
-- spec/grape/validations/validators/default_spec.rb
-- spec/grape/validations/validators/regexp_spec.rb
 - spec/grape/validations/validators/all_or_none_spec.rb
-- spec/grape/validations/validators/except_values_spec.rb
-- spec/grape/validations/validators/mutual_exclusion_spec.rb
 - spec/grape/validations/validators/allow_blank_spec.rb
-- spec/grape/validations/params_scope_spec.rb
-- spec/grape/validations/instance_behaivour_spec.rb
-- spec/grape/validations/types_spec.rb
-- spec/grape/api_spec.rb
-- spec/grape/loading_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/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/invalid_format_spec.rb
+- spec/grape/api/required_parameters_in_route_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/helpers_spec.rb
+- spec/grape/dsl/middleware_spec.rb
+- spec/grape/dsl/headers_spec.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
-- spec/support/file_streamer.rb
-- spec/support/versioned_helpers.rb
-- spec/support/content_type_helpers.rb
-- spec/support/integer_helpers.rb
-- spec/support/basic_auth_encode_helpers.rb
-- spec/support/endpoint_faker.rb
-- spec/spec_helper.rb
-- spec/integration/multi_json/json_spec.rb
-- spec/integration/multi_xml/xml_spec.rb