apipie-rails 0.9.3 → 1.0.0

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

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
+  let(:http_method) { nil }
+  let(:controller_method) { nil }
+  let(:allow_null) { false }
+
+  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) do
+    proc do
+      property :a_number, Integer
+      property :an_optional_number, Integer, required: false
+    end
+  end
+
+  let(:options) { {} }
+
+  let(:response_description) do
+    Apipie::ResponseDescription.new(
+      method_description,
+      204,
+      options,
+      PetsController,
+      response_description_dsl,
+      nil
+    )
+  end
+
+  let(:service) do
+    described_class.new(
+      response_description,
+      allow_null: allow_null,
+      http_method: http_method,
+      controller_method: controller_method
+    )
+  end
+
+  describe '#to_swagger' do
+    let(:swagger_response) { service.to_swagger }
+
+    describe 'properties' do
+      subject(:properties) { swagger_response[:properties] }
+
+      it 'returns correct properties' do
+        expect(properties).to eq(
+          {
+            a_number: {
+              type: 'number'
+            },
+            an_optional_number: {
+              type: 'number'
+            }
+          }
+        )
+      end
+
+      context 'when nulls are allowed' do
+        let(:allow_null) { true }
+
+        it 'returns correct properties' do
+          expect(properties).to eq(
+            {
+              a_number: {
+                type: %w[number null]
+              },
+              an_optional_number: {
+                type: %w[number null]
+              }
+            }
+          )
+        end
+      end
+    end
+
+    context 'when responses_use_refs is set to true' do
+      subject(:response) { swagger_response }
+
+      before { Apipie.configuration.generator.swagger.responses_use_refs = true }
+      after { Apipie.configuration.generator.swagger.responses_use_refs = false }
+
+      context 'when typename is given' do
+        let(:options) { { param_group: :some_param_group } }
+
+        it 'returns the reference' do
+          expect(response).to eq(
+            {
+              '$ref' => '#/definitions/some_param_group'
+            }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
     described_class.new(
       param_description,
       in_schema: in_schema,
-      controller_method: 'show'
+      controller_method: method_desc
     )
   end
   let(:generated_block) { builder.to_swagger }

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

@@ -13,7 +13,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Composite do
     Apipie::Generator::Swagger::Context.new(
       allow_null: true,
       http_method: 'get',
-      controller_method: 'show'
+      controller_method: method_description
     )
   end
 
@@ -50,7 +50,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Composite do
 
     context 'when additional properties in response allowed' do
       before do
-        Apipie.configuration.swagger_allow_additional_properties_in_response = true
+        Apipie.configuration.generator.swagger.allow_additional_properties_in_response = true
       end
 
       it { is_expected.to be_blank }

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

@@ -75,7 +75,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
     it { is_expected.to eq(validator.to_s.downcase) }
 
     context 'when validator is enum' do
-      let(:validator) { ['name', 'enum'] }
+      let(:validator) { %w[name enum] }
 
       it { is_expected.to eq('string') }
     end
@@ -108,9 +108,9 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
 
         it { is_expected.to eq({ type: 'string' }) }
 
-        context 'and swagger_json_input_uses_refs is set to true' do
-          before { Apipie.configuration.swagger_json_input_uses_refs = true }
-          after { Apipie.configuration.swagger_json_input_uses_refs = false }
+        context 'and swagger.json_input_uses_refs is set to true' do
+          before { Apipie.configuration.generator.swagger.json_input_uses_refs = true }
+          after { Apipie.configuration.generator.swagger.json_input_uses_refs = false }
 
           it 'returns the reference' do
             expect(subject).to eq({ '$ref' => reference })
@@ -130,8 +130,8 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
           it { is_expected.to be_blank }
 
           context 'and an array of in values is given' do
-            let(:enum_values) { ['enum-value-1', 'enum-value-2'] }
-            let(:validator_options) { { in: ['enum-value-1', 'enum-value-2'] } }
+            let(:enum_values) { %w[enum-value-1 enum-value-2] }
+            let(:validator_options) { { in: %w[enum-value-1 enum-value-2] } }
 
             it { is_expected.to eq(enum_values) }
           end
@@ -144,7 +144,7 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
     subject { type_definition[:enum] }
 
     context 'and an array of in values is given' do
-      let(:validator) { ['enum-value-1', 'enum-value-2'] }
+      let(:validator) { %w[enum-value-1 enum-value-2] }
 
       it { is_expected.to eq(validator) }
     end

data/spec/lib/apipie/generator/swagger/path_decorator_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::PathDecorator do
+  let(:decorated_path) { described_class.new(path) }
+
+  describe '#param_names' do
+    subject { decorated_path.param_names }
+
+    context 'when path does not contain any params' do
+      let(:path) { 'some/path/without_params' }
+
+      it { is_expected.to be_empty }
+    end
+
+    context 'when path has a param' do
+      let(:path) { '/:resource_id/custom' }
+
+      it { is_expected.to eq([:resource_id]) }
+    end
+  end
+
+  describe '#param?' do
+    subject { decorated_path.param?(param) }
+
+    context 'when path has params' do
+      let(:path) { '/:resource_id/custom' }
+
+      context 'when param to check is in the path' do
+        let(:param) { :resource_id }
+
+        it { is_expected.to be(true) }
+      end
+
+      context 'when param to check is not in the path' do
+        let(:param) { :some_param }
+
+        it { is_expected.to be(false) }
+      end
+    end
+  end
+
+  describe '#swagger_path' do
+    subject(:swagger_path) { decorated_path.swagger_path }
+
+    let(:path) { '/some/custom/path' }
+
+    it { is_expected.to eq('/some/custom/path') }
+
+    context 'when path does not start with slash' do
+      let(:path) { ':resource_id/custom' }
+
+      it 'adds the slash in the beginning' do
+        expect(swagger_path).to eq('/{resource_id}/custom')
+      end
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/referenced_definitions_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ReferencedDefinitions do
+  let(:definitions) { described_class.instance }
+
+  before { Singleton.__init__(described_class) }
+
+  describe '.add!' do
+    subject(:add_call) { definitions.add!(param_type, schema) }
+
+    let(:param_type) { :some_type }
+    let(:schema) { { key: 'value' } }
+
+    it 'returns add the definition' do
+      expect { add_call }
+        .to change(definitions, :definitions)
+        .from({})
+        .to({ param_type => schema })
+    end
+  end
+
+  describe '.added?' do
+    subject { definitions.added?(param_type) }
+
+    let(:param_type) { :some_type }
+
+    it { is_expected.to be_blank }
+
+    context 'when definition exists' do
+      before { definitions.add!(param_type, {}) }
+
+      it { is_expected.to be(true) }
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/resource_description_composite_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ResourceDescriptionComposite do
+  let(:dsl_data) { {} }
+  let(:resource_id) { 'pets' }
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(PetsController, resource_id, dsl_data)
+  end
+
+  let(:resource_descriptions) { [resource_description] }
+  let(:composite) { described_class.new(resource_descriptions, language: :en) }
+
+  describe '#to-swagger' do
+    subject { composite.to_swagger }
+
+    it { is_expected.to include(:paths, :tags) }
+
+    describe 'tags' do
+      subject(:tag) { composite.to_swagger[:tags].first }
+
+      it { is_expected.to be_blank }
+
+      context 'when resource description has full description' do
+        let(:dsl_data) { { description: 'something' } }
+
+        it 'returns the name and description' do
+          expect(tag).to eq(
+            {
+              name: resource_id,
+              description: resource_description._full_description
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/resource_descriptions_collection_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ResourceDescriptionsCollection do
+  let(:collection) { described_class.new(resource_descriptions) }
+
+  let(:users_resource_description) do
+    Apipie.get_resource_description(UsersController, Apipie.configuration.default_version)
+  end
+
+  let(:pets_resource_description) do
+    Apipie.get_resource_description(PetsController, Apipie.configuration.default_version)
+  end
+
+  let(:resource_descriptions) do
+    {
+      'development' => {
+        users_resource_description._id => users_resource_description,
+        pets_resource_description._id => pets_resource_description
+      },
+      'production' => {
+        pets_resource_description._id => pets_resource_description
+      }
+    }
+  end
+
+  describe '#filter' do
+    subject(:filtered_resource_descriptions) do
+      collection.filter(
+        version: version,
+        resource_id: resource_id,
+        method_name: method_name
+      )
+    end
+
+    let(:version) { 'development' }
+    let(:resource_id) { users_resource_description._id }
+    let(:method_name) { nil }
+
+    it 'filters resources for the given version and resource name' do
+      expect(filtered_resource_descriptions).to eq([users_resource_description])
+    end
+
+    context 'when method name is given' do
+      context 'when does not exist in the controller' do
+        let(:method_name) { :i_do_not_exist }
+
+        it { is_expected.to be_empty }
+      end
+
+      context 'when exists in the controller' do
+        let(:method_name) { :show }
+
+        it { is_expected.to eq([users_resource_description]) }
+      end
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/schema_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::Schema do
+  let(:version) { :ok }
+  let(:language) { :ok }
+  let(:clear_warnings) { :ok }
+  let(:dsl_data) { {} }
+  let(:resource_id) { 'pets' }
+  let(:resource_descriptions) { [resource_description] }
+
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(PetsController, resource_id, dsl_data)
+  end
+
+  let(:schema_generator) do
+    described_class.new(
+      resource_descriptions,
+      version: version,
+      language: language,
+      clear_warnings: clear_warnings
+    )
+  end
+
+  describe '#generate' do
+    subject(:schema) { schema_generator.generate }
+
+    describe 'host' do
+      before { Apipie.configuration.generator.swagger.api_host = nil }
+
+      it 'is not returned' do
+        expect(schema.keys).not_to include(:host)
+      end
+
+      context 'when api_host is set' do
+        let(:host) { 'localhost:3000' }
+
+        before { Apipie.configuration.generator.swagger.api_host = host }
+
+        it 'returns the host' do
+          expect(schema[:host]).to eq(host)
+        end
+      end
+    end
+
+    describe 'consumes' do
+      subject { schema_generator.generate[:consumes] }
+
+      before { Apipie.configuration.generator.swagger.content_type_input = nil }
+
+      it { is_expected.to eq(['application/x-www-form-urlencoded', 'multipart/form-data']) }
+
+      context 'when swagger.content_type_input is set to json' do
+        before { Apipie.configuration.generator.swagger.content_type_input = :json }
+
+        it { is_expected.to eq(['application/json']) }
+      end
+    end
+
+    describe 'title' do
+      subject { schema_generator.generate[:info][:title] }
+
+      before { Apipie.configuration.generator.swagger.content_type_input = nil }
+
+      it { is_expected.to include(' (params in:formData)') }
+
+      context 'when swagger.content_type_input is set to json' do
+        before { Apipie.configuration.generator.swagger.content_type_input = :json }
+
+        it { is_expected.to include(' (params in:body)') }
+      end
+    end
+
+    describe 'x-computed-id' do
+      subject(:schema) { schema_generator.generate[:info] }
+
+      before { Apipie.configuration.generator.swagger.generate_x_computed_id_field = false }
+
+      it 'is not returned' do
+        expect(schema.keys).not_to include('x-computed-id')
+      end
+
+      context 'when swagger.content_type_input is set to json' do
+        before { Apipie.configuration.generator.swagger.generate_x_computed_id_field = true }
+
+        it { is_expected.to include('x-computed-id') }
+      end
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/type_extractor_spec.rb

@@ -26,15 +26,6 @@ describe Apipie::Generator::Swagger::TypeExtractor do
         it 'returns an enum type' do
           expect(subject).to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:enum])
         end
-
-        context 'and has `true`, `false` as values' do
-          let(:param_description_name) { :visible }
-          let(:enum_values) { [true, false] }
-
-          it 'returns a boolean type' do
-            expect(subject).to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:boolean])
-          end
-        end
       end
     end
   end
@@ -44,38 +35,4 @@ describe Apipie::Generator::Swagger::TypeExtractor do
 
     it_behaves_like 'extractable method'
   end
-
-  describe '#extarct_with_warnings' do
-    before { Apipie.configuration.swagger_suppress_warnings = false }
-
-    subject { extractor.extract_with_warnings(warnings) }
-
-    it_behaves_like 'extractable method'
-
-    context "when enum validator is used" do
-      context "and has `true`, `false` as values" do
-        let(:enum_values) { [true, false] }
-
-        let(:validator) do
-          Apipie::ResponseDescriptionAdapter::PropDesc::Validator.new('some-type', enum_values)
-        end
-
-        context 'and a boolean warning is passed' do
-          let(:boolean_warning) do
-            Apipie::Generator::Swagger::Warning.for_code(
-              Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_CODE,
-              'SampleController#action',
-              { parameter: 'some-param' }
-            )
-          end
-
-          let(:warnings) { { boolean: boolean_warning } }
-
-          it 'outputs the warning' do
-            expect { subject }.to output(boolean_warning.warning_message).to_stderr
-          end
-        end
-      end
-    end
-  end
 end

data/spec/lib/apipie/generator/swagger/warning_spec.rb

@@ -16,7 +16,7 @@ describe Apipie::Generator::Swagger::Warning do
   describe '#warning_message' do
     subject { warning.warning_message }
 
-    it { is_expected.to eq("WARNING (#{code}): [#{method_id}] -- #{info_message}") }
+    it { is_expected.to eq("WARNING (#{code}): [#{method_id}] -- #{info_message}\n") }
   end
 
   describe '#warn' do

data/spec/lib/apipie/generator/swagger/warning_writer_spec.rb

@@ -5,14 +5,14 @@ describe Apipie::Generator::Swagger::WarningWriter do
 
   let(:warning) do
     Apipie::Generator::Swagger::Warning.for_code(
-      Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_CODE,
+      Apipie::Generator::Swagger::Warning::PARAM_IGNORED_IN_FORM_DATA_CODE,
       'SampleController#action',
       { parameter: 'some-param' }
     )
   end
 
   before do
-    Apipie.configuration.swagger_suppress_warnings = false
+    Apipie.configuration.generator.swagger.suppress_warnings = false
     Singleton.__init__(described_class)
   end
 
@@ -23,16 +23,16 @@ describe Apipie::Generator::Swagger::WarningWriter do
       expect { subject }.to output(warning.warning_message).to_stderr
     end
 
-    context 'when Apipie.configuration.swagger_suppress_warnings is true' do
-      before { Apipie.configuration.swagger_suppress_warnings = true }
+    context 'when Apipie.configuration.generator.swagger.suppress_warnings is true' do
+      before { Apipie.configuration.generator.swagger.suppress_warnings = true }
 
       it { is_expected.to be_falsey }
     end
 
-    context 'when Apipie.configuration.swagger_suppress_warnings includes warning code' do
+    context 'when Apipie.configuration.generator.swagger.suppress_warnings includes warning code' do
       before do
-        Apipie.configuration.swagger_suppress_warnings =
-          Array(Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_CODE)
+        Apipie.configuration.generator.swagger.suppress_warnings =
+          Array(Apipie::Generator::Swagger::Warning::PARAM_IGNORED_IN_FORM_DATA_CODE)
       end
 
       it { is_expected.to be_falsey }
@@ -56,4 +56,16 @@ describe Apipie::Generator::Swagger::WarningWriter do
       it { is_expected.to be_truthy }
     end
   end
+
+  describe '#clear!' do
+    subject { writer.clear! }
+
+    context 'when writer has issued warnings' do
+      before { writer.warn(warning) }
+
+      it 'removes issued warnings' do
+        expect { subject }.to change(writer, :issued_warnings?).from(true).to(false)
+      end
+    end
+  end
 end