apipie-rails 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f474f2a3ff7eda3acca1a76fb6199da314c0ad3c9a1241662bad03d3e762c9
-  data.tar.gz: 677da6befb97f5eb0c6c761758c0e159cabe8de3d2bf15b2acdb2bc03f3d069f
+  metadata.gz: 555b019a70732e777c4f42b25dd62362be62674c55f31dba9106434969ff7f9f
+  data.tar.gz: e63cd96de5768bc21b4a86b755b883440a36ca8c8914ec5af4c89dfe525d94ab
 SHA512:
-  metadata.gz: 2fc436669c44ca181d6a1fce639762bba9ae7f508d9527c52bbcf1e9846135bc94de36f7148e8b29273cf6f6e389aa6104cf0da7410d18c33856afa0a7f264e2
-  data.tar.gz: afaedf8cdb2c0d0e326dcc82d896e9dd524cbc91b5c914e44c0b62272076f4830f8318e14985e59dfdceb81b7d4d5b7865dd27b82ffb687f100943cba0d6ac6b
+  metadata.gz: 0d6aca2dea2281738587924ee7e3388b1b36beb25d9bac7e46f05044080535f52fb77a3523d9262344410f3d76683c0d33a7d0188d99a51d957a9f9392ba7a3e
+  data.tar.gz: 7f74cc96e3694406b579649cbd44b8a9ab7d7c273b57d93a7530e1b67a2e32dca27efa408b27a10d87f342abc5badde819e7f02e363ff3d924d3988db33501f2

data/.rubocop.yml

@@ -46,7 +46,7 @@ Metrics/ClassLength:
     - spec/dummy/app/controllers/users_controller.rb
 
 Metrics/BlockLength:
-  Max: 25 # default
+  Max: 26 # default
   Exclude:
     - app/controllers/apipie/apipies_controller.rb
     - lib/apipie/generator/swagger/param_description/composite.rb

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 180`
-# on 2023-06-02 23:32:14 UTC using RuboCop version 1.52.0.
+# on 2023-06-09 05:29:05 UTC using RuboCop version 1.52.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -118,7 +118,7 @@ Layout/ElseAlignment:
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/resource_description.rb'
 
-# Offense count: 59
+# Offense count: 58
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLineAfterGuardClause:
   Exclude:
@@ -783,6 +783,12 @@ Lint/Void:
 Metrics/AbcSize:
   Max: 96
 
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 26
+
 # Offense count: 4
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
@@ -793,11 +799,16 @@ Metrics/BlockNesting:
 Metrics/CyclomaticComplexity:
   Max: 24
 
-# Offense count: 78
+# Offense count: 79
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 58
 
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 101
+
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
@@ -1048,7 +1059,7 @@ RSpec/EmptyLineAfterHook:
 RSpec/ExampleLength:
   Max: 85
 
-# Offense count: 158
+# Offense count: 159
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples.
 # DisallowedExamples: works
@@ -1137,7 +1148,7 @@ RSpec/MessageSpies:
 RSpec/MultipleExpectations:
   Max: 19
 
-# Offense count: 154
+# Offense count: 156
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15
@@ -1162,18 +1173,17 @@ RSpec/NamedSubject:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 93
+# Offense count: 94
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: AllowedPatterns.
 # AllowedPatterns: ^expect_, ^assert_
 RSpec/NoExpectationExample:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
-    - 'spec/test_engine/memes_controller_spec.rb'
 
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
@@ -1366,7 +1376,7 @@ Style/AndOr:
   Exclude:
     - 'lib/apipie/param_description.rb'
 
-# Offense count: 17
+# Offense count: 18
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
 # SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
@@ -1522,7 +1532,7 @@ Style/EmptyElse:
     - 'lib/apipie/extractor/recorder.rb'
     - 'lib/apipie/extractor/writer.rb'
 
-# Offense count: 26
+# Offense count: 27
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: compact, expanded
@@ -1765,7 +1775,6 @@ Style/Proc:
 Style/RaiseArgs:
   Exclude:
     - 'lib/apipie/application.rb'
-    - 'lib/apipie/dsl_definition.rb'
     - 'lib/apipie/extractor/writer.rb'
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/see_description.rb'
@@ -1917,7 +1926,7 @@ Style/StringConcatenation:
     - 'lib/apipie/application.rb'
     - 'lib/apipie/extractor/writer.rb'
 
-# Offense count: 1210
+# Offense count: 1212
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes

data/CHANGELOG.md

@@ -1,6 +1,14 @@
  Changelog
 ===========
 
+## [v1.2.1](https://github.com/Apipie/apipie-rails/tree/v1.2.1) (2023-06-09)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.0...v1.2.1)
+* rspec: Fixes deprecated matcher ([#882](https://github.com/Apipie/apipie-rails/pull/882)) (David Wessman)
+* Fix streaming bug ([#677](https://github.com/Apipie/apipie-rails/pull/677)) (Hunter Braun)
+* Update README URLs based on HTTP redirects ([#448](https://github.com/Apipie/apipie-rails/pull/448)) (ReadmeCritic)
+* Swagger: Adds option to skip default tags ([#881](https://github.com/Apipie/apipie-rails/pull/881)) (David Wessman)
+* Parameter validation: Raises error for all missing ([#886](https://github.com/Apipie/apipie-rails/pull/886)) (David Wessman)
+
 ## [v1.2.0](https://github.com/Apipie/apipie-rails/tree/v1.2.0) (2023-06-03)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.1.0...v1.2.0)
 * Allow resource_name to be inherited ([#872](https://github.com/Apipie/apipie-rails/pull/872)) (Eric Hankins)

data/README.rst

@@ -56,7 +56,7 @@ Run your application and see the result at
 use ``http://localhost:3000/apipie.json``.
 
 For a more comprehensive getting started guide, see
-`this demo <https://github.com/iNecas/apipie-demo>`_, which includes
+`this demo <https://github.com/Apipie/apipie-demo>`_, which includes
 features such as generating documentation from tests, recording examples etc.
 
 Screenshots
@@ -78,7 +78,7 @@ See `Contributors page  <https://github.com/Apipie/apipie-rails/graphs/contribut
 License
 -------
 
-Apipie-rails is released under the `MIT License <http://opensource.org/licenses/MIT>`_
+Apipie-rails is released under the `MIT License <https://opensource.org/licenses/MIT>`_
 
 ===============
  Documentation
@@ -1730,6 +1730,9 @@ There are several configuration parameters that determine the structure of the g
     See [https://swagger.io/docs/specification/2-0/authentication/] for details of what values can be specified
     By default, no security is defined.
 
+``config.generator.swagger.skip_default_tags``
+    By setting ``false`` (default): The resource name for e.g. ``/pets/{petId}`` will automatically be added as a tag ``pets``.
+    By setting ``true``: The tags needs to be explicitly added to the resource using the DSL.
 
 Known limitations of the current implementation
 -------------------------------------------------
@@ -1940,7 +1943,7 @@ Then, you can install dependencies and run the test suite:
  Disqus Integration
 ====================
 
-You can setup `Disqus <http://www.disqus.com>`_ discussion within
+You can setup `Disqus <https://disqus.com/>`_ discussion within
 your documentation. Just set the credentials in the Apipie
 configuration:
 

data/lib/apipie/dsl_definition.rb

@@ -241,9 +241,11 @@ module Apipie
               method_params = self.class._apipie_get_method_params(action_name)
 
               if Apipie.configuration.validate_presence?
-                method_params.each do |_, param|
-                  # check if required parameters are present
-                  raise ParamMissing.new(param) if param.required && !params.key?(param.name)
+                Validator::BaseValidator.raise_if_missing_params do |missing|
+                  method_params.each do |_, param|
+                    # check if required parameters are present
+                    missing << param if param.required && !params.key?(param.name)
+                  end
                 end
               end
 
@@ -285,7 +287,6 @@ module Apipie
               old_method.bind(self).call(*args)
             end
           end
-
         end
       end
 

data/lib/apipie/errors.rb

@@ -24,6 +24,20 @@ module Apipie
     end
   end
 
+  class ParamMultipleMissing < ParamError
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def to_s
+      params.map do |param|
+        ParamMissing.new(param).to_s
+      end.join("\n")
+    end
+  end
+
   class ParamMissing < DefinedParamError
     def to_s
       unless @param.options[:missing_message].nil?

data/lib/apipie/extractor.rb

@@ -15,10 +15,13 @@ class Apipie::Railtie
         end
       end
     end
-    app.middleware.use ::Apipie::Extractor::Recorder::Middleware
 
-    ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
-    ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+    if Apipie.configuration.record
+      app.middleware.use ::Apipie::Extractor::Recorder::Middleware
+
+      ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+      ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+    end
   end
 end
 

data/lib/apipie/generator/swagger/config.rb

@@ -10,7 +10,7 @@ module Apipie
                              :json_input_uses_refs, :suppress_warnings, :api_host,
                              :generate_x_computed_id_field, :allow_additional_properties_in_response,
                              :responses_use_refs, :schemes, :security_definitions,
-                             :global_security].freeze
+                             :global_security, :skip_default_tags].freeze
 
         attr_accessor(*CONFIG_ATTRIBUTES)
 
@@ -43,6 +43,7 @@ module Apipie
         alias include_warning_tags? include_warning_tags
         alias json_input_uses_refs? json_input_uses_refs
         alias responses_use_refs? responses_use_refs
+        alias skip_default_tags? skip_default_tags
         alias generate_x_computed_id_field? generate_x_computed_id_field
         alias swagger_include_warning_tags? swagger_include_warning_tags
         alias swagger_json_input_uses_refs? swagger_json_input_uses_refs
@@ -61,6 +62,7 @@ module Apipie
           @schemes = [:https]
           @security_definitions = {}
           @global_security = []
+          @skip_default_tags = false
         end
 
         def self.deprecated_methods

data/lib/apipie/generator/swagger/method_description/api_schema_service.rb

@@ -47,9 +47,12 @@ class Apipie::Generator::Swagger::MethodDescription::ApiSchemaService
   end
 
   def tags
-    [@method_description.resource._id] +
-      warning_tags +
-      @method_description.tag_list.tags
+    tags = if Apipie.configuration.generator.swagger.skip_default_tags?
+             []
+           else
+             [@method_description.resource._id]
+           end
+    tags + warning_tags + @method_description.tag_list.tags
   end
 
   def warning_tags

data/lib/apipie/validator.rb

@@ -38,6 +38,16 @@ module Apipie
         return nil
       end
 
+      def self.raise_if_missing_params
+        missing_params = []
+        yield missing_params
+        if missing_params.size > 1
+          raise ParamMultipleMissing.new(missing_params)
+        elsif missing_params.size == 1
+          raise ParamMissing.new(missing_params.first)
+        end
+      end
+
       # check if value is valid
       def valid?(value)
         if self.validate(value)
@@ -345,14 +355,18 @@ module Apipie
 
       def validate(value)
         return false if !value.is_a? Hash
-        @hash_params&.each do |k, p|
-          if Apipie.configuration.validate_presence?
-            raise ParamMissing.new(p) if p.required && !value.key?(k)
-          end
-          if Apipie.configuration.validate_value?
-            p.validate(value[k]) if value.key?(k)
+
+        BaseValidator.raise_if_missing_params do |missing|
+          @hash_params&.each do |k, p|
+            if Apipie.configuration.validate_presence?
+              missing << p if p.required && !value.key?(k)
+            end
+            if Apipie.configuration.validate_value?
+              p.validate(value[k]) if value.key?(k)
+            end
           end
         end
+
         return true
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/spec/controllers/users_controller_spec.rb

@@ -37,6 +37,7 @@ describe UsersController do
       expect(methods.keys).to include(:update)
       expect(methods.keys).to include(:two_urls)
       expect(methods.keys).to include(:action_with_headers)
+      expect(methods.keys).to include(:multiple_required_params)
     end
 
     it "should contain info about resource" do
@@ -101,6 +102,10 @@ describe UsersController do
             expect { get :show, :params => { :id => 5 }}.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
+          it "should fail if multiple required parameters are missing" do
+            expect { get :multiple_required_params }.to raise_error(Apipie::ParamMultipleMissing, /required_param1.*\n.*required_param2|required_param2.*\n.*required_parameter1/)
+          end
+
           it "should pass if required parameter has wrong type" do
             expect { get :show, :params => { :id => 5 , :session => "secret_hash" }}.not_to raise_error
             expect { get :show, :params => { :id => "ten" , :session => "secret_hash" }}.not_to raise_error
@@ -246,6 +251,11 @@ describe UsersController do
               post :create, :params => { :user => { :name => "root", :pass => "12345", :membership => "____" } }
             }.to raise_error(Apipie::ParamInvalid, /membership/)
 
+            # Should include both pass and name
+            expect {
+              post :create, :params => { :user => { :membership => "standard" } }
+            }.to raise_error(Apipie::ParamMultipleMissing, /pass.*\n.*name|name.*\n.*pass/)
+
             expect {
               post :create, :params => { :user => { :name => "root" } }
             }.to raise_error(Apipie::ParamMissing, /pass/)

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

@@ -301,4 +301,10 @@ class UsersController < ApplicationController
   header :HeaderNameWithDefaultValue, 'Header with default value', required: true, default: 'default value'
   def action_with_headers
   end
+
+  api :GET, '/users/multiple_required_params'
+  param :required_param1, String, required: true
+  param :required_param2, String, required: true
+  def multiple_required_params
+  end
 end

data/spec/dummy/config/routes.rb

@@ -8,6 +8,7 @@ Dummy::Application.routes.draw do
       resources :users do
         collection do
           post :create_route
+          get :multiple_required_params
         end
       end
       resources :concerns, :only => [:index, :show]

data/spec/lib/apipie/generator/swagger/method_description/api_schema_service_spec.rb

@@ -64,6 +64,19 @@ describe Apipie::Generator::Swagger::MethodDescription::ApiSchemaService do
       it { is_expected.to include(*tags) }
     end
 
+    context 'when Apipie.configuration.generator.swagger.skip_default_tags is enabled' do
+      before { Apipie.configuration.generator.swagger.skip_default_tags = true }
+      after { Apipie.configuration.generator.swagger.skip_default_tags = false }
+
+      it { is_expected.to be_empty }
+
+      context 'when tags are available' do
+        let(:tags) { ['Tag 1', 'Tag 2'] }
+
+        it { is_expected.to eq(tags) }
+      end
+    end
+
     context 'when Apipie.configuration.generator.swagger.include_warning_tags is enabled' do
       before { Apipie.configuration.generator.swagger.include_warning_tags = true }
 

data/spec/test_engine/memes_controller_spec.rb

@@ -4,7 +4,7 @@ describe TestEngine::MemesController do
 
   describe "#index" do
     it "should have the full mounted path of engine" do
-      Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path].should eq("/test/memes")
+      expect(Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path]).to eq("/test/memes")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack