apipie-rails 1.2.3 → 1.4.0

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

@@ -19,8 +19,8 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
 
   let(:response_description_dsl) do
     proc do
-      property :a_number, Integer
-      property :an_optional_number, Integer, required: false
+      property :a_number, Integer, example: 1
+      property :an_optional_number, Integer, required: false, example: 2
     end
   end
 
@@ -56,10 +56,10 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
         expect(properties).to eq(
           {
             a_number: {
-              type: 'number', required: true
+              type: 'number', required: true, example: 1
             },
             an_optional_number: {
-              type: 'number'
+              type: 'number', example: 2
             }
           }
         )
@@ -72,10 +72,10 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
           expect(properties).to eq(
             {
               a_number: {
-                type: %w[number null], required: true
+                type: %w[number null], required: true, example: 1
               },
               an_optional_number: {
-                type: %w[number null]
+                type: %w[number null], example: 2
               }
             }
           )

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

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::MethodDescription::ResponseService do
+  let(:http_method) { nil }
+  let(:language) { :en }
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:method_description) do
+    Apipie::Generator::Swagger::MethodDescription::Decorator.new(
+      Apipie::MethodDescription.new(
+        'create',
+        Apipie::ResourceDescription.new(ApplicationController, 'pets'),
+        dsl_data
+      )
+    )
+  end
+
+  let(:returns) { [] }
+
+  let(:service) do
+    described_class.new(
+      method_description,
+      http_method: http_method,
+      language: language
+    )
+  end
+
+  describe '#call' do
+    describe 'headers' do
+      subject(:headers) { service.call[status_code][:headers] }
+
+      let(:status_code) { 200 }
+
+      it { is_expected.to be_blank }
+
+      context 'when headers exists' do
+        let(:dsl_data) { super().merge({ returns: returns }) }
+        let(:returns) { { status_code => [{}, nil, returns_dsl, nil] } }
+
+        let(:returns_dsl) do
+          proc do
+            header 'link', String, 'Relative links'
+            header 'Current-Page', Integer, 'The current page'
+          end
+        end
+
+        it 'returns the correct format headers' do
+          expect(headers).to eq({
+                                  'link' => {
+                                    description: 'Relative links',
+                                    type: 'string'
+                                  },
+                                  'Current-Page' => {
+                                    description: 'The current page',
+                                    type: 'integer'
+                                  }
+                                })
+        end
+      end
+    end
+  end
+end

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

@@ -118,7 +118,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
           { required: false, default_value: nil }
         end
 
-        it 'will not warn' do
+        it 'does not warn' do
           expect { subject }.not_to output(
             /is optional but default value is not specified/
           ).to_stderr
@@ -130,7 +130,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
           { required: false, default_value: 123 }
         end
 
-        it 'will not warn' do
+        it 'does not warn' do
           expect { subject }.not_to output(
             /is optional but default value is not specified/
           ).to_stderr
@@ -200,4 +200,16 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
       it { is_expected.to be_present }
     end
   end
+
+  describe 'example' do
+    subject { generated_block[:example] }
+
+    it { is_expected.to be_blank }
+
+    context 'when example is assigned' do
+      let(:base_param_description_options) { { example: 'example' } }
+
+      it { is_expected.to eq('example') }
+    end
+  end
 end

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

@@ -115,10 +115,15 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
           it 'returns the reference' do
             expect(subject).to eq({ '$ref' => reference })
           end
-
         end
       end
 
+      context 'of a Swagger type' do
+        let(:validator_options) { { of: Integer } }
+
+        it { is_expected.to eq({ type: 'integer' }) }
+      end
+
       describe 'enum' do
         subject { items[:enum] }
 

data/spec/lib/apipie/param_description_spec.rb

@@ -21,7 +21,7 @@ describe Apipie::ParamDescription do
 
     it "should return the metadata" do
       meta = {
-        :lenght => 32,
+        :length => 32,
         :weight => '830g'
       }
       param = Apipie::ParamDescription.new(method_desc, :some_param, String, :meta => meta)

data/spec/lib/apipie/response_description/response_object_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Apipie::ResponseDescription::ResponseObject do
+  describe '#header' do
+    let(:response_object) { described_class.new(nil, nil, nil, nil) }
+    let(:name) { 'Current-Page' }
+    let(:description) { 'The current page in the pagination' }
+
+    before { response_object.header(name, String, description) }
+
+    it 'adds it to the headers' do
+      expect(response_object.headers).to(
+        contain_exactly({
+                          name: name,
+                          description: description,
+                          validator: 'string',
+                          options: {}
+                        })
+      )
+    end
+  end
+end

data/spec/lib/apipie/response_description_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Apipie::ResponseDescription do
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(PetsController, 'pets')
+  end
+
+  let(:method_description) do
+    Apipie::MethodDescription.new(
+      'create',
+      resource_description,
+      ActionController::Base.send(:_apipie_dsl_data_init)
+    )
+  end
+
+  let(:response_description_dsl) { proc {} }
+  let(:options) { {} }
+
+  let(:response_description) do
+    described_class.new(
+      method_description,
+      204,
+      options,
+      PetsController,
+      response_description_dsl,
+      nil
+    )
+  end
+
+  describe '#to_json' do
+    let(:to_json) { response_description.to_json }
+
+    describe 'headers' do
+      subject(:headers) { to_json[:headers] }
+
+      it { is_expected.to be_blank }
+
+      context 'when response has headers' do
+        let(:response_description_dsl) do
+          proc do
+            header 'Current-Page', Integer, 'The current page in the pagination', required: true
+          end
+        end
+
+        it 'returns the header' do
+          expect(headers).to contain_exactly({
+                                               name: 'Current-Page',
+                                               description: 'The current page in the pagination',
+                                               validator: 'integer',
+                                               options: { required: true }
+                                             })
+        end
+      end
+    end
+  end
+end

data/spec/lib/apipie/swagger_generator_spec.rb

@@ -7,7 +7,7 @@ describe Apipie::SwaggerGenerator do
 
     let(:response_description_dsl) do
       proc do
-        property :a_number, Integer
+        property :a_number, Integer, example: 1
         property :an_optional_number, Integer, required: false
       end
     end
@@ -61,7 +61,7 @@ describe Apipie::SwaggerGenerator do
           expect(properties).to eq(
             {
               a_number: {
-                type: 'number', required: true
+                type: 'number', required: true, example: 1
               },
               an_optional_number: {
                 type: 'number'

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -82,6 +82,10 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_response_params_def(http_method, path, response_code, param_name, field, value)
+      param = apidoc_swagger["paths"][path][http_method]["responses"][response_code.to_s]["schema"]["properties"][param_name]
+      expect(param[field]).to eq(value)
+    end
 
     describe 'apipie:static_swagger_json[development,json,_tmp]' do
       it "generates static swagger files for the default version of apipie docs" do
@@ -105,6 +109,7 @@ describe 'rake tasks' do
                          %w[finance operations sales marketing HR])
 
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
+        expect_response_params_def("get", "/pets/{id}/as_properties", 200, "pet_name", "example", "mypet")
       end
 
       it "generates a valid swagger file" do
@@ -146,7 +151,7 @@ describe 'rake tasks' do
 
     describe 'apipie:did_swagger_change[development,form_data,_tmp]' do
       it "keeps a reference file" do
-        expect(Pathname(ref_output).children.count).to eq(2)  # one file for each language
+        expect(Pathname(ref_output).children.count).to eq(2) # one file for each language
       end
     end
   end

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -283,7 +283,7 @@ describe "Swagger Responses" do
         expect(schema).to have_field(:pet_id, 'number', {:description => 'id of pet'})
         expect(schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
         expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
-        expect(schema).not_to have_field(:partial_match_allowed, 'boolean', {:required => false})
+        expect(schema).not_to have_field(:partial_match_allowed, 'boolean', {:required => false}) # rubocop:disable Capybara/NegationMatcher
       end
 
       it "creates a swagger definition with all input parameters" do

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'simplecov'
-SimpleCov.minimum_coverage 89
+SimpleCov.minimum_coverage 91
 SimpleCov.start
 
 ENV["RAILS_ENV"] ||= 'test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -215,7 +215,7 @@ files:
 - MIT-LICENSE
 - NOTICE
 - PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
-- README.rst
+- README.md
 - Rakefile
 - apipie-rails.gemspec
 - app/controllers/apipie/apipies_controller.rb
@@ -419,6 +419,7 @@ files:
 - spec/lib/apipie/generator/swagger/context_spec.rb
 - spec/lib/apipie/generator/swagger/method_description/api_schema_service_spec.rb
 - spec/lib/apipie/generator/swagger/method_description/response_schema_service_spec.rb
+- spec/lib/apipie/generator/swagger/method_description/response_service_spec.rb
 - spec/lib/apipie/generator/swagger/operation_id_spec.rb
 - spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
 - spec/lib/apipie/generator/swagger/param_description/composite_spec.rb
@@ -442,6 +443,8 @@ files:
 - spec/lib/apipie/param_description_spec.rb
 - spec/lib/apipie/param_group_spec.rb
 - spec/lib/apipie/resource_description_spec.rb
+- spec/lib/apipie/response_description/response_object_spec.rb
+- spec/lib/apipie/response_description_spec.rb
 - spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb
 - spec/lib/apipie/swagger_generator_spec.rb
 - spec/lib/apipie/validator_spec.rb
@@ -454,9 +457,12 @@ files:
 - spec/support/custom_bool_validator.rb
 - spec/support/rake.rb
 - spec/test_engine/memes_controller_spec.rb
-homepage: http://github.com/Apipie/apipie-rails
+homepage: https://github.com/Apipie/apipie-rails
 licenses: []
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/Apipie/apipie-rails/issues
+  changelog_uri: https://github.com/Apipie/apipie-rails/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/Apipie/apipie-rails
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -472,7 +478,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool