apipie-rails 0.3.6 → 0.9.1

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

@@ -0,0 +1,59 @@
+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::INFERRING_BOOLEAN_CODE,
+      'SampleController#action',
+      { parameter: 'some-param' }
+    )
+  end
+
+  before do
+    Apipie.configuration.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.swagger_suppress_warnings is true' do
+      before { Apipie.configuration.swagger_suppress_warnings = true }
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when Apipie.configuration.swagger_suppress_warnings includes warning code' do
+      before do
+        Apipie.configuration.swagger_suppress_warnings =
+          Array(Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_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
+end

data/spec/lib/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/method_description_spec.rb

@@ -36,6 +36,13 @@ describe Apipie::MethodDescription do
       method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
       expect(method.method_apis_to_json.first[:deprecated]).to eq(true)
     end
+
+    it "should return the deprecated flag if resource is deprecated" do
+      @resource.instance_variable_set("@_deprecated", true)
+      dsl_data[:api_args] = [[:GET, "/foo/bar", "description", {}]]
+      method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      expect(method.method_apis_to_json.first[:deprecated]).to eq(true)
+    end
   end
 
   describe "params descriptions" do
@@ -61,4 +68,31 @@ describe Apipie::MethodDescription do
 
   end
 
+  describe "response-only properties" do
+    before(:each) do
+      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
+      dsl_data[:params] = [[:a, String, nil, {:only_in => :request}, nil],
+                           [:b, String, nil, {:only_in => :response}, nil],
+                           [:c, String, nil, {}, nil]]
+      @method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      @resource.add_method_description @method
+    end
+
+    it "should ignore response-only parameters" do
+      expect(@method.params.keys).to eq([:a, :c])
+      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'c'])
+    end
+  end
+
+
+  describe "'returns' properties" do
+    it "should raise an error if both :param_group and :array_of are specified in 'returns'" do
+      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
+      dsl_data[:returns] = { 200 => [{:param_group => 'pet', :array_of => 'pet'}, nil, nil] }
+
+      expect {Apipie::MethodDescription.new(:a, @resource, dsl_data)}.to raise_error(Apipie::ReturnsMultipleDefinitionError)
+    end
+  end
+
+
 end

data/spec/lib/param_description_spec.rb

@@ -113,6 +113,92 @@ describe Apipie::ParamDescription do
 
   end
 
+  describe 'validate' do
+    context 'when allow_blank is ignored, as it was before 0.7.0' do
+      before do
+        Apipie.configuration.ignore_allow_blank_false = true
+      end
+
+      context 'when the parameter is a boolean' do
+        it "should not throw an exception when passed false" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
+        end
+
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+
+      context 'when the parameter is a string' do
+        context 'when allow_blank is specified as true' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
+          end
+        end
+        context 'when allow_blank is specified as false' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to_not raise_error
+          end
+        end
+        context 'when allow_blank is not specified' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to_not raise_error
+          end
+        end
+      end
+
+      after do
+        Apipie.configuration.ignore_allow_blank_false = false
+      end
+    end
+
+    context 'when the parameter is a boolean' do
+      it "should not throw an exception when passed false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
+      end
+
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an empty value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
+    context "when the parameter is a custom type with ignore_allow_blank? returning true" do
+      it "should not throw an exception when passed a blank but valid value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate(false) }.to_not raise_error
+      end
+
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an invalid but blank value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate("") }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
+    context 'when the parameter is a string' do
+      context 'when allow_blank is specified as true' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
+        end
+      end
+      context 'when allow_blank is specified as false' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+      context 'when allow_blank is not specified' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+    end
+  end
+
   describe "concern substitution" do
 
     let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }
@@ -288,7 +374,7 @@ describe Apipie::ParamDescription do
 
       subject do
         Apipie::ParamDescription.new(method_desc, :param, Hash) do
-          param :answer, Fixnum
+          param :answer, Integer
         end
       end
 
@@ -306,7 +392,7 @@ describe Apipie::ParamDescription do
 
       subject do
         Apipie::ParamDescription.new(method_desc, :param, Array) do
-          param :answer, Fixnum
+          param :answer, Integer
         end
       end
 
@@ -336,9 +422,9 @@ 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
 

data/spec/lib/rake_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'rake tasks' do
   include_context "rake"
 
-  let(:doc_path)  { "user_specified_doc_path" }
+  let(:doc_path)  { 'tmp/user_specified_doc_path' }
 
   before do
     Apipie.configuration.doc_path = doc_path
@@ -49,9 +49,7 @@ describe 'rake tasks' do
   end
 
   describe 'apipie:cache' do
-    let(:cache_output) do
-      File.join(::Rails.root, 'public', 'apipie-cache')
-    end
+    let(:cache_output) { Apipie.configuration.cache_dir }
 
     let(:apidoc_html) do
       File.read("#{cache_output}.html")