apipie-rails 0.5.19 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 444b1aeccaa322d75d64131d2539ae5ecb9ceb3ea984e02c9cfd17a2c80d1190
-  data.tar.gz: ddbcdfaee3494a2f35f343a361c9e07b72541b5a75e5e537c0776f8b6c9669e9
+  metadata.gz: 29292cefe596185a3becf01f657a1c8826ea2aa5601e5549926672d1ebaf9309
+  data.tar.gz: 8c1419363f237e7cb8beb61940af1303bdef53a8830e0347f9afbca29d99e32f
 SHA512:
-  metadata.gz: 18f5f97fc24bab7aa9c554cd3be305e9bf5eb5266466a79c4484fb0c7f6e4b80912d5ddb224a8ed1dd8d8002c376cd7e30a359ab4f0855d60d404352dc74acb0
-  data.tar.gz: 1c66c6990ab997d21e727900a4a36648b76aa08357491007821c4a5f1b46b25f8e48fbb9cdeccfd26f20b1ea268c32c6698f73b040226036b0f5f72fc9447060
+  metadata.gz: 87f52d7d548463ec69639b85c7cb9b322b29f711fdd38800365f13bc8963a8a461f840ac8f36300e18236212b088298d90d482a0537d58b857eecbd2b479bdc5
+  data.tar.gz: 895cb9c91976d485ab1442f42895114e15c102cccc8d3b853ea6242de360f7756c5337faa086e4df7b5536079285ab83d259ce21b292c0da7fe766decdaddb32

data/.github/workflows/build.yml

@@ -0,0 +1,57 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+        gemfile:
+          - 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.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 }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,27 @@
  Changelog
 ===========
+
+## [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)
+* Deprecate travis, run tests on github actions [#740](https://github.com/Apipie/apipie-rails/pull/740) (Mathieu Jobin)
+* Update validator.rb [#739](https://github.com/Apipie/apipie-rails/pull/739) (Dmytro Budnyk)
+* Fix wrong number of arguments for recorder#process [#725](https://github.com/Apipie/apipie-rails/pull/725) (rob mathews)
+* Change "an" to "a" [#723](https://github.com/Apipie/apipie-rails/pull/723) (Naokimi)
+
 ## [v0.5.19](https://github.com/Apipie/apipie-rails/tree/v0.5.19) (2021-07-25)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.18...v0.5.19)
 * Add rel-eng notebook (Oleh Fedorenko)

data/README.rst

@@ -387,20 +387,20 @@ Example:
      end
    end
 
-   api :POST, "/users", "Create an user"
+   api :POST, "/users", "Create a user"
    param_group :user
    def create
      # ...
    end
 
-   api :PUT, "/users/:id", "Update an user"
+   api :PUT, "/users/:id", "Update a user"
    param_group :user
    def update
      # ...
    end
 
    # v2/users_controller.rb
-   api :POST, "/users", "Create an user"
+   api :POST, "/users", "Create a user"
    param_group :user, V1::UsersController
    def create
      # ...
@@ -434,7 +434,7 @@ Example
      end
    end
 
-   api :POST, "/users", "Create an user"
+   api :POST, "/users", "Create a user"
    param_group :user
    def create
      # ...
@@ -446,7 +446,7 @@ Example
      # ...
    end
 
-   api :PUT, "/users/:id", "Update an user"
+   api :PUT, "/users/:id", "Update a user"
    param_group :user
    def update
      # ...

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

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

data/gemfiles/Gemfile.rails60

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 6.0.4'
+gem 'activesupport', '~> 6.0.4'
+gem 'mime-types', '~> 3.0'
+gem 'rails-controller-testing'
+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

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 6.1.5'
+gem 'activesupport', '~> 6.1.5'
+gem 'mime-types', '~> 3.0'
+gem 'rails-controller-testing'
+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/extractor/recorder.rb

@@ -150,8 +150,8 @@ module Apipie
       end
 
       module FunctionalTestRecording
-        def process(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
-          ret = super(*args)
+        def process(*, **) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          ret = super
           if Apipie.configuration.record
             Apipie::Extractor.call_recorder.analyze_functional_test(self)
             Apipie::Extractor.call_finished
@@ -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

@@ -117,7 +117,7 @@ module Apipie
       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)
+      if (!@allow_nil && value.nil?) || (!@allow_blank && value.blank?) || !@validator.valid?(value)
         error = @validator.error
         error = ParamError.new(error) unless error.is_a? StandardError
         raise error

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

@@ -476,6 +476,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 +507,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/validator.rb

@@ -3,7 +3,7 @@ module Apipie
 
   module Validator
 
-    # to create new validator, inherit from Apipie::Validator::Base
+    # to create new validator, inherit from Apipie::Validator::BaseValidator
     # and implement class method build and instance method validate
     class BaseValidator
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.5.19"
+  VERSION = "0.7.0"
 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/rel-eng/gem_release.ipynb

@@ -10,7 +10,8 @@
     "- push access to https://github.com/Apipie/apipie-rails\n",
     "- push access to rubygems.org for apipie-rails\n",
     "- sudo yum install python-slugify asciidoc\n",
-    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually \n",
+    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually\n",
+    "- ensure all checks have passed on the branch you're about to release\n",
     "\n",
     "### Release process\n",
     "- Follow the steps with `<Shift>+<Enter>` or `<Ctrl>+<Enter>,<Down>`\n",
@@ -19,6 +20,15 @@
     "### Release settings"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%autosave 0"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -41,10 +51,14 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "NEW_VERSION = '0.5.19'\n",
-    "LAST_VERSION = '0.5.18'\n",
+    "NEW_VERSION = '0.5.20'\n",
+    "LAST_VERSION = '0.5.19'\n",
     "GIT_REMOTE_UPSTREAM = 'origin'\n",
-    "WORK_BRANCH = 'master'\n"
+    "STABLE_RELEASE = False\n",
+    "WORK_BRANCH = 'stable' if STABLE_RELEASE else 'master'\n",
+    "# Array of strings, e.g. [\"21cbsc214g3\", \"21casc214g3\"]\n",
+    "CHERRY_PICKS = []\n",
+    "GEMFILE='Gemfile.rails61'"
    ]
   },
   {
@@ -85,7 +99,25 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Run tests localy"
+    "### Cherry picks for stable release"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "if STABLE_RELEASE:\n",
+    "    for cp in CHERRY_PICKS:\n",
+    "        ! git cherry-pick -x {cp}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run tests localy if your setup allows, otherwise ensure the HEAD is green"
    ]
   },
   {
@@ -94,7 +126,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "! bundle update"
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle update"
    ]
   },
   {
@@ -105,7 +137,7 @@
    },
    "outputs": [],
    "source": [
-    "! bundle exec rake"
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle exec rspec"
    ]
   },
   {
@@ -249,7 +281,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "! git tag v{NEW_VERSION}"
+    "! git tag {NEW_VERSION}"
    ]
   },
   {
@@ -265,7 +297,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "! rake build"
+    "! BUNDLE_GEMFILE=gemfiles/{GEMFILE} bundle exec rake build"
    ]
   },
   {

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/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/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 = {})

data/spec/support/rails-42-ruby-26.rb

@@ -0,0 +1,15 @@
+if RUBY_VERSION >= '2.6.0'
+  if Rails.version < '5'
+    # rubocop:disable Style/CommentAnnotation
+    class ActionController::TestResponse < ActionDispatch::TestResponse
+      def recycle!
+        # hack to avoid MonitorMixin double-initialize error:
+        @mon_mutex_owner_object_id = nil
+        @mon_mutex = nil
+        initialize
+      end
+    end
+    # rubocop:enable Style/CommentAnnotation
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.19
+  version: 0.7.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,22 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-25 00:00:00.000000000 Z
+date: 2022-03-29 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
@@ -145,18 +159,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
 - Gemfile
-- Gemfile.rails41
-- Gemfile.rails42
-- Gemfile.rails50
-- Gemfile.rails51
-- Gemfile.rails60
-- Gemfile.rails61
 - MIT-LICENSE
 - NOTICE
 - PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
@@ -203,6 +211,11 @@ files:
 - config/locales/tr.yml
 - config/locales/zh-CN.yml
 - config/locales/zh-TW.yml
+- gemfiles/Gemfile.rails50
+- gemfiles/Gemfile.rails51
+- gemfiles/Gemfile.rails52
+- gemfiles/Gemfile.rails60
+- gemfiles/Gemfile.rails61
 - images/screenshot-1.png
 - images/screenshot-2.png
 - lib/apipie-rails.rb
@@ -324,6 +337,7 @@ files:
 - 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
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
@@ -336,96 +350,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
+rubygems_version: 3.0.9
 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/rake.rb
+test_files: []

data/.travis.yml

@@ -1,41 +0,0 @@
-language: ruby
-sudo: false
-before_install: >-
-  if ruby -v | grep 'ruby 2.2'; then
-    gem install bundler -v '~> 1.17'
-  fi
-rvm:
-  - 2.2.10
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.5
-  - 2.7.0
-gemfile:
-  - Gemfile.rails42
-  - Gemfile.rails51 # Min ruby 2.2.2
-  - Gemfile.rails60 # Min ruby 2.5.0
-  - Gemfile.rails61 # Min ruby 2.5.0
-
-matrix:
-  exclude:
-    - rvm: 2.5.3
-      gemfile: Gemfile.rails42
-    - rvm: 2.6.5
-      gemfile: Gemfile.rails42
-    - rvm: 2.7.0
-      gemfile: Gemfile.rails42
-    - rvm: 2.7.0
-      gemfile: Gemfile.rails51
-    - rvm: 2.2.10
-      gemfile: Gemfile.rails60
-    - rvm: 2.3.8
-      gemfile: Gemfile.rails60
-    - rvm: 2.4.5
-      gemfile: Gemfile.rails60
-    - rvm: 2.2.10
-      gemfile: Gemfile.rails61
-    - rvm: 2.3.8
-      gemfile: Gemfile.rails61
-    - rvm: 2.4.5
-      gemfile: Gemfile.rails61

data/Gemfile.rails41

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.1.0'
-gem 'mime-types', '~> 2.99.3'
-gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails42

@@ -1,14 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-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/Gemfile.rails50

@@ -1,9 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 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/Gemfile.rails51

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

data/Gemfile.rails60

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

data/Gemfile.rails61

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