apipie-rails 0.5.19 → 1.3.0

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

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Apipie::Generator::Swagger::Warning do
+  let(:code) { Apipie::Generator::Swagger::Warning::MISSING_METHOD_SUMMARY_CODE }
+  let(:method_id) { 'Examples#index' }
+  let(:info_message) { 'Something went wrong' }
+
+  let(:warning) { described_class.new(code, info_message, method_id) }
+
+  describe '#id' do
+    subject { warning.id }
+
+    it { is_expected.to eq("#{method_id}#{code}#{info_message}") }
+  end
+
+  describe '#warning_message' do
+    subject { warning.warning_message }
+
+    it { is_expected.to eq("WARNING (#{code}): [#{method_id}] -- #{info_message}\n") }
+  end
+
+  describe '#warn' do
+    subject { warning.warn }
+
+    it 'outputs the warning' do
+      expect { subject }.to output(warning.warning_message).to_stderr
+    end
+  end
+
+  describe '#warn_through_writer' do
+    subject { warning.warn }
+
+    it 'outputs the warning' do
+      expect { subject }.to output(warning.warning_message).to_stderr
+    end
+  end
+
+  describe '.for_code' do
+    subject { described_class.for_code(code, method_id) }
+
+    it { is_expected.to be_an_instance_of(described_class)}
+
+    context 'when code is invalid' do
+      let(:code) { 12345 }
+
+      it 'raises an argument error' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::WarningWriter do
+  let(:writer) { described_class.clone.instance }
+
+  let(:warning) do
+    Apipie::Generator::Swagger::Warning.for_code(
+      Apipie::Generator::Swagger::Warning::PARAM_IGNORED_IN_FORM_DATA_CODE,
+      'SampleController#action',
+      { parameter: 'some-param' }
+    )
+  end
+
+  before do
+    Apipie.configuration.generator.swagger.suppress_warnings = false
+    Singleton.__init__(described_class)
+  end
+
+  describe '#warn' do
+    subject { writer.warn(warning) }
+
+    it 'outputs the warning' do
+      expect { subject }.to output(warning.warning_message).to_stderr
+    end
+
+    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.generator.swagger.suppress_warnings includes warning code' do
+      before do
+        Apipie.configuration.generator.swagger.suppress_warnings =
+          Array(Apipie::Generator::Swagger::Warning::PARAM_IGNORED_IN_FORM_DATA_CODE)
+      end
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when a warning already been logged' do
+      before { writer.warn(warning) }
+
+      it { is_expected.to be_falsey }
+    end
+  end
+
+  describe '#issued_warnings?' do
+    subject { writer.issued_warnings? }
+
+    it { is_expected.to be_falsey }
+
+    context 'when a warning already been logged' do
+      before { writer.warn(warning) }
+
+      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

data/spec/lib/apipie/method_description/apis_service_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Apipie::MethodDescription::ApisService do
+  let(:resource) {}
+  let(:controller_action) {}
+  let(:api_args) { [] }
+  let(:dsl) { { api_args: api_args } }
+  let(:service) { described_class.new(resource, controller_action, dsl) }
+
+  describe '#call' do
+    subject { service.call }
+
+    it { is_expected.to eq(api_args) }
+
+    context 'when api_from_routes is given' do
+      let(:controller) { UsersController }
+      let(:controller_action) { :show }
+      let(:resource) { Apipie::ResourceDescription.new(controller, 'dummy') }
+      let(:short_description) { 'Short description' }
+
+      let(:dsl) do
+        super().merge({
+          api_from_routes: {
+            desc: short_description,
+            options: {}
+          }
+        })
+      end
+
+      it 'returns an array of Apipie::MethodDescription::Api' do
+        expect(subject).to all(be_an_instance_of(Apipie::MethodDescription::Api))
+        expect(subject.count).to eq(1)
+      end
+
+      context 'Apipie::MethodDescription::Api' do
+        subject { service.call.first }
+
+        it 'has the correct values' do
+          expect(subject.short_description).to eq(short_description)
+          expect(subject.path).to eq('/api/users/:id')
+          expect(subject.from_routes).to eq(true)
+          expect(subject.options).to eq({ from_routes: true })
+        end
+
+        context "when it's from concern" do
+          let(:controller) { ConcernsController }
+          let(:controller_action) { :custom }
+          let(:dsl) { super().merge(from_concern: true ) }
+
+          it 'has the correct values' do
+            expect(subject.short_description).to eq(short_description)
+            expect(subject.path).to eq('/api/concern_resources/custom')
+            expect(subject.from_routes).to eq(true)
+            expect(subject.options).to eq({ from_routes: true })
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/apipie/method_description_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+
+describe Apipie::MethodDescription do
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+  let(:deprecated_resource_description) { false }
+  let(:method_description_method) { :some_method }
+
+  let(:resource_description_dsl) do
+    ActionController::Base.send(:_apipie_dsl_data_init).merge(
+      {
+        deprecated: deprecated_resource_description
+      }
+    )
+  end
+
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(
+      ApplicationController,
+      'dummy',
+      resource_description_dsl
+    )
+  end
+
+  let(:method_description) do
+    Apipie::MethodDescription.new(
+      method_description_method,
+      resource_description,
+      dsl_data
+    )
+  end
+
+  describe '#to_json' do
+    describe 'metadata' do
+      subject { method_description.to_json[:metadata] }
+
+      it { is_expected.to be_nil }
+
+      context 'when meta are given' do
+        let(:meta) { { length: 32, weight: '830g' } }
+        let(:dsl_data) { super().merge(meta: meta) }
+
+        it { is_expected.to eq(meta) }
+      end
+    end
+
+    describe 'params' do
+      subject(:json_params) { method_description.to_json[:params].map { |h| h[:name] } }
+
+      let(:dsl_data) do
+        super().merge(
+          {
+            params: [
+              [:a, String, nil, {}, nil],
+              [:b, String, nil, {}, nil],
+              [:c, String, nil, {}, nil]
+            ]
+          }
+        )
+      end
+
+      it 'should be ordered' do
+        expect(json_params).to eq(%w[a b c])
+      end
+
+      context 'when param is only for response' do
+        let(:dsl_data) do
+          super().merge(
+            {
+              params: [
+                [:a, String, nil, { only_in: :request }, nil],
+                [:b, String, nil, { only_in: :response }, nil],
+                [:c, String, nil, {}, nil]
+              ]
+            }
+          )
+        end
+
+        it 'should ignore response-only parameters' do
+          expect(json_params).to eq(%w[a c])
+        end
+      end
+    end
+  end
+
+  describe '#method_apis_to_json' do
+    describe 'deprecated' do
+      subject { method_description.method_apis_to_json.first[:deprecated] }
+
+      let(:api_deprecated) { false }
+      let(:dsl_data) { super().merge(api_args: api_args) }
+
+      let(:api_args) do
+        [[:GET, "/foo/bar", "description", { deprecated: api_deprecated }]]
+      end
+
+      it { is_expected.to eq(false) }
+
+      context 'when api is deprecated' do
+        let(:api_deprecated) { true }
+
+        it { is_expected.to eq(true) }
+      end
+
+      context 'when resource description is deprecated' do
+        let(:deprecated_resource_description) { true }
+
+        it { is_expected.to eq(true) }
+      end
+    end
+  end
+
+  describe '#returns' do
+    subject(:method_desc) { method_description }
+
+    context 'when both :param_group and :array_of are specified' do
+      let(:returns) do
+        { 200 => [{ param_group: 'pet', array_of: 'pet' }, nil, nil] }
+      end
+
+      let(:dsl_data) { super().merge({ returns: returns }) }
+
+      it 'raises an error' do
+        expect { method_desc }.to raise_error(Apipie::ReturnsMultipleDefinitionError)
+      end
+    end
+  end
+
+  describe '#method_name' do
+    subject { method_description.method_name }
+
+    it { is_expected.to eq(method_description_method.to_s) }
+  end
+end

data/spec/lib/apipie/no_documented_method_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Apipie::NoDocumentedMethod do
+  let(:error) { described_class.new(controller_name, method_name) }
+  let(:controller_name) { 'UserController' }
+  let(:method_name) { 'index' }
+
+  describe '#to_s' do
+    subject { error.to_s }
+
+    let(:error_message) do
+      "There is no documented method #{controller_name}##{method_name}"
+    end
+
+    it { is_expected.to eq(error_message) }
+  end
+end

data/spec/lib/apipie/param_description/deprecation_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Apipie::ParamDescription::Deprecation do
+  let(:info) { nil }
+  let(:deprecated_in) { nil }
+  let(:sunset_at) { nil }
+
+  let(:deprecation) do
+    described_class.new(
+      info: info,
+      deprecated_in: deprecated_in,
+      sunset_at: sunset_at
+    )
+  end
+
+  describe '#to_json' do
+    subject { deprecation.to_json }
+
+    it { is_expected.to eq({ info: nil, deprecated_in: nil, sunset_at: nil }) }
+
+    context 'when attributes are given' do
+      let(:info) { 'info' }
+      let(:deprecated_in) { '2.3' }
+      let(:sunset_at) { '3.0' }
+
+      it 'returns the correct attributes' do
+        expect(subject).to eq({ info: info, deprecated_in: deprecated_in, sunset_at: sunset_at })
+      end
+    end
+  end
+end