apipie-rails 0.5.19 → 1.3.0

data/spec/lib/{param_description_spec.rb → apipie/param_description_spec.rb}

@@ -113,6 +113,216 @@ describe Apipie::ParamDescription do
 
   end
 
+  describe 'validate' do
+    subject { param_description.validate(validation_value) }
+
+    let(:allow_blank) { nil }
+
+    let(:param_description) do
+      Apipie::ParamDescription.new(
+        method_desc,
+        :param,
+        validation_type,
+        allow_blank: allow_blank
+      )
+    end
+
+    context 'when allow_blank is ignored, as it was before 0.7.0' do
+      before { Apipie.configuration.ignore_allow_blank_false = true }
+      after { Apipie.configuration.ignore_allow_blank_false = false }
+
+      context 'when validation type is :boolean' do
+        let(:validation_type) { :boolean }
+
+        context 'when validation value is false' do
+          let(:validation_value) { false }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+        end
+
+        context 'when validation value is an empty string' do
+          let(:validation_value) { '' }
+
+          it 'should raise an error' do
+            expect { subject }.to raise_error(Apipie::ParamInvalid)
+          end
+        end
+      end
+
+      context 'when validation type is a boolean array' do
+        let(:validation_type) { [true, false] }
+
+        context 'when validation value is false' do
+          let(:validation_value) { false }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+        end
+
+        context 'when validation value is true' do
+          let(:validation_value) { true }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+        end
+
+        context 'when validation value is an empty string' do
+          let(:validation_value) { '' }
+
+          it 'should raise an error' do
+            expect { subject }.to raise_error(Apipie::ParamInvalid)
+          end
+        end
+      end
+
+      context 'when validation type is String' do
+        let(:validation_type) { String }
+
+        context 'when validation value is empty string' do
+          let(:validation_value) { '' }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+
+          context 'when allow_blank is specified as true' do
+            let(:allow_blank) { true }
+
+            it 'should not raise an error' do
+              expect { subject }.not_to raise_error
+            end
+          end
+        end
+      end
+    end
+
+    context 'when the validation type is :boolean' do
+      let(:validation_type) { :boolean }
+
+      context 'when validation value' do
+        let(:validation_value) { false }
+
+        it 'should not raise an error' do
+          expect { subject }.not_to raise_error
+        end
+
+        context 'when allow_blank is false' do
+          let(:allow_blank) { false }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+        end
+
+        context 'when allow_blank is true' do
+          let(:allow_blank) { true }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+        end
+      end
+
+      context 'when validation value is empty string' do
+        let(:validation_value) { '' }
+
+        it 'should raise an error' do
+          expect { subject }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+    end
+
+    context 'when validation type is a boolean array' do
+      let(:validation_type) { [true, false] }
+
+      context 'when validation value is false' do
+        let(:validation_value) { false }
+
+        it 'should not raise an error' do
+          expect { subject }.not_to raise_error
+        end
+      end
+
+      context 'when validation value is true' do
+        let(:validation_value) { true }
+
+        it 'should not raise an error' do
+          expect { subject }.not_to raise_error
+        end
+      end
+
+      context 'when validation value is an empty string' do
+        let(:validation_value) { '' }
+
+        it 'should raise an error' do
+          expect { subject }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+    end
+
+    context 'when the validation type is a custom one' do
+      let(:validation_type) { :custom_bool }
+
+      context 'when ignore_allow_blank? returning true' do
+        before do
+          allow(CustomBoolValidator).to receive(:ignore_allow_blank?).and_return(true)
+        end
+
+        context 'when a blank but valid value is passed' do
+          let(:validation_value) { false }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+
+          context 'when allow_blank is false' do
+            let(:allow_blank) { false }
+
+            it 'should not raise an error' do
+              expect { subject }.not_to raise_error
+            end
+          end
+        end
+
+        context 'when a blank but invalid value is passed' do
+          let(:validation_value) { '' }
+
+          it 'should raise an error' do
+            expect { subject }.to raise_error(Apipie::ParamInvalid)
+          end
+        end
+      end
+    end
+
+    context 'when validation type is String' do
+      let(:validation_type) { String }
+
+      context 'when a blank but invalid value is passed' do
+        let(:validation_value) { '' }
+
+        it 'should raise an error' do
+          expect { subject }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+
+      context 'when allow_blank is specified as true' do
+        let(:allow_blank) { true }
+
+        context 'when and empty string is given' do
+          let(:validation_value) { '' }
+
+          it 'should not raise an error' do
+            expect { subject }.not_to raise_error
+          end
+        end
+      end
+    end
+  end
+
   describe "concern substitution" do
 
     let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }
@@ -151,7 +361,6 @@ describe Apipie::ParamDescription do
     end
   end
 
-
   describe "required_by_default config option" do
     context "parameters required by default" do
 
@@ -281,14 +490,13 @@ describe Apipie::ParamDescription do
     end
   end
 
-
   describe 'sub params' do
 
     context 'with HashValidator' do
 
       subject do
         Apipie::ParamDescription.new(method_desc, :param, Hash) do
-          param :answer, Fixnum
+          param :answer, Integer
         end
       end
 
@@ -306,7 +514,7 @@ describe Apipie::ParamDescription do
 
       subject do
         Apipie::ParamDescription.new(method_desc, :param, Array) do
-          param :answer, Fixnum
+          param :answer, Integer
         end
       end
 
@@ -336,10 +544,128 @@ describe Apipie::ParamDescription do
 
   describe "Array with classes" do
     it "should be valid for objects included in class array" do
-      param = Apipie::ParamDescription.new(method_desc, :param, [Fixnum, String])
+      param = Apipie::ParamDescription.new(method_desc, :param, [Integer, String])
       expect { param.validate("1") }.not_to raise_error
-      expect { param.validate(Fixnum) }.to raise_error(Apipie::ParamInvalid)
+      expect { param.validate(Integer) }.to raise_error(Apipie::ParamInvalid)
     end
   end
 
+  describe '#deprecated?' do
+    subject do
+      Apipie::ParamDescription.new(method_desc, :param, Integer, options)
+    end
+
+    let(:options) { {} }
+
+    it { is_expected.not_to be_deprecated }
+
+    context 'when deprecated option is passed' do
+      context 'and is true' do
+        let(:options) { { deprecated: true } }
+
+        it { is_expected.to be_deprecated }
+      end
+
+      context 'and is false' do
+        let(:options) { { deprecated: false } }
+
+        it { is_expected.not_to be_deprecated }
+      end
+
+      context 'and is a string' do
+        let(:options) { { deprecated: 'Some description' } }
+
+        it { is_expected.to be_deprecated }
+      end
+
+      context 'and deprecation options are given' do
+        let(:options) do
+          { deprecated: { in: '2.3', info: 'Something', sunset: '3.0' } }
+        end
+
+        it { is_expected.to be_deprecated }
+      end
+    end
+  end
+
+  describe '#deprecation' do
+    subject { param_description.deprecation }
+
+    let(:options) { {} }
+
+    let(:param_description) do
+      Apipie::ParamDescription.new(method_desc, :param, Integer, options)
+    end
+
+    it { is_expected.to be_blank }
+
+    context 'when deprecated option is passed' do
+      context 'and is true' do
+        let(:options) { { deprecated: true } }
+
+        it { is_expected.to be_blank }
+      end
+
+      context 'and is false' do
+        let(:options) { { deprecated: false } }
+
+        it { is_expected.to be_blank }
+      end
+
+      context 'and is a string' do
+        let(:options) { { deprecated: 'Some description' } }
+
+        it { is_expected.to be_an_instance_of(Apipie::ParamDescription::Deprecation) }
+      end
+
+      context 'and deprecation options are given' do
+        let(:options) do
+          { deprecated: { in: '2.3', info: 'Something', sunset: '3.0' } }
+        end
+
+        it { is_expected.to be_an_instance_of(Apipie::ParamDescription::Deprecation) }
+      end
+    end
+  end
+
+  describe '#required' do
+    subject { param_description.required }
+
+    let(:param_description) do
+      Apipie::ParamDescription.new(method_desc, :param, validator, options)
+    end
+
+    context 'when is passed in options' do
+      let(:validator) { String }
+
+      context 'when is false' do
+        let(:options) { { required: false } }
+
+        it { is_expected.to eq(false) }
+      end
+
+      context 'when is true' do
+        let(:options) { { required: true } }
+
+        it { is_expected.to eq(true) }
+      end
+    end
+
+    context 'when validator options are passed' do
+      let(:options) { { only_in: :response } }
+      let(:validator) { { array_of: String, required: required } }
+
+      context 'when required is false' do
+        let(:required) { false }
+
+        it { is_expected.to eq(false) }
+      end
+
+      context 'when required is true' do
+        let(:required) { true }
+
+        it { is_expected.to eq(true) }
+      end
+    end
+  end
 end

data/spec/lib/{param_group_spec.rb → apipie/param_group_spec.rb}

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 describe "param groups" do
+  before { Apipie.reload_documentation }
 
   it "lets reuse the params description in more actions" do
     user_create_desc = Apipie["users#create"].params[:user]
@@ -43,17 +44,17 @@ describe "param groups" do
   end
 
   it "should replace parameter name in a group when it comes from concern" do
-    expect(Apipie["overridden_concern_resources#update"].params.has_key?(:user)).to eq(true)
+    expect(Apipie["overridden_concern_resources#update"].params.key?(:user)).to eq(true)
   end
 
   it "shouldn't replace parameter name in a group redefined in the controller" do
-    expect(Apipie["overridden_concern_resources#create"].params.has_key?(:concern)).to eq(true)
-    expect(Apipie["overridden_concern_resources#create"].params.has_key?(:user)).to eq(false)
+    expect(Apipie["overridden_concern_resources#create"].params.key?(:concern)).to eq(true)
+    expect(Apipie["overridden_concern_resources#create"].params.key?(:user)).to eq(false)
   end
 
 it "shouldn't replace name of a parameter defined in the controller" do
-    expect(Apipie["overridden_concern_resources#custom"].params.has_key?(:concern)).to eq(true)
-    expect(Apipie["overridden_concern_resources#custom"].params.has_key?(:user)).to eq(false)
+    expect(Apipie["overridden_concern_resources#custom"].params.key?(:concern)).to eq(true)
+    expect(Apipie["overridden_concern_resources#custom"].params.key?(:user)).to eq(false)
   end
 
 end

data/spec/lib/apipie/resource_description_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+describe Apipie::ResourceDescription do
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(controller, id, dsl_data)
+  end
+
+  let(:controller) { ApplicationController }
+  let(:id) { 'dummy' }
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  describe '#_methods' do
+    subject(:methods) { resource_description._methods }
+
+    context 'when has method descriptions' do
+      before do
+        resource_description.add_method_description(
+          Apipie::MethodDescription.new(:a, resource_description, dsl_data)
+        )
+        resource_description.add_method_description(
+          Apipie::MethodDescription.new(:b, resource_description, dsl_data)
+        )
+        resource_description.add_method_description(
+          Apipie::MethodDescription.new(:c, resource_description, dsl_data)
+        )
+      end
+
+      it 'should be ordered' do
+        expect(methods.keys).to eq([:a, :b, :c])
+      end
+    end
+  end
+
+  describe '#to_json' do
+    let(:json_data) { resource_description.to_json }
+
+    describe 'metadata' do
+      subject { json_data[:metadata] }
+
+      it { is_expected.to be_nil }
+
+      context 'when meta data are provided' do
+        let(:meta) { { length: 32, weight: '830g' } }
+        let(:dsl_data) { super().update({ meta: meta }) }
+
+        it { is_expected.to eq(meta) }
+      end
+    end
+
+    describe 'methods' do
+      subject(:methods_as_json) { json_data[:methods] }
+
+      context 'when has method descriptions' do
+        before do
+          resource_description.add_method_description(
+            Apipie::MethodDescription.new(:a, resource_description, dsl_data)
+          )
+          resource_description.add_method_description(
+            Apipie::MethodDescription.new(:b, resource_description, dsl_data)
+          )
+          resource_description.add_method_description(
+            Apipie::MethodDescription.new(:c, resource_description, dsl_data)
+          )
+        end
+
+        it 'should be ordered' do
+          expect(methods_as_json.map { |h| h[:name] }).to eq(%w[a b c])
+        end
+      end
+    end
+  end
+
+  describe 'name' do
+    subject { resource_description.name }
+
+    it { is_expected.to eq('Dummy') }
+
+    context 'when given id contains dashes' do
+      let(:id) { 'some-nested-resource' }
+
+      it { is_expected.to eq('Some::Nested::Resource') }
+    end
+
+    context 'when resource_name is given' do
+      let(:resource_name) { 'Some-Resource' }
+      let(:dsl_data) { super().merge!(resource_name: 'Some-Resource') }
+
+      it { is_expected.to eq(resource_name) }
+    end
+  end
+end

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, example: 1
+        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', required: true, example: 1
+              },
+              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/{validator_spec.rb → apipie/validator_spec.rb}

@@ -51,25 +51,61 @@ 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
 
   describe 'ArrayClassValidator' do
     it "should validate by object class" do
-      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Fixnum, String])
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Integer, String])
       expect(validator.validate("1")).to be_truthy
       expect(validator.validate(1)).to be_truthy
       expect(validator.validate({ 1 => 1 })).to be_falsey