apipie-rails 0.9.3 → 1.0.0

data/spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Apipie::ResponseDoesNotMatchSwaggerSchema do
+  let(:error) do
+    described_class.new(
+      controller_name,
+      method_name,
+      response_code,
+      error_messages,
+      schema,
+      returned_object
+    )
+  end
+
+  let(:controller_name) { 'UserController' }
+  let(:method_name) { 'index' }
+  let(:response_code) { 200 }
+  let(:error_messages) { [] }
+  let(:schema) { {} }
+  let(:returned_object) { {} }
+
+  describe '#to_s' do
+    subject { error.to_s }
+
+    let(:error_message) do
+      <<~HEREDOC.chomp
+        Response does not match swagger schema (#{controller_name}##{method_name} #{response_code}): #{error_messages}
+        Schema: #{JSON(schema)}
+        Returned object: #{returned_object}
+      HEREDOC
+    end
+
+    it { is_expected.to eq(error_message) }
+  end
+end

data/spec/lib/apipie/swagger_generator_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'dummy/app/controllers/pets_using_self_describing_classes_controller'
+
+describe Apipie::SwaggerGenerator do
+  describe '.json_schema_for_method_response' do
+    subject { json_schema_for_method_response }
+
+    let(:response_description_dsl) do
+      proc do
+        property :a_number, Integer
+        property :an_optional_number, Integer, required: false
+      end
+    end
+
+    let(:response_description_options) do
+      [{}, PetsController, response_description_dsl, nil]
+    end
+
+    let(:dsl_data) do
+      ActionController::Base
+        .send(:_apipie_dsl_data_init)
+        .merge(
+          {
+            returns: [[200, response_description_options]],
+            api_args: [
+              ['get', '/path', 'Some api description', { deprecated: true }]
+            ]
+          }
+        )
+    end
+
+    let(:method_description) do
+      Apipie::MethodDescription.new(
+        :show,
+        Apipie::ResourceDescription.new(UsersController, 'users'),
+        dsl_data
+      )
+    end
+
+    let(:json_schema_for_method_response) do
+      described_class.json_schema_for_method_response(
+        method_description,
+        return_code,
+        false
+      )
+    end
+
+    context 'when there is no return code for responses' do
+      let(:return_code) { 3000 }
+
+      it { is_expected.to be_nil }
+    end
+
+    context 'when return code exists' do
+      let(:return_code) { 200 }
+
+      describe 'properties' do
+        subject(:properties) { json_schema_for_method_response[:properties] }
+
+        it 'returns correct properties' do
+          expect(properties).to eq(
+            {
+              a_number: {
+                type: 'number'
+              },
+              an_optional_number: {
+                type: 'number'
+              }
+            }
+          )
+        end
+      end
+    end
+  end
+
+  describe '.json_schema_for_self_describing_class' do
+    subject(:schema) do
+      described_class.json_schema_for_self_describing_class(
+        self_describing_class,
+        allow_null
+      )
+    end
+
+    let(:self_describing_class) { PetWithMeasurements }
+    let(:allow_null) { false }
+
+    before { Apipie.configuration.generator.swagger.responses_use_refs = false }
+
+    it 'returns the self describing class schema' do
+      expect(schema.keys).to include(:type, :properties, :required)
+      expect(schema[:properties].keys).to include(:pet_name, :animal_type, :pet_measurements)
+    end
+  end
+end

data/spec/lib/apipie/validator_spec.rb

@@ -51,19 +51,55 @@ describe Apipie::Validator do
   end
 
   describe 'BooleanValidator' do
-    it "should validate by object class" do
-      validator = Apipie::Validator::BooleanValidator.new(params_desc)
-      expect(validator.validate("1")).to be_truthy
-      expect(validator.validate(1)).to be_truthy
-      expect(validator.validate(true)).to be_truthy
-      expect(validator.validate(0)).to be_truthy
-      expect(validator.validate(false)).to be_truthy
-      expect(validator.validate({ 1 => 1 })).to be_falsey
+    let(:validator) do
+      Apipie::Validator::BooleanValidator
     end
 
-    it "should have a valid description" do
-      validator = Apipie::Validator::BooleanValidator.new(params_desc)
-      expect(validator.description).to eq('Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.')
+    let(:validator_instance) { validator.new(params_desc) }
+
+    describe '.build' do
+      subject { validator.build(params_desc, argument, nil, nil) }
+
+      context 'when argument is [true, false]' do
+        let(:argument) { [true, false] }
+
+        it { is_expected.to be_an_instance_of(Apipie::Validator::BooleanValidator) }
+      end
+
+      context 'when argument is :bool' do
+        let(:argument) { :bool }
+
+        it { is_expected.to be_an_instance_of(Apipie::Validator::BooleanValidator) }
+      end
+
+      context 'when argument :boolean' do
+        let(:argument) { :boolean }
+
+        it { is_expected.to be_an_instance_of(Apipie::Validator::BooleanValidator) }
+      end
+
+      context 'when argument :booooooooolean' do
+        let(:argument) { :booooooooolean }
+
+        it { is_expected.to be_nil }
+      end
+    end
+
+    describe '#validate' do
+      it "should validate by object class" do
+        expect(validator_instance.validate("1")).to be_truthy
+        expect(validator_instance.validate(1)).to be_truthy
+        expect(validator_instance.validate(true)).to be_truthy
+        expect(validator_instance.validate(0)).to be_truthy
+        expect(validator_instance.validate(false)).to be_truthy
+        expect(validator_instance.validate({ 1 => 1 })).to be_falsey
+      end
+    end
+
+    describe '#description' do
+      subject { validator_instance.description }
+
+      it { is_expected.to eq('Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.') }
     end
   end
 

data/spec/lib/rake_spec.rb

@@ -18,7 +18,7 @@ describe 'rake tasks' do
     end
 
     let(:doc_output) do
-      File.join(::Rails.root, doc_path, 'apidoc')
+      File.join(Rails.root, doc_path, 'apidoc')
     end
 
     after do

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -12,7 +12,7 @@ describe 'rake tasks' do
 
   before do
     Apipie.configuration.doc_path = doc_path
-    Apipie.configuration.swagger_suppress_warnings = true
+    Apipie.configuration.generator.swagger.suppress_warnings = true
     allow(Apipie).to receive(:reload_documentation)
     subject.invoke(*task_args)
   end
@@ -37,11 +37,11 @@ describe 'rake tasks' do
     end
 
     let(:doc_output) do
-      File.join(::Rails.root, doc_path, 'apidoc')
+      File.join(Rails.root, doc_path, 'apidoc')
     end
 
     let(:ref_output) do
-      File.join(::Rails.root, doc_path, 'apidoc_ref')
+      File.join(Rails.root, doc_path, 'apidoc_ref')
     end
 
 
@@ -102,7 +102,7 @@ describe 'rake tasks' do
 
         expect_param_def("get", "/users/by_department", "department", "in", "query")
         expect_param_def("get", "/users/by_department", "department", "enum",
-                         ["finance", "operations", "sales", "marketing", "HR"])
+                         %w[finance operations sales marketing HR])
 
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
       end
@@ -128,11 +128,11 @@ describe 'rake tasks' do
         expect_param_def("put", "/users/{id}", "oauth", "in", "formData")
         expect_param_def("get", "/users/by_department", "department", "in", "query")
         expect_param_def("get", "/users/by_department", "department", "enum",
-                         ["finance", "operations", "sales", "marketing", "HR"])
+                         %w[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"])
+                         %w[finance operations sales marketing HR])
 
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
 

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -6,7 +6,7 @@ describe "Swagger Responses" do
   let(:desc) { Apipie.get_resource_description(controller_class, Apipie.configuration.default_version) }
 
   let(:swagger) {
-    Apipie.configuration.swagger_suppress_warnings = true
+    Apipie.configuration.generator.swagger.suppress_warnings = true
     Apipie.to_swagger_json(Apipie.configuration.default_version, controller_class.to_s.underscore.sub("_controller", ""))
   }
 
@@ -24,17 +24,17 @@ describe "Swagger Responses" do
     schema
   end
 
-  def swagger_response_for(path, code=200, method='get')
+  def swagger_response_for(path, code = 200, method = 'get')
     response = swagger[:paths][path][method][:responses][code]
     response[:schema] = resolve_refs(response[:schema])
     response
   end
 
-  def swagger_params_for(path, method='get')
+  def swagger_params_for(path, method = 'get')
     swagger[:paths][path][method][:parameters]
   end
 
-  def swagger_param_by_name(param_name, path, method='get')
+  def swagger_param_by_name(param_name, path, method = 'get')
     params = swagger_params_for(path, method)
     matching = params.select{|p| p[:name] == param_name }
     raise "multiple params named [#{param_name}] in swagger definition for [#{method} #{path}]" if matching.length > 1
@@ -72,7 +72,7 @@ describe "Swagger Responses" do
       deep_match?(actual, expected)
     end
 
-    def deep_match?(actual, expected, breadcrumb=[])
+    def deep_match?(actual, expected, breadcrumb = [])
       pending_params = actual.params_ordered.dup
       expected.each do |expected_param|
         expected_param_name = expected_param.is_a?(Hash) ? expected_param.keys.first : expected_param
@@ -141,7 +141,7 @@ describe "Swagger Responses" do
 
         a_schema = resolve_refs(schema[:items])
         expect(a_schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
 
 
@@ -210,7 +210,7 @@ describe "Swagger Responses" do
 
         schema = response[:schema]
         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 => ['dog','cat','iguana','kangaroo']})
+        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
 
       it 'should have the 404 response description overridden' do
@@ -247,7 +247,7 @@ describe "Swagger Responses" do
 
         schema = response[:schema]
         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 => ['dog','cat','iguana','kangaroo']})
+        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
     end
 
@@ -282,7 +282,7 @@ describe "Swagger Responses" do
         schema = response[:schema]
         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 => ['dog','cat','iguana','kangaroo']})
+        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})
       end
 
@@ -338,6 +338,7 @@ describe "Swagger Responses" do
 
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type])
       end
+
       it 'should have the 201 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 201)
         expect(response[:description]).to eq("Found a pet")
@@ -359,6 +360,7 @@ describe "Swagger Responses" do
                                                       {:pet_measurements => [:weight, :height, :num_legs]}
                                                      ])
       end
+
       it 'should have the 202 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 202)
         expect(response[:description]).to eq('Accepted')
@@ -388,6 +390,7 @@ describe "Swagger Responses" do
                                                       {:additional_histories => [:did_visit_vet, :avg_meals_per_day]}
                                                      ])
       end
+
       it 'should have the 203 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 203)
         expect(response[:description]).to eq('Non-Authoritative Information')
@@ -424,12 +427,13 @@ describe "Swagger Responses" do
 
         expect(returns_obj).to match_field_structure([:int_array, :enum_array])
       end
+
       it 'should have the 204 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 204)
 
         schema = response[:schema]
         expect(schema).to have_field(:int_array, 'array', {items: {type: 'number'}})
-        expect(schema).to have_field(:enum_array, 'array', {items: {type: 'string', enum: ['v1','v2','v3']}})
+        expect(schema).to have_field(:enum_array, 'array', {items: {type: 'string', enum: %w[v1 v2 v3]}})
       end
 
 
@@ -444,6 +448,7 @@ describe "Swagger Responses" do
                                                       :num_fleas
                                                      ])
       end
+
       it 'should have the 422 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 422)
         expect(response[:description]).to eq('Fleas were discovered on the pet')
@@ -546,7 +551,7 @@ describe "Swagger Responses" do
 
         a_schema = schema[:items]
         expect(a_schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
     end
 
@@ -568,6 +573,7 @@ describe "Swagger Responses" do
                                                       {:pet_measurements => [:weight, :height, :num_legs]}
                                                      ])
       end
+
       it 'should have the 200 response described in the swagger' do
         response = swagger_response_for('/pets_with_measurements_described_as_class/{id}', 200)
         expect(response[:description]).to eq('measurements of the pet')

data/spec/lib/validators/array_validator_spec.rb

@@ -30,7 +30,7 @@ module Apipie::Validator
         let(:type) { String }
 
         it "accepts array of specified type" do
-          expect(validator.validate(['string1', 'string2'])).to eq(true)
+          expect(validator.validate(%w[string1 string2])).to eq(true)
         end
 
         it "accepts empty array" do

data/spec/spec_helper.rb

@@ -24,7 +24,7 @@ require 'test_engine'
 #
 # will verify that the selected response schema includes a required string field called 'pet_name'
 #
-RSpec::Matchers.define :have_field do |name, type, opts={}|
+RSpec::Matchers.define :have_field do |name, type, opts = {}|
   def fail(msg)
     @fail_message = msg
     false
@@ -62,7 +62,7 @@ RSpec.configure do |config|
   config.mock_with :rspec
 
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.fixture_path = "#{Rails.root}/spec/fixtures"
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -278,8 +278,18 @@ files:
 - lib/apipie/extractor/collector.rb
 - lib/apipie/extractor/recorder.rb
 - lib/apipie/extractor/writer.rb
+- lib/apipie/generator/config.rb
 - lib/apipie/generator/generator.rb
+- lib/apipie/generator/swagger/computed_interface_id.rb
+- lib/apipie/generator/swagger/config.rb
 - lib/apipie/generator/swagger/context.rb
+- lib/apipie/generator/swagger/method_description.rb
+- lib/apipie/generator/swagger/method_description/api_decorator.rb
+- lib/apipie/generator/swagger/method_description/api_schema_service.rb
+- lib/apipie/generator/swagger/method_description/decorator.rb
+- lib/apipie/generator/swagger/method_description/parameters_service.rb
+- lib/apipie/generator/swagger/method_description/response_schema_service.rb
+- lib/apipie/generator/swagger/method_description/response_service.rb
 - lib/apipie/generator/swagger/operation_id.rb
 - lib/apipie/generator/swagger/param_description.rb
 - lib/apipie/generator/swagger/param_description/builder.rb
@@ -287,7 +297,14 @@ files:
 - lib/apipie/generator/swagger/param_description/description.rb
 - lib/apipie/generator/swagger/param_description/in.rb
 - lib/apipie/generator/swagger/param_description/name.rb
+- lib/apipie/generator/swagger/param_description/path_params_composite.rb
+- lib/apipie/generator/swagger/param_description/referenced_composite.rb
 - lib/apipie/generator/swagger/param_description/type.rb
+- lib/apipie/generator/swagger/path_decorator.rb
+- lib/apipie/generator/swagger/referenced_definitions.rb
+- lib/apipie/generator/swagger/resource_description_collection.rb
+- lib/apipie/generator/swagger/resource_description_composite.rb
+- lib/apipie/generator/swagger/schema.rb
 - lib/apipie/generator/swagger/swagger.rb
 - lib/apipie/generator/swagger/type.rb
 - lib/apipie/generator/swagger/type_extractor.rb
@@ -396,7 +413,10 @@ files:
 - spec/lib/apipie/extractor/writer_spec.rb
 - spec/lib/apipie/extractor_spec.rb
 - spec/lib/apipie/file_handler_spec.rb
+- spec/lib/apipie/generator/swagger/config_spec.rb
 - 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/operation_id_spec.rb
 - spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
 - spec/lib/apipie/generator/swagger/param_description/composite_spec.rb
@@ -405,15 +425,23 @@ files:
 - spec/lib/apipie/generator/swagger/param_description/name_spec.rb
 - spec/lib/apipie/generator/swagger/param_description/type_spec.rb
 - spec/lib/apipie/generator/swagger/param_description_spec.rb
+- spec/lib/apipie/generator/swagger/path_decorator_spec.rb
+- spec/lib/apipie/generator/swagger/referenced_definitions_spec.rb
+- spec/lib/apipie/generator/swagger/resource_description_composite_spec.rb
+- spec/lib/apipie/generator/swagger/resource_descriptions_collection_spec.rb
+- spec/lib/apipie/generator/swagger/schema_spec.rb
 - spec/lib/apipie/generator/swagger/type_extractor_spec.rb
 - spec/lib/apipie/generator/swagger/warning_spec.rb
 - spec/lib/apipie/generator/swagger/warning_writer_spec.rb
 - spec/lib/apipie/method_description/apis_service_spec.rb
 - spec/lib/apipie/method_description_spec.rb
+- spec/lib/apipie/no_documented_method_spec.rb
 - spec/lib/apipie/param_description/deprecation_spec.rb
 - 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_does_not_match_swagger_schema_spec.rb
+- spec/lib/apipie/swagger_generator_spec.rb
 - spec/lib/apipie/validator_spec.rb
 - spec/lib/rake_spec.rb
 - spec/lib/swagger/openapi_2_0_schema.json
@@ -442,7 +470,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool