apipie-rails 0.5.20 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f03c36e5a39960d1394d5c46fbda7dc5b95394860b31e9850746b35cf54069d2
-  data.tar.gz: ef86bead84c3da5b9f51f2064ea9572b04c8bc1dc361f82a2c074d6b895ea57b
+  metadata.gz: ca6da3e428a5c61d9015882992836106ba91778cda6a833fca9ddced24378ebc
+  data.tar.gz: 6268486cd2419034400e32020ed6869cb361ee997ec60f22170b97758b941c00
 SHA512:
-  metadata.gz: 0a6fc972abb448496bbed54576bb6afceeda7aa555caa2836134435b6047c9dccd0b0b5f9d4256301ee06954f850fc84e1dee0b8b615428ca3029cb302f4be18
-  data.tar.gz: 541f09ee30bd58ef7a88da099d68cb095ad3c0e1929bb9fe75d1f41320daf7188161b2bcdfe36a1017e81777f0cf181c1253be4cf53878acf7291f6c3974463f
+  metadata.gz: 84ff46aa072d18ae94a7ceb5710c27ee085cfc2662d6da76dcd06457ea966be2b57a23e0d314922dc092ba1ffc786a6c861faaf71411088e3623ad34aa3c080b
+  data.tar.gz: 4bf22cb4b69ce75fbe795f21843baf25d4c2c7d545c36923cf884372fae2a0db80b01c52eecb1b9d3a838c137948f5bcb4eea1bf61941d6dc605e97c17bc8057

data/.github/workflows/build.yml

@@ -16,18 +16,35 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.7
           - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
         gemfile:
-          - Gemfile.rails42
+          - Gemfile.rails50
+          - Gemfile.rails51
           - Gemfile.rails52 # Min ruby 2.2.2
           - Gemfile.rails60 # Min ruby 2.5.0
           - Gemfile.rails61 # Min ruby 2.5.0
         exclude:
-        - gemfile: Gemfile.rails42
+        - gemfile: Gemfile.rails50
+          ruby: 2.7
+        - gemfile: Gemfile.rails50
+          ruby: '3.0'
+        - gemfile: Gemfile.rails50
+          ruby: 3.1
+        - gemfile: Gemfile.rails51
           ruby: 2.7
+        - gemfile: Gemfile.rails51
+          ruby: '3.0'
+        - gemfile: Gemfile.rails51
+          ruby: 3.1
         - gemfile: Gemfile.rails52
           ruby: 2.7
+        - gemfile: Gemfile.rails52
+          ruby: '3.0'
+        - gemfile: Gemfile.rails52
+          ruby: 3.1
 
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}

data/CHANGELOG.md

@@ -1,5 +1,31 @@
  Changelog
 ===========
+
+## [v0.7.1](https://github.com/Apipie/apipie-rails/tree/v0.7.1) (2022-04-06)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.7.0...v0.7.1)
+* Skip extra parameters while validating the keys. [#690](https://github.com/Apipie/apipie-rails/pull/690) (Omkar Joshi)
+* Support defining security mechanisms for Swagger [#711](https://github.com/Apipie/apipie-rails/pull/711) (Dan Leyden)
+* Update boolean handling of false [#749](https://github.com/Apipie/apipie-rails/pull/749) (Colin Bruce)
+
+Note: Up until and including v0.6.x, apipie-rails was silently ignoring allow_blank == false on String validation.
+when allow_blank is not specified, it default to false. to allow blank strings, you must specify it as a parameter.
+
+Alternatively, if you want to revert to the previous behavior, you can set this configuration option:
+`Apipie.configuration.ignore_allow_blank_false = true`.
+
+## [v0.7.0](https://github.com/Apipie/apipie-rails/tree/v0.7.0) (2022-03-30)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.6.0...v0.7.0)
+* ArgumentError (invalid byte sequence in UTF-8) [#746](https://github.com/Apipie/apipie-rails/pull/746) (David Milanese)
+* Fix allow_blank does not work [#733](https://github.com/Apipie/apipie-rails/pull/733) (CHEN Song)
+* Fix schema generation for param descriptions using the array validator in option [#732](https://github.com/Apipie/apipie-rails/pull/732) (Frank Hock)
+* Remove support for Rails 4 and Ruby <= 2.5 [#747](https://github.com/Apipie/apipie-rails/pull/747) (Mathieu Jobin)
+
+## [v0.6.0](https://github.com/Apipie/apipie-rails/tree/v0.6.0) (2022-03-29)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.20...v0.6.0)
+* Ruby 3.0 fixes [#716](https://github.com/Apipie/apipie-rails/pull/716) (hank-spokeo)
+* only depends on actionpack and activesupport [#741](https://github.com/Apipie/apipie-rails/pull/741) (Mathieu Jobin)
+* language fix, fallback to default locale [#726](https://github.com/Apipie/apipie-rails/pull/726) (Alex Coomans)
+
 ## [v0.5.20](https://github.com/Apipie/apipie-rails/tree/v0.5.20) (2022-03-16)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.19...v0.5.20)
 * Update rel-eng (Oleh Fedorenko)

data/README.rst

@@ -966,6 +966,9 @@ validate_presence
 validate_key
   Check the received params to ensure they are defined in the API. (false by default)
 
+action_on_non_validated_keys
+  Either `:raise` or `:skip`. If `validate_key` fails, raise error or delete the non-validated key from the params and log the key (`:raise` by default)
+
 process_params
   Process and extract the parameter defined from the params of the request
   to the api_params variable
@@ -1021,6 +1024,10 @@ authorize
 show_all_examples
   Set this to true to set show_in_doc=1 in all recorded examples
 
+ignore_allow_blank_false
+  `allow_blank: false` was incorrectly ignored up until version 0.6.0, this bug was fixed in 0.7.0
+  if you need the old behavior, set this to true
+
 link_extension
   The extension to use for API pages ('.html' by default). Link extensions
   in static API docs cannot be changed from '.html'.
@@ -1654,6 +1661,18 @@ There are several configuration parameters that determine the structure of the g
     If ``true``:  the ``additional-properties: false`` field will not be included in response object descriptions
 
 
+``config:swagger_security_definitions``
+    If the API requires authentication, you can specify details of the authentication mechanisms supported as a (Hash) value here.
+    See [https://swagger.io/docs/specification/2-0/authentication/] for details of what values can be specified
+    By default, no security is defined.
+
+``config.swagger_global_security``
+    If the API requires authentication, you can specify which of the authentication mechanisms are supported by all API operations as an Array of hashes here.
+    This should be used in conjunction with the mechanisms defined by ``swagger_security_definitions``.
+    See [https://swagger.io/docs/specification/2-0/authentication/] for details of what values can be specified
+    By default, no security is defined.
+
+
 Known limitations of the current implementation
 -------------------------------------------------
 * There is currently no way to document the structure and content-type of the data returned from a method
@@ -1663,6 +1682,7 @@ Known limitations of the current implementation
 * It is not possible to leverage all of the parameter type/format capabilities of swagger
 * Only OpenAPI 2.0 is supported
 * Responses are defined inline and not as a $ref
+* It is not possible to specify per-operation security requirements (only global)
 
 ====================================
  Dynamic Swagger generation

data/apipie-rails.gemspec

@@ -10,13 +10,14 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/Apipie/apipie-rails"
   s.summary     = %q{Rails REST API documentation tool}
   s.description = %q{Rails REST API documentation tool}
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.6.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 4.1"
+  s.add_dependency "actionpack", ">= 5.0"
+  s.add_dependency "activesupport", ">= 5.0"
   s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"

data/app/controllers/apipie/apipies_controller.rb

@@ -100,7 +100,7 @@ module Apipie
       [:resource, :method, :version].each do |par|
         if params[par]
           splitted = params[par].split('.')
-          if splitted.length > 1 && Apipie.configuration.languages.include?(splitted.last)
+          if splitted.length > 1 && (Apipie.configuration.languages.include?(splitted.last) || Apipie.configuration.default_locale == splitted.last)
             lang = splitted.last
             params[par].sub!(".#{lang}", '')
           end

data/gemfiles/Gemfile.rails50

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 5.0.0'
+gem 'activesupport', '~> 5.0.0'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'
+
+gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails51

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 5.1.0'
+gem 'activesupport', '~> 5.1.0'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'
+
+gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails52

@@ -2,7 +2,8 @@ source "https://rubygems.org"
 
 gemspec path: '..'
 
-gem 'rails', '~> 5.2.6'
+gem 'actionpack', '~> 5.2.6'
+gem 'activesupport', '~> 5.2.6'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'
 

data/gemfiles/Gemfile.rails60

@@ -2,9 +2,16 @@ source "https://rubygems.org"
 
 gemspec path: '..'
 
-gem 'rails', '~> 6.0.2'
-gem 'mime-types', '~> 2.99.3'
+gem 'actionpack', '~> 6.0.4'
+gem 'activesupport', '~> 6.0.4'
+gem 'mime-types', '~> 3.0'
 gem 'rails-controller-testing'
-gem 'rspec-rails', '~> 4.0.2'
+gem 'rspec-rails', '~> 5.0'
+
+# net-smtp not included by default in Ruby 3.1
+# Will be fixed by https://github.com/mikel/mail/pull/1439
+if Gem.ruby_version >= Gem::Version.new("3.1.0")
+  gem 'net-smtp', require: false
+end
 
 gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails61

@@ -2,9 +2,16 @@ source "https://rubygems.org"
 
 gemspec path: '..'
 
-gem 'rails', '~> 6.1.1'
-gem 'mime-types', '~> 2.99.3'
+gem 'actionpack', '~> 6.1.5'
+gem 'activesupport', '~> 6.1.5'
+gem 'mime-types', '~> 3.0'
 gem 'rails-controller-testing'
-gem 'rspec-rails', '~> 4.0.2'
+gem 'rspec-rails', '~> 5.0'
+
+# net-smtp not included by default in Ruby 3.1
+# Will be fixed by https://github.com/mikel/mail/pull/1439
+if Gem.ruby_version >= Gem::Version.new("3.1.0")
+  gem 'net-smtp', require: false
+end
 
 gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/lib/apipie/configuration.rb

@@ -5,13 +5,14 @@ module Apipie
       :markup, :disqus_shortname,
       :api_base_url, :doc_base_url, :required_by_default, :layout,
       :default_version, :debug, :version_in_url, :namespaced_resources,
-      :validate, :validate_value, :validate_presence, :validate_key, :authenticate, :doc_path,
+      :validate, :validate_value, :validate_presence, :validate_key, :action_on_non_validated_keys, :authenticate, :doc_path,
       :show_all_examples, :process_params, :update_checksum, :checksum_path,
       :link_extension, :record, :languages, :translate, :locale, :default_locale,
-      :persist_show_in_doc, :authorize,
+      :persist_show_in_doc, :authorize, :ignore_allow_blank_false,
       :swagger_include_warning_tags, :swagger_content_type_input, :swagger_json_input_uses_refs,
       :swagger_suppress_warnings, :swagger_api_host, :swagger_generate_x_computed_id_field,
-      :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs
+      :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs,
+      :swagger_security_definitions, :swagger_global_security
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default
@@ -152,6 +153,7 @@ module Apipie
       @validate_value = true
       @validate_presence = true
       @validate_key = false
+      @action_on_non_validated_keys = :raise
       @required_by_default = false
       @api_base_url = HashWithIndifferentAccess.new
       @doc_base_url = "/apipie"
@@ -159,6 +161,7 @@ module Apipie
       @disqus_shortname = nil
       @default_version = "1.0"
       @debug = false
+      @ignore_allow_blank_false = false
       @version_in_url = true
       @namespaced_resources = false
       @doc_path = "doc"
@@ -181,6 +184,8 @@ module Apipie
       @swagger_generate_x_computed_id_field = false
       @swagger_allow_additional_properties_in_response = false
       @swagger_responses_use_refs = true
+      @swagger_security_definitions = {}
+      @swagger_global_security = []
     end
   end
 end

data/lib/apipie/dsl_definition.rb

@@ -262,7 +262,9 @@ module Apipie
               if Apipie.configuration.validate_key?
                 params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_pair do |param, _|
                   # params allowed
-                  raise UnknownParam.new(param) if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
+                  if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
+                    self.class._apipie_handle_validate_key_error params, param
+                  end
                 end
               end
 
@@ -290,6 +292,15 @@ module Apipie
         end
       end
 
+      def _apipie_handle_validate_key_error params, param
+        if Apipie.configuration.action_on_non_validated_keys == :raise
+          raise UnknownParam, param
+        elsif Apipie.configuration.action_on_non_validated_keys == :skip
+          params.delete(param)
+          Rails.logger.warn(UnknownParam.new(param).to_s)
+        end
+      end
+
       def _apipie_save_method_params(method, params)
         @method_params ||= {}
         @method_params[method] = params

data/lib/apipie/extractor/recorder.rb

@@ -160,6 +160,7 @@ module Apipie
         ensure
           Apipie::Extractor.clean_call_recorder
         end
+        ruby2_keywords :process if respond_to?(:ruby2_keywords, true)
       end
     end
   end

data/lib/apipie/param_description.rb

@@ -114,16 +114,20 @@ module Apipie
     end
 
     def validate(value)
-      return true if @allow_nil && value.nil?
-      return true if @allow_blank && value.blank?
+      return true if allow_nil && value.nil?
+      return true if allow_blank && value.blank?
       value = normalized_value(value)
-      if (!@allow_nil && value.nil?) || !@validator.valid?(value)
-        error = @validator.error
+      if (!allow_nil && value.nil?) || (blank_forbidden? && value.blank?) || !validator.valid?(value)
+        error = validator.error
         error = ParamError.new(error) unless error.is_a? StandardError
         raise error
       end
     end
 
+    def blank_forbidden?
+      !Apipie.configuration.ignore_allow_blank_false && !allow_blank && !validator.is_a?(Validator::BooleanValidator)
+    end
+
     def process_value(value)
       value = normalized_value(value)
       if @validator.respond_to?(:process_value)

data/lib/apipie/static_dispatcher.rb

@@ -9,7 +9,9 @@ module Apipie
 
     def match?(path)
       # Replace all null bytes
-      path = ::Rack::Utils.unescape(path || '').gsub(/\x0/, '')
+      path = ::Rack::Utils.unescape(path || '')
+                          .encode(Encoding::UTF_8, invalid: :replace, replace: '')
+                          .gsub(/\x0/, '')
 
       full_path = path.empty? ? @root : File.join(@root, path)
       paths = "#{full_path}#{ext}"

data/lib/apipie/swagger_generator.rb

@@ -74,6 +74,8 @@ module Apipie
           paths: {},
           definitions: {},
           tags: [],
+          securityDefinitions: Apipie.configuration.swagger_security_definitions,
+          security: Apipie.configuration.swagger_global_security
       }
 
       if Apipie.configuration.swagger_api_host
@@ -476,6 +478,9 @@ module Apipie
 
       if swagger_def[:type] == "array"
         swagger_def[:items] = {type: "string"}
+        enum = param_desc.options.fetch(:in, [])
+
+        swagger_def[:items][:enum] = enum if enum.any?
       end
 
       if swagger_def[:type] == "enum"
@@ -504,7 +509,8 @@ module Apipie
       end
 
       if !in_schema
-        swagger_def[:in] = param_desc.options.fetch(:in, @default_value_for_param_in)
+        # the "name" and "in" keys can only be set on root parameters (non-nested)
+        swagger_def[:in] = @default_value_for_param_in if name.present?
         swagger_def[:required] = param_desc.required if param_desc.required
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.5.20"
+  VERSION = "0.7.1"
 end

data/lib/apipie-rails.rb

@@ -23,7 +23,3 @@ require "apipie/railtie"
 require 'apipie/extractor'
 require "apipie/version"
 require "apipie/swagger_generator"
-
-if Rails.version.start_with?("3.0")
-  warn 'Warning: apipie-rails is not going to support Rails 3.0 anymore in future versions'
-end

data/spec/controllers/apipies_controller_spec.rb

@@ -47,6 +47,31 @@ describe Apipie::ApipiesController do
 
       assert_response :not_found
     end
+
+    it "succeeds on method details with a supported language" do
+      allow(Apipie.configuration).to receive(:languages).and_return(%w[en es])
+
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.es" }
+
+      assert_response :success
+    end
+
+    it "succeeds on method details with the default language" do
+      allow(Apipie.configuration).to receive(:default_locale).and_return("en")
+      allow(Apipie.configuration).to receive(:languages).and_return([])
+
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.en" }
+
+      assert_response :success
+    end
+
+    it "returns not_found on a method with an unsupported language" do
+      allow(Apipie.configuration).to receive(:languages).and_return(%w[en es])
+
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.jp" }
+
+      assert_response :not_found
+    end
   end
 
   describe "reload_controllers" do

data/spec/controllers/users_controller_spec.rb

@@ -124,6 +124,29 @@ describe UsersController do
           end
         end
 
+        context "key validations are enabled and skip on non-validated keys" do
+          before do
+            Apipie.configuration.validate_value = false
+            Apipie.configuration.validate_presence = true
+            Apipie.configuration.validate_key = true
+            Apipie.configuration.action_on_non_validated_keys = :skip
+          end
+
+          it "should reply to valid request" do
+            expect { get :show, :params => { :id => 5, :session => 'secret_hash' }}.not_to raise_error
+            assert_response :success
+          end
+
+          it "should delete the param and not fail if an extra parameter is passed." do
+            expect { get :show, :params => { :id => 5 , :badparam => 'badfoo', :session => "secret_hash" }}.not_to raise_error
+            expect(controller.params.as_json).to eq({"session"=>"secret_hash", "id"=>"5", "controller"=>"users", "action"=>"show"})
+          end
+
+          after do
+            Apipie.configuration.action_on_non_validated_keys = :raise
+          end
+        end
+
         context "presence and value validations are enabled" do
           before do
             Apipie.configuration.validate_value = true

data/spec/dummy/app/controllers/users_controller.rb

@@ -274,6 +274,12 @@ class UsersController < ApplicationController
     render :plain => 'nothing to see here'
   end
 
+  api :GET, '/users/in_departments', 'show users from specific departments'
+  param :departments, Array, in: ["finance", "operations", "sales", "marketing", "HR"], default_value: ['sales']
+  def get_in_departments
+    render :plain => 'nothing to see here'
+  end
+
   api :GET, '/users/desc_from_file', 'desc from file'
   document 'users/desc_from_file.md'
   def desc_from_file

data/spec/dummy/config/application.rb

@@ -1,10 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_model/railtie"
-require "active_record/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
-require "action_mailer/railtie"
 
 Bundler.require
 require "apipie-rails"

data/spec/dummy/config/environments/development.rb

@@ -13,9 +13,6 @@ Dummy::Application.configure do
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 

data/spec/dummy/config/environments/production.rb

@@ -34,9 +34,6 @@ Dummy::Application.configure do
   # Enable serving of images, stylesheets, and javascripts from an asset server
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Disable delivery errors, bad email addresses will be ignored
-  # config.action_mailer.raise_delivery_errors = false
-
   # Enable threaded mode
   # config.threadsafe!
 

data/spec/dummy/config/environments/test.rb

@@ -20,11 +20,6 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Use SQL instead of Active Record's schema dumper when creating the test database.
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types

data/spec/lib/file_handler_spec.rb

@@ -14,5 +14,12 @@ describe Apipie::FileHandler do
       it { expect(file_handler.match? path).to be_falsy }
       it { expect { file_handler.match? path }.to_not raise_error }
     end
+
+    context 'when the path contans an invalid byte sequence in UTF-8' do
+      let(:path) { "%B6" }
+
+      it { expect(file_handler.match? path).to be_falsy }
+      it { expect { file_handler.match? path }.to_not raise_error }
+    end
   end
 end

data/spec/lib/param_description_spec.rb

@@ -113,6 +113,74 @@ describe Apipie::ParamDescription do
 
   end
 
+  describe 'validate' do
+    context 'when allow_blank is ignored, as it was before 0.7.0' do
+      before do
+        Apipie.configuration.ignore_allow_blank_false = true
+      end
+
+      context 'when the parameter is a boolean' do
+        it "should not throw an exception when passed false" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
+        end
+
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+
+      context 'when the parameter is a string' do
+        context 'when allow_blank is specified as true' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
+          end
+        end
+        context 'when allow_blank is specified as false' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to_not raise_error
+          end
+        end
+        context 'when allow_blank is not specified' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to_not raise_error
+          end
+        end
+      end
+
+      after do
+        Apipie.configuration.ignore_allow_blank_false = false
+      end
+    end
+
+    context 'when the parameter is a boolean' do
+      it "should not throw an exception when passed false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an empty value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
+    context 'when the parameter is a string' do
+      context 'when allow_blank is specified as true' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
+        end
+      end
+      context 'when allow_blank is specified as false' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+      context 'when allow_blank is not specified' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+    end
+  end
+
   describe "concern substitution" do
 
     let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -51,6 +51,17 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_array_param_def(http_method, path, param_name, value)
+      params = apidoc_swagger["paths"][path][http_method]["parameters"]
+      param = params.select { |p| p if p["name"] == param_name }[0]
+
+      expect(param['type']).to eq('array')
+      expect(param['items']).to eq(
+        'type' => 'string',
+        'enum' => value
+      )
+    end
+
     def expect_tags_def(http_method, path, value)
       params = apidoc_swagger["paths"][path][http_method]["tags"]
       expect(params).to eq(value)
@@ -119,6 +130,10 @@ describe 'rake tasks' do
         expect_param_def("get", "/users/by_department", "department", "enum",
                          ["finance", "operations", "sales", "marketing", "HR"])
 
+        expect_param_def("get", "/users/in_departments", "departments", "in", "query")
+        expect_array_param_def("get", "/users/in_departments", "departments",
+                         ["finance", "operations", "sales", "marketing", "HR"])
+
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
 
       end

data/spec/lib/swagger/response_validation_spec.rb

@@ -10,78 +10,78 @@ RSpec.describe PetsController, :type => :controller do
   end
 
   it "does not raise error when rendered output matches the described response" do
-    response = get :return_and_validate_expected_response, {format: :json}
+    response = get :return_and_validate_expected_response, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raise error when rendered output (array) matches the described response" do
-    response = get :return_and_validate_expected_array_response, {format: :json}
+    response = get :return_and_validate_expected_array_response, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raises error when rendered output includes null in the response" do
-    response = get :return_and_validate_expected_response_with_null, {format: :json}
+    response = get :return_and_validate_expected_response_with_null, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raise error when rendered output includes null (instead of an object) in the response" do
-    response = get :return_and_validate_expected_response_with_null_object, {format: :json}
+    response = get :return_and_validate_expected_response_with_null_object, format: :json
     expect(response).to match_declared_responses
   end
 
   it "raises error when a response field has the wrong type" do
-    response = get :return_and_validate_type_mismatch, {format: :json}
+    response = get :return_and_validate_type_mismatch, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "raises error when a response has a missing field" do
-    response = get :return_and_validate_missing_field, {format: :json}
+    response = get :return_and_validate_missing_field, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "raises error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is false" do
-    response = get :return_and_validate_extra_property, {format: :json}
+    response = get :return_and_validate_extra_property, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "raises error when a response has is array instead of object" do
     # note: this action returns HTTP 201, not HTTP 200!
-    response = get :return_and_validate_unexpected_array_response, {format: :json}
+    response = get :return_and_validate_unexpected_array_response, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "does not raise error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is true" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = true
-    response = get :return_and_validate_extra_property, {format: :json}
+    response = get :return_and_validate_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   it "does not raise error when a response has an extra field and 'additional_properties' is specified in the response" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = false
-    response = get :return_and_validate_allowed_extra_property, {format: :json}
+    response = get :return_and_validate_allowed_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   it "raises error when a response sub-object has an extra field and 'additional_properties' is not specified on it, but specified on the top level of the response" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = false
-    response = get :sub_object_invalid_extra_property, {format: :json}
+    response = get :sub_object_invalid_extra_property, format: :json
     expect(response).not_to match_declared_responses
   end
 
-  it "does not rais error when a response sub-object has an extra field and 'additional_properties' is specified on it" do
+  it "does not raise error when a response sub-object has an extra field and 'additional_properties' is specified on it" do
     Apipie.configuration.swagger_allow_additional_properties_in_response = false
-    response = get :sub_object_allowed_extra_property, {format: :json}
+    response = get :sub_object_allowed_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   describe "auto validation" do
     auto_validate_rendered_views
     it "raises exception when a response field has the wrong type and auto validation is turned on" do
-      expect { get :return_and_validate_type_mismatch, {format: :json} }.to raise_error(Apipie::ResponseDoesNotMatchSwaggerSchema)
+      expect { get :return_and_validate_type_mismatch, format: :json }.to raise_error(Apipie::ResponseDoesNotMatchSwaggerSchema)
     end
 
     it "does not raise an exception when calling an undocumented method" do
-      expect { get :undocumented_method, {format: :json} }.not_to raise_error
+      expect { get :undocumented_method, format: :json }.not_to raise_error
     end
 
   end
@@ -89,12 +89,12 @@ RSpec.describe PetsController, :type => :controller do
 
   describe "with array field" do
     it "no error for valid response" do
-      response = get :returns_response_with_valid_array, {format: :json}
+      response = get :returns_response_with_valid_array, format: :json
       expect(response).to match_declared_responses
     end
 
     it "error if type of element in the array is wrong" do
-      response = get :returns_response_with_invalid_array, {format: :json}
+      response = get :returns_response_with_invalid_array, format: :json
       expect(response).not_to match_declared_responses
     end
   end

data/spec/spec_helper.rb

@@ -13,7 +13,13 @@ require 'test_engine'
 module Rails4Compatibility
   module Testing
     def process(*args)
-      compatible_request(*args) { |*new_args| super(*new_args) }
+      compatible_request(*args) do |*new_args|
+        if Gem.ruby_version < Gem::Version.new('3.0.0')
+          super(*new_args)
+        else
+          super(new_args[0], **new_args[1])
+        end
+      end
     end
 
     def compatible_request(method, action, hash = {})

metadata

@@ -1,30 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.20
+  version: 0.7.1
 platform: ruby
 authors:
 - Pavel Pokorny
 - Ivan Necas
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +164,6 @@ files:
 - ".rspec"
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
-- Gemfile
 - MIT-LICENSE
 - NOTICE
 - PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
@@ -197,8 +210,8 @@ files:
 - config/locales/tr.yml
 - config/locales/zh-CN.yml
 - config/locales/zh-TW.yml
-- gemfiles/Gemfile.rails42
-- gemfiles/Gemfile.rails42.lock
+- gemfiles/Gemfile.rails50
+- gemfiles/Gemfile.rails51
 - gemfiles/Gemfile.rails52
 - gemfiles/Gemfile.rails60
 - gemfiles/Gemfile.rails61
@@ -328,7 +341,7 @@ files:
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -336,97 +349,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool
-test_files:
-- spec/controllers/api/v1/architectures_controller_spec.rb
-- spec/controllers/api/v2/architectures_controller_spec.rb
-- spec/controllers/api/v2/nested/resources_controller_spec.rb
-- spec/controllers/apipies_controller_spec.rb
-- spec/controllers/concerns_controller_spec.rb
-- spec/controllers/extended_controller_spec.rb
-- spec/controllers/memes_controller_spec.rb
-- spec/controllers/users_controller_spec.rb
-- spec/dummy/Rakefile
-- spec/dummy/app/controllers/api/base_controller.rb
-- spec/dummy/app/controllers/api/v1/architectures_controller.rb
-- spec/dummy/app/controllers/api/v1/base_controller.rb
-- spec/dummy/app/controllers/api/v2/architectures_controller.rb
-- spec/dummy/app/controllers/api/v2/base_controller.rb
-- spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb
-- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/concerns/extending_concern.rb
-- spec/dummy/app/controllers/concerns/sample_controller.rb
-- spec/dummy/app/controllers/concerns_controller.rb
-- spec/dummy/app/controllers/extended_controller.rb
-- spec/dummy/app/controllers/files_controller.rb
-- spec/dummy/app/controllers/overridden_concerns_controller.rb
-- spec/dummy/app/controllers/pets_controller.rb
-- spec/dummy/app/controllers/pets_using_auto_views_controller.rb
-- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
-- spec/dummy/app/controllers/tagged_cats_controller.rb
-- spec/dummy/app/controllers/tagged_dogs_controller.rb
-- spec/dummy/app/controllers/twitter_example_controller.rb
-- spec/dummy/app/controllers/users_controller.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/components/test_engine/Gemfile
-- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
-- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
-- spec/dummy/components/test_engine/config/routes.rb
-- spec/dummy/components/test_engine/db/.gitkeep
-- spec/dummy/components/test_engine/lib/test_engine.rb
-- spec/dummy/components/test_engine/test_engine.gemspec
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/apipie.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/.gitkeep
-- spec/dummy/doc/apipie_examples.json
-- spec/dummy/doc/users/desc_from_file.md
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/stylesheets/.gitkeep
-- spec/dummy/script/rails
-- spec/lib/application_spec.rb
-- spec/lib/extractor/extractor_spec.rb
-- spec/lib/extractor/middleware_spec.rb
-- spec/lib/extractor/writer_spec.rb
-- spec/lib/file_handler_spec.rb
-- spec/lib/method_description_spec.rb
-- spec/lib/param_description_spec.rb
-- spec/lib/param_group_spec.rb
-- spec/lib/rake_spec.rb
-- spec/lib/resource_description_spec.rb
-- spec/lib/swagger/openapi_2_0_schema.json
-- spec/lib/swagger/rake_swagger_spec.rb
-- spec/lib/swagger/response_validation_spec.rb
-- spec/lib/swagger/swagger_dsl_spec.rb
-- spec/lib/validator_spec.rb
-- spec/lib/validators/array_validator_spec.rb
-- spec/spec_helper.rb
-- spec/support/rails-42-ruby-26.rb
-- spec/support/rake.rb
+test_files: []

data/Gemfile

@@ -1 +0,0 @@
-./Gemfile.rails61

data/gemfiles/Gemfile.rails42

@@ -1,14 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: '..'
-
-gem 'rails', '~> 4.2.5'
-gem 'mime-types', '~> 2.99.3'
-gem 'sqlite3', '~> 1.3.6'
-
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1.0')
-  gem 'nokogiri', '~> 1.6.8'
-  gem 'rdoc', '~> 4.2.2'
-end
-
-gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails42.lock

@@ -1,160 +0,0 @@
-PATH
-  remote: ../spec/dummy/components/test_engine
-  specs:
-    test_engine (0.0.1)
-
-PATH
-  remote: ..
-  specs:
-    apipie-rails (0.5.19)
-      rails (>= 4.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    RedCloth (4.3.2)
-    actionmailer (4.2.11.3)
-      actionpack (= 4.2.11.3)
-      actionview (= 4.2.11.3)
-      activejob (= 4.2.11.3)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.11.3)
-      actionview (= 4.2.11.3)
-      activesupport (= 4.2.11.3)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.11.3)
-      activesupport (= 4.2.11.3)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (4.2.11.3)
-      activesupport (= 4.2.11.3)
-      globalid (>= 0.3.0)
-    activemodel (4.2.11.3)
-      activesupport (= 4.2.11.3)
-      builder (~> 3.1)
-    activerecord (4.2.11.3)
-      activemodel (= 4.2.11.3)
-      activesupport (= 4.2.11.3)
-      arel (~> 6.0)
-    activesupport (4.2.11.3)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    arel (6.0.4)
-    builder (3.2.4)
-    concurrent-ruby (1.1.9)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    erubis (2.7.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    json-schema (2.8.1)
-      addressable (>= 2.4)
-    loofah (2.13.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    maruku (0.7.3)
-    mime-types (2.99.3)
-    mini_mime (1.1.2)
-    mini_portile2 (2.7.1)
-    minitest (5.15.0)
-    nokogiri (1.13.1)
-      mini_portile2 (~> 2.7.0)
-      racc (~> 1.4)
-    psych (4.0.3)
-      stringio
-    public_suffix (4.0.6)
-    racc (1.6.0)
-    rack (1.6.13)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.11.3)
-      actionmailer (= 4.2.11.3)
-      actionpack (= 4.2.11.3)
-      actionview (= 4.2.11.3)
-      activejob (= 4.2.11.3)
-      activemodel (= 4.2.11.3)
-      activerecord (= 4.2.11.3)
-      activesupport (= 4.2.11.3)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.11.3)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.4)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.9)
-      activesupport (>= 4.2.0, < 5.0)
-      nokogiri (~> 1.6)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (4.2.11.3)
-      actionpack (= 4.2.11.3)
-      activesupport (= 4.2.11.3)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (13.0.6)
-    rdoc (6.4.0)
-      psych (>= 4.0.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (3.9.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
-    stringio (3.0.1)
-    thor (1.2.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  RedCloth
-  apipie-rails!
-  json-schema (~> 2.8)
-  maruku
-  mime-types (~> 2.99.3)
-  minitest
-  rails (~> 4.2.5)
-  rake
-  rdoc
-  rspec-rails (~> 3.0)
-  sqlite3 (~> 1.3.6)
-  test_engine!
-
-BUNDLED WITH
-   1.17.3