apipie-rails 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 555b019a70732e777c4f42b25dd62362be62674c55f31dba9106434969ff7f9f
-  data.tar.gz: e63cd96de5768bc21b4a86b755b883440a36ca8c8914ec5af4c89dfe525d94ab
+  metadata.gz: 589dc3b1a0a39f1b2fae7fa811e27969b3f8de5c6eb2e187ca1c61e3d77edd5a
+  data.tar.gz: b99b476c03dadcce53f6fe2c4e712a9e6a30960762de9fead0b755ef3d6ebee2
 SHA512:
-  metadata.gz: 0d6aca2dea2281738587924ee7e3388b1b36beb25d9bac7e46f05044080535f52fb77a3523d9262344410f3d76683c0d33a7d0188d99a51d957a9f9392ba7a3e
-  data.tar.gz: 7f74cc96e3694406b579649cbd44b8a9ab7d7c273b57d93a7530e1b67a2e32dca27efa408b27a10d87f342abc5badde819e7f02e363ff3d924d3988db33501f2
+  metadata.gz: 765673e5c7ca984ad30d1d1f815f583f92d3f9dfdd595228c74e73b9fac3fd0e60260f65e6f9e8eb6b19f24de1f8b814cb917f38bf312ec8a30c52b8e1eea901
+  data.tar.gz: 3afe26c57541633e04017eb022f4f526ed08c22b4d1a2ad7ca44364a49ce88f5e868e1651a468e5d0707325bf4abdc2fc15c1bbc8bebae0bc288b795ac6f0848

data/.rubocop_todo.yml

@@ -1242,6 +1242,7 @@ RSpec/VerifiedDoubles:
     - 'spec/lib/apipie/apipies_controller_spec.rb'
     - 'spec/lib/apipie/extractor/writer_spec.rb'
     - 'spec/lib/validators/array_validator_spec.rb'
+    - 'spec/lib/apipie/extractor/recorder_spec.rb'
 
 # Offense count: 1
 RSpec/VoidExpect:

data/CHANGELOG.md

@@ -1,6 +1,16 @@
  Changelog
 ===========
 
+## [v1.2.3](https://github.com/Apipie/apipie-rails/tree/v1.2.3) (2023-10-11)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.2...v1.2.3)
+* Fix param: Consider default_value: nil as valid config ([#894](https://github.com/Apipie/apipie-rails/pull/894)) (davidwessman)
+
+## [v1.2.2](https://github.com/Apipie/apipie-rails/tree/v1.2.2) (2023-07-18)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.1...v1.2.2)
+* Fixed Swagger warnings for properties ([#892](https://github.com/Apipie/apipie-rails/pull/892)) (shev-vadim-net)
+* Improved support for multipart/form-data example recording ([#891](https://github.com/Apipie/apipie-rails/pull/891)) (Butiri Cristian & hossenlopp)
+* rubocop (1.54.2) fixes required with latest version ([#893](https://github.com/Apipie/apipie-rails/pull/893)) (Mathieu Jobin)
+
 ## [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)

data/lib/apipie/application.rb

@@ -405,12 +405,10 @@ module Apipie
         version_prefix = version_prefix(klass)
         path = klass.controller_path
 
-        path =
-          if version_prefix == '/'
-            path
-          else
+        unless version_prefix == '/'
+          path =
             path.gsub(version_prefix, '')
-          end
+        end
 
         path.gsub('/', '-')
       elsif klass.respond_to?(:controller_name)

data/lib/apipie/extractor/collector.rb

@@ -24,10 +24,10 @@ module Apipie
       end
 
       def handle_record(record)
-        add_to_records(record)
         if ignore_call?(record)
           Extractor.logger.info("REST_API: skipping #{record_to_s(record)}")
         else
+          add_to_records(record)
           refine_description(record)
         end
       end
@@ -114,4 +114,3 @@ module Apipie
     end
   end
 end
-

data/lib/apipie/extractor/recorder.rb

@@ -44,7 +44,7 @@ module Apipie
         @path = request.path
         @params = request.request_parameters
         if [:POST, :PUT, :PATCH, :DELETE].include?(@verb)
-          @request_data = @params
+          @request_data = request.content_type == "multipart/form-data" ? reformat_multipart_data(@params) : @params
         else
           @query = request.query_string
         end
@@ -66,8 +66,14 @@ module Apipie
         lines = ["Content-Type: multipart/form-data; boundary=#{MULTIPART_BOUNDARY}",'']
         boundary = "--#{MULTIPART_BOUNDARY}"
         form.each do |key, attrs|
-          if attrs.is_a?(String)
+          if attrs.is_a?(String) # rubocop:disable Style/CaseLikeIf
             lines << boundary << content_disposition(key) << "Content-Length: #{attrs.size}" << '' << attrs
+          elsif attrs.is_a?(Rack::Test::UploadedFile) || attrs.is_a?(ActionDispatch::Http::UploadedFile)
+            reformat_uploaded_file(boundary, attrs, key, lines)
+          elsif attrs.is_a?(Array)
+            reformat_array(boundary, attrs, key, lines)
+          elsif attrs.is_a?(TrueClass) || attrs.is_a?(FalseClass)
+            reformat_boolean(boundary, attrs, key, lines)
           else
             reformat_hash(boundary, attrs, lines)
           end
@@ -88,6 +94,24 @@ module Apipie
         end
       end
 
+      def reformat_boolean(boundary, attrs, key, lines)
+        lines << boundary << content_disposition(key)
+        lines << '' << attrs.to_s
+      end
+
+      def reformat_array(boundary, attrs, key, lines)
+        attrs.each do |item|
+          lines << boundary << content_disposition("#{key}[]")
+          lines << '' << item
+        end
+      end
+
+      def reformat_uploaded_file(boundary, file, key, lines)
+        lines << boundary << %{#{content_disposition(key)}; filename="#{file.original_filename}"}
+        lines << "Content-Length: #{file.size}" << "Content-Type: #{file.content_type}" << "Content-Transfer-Encoding: binary"
+        lines << '' << %{... contents of "#{key}" ...}
+      end
+
       def content_disposition(name)
         %{Content-Disposition: form-data; name="#{name}"}
       end

data/lib/apipie/generator/swagger/param_description/builder.rb

@@ -71,7 +71,7 @@ class Apipie::Generator::Swagger::ParamDescription::Builder
   end
 
   def for_default
-    return {} if @param_description.options[:default_value].blank?
+    return {} unless @param_description.options.key?(:default_value)
 
     {
       default: @param_description.options[:default_value],
@@ -79,7 +79,7 @@ class Apipie::Generator::Swagger::ParamDescription::Builder
   end
 
   def required?
-    required_from_path? || (!@in_schema && @param_description.required)
+    required_from_path? || @param_description.required
   end
 
   def required_from_path?

data/lib/apipie/static_dispatcher.rb

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

data/lib/apipie/version.rb

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

data/spec/lib/apipie/apipies_controller_spec.rb

@@ -57,8 +57,7 @@ describe Apipie::ApipiesController, type: :controller do
     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([])
+      allow(Apipie.configuration).to receive_messages(default_locale: "en", languages: [])
 
       get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.en" }
 

data/spec/lib/apipie/extractor/recorder_spec.rb

@@ -4,6 +4,11 @@ require 'spec_helper'
 
 describe 'Apipie::Extractor::Recorder' do
   let(:recorder) { Apipie::Extractor::Recorder.new }
+  let(:controller) do
+    controller = ActionController::Metal.new
+    controller.set_request!(request)
+    controller
+  end
 
   describe '#analyse_controller' do
     subject do
@@ -19,12 +24,6 @@ describe 'Apipie::Extractor::Recorder' do
       request
     end
 
-    let(:controller) do
-      controller = ActionController::Metal.new
-      controller.set_request!(request)
-      controller
-    end
-
     it { is_expected.to eq(action) }
 
     context 'when a api_action_matcher is configured' do
@@ -37,4 +36,42 @@ describe 'Apipie::Extractor::Recorder' do
       it { is_expected.to eq(matcher_action) }
     end
   end
+
+  describe '#analyse_functional_test' do
+    context 'with multipart-form data' do
+      subject do
+        recorder.analyse_controller(controller)
+        recorder.analyze_functional_test(test_context)
+        recorder.record[:request_data]
+      end
+
+      let(:test_context) do
+        double(controller: controller, request: request, response: ActionDispatch::Response.new(200))
+      end
+
+      let(:file) do
+        instance_double(
+          ActionDispatch::Http::UploadedFile,
+          original_filename: 'file.txt',
+          content_type: 'text/plain',
+          size: '1MB'
+        )
+      end
+
+      let(:request) do
+        request = ActionDispatch::Request.new({})
+        request.request_method = 'POST'
+        request.headers['Content-Type'] = 'multipart/form-data'
+        request.request_parameters = { file: file }
+        request
+      end
+
+      before do
+        allow(file).to receive(:is_a?).and_return(false)
+        allow(file).to receive(:is_a?).with(ActionDispatch::Http::UploadedFile).and_return(true)
+      end
+
+      it { is_expected.to include("filename=\"#{file.original_filename}\"") }
+    end
+  end
 end

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

@@ -56,7 +56,7 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
         expect(properties).to eq(
           {
             a_number: {
-              type: 'number'
+              type: 'number', required: true
             },
             an_optional_number: {
               type: 'number'
@@ -72,7 +72,7 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
           expect(properties).to eq(
             {
               a_number: {
-                type: %w[number null]
+                type: %w[number null], required: true
               },
               an_optional_number: {
                 type: %w[number null]

data/spec/lib/apipie/generator/swagger/param_description/builder_spec.rb

@@ -78,6 +78,12 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
 
     it { is_expected.to be_blank }
 
+    context 'when is required' do
+      let(:base_param_description_options) { { required: true } }
+
+      it { is_expected.to eq(true) }
+    end
+
     context 'when in_schema is false' do
       let(:in_schema) { false }
 
@@ -96,14 +102,48 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
 
     subject { generated_block }
 
-    context 'when is not required' do
-      let(:base_param_description_options) { { required: false } }
+    context 'when required is true' do
+      let(:base_param_description_options) { { required: true } }
+
+      it 'does not output an option without default warning' do
+        expect { subject }.not_to output(
+          /is optional but default value is not specified/
+        ).to_stderr
+      end
+    end
+
+    context 'when required is false' do
+      context 'when default_value is nil' do
+        let(:base_param_description_options) do
+          { required: false, default_value: nil }
+        end
+
+        it 'will not warn' do
+          expect { subject }.not_to output(
+            /is optional but default value is not specified/
+          ).to_stderr
+        end
+      end
+
+      context 'when default_value is 123' do
+        let(:base_param_description_options) do
+          { required: false, default_value: 123 }
+        end
+
+        it 'will not warn' do
+          expect { subject }.not_to output(
+            /is optional but default value is not specified/
+          ).to_stderr
+        end
+      end
 
-      context 'and no default is given' do
-        before { param_description_options.delete(:default) }
+      context 'default_value not given' do
+        let(:base_param_description_options) { { required: false } }
 
-        it 'outputs an option without default warning' do
-          expect { subject }.to output(/is optional but default value is not specified/).to_stderr
+        it 'warns' do
+          expect { subject }.to output(
+            /is optional but default value is not specified/
+          ).to_stderr
         end
       end
     end

data/spec/lib/apipie/swagger_generator_spec.rb

@@ -61,7 +61,7 @@ describe Apipie::SwaggerGenerator do
           expect(properties).to eq(
             {
               a_number: {
-                type: 'number'
+                type: 'number', required: true
               },
               an_optional_number: {
                 type: 'number'

data/spec/lib/swagger/openapi_2_0_schema.json

@@ -996,7 +996,14 @@
           "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
         },
         "required": {
-          "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray"
+          "anyOf": [
+            {
+              "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray"
+            },
+            {
+              "type": "boolean"
+            }
+          ]
         },
         "enum": {
           "$ref": "http://json-schema.org/draft-04/schema#/properties/enum"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -472,7 +472,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.11
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool