apipie-rails 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7a94176378d53856507d3df6c324e69b2637430e6d627726d344fc427e619a7
-  data.tar.gz: 5f00ebcf9cf5fb2940e86681f2fbdb685ed215bf3708ebcc41ab0f34a0f2bab1
+  metadata.gz: 231e8e86bd335aa018fcd0a8bf07730dd452968bde2a9491374979ec368f2a06
+  data.tar.gz: 39075cddca5f3ba6ef9c412e267d10f934ea37d08696d67f5069c16eb93fd41d
 SHA512:
-  metadata.gz: fd4340d9646496246e06454941c93ebae9039d59c0449e5b9683f01aa18cd02414ea0233f0345e09f4b4107f8daeb84387ace0af32b5e2d82cea0f6cbd57a53b
-  data.tar.gz: 6abd0665093f3e7c9fd2d9bcf965bf85b2b4bbff937c52b317c4601898e6a71683686cdcc690f7983826db612e9f5910b55b18a011f1755f1c9b884f20681fdf
+  metadata.gz: c01816a4e5e254e620889e950f19bd7983b7b80d32ab8028656b2cb016cff58cd42299397f0c03b7c7e439d555c7fde6f7e1cacbbfcc9ae6115e8549c0469f80
+  data.tar.gz: a5d25cc68efc019d7624cf51c681fc5a7b7376615959c5f30c3858fb29e13aeccc03f113ac763b3615b0317ff29c1117ad3d003a93d26e9ca69af5e77f05a51e

data/.github/workflows/build.yml

@@ -26,6 +26,7 @@ jobs:
           - Gemfile.rails52 # Min ruby 2.2.2
           - Gemfile.rails60 # Min ruby 2.5.0
           - Gemfile.rails61 # Min ruby 2.5.0
+          - Gemfile.rails70 # Min ruby 2.7.0
         exclude:
         - gemfile: Gemfile.rails50
           ruby: 2.7
@@ -45,6 +46,8 @@ jobs:
           ruby: '3.0'
         - gemfile: Gemfile.rails52
           ruby: 3.1
+        - gemfile: Gemfile.rails70
+          ruby: 2.6
 
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}

data/CHANGELOG.md

@@ -1,6 +1,17 @@
  Changelog
 ===========
 
+Also deleted the `Gemfile` that was now a broken symlink.
+please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
+
+## [v0.8.0](https://github.com/Apipie/apipie-rails/tree/v0.8.0) (2022-05-24)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.7.2...v0.8.0)
+* Add support for scheme definition in Swagger docs. [#710](https://github.com/Apipie/apipie-rails/pull/710) (Dan Leyden)
+* Add support for Rails 7 [#760](https://github.com/Apipie/apipie-rails/pull/760) (Mathieu Jobin)
+* Clean up code base, removing all trace of unsupported Rails 4.x [#752](https://github.com/Apipie/apipie-rails/pull/752) (Mathieu Jobin)
+* fix: Controller resource set before version [#744](https://github.com/Apipie/apipie-rails/pull/744) (LuukvH)
+* fix: enable swagger generator to add referenced schema for an array of hashes param [#689](https://github.com/Apipie/apipie-rails/pull/689) (Francis San Juan)
+
 ## [v0.7.2](https://github.com/Apipie/apipie-rails/tree/v0.7.2) (2022-04-19)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.7.1...v0.7.2)
 * Added Korean locale. [#480](https://github.com/Apipie/apipie-rails/pull/480) (Jaehyun Shin ) [#757](https://github.com/Apipie/apipie-rails/pull/757) (Jorge Santos)

data/README.rst

@@ -1660,6 +1660,11 @@ 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_schemes``
+    An array of transport schemes that the API supports.
+    This can include any combination of ``http``, ``https``, ``ws`` and ``wss``.
+    By default to encourage good security practices, ``['https']`` is specified.
+
 
 ``config:swagger_security_definitions``
     If the API requires authentication, you can specify details of the authentication mechanisms supported as a (Hash) value here.

data/app/controllers/apipie/apipies_controller.rb

@@ -34,7 +34,7 @@ module Apipie
 
         @language = get_language
 
-        Apipie.load_documentation if Apipie.configuration.reload_controllers? || (Rails.version.to_i >= 4.0 && !Rails.application.config.eager_load)
+        Apipie.load_documentation if Apipie.configuration.reload_controllers? || !Rails.application.config.eager_load
 
         I18n.locale = @language
 

data/gemfiles/Gemfile.rails70

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 7.0.2'
+gem 'activesupport', '~> 7.0.2'
+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/application.rb

@@ -40,8 +40,10 @@ module Apipie
       flatten_routes = []
 
       route_set.routes.each do |route|
-        # This is a hack to workaround a bug in apipie with Rails 4.2.5.1 or newer. See https://github.com/Apipie/apipie-rails/issues/415
-        route_app = Rails::VERSION::STRING.to_f >= 4.2 ? route.app.app : route.app
+        # route is_a ActionDispatch::Journey::Route
+        # route.app is_a ActionDispatch::Routing::Mapper::Constraints
+        # route.app.app is_a TestEngine::Engine
+        route_app = route.app.app
         if route_app.respond_to?(:routes) && route_app.routes.is_a?(ActionDispatch::Routing::RouteSet)
           # recursively go though the mounted engines
           flatten_routes.concat(rails_routes(route_app.routes, File.join(base_url, route.path.spec.to_s)))
@@ -456,10 +458,10 @@ module Apipie
     # as this would break loading of the controllers.
     def rails_mark_classes_for_reload
       unless Rails.application.config.cache_classes
-        Rails::VERSION::MAJOR == 4 ? ActionDispatch::Reloader.cleanup! : Rails.application.reloader.reload!
+        Rails.application.reloader.reload!
         init_env
         reload_examples
-        Rails::VERSION::MAJOR == 4 ? ActionDispatch::Reloader.prepare! : Rails.application.reloader.prepare!
+        Rails.application.reloader.prepare!
       end
     end
 

data/lib/apipie/configuration.rb

@@ -12,7 +12,7 @@ module Apipie
       :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_security_definitions, :swagger_global_security
+      :swagger_schemes, :swagger_security_definitions, :swagger_global_security
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default
@@ -184,6 +184,7 @@ module Apipie
       @swagger_generate_x_computed_id_field = false
       @swagger_allow_additional_properties_in_response = false
       @swagger_responses_use_refs = true
+      @swagger_schemes = [:https]
       @swagger_security_definitions = {}
       @swagger_global_security = []
     end

data/lib/apipie/dsl_definition.rb

@@ -149,10 +149,10 @@ module Apipie
 
         dsl_data = ResourceDescriptionDsl.eval_dsl(self, &block)
         versions = dsl_data[:api_versions]
+        Apipie.set_controller_versions(self, versions)
         @apipie_resource_descriptions = versions.map do |version|
           Apipie.define_resource_description(self, version, dsl_data)
         end
-        Apipie.set_controller_versions(self, versions)
       end
     end
 

data/lib/apipie/extractor/recorder.rb

@@ -150,7 +150,7 @@ module Apipie
       end
 
       module FunctionalTestRecording
-        def process(*) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+        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)

data/lib/apipie/extractor.rb

@@ -17,14 +17,8 @@ class Apipie::Railtie
     end
     app.middleware.use ::Apipie::Extractor::Recorder::Middleware
 
-    if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
-      ActionController::TestCase::Behavior.instance_eval do
-        prepend Apipie::Extractor::Recorder::FunctionalTestRecording
-      end
-    else
-      ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
-      ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
-    end
+    ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+    ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
   end
 end
 

data/lib/apipie/rspec/response_validation_helper.rb

@@ -161,8 +161,8 @@ ActionController::TestCase::Behavior.instance_eval do
   # instrument the 'process' method in ActionController::TestCase to enable response validation
   module Apipie::ResponseValidationHelpers
     @is_response_validation_on = false
-    def process(*args)
-      result = super(*args)
+    def process(*, **)
+      result = super
       validate_response if @is_response_validation_on
 
       result

data/lib/apipie/swagger_generator.rb

@@ -73,6 +73,7 @@ module Apipie
           consumes: [],
           paths: {},
           definitions: {},
+          schemes: Apipie.configuration.swagger_schemes,
           tags: [],
           securityDefinitions: Apipie.configuration.swagger_security_definitions,
           security: Apipie.configuration.swagger_global_security
@@ -477,9 +478,16 @@ module Apipie
       end
 
       if swagger_def[:type] == "array"
-        swagger_def[:items] = {type: "string"}
-        enum = param_desc.options.fetch(:in, [])
+        array_of_validator_opts = param_desc.validator.param_description.options
+        items_type = array_of_validator_opts[:of].to_s || array_of_validator_opts[:array_of].to_s
+        if items_type == "Hash"
+          ref_name = "#{swagger_op_id_for_path(param_desc.method_description.apis.first.http_method, param_desc.method_description.apis.first.path)}_param_#{param_desc.name}"
+          swagger_def[:items] = {"$ref" => gen_referenced_block_from_params_array(ref_name, param_desc.validator.param_description.validator.params_ordered, allow_nulls)}
+        else
+          swagger_def[:items] = {type: "string"}
+        end
 
+        enum = param_desc.options.fetch(:in, [])
         swagger_def[:items][:enum] = enum if enum.any?
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

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

@@ -3,6 +3,6 @@ class ConcernsController < ApplicationController
   resource_description { resource_id 'concern_resources' }
 
   apipie_concern_subst(:concern => 'user', :custom_subst => 'custom', 'string_subst' => 'string')
-  include ::Concerns::SampleController
+  include SampleController
 
 end

data/spec/dummy/app/controllers/{concerns/extending_concern.rb → extending_concern.rb}

@@ -1,4 +1,3 @@
-module Concerns
   module ExtendingConcern
     extend Apipie::DSL::Concern
 
@@ -9,4 +8,3 @@ module Concerns
       meta metadata: 'data'
     end
   end
-end

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

@@ -3,7 +3,7 @@ class OverriddenConcernsController < ApplicationController
   resource_description { resource_id 'overridden_concern_resources' }
 
   apipie_concern_subst(:concern => 'user')
-  include ::Concerns::SampleController
+  include SampleController
 
   def_param_group :concern do
     param :concern, String
@@ -11,7 +11,7 @@ class OverriddenConcernsController < ApplicationController
 
   api :PUT, '/:resource_id/:id'
   param :custom_parameter, String, "New parameter added by the overriding method"
-  param_group :concern, ::Concerns::SampleController
+  param_group :concern, SampleController
   def update
     super
   end

data/spec/dummy/app/controllers/{concerns/sample_controller.rb → sample_controller.rb}

@@ -1,4 +1,3 @@
-module Concerns
   module SampleController
     extend Apipie::DSL::Concern
 
@@ -38,4 +37,3 @@ module Concerns
       render :plain => "OK #{params.inspect}"
     end
   end
-end

data/spec/dummy/config/application.rb

@@ -41,7 +41,7 @@ module Dummy
     config.filter_parameters += [:password]
 
     config.to_prepare do
-      ExtendedController.send(:include, Concerns::ExtendingConcern)
+      ExtendedController.send(:include, ExtendingConcern)
     end
   end
 end

data/spec/spec_helper.rb

@@ -10,37 +10,6 @@ require 'rspec/rails'
 require 'apipie-rails'
 require 'test_engine'
 
-module Rails4Compatibility
-  module Testing
-    def process(*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 = {})
-      if hash.is_a?(Hash)
-        if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
-          hash = hash.dup
-          hash.merge!(hash.delete(:params) || {})
-        elsif hash.key?(:params)
-          hash = { :params => hash }
-        end
-      end
-      if hash.empty?
-        yield method, action
-      else
-        yield method, action, hash
-      end
-    end
-  end
-end
-
-
 #
 # Matcher to validate the properties (name, type and options) of a single field in the
 # internal representation of a swagger schema
@@ -114,4 +83,3 @@ RSpec.configure do |config|
 end
 
 require 'action_controller/test_case.rb'
-ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -216,6 +216,7 @@ files:
 - gemfiles/Gemfile.rails52
 - gemfiles/Gemfile.rails60
 - gemfiles/Gemfile.rails61
+- gemfiles/Gemfile.rails70
 - images/screenshot-1.png
 - images/screenshot-2.png
 - lib/apipie-rails.rb
@@ -274,15 +275,15 @@ files:
 - 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/extending_concern.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/sample_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
@@ -337,7 +338,6 @@ 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: []
@@ -357,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool

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

@@ -1,15 +0,0 @@
-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
-