apipie-rails 0.3.6 → 0.5.17

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+require "json-schema"
+
+require File.expand_path("../../../dummy/app/controllers/twitter_example_controller.rb", __FILE__)
+require File.expand_path("../../../dummy/app/controllers/users_controller.rb", __FILE__)
+require File.expand_path("../../../dummy/app/controllers/pets_controller.rb", __FILE__)
+
+describe 'rake tasks' do
+  include_context "rake"
+
+  let(:doc_path)  { "user_specified_doc_path" }
+
+  before do
+    Apipie.configuration.doc_path = doc_path
+    Apipie.configuration.swagger_suppress_warnings = true
+    allow(Apipie).to receive(:reload_documentation)
+    subject.invoke(*task_args)
+  end
+
+  describe 'static swagger specification files' do
+
+    after do
+      Dir["#{doc_output}*"].each { |static_file| FileUtils.rm_rf(static_file) }
+    end
+
+    let(:swagger_schema) do
+      File.read(File.join(File.dirname(__FILE__),"openapi_2_0_schema.json"))
+    end
+
+    let(:apidoc_swagger_json) do
+      # note:  the filename ends with '_tmp' because this suffix is passed as a parameter to the rake task
+      File.read("#{doc_output}/schema_swagger_tmp.json")
+    end
+
+    let(:apidoc_swagger) do
+      JSON.parse(apidoc_swagger_json)
+    end
+
+    let(:doc_output) do
+      File.join(::Rails.root, doc_path, 'apidoc')
+    end
+
+    let(:ref_output) do
+      File.join(::Rails.root, doc_path, 'apidoc_ref')
+    end
+
+
+    def expect_param_def(http_method, path, param_name, field, value)
+      params = apidoc_swagger["paths"][path][http_method]["parameters"]
+      param = params.select {|p| p if p["name"]==param_name}[0]
+      expect(param[field]).to eq(value)
+    end
+
+    def expect_tags_def(http_method, path, value)
+      params = apidoc_swagger["paths"][path][http_method]["tags"]
+      expect(params).to eq(value)
+    end
+
+    def body_param_def(http_method, path, param_name)
+      params = apidoc_swagger["paths"][path][http_method]["parameters"]
+      body = params.select {|p| p if p["name"]=="body"}[0]
+      schema_properties = body["schema"]["properties"]
+      # print JSON.pretty_generate(schema_properties)
+      param = (schema_properties.select {|k,v| v if k == param_name })[param_name]
+      # print JSON.pretty_generate(param)
+      param
+    end
+
+    def expect_body_param_def(http_method, path, param_name, field, value)
+      param = body_param_def(http_method, path, param_name)
+      expect(param[field]).to eq(value)
+    end
+
+
+    describe 'apipie:static_swagger_json[development,json,_tmp]' do
+      it "generates static swagger files for the default version of apipie docs" do
+        # print apidoc_swagger_json
+
+        expect(apidoc_swagger["info"]["title"]).to eq("Test app (params in:body)")
+        expect(apidoc_swagger["info"]["version"]).to eq("#{Apipie.configuration.default_version}")
+      end
+
+      it "includes expected values in the generated swagger file" do
+        expect_param_def("get", "/twitter_example/{id}", "screen_name", "in", "query")
+        expect_param_def("put", "/users/{id}", "id", "in", "path")
+        expect_body_param_def("put", "/users/{id}", "oauth", "type", "string")
+        expect_body_param_def("put", "/users/{id}", "user", "type", "object")
+
+        user = body_param_def("put", "/users/{id}", "user")
+        expect(user["properties"]["name"]["type"]).to eq("string")
+
+        expect_param_def("get", "/users/by_department", "department", "in", "query")
+        expect_param_def("get", "/users/by_department", "department", "enum",
+                         ["finance", "operations", "sales", "marketing", "HR"])
+
+        expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
+      end
+
+      it "generates a valid swagger file" do
+        # print apidoc_swagger_json
+        expect(JSON::Validator.validate(swagger_schema, apidoc_swagger_json)).to be_truthy
+      end
+    end
+
+    describe 'apipie:static_swagger_json[development,form_data,_tmp]' do
+      it "generates static swagger files for the default version of apipie docs" do
+        # print apidoc_swagger_json
+
+        expect(apidoc_swagger["info"]["title"]).to eq("Test app (params in:formData)")
+        expect(apidoc_swagger["info"]["version"]).to eq("#{Apipie.configuration.default_version}")
+
+      end
+
+      it "includes expected values in the generated swagger file" do
+        expect_param_def("get", "/twitter_example/{id}", "screen_name", "in", "query")
+        expect_param_def("put", "/users/{id}", "id", "in", "path")
+        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"])
+
+        expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
+
+      end
+
+      it "generates a valid swagger file" do
+        # print apidoc_swagger_json
+        expect(JSON::Validator.validate(swagger_schema, apidoc_swagger_json)).to be_truthy
+      end
+    end
+
+    describe 'apipie:did_swagger_change[development,form_data,_tmp]' do
+      it "keeps a reference file" do
+        expect(Pathname(ref_output).children.count).to eq(2)  # one file for each language
+      end
+    end
+  end
+
+end

data/spec/lib/swagger/response_validation_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+require 'rack/utils'
+require 'rspec/expectations'
+require 'apipie/rspec/response_validation_helper'
+require "json-schema"
+
+RSpec.describe PetsController, :type => :controller do
+  before :each do
+    Apipie.configuration.swagger_allow_additional_properties_in_response = false
+  end
+
+  it "does not raise error when rendered output matches the described response" do
+    response = get :return_and_validate_expected_response, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  it "does not raise error when rendered output (array) matches the described response" do
+    response = get :return_and_validate_expected_array_response, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  it "does not raises error when rendered output includes null in the response" do
+    response = get :return_and_validate_expected_response_with_null, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  it "does not raise error when rendered output includes null (instead of an object) in the response" do
+    response = get :return_and_validate_expected_response_with_null_object, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  it "raises error when a response field has the wrong type" do
+    response = get :return_and_validate_type_mismatch, {format: :json}
+    expect(response).not_to match_declared_responses
+  end
+
+  it "raises error when a response has a missing field" do
+    response = get :return_and_validate_missing_field, {format: :json}
+    expect(response).not_to match_declared_responses
+  end
+
+  it "raises error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is false" do
+    response = get :return_and_validate_extra_property, {format: :json}
+    expect(response).not_to match_declared_responses
+  end
+
+  it "raises error when a response has is array instead of object" do
+    # note: this action returns HTTP 201, not HTTP 200!
+    response = get :return_and_validate_unexpected_array_response, {format: :json}
+    expect(response).not_to match_declared_responses
+  end
+
+  it "does not raise error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is true" do
+    Apipie.configuration.swagger_allow_additional_properties_in_response = true
+    response = get :return_and_validate_extra_property, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  it "does not raise error when a response has an extra field and 'additional_properties' is specified in the response" do
+    Apipie.configuration.swagger_allow_additional_properties_in_response = false
+    response = get :return_and_validate_allowed_extra_property, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  it "raises error when a response sub-object has an extra field and 'additional_properties' is not specified on it, but specified on the top level of the response" do
+    Apipie.configuration.swagger_allow_additional_properties_in_response = false
+    response = get :sub_object_invalid_extra_property, {format: :json}
+    expect(response).not_to match_declared_responses
+  end
+
+  it "does not rais error when a response sub-object has an extra field and 'additional_properties' is specified on it" do
+    Apipie.configuration.swagger_allow_additional_properties_in_response = false
+    response = get :sub_object_allowed_extra_property, {format: :json}
+    expect(response).to match_declared_responses
+  end
+
+  describe "auto validation" do
+    auto_validate_rendered_views
+    it "raises exception when a response field has the wrong type and auto validation is turned on" do
+      expect { get :return_and_validate_type_mismatch, {format: :json} }.to raise_error(Apipie::ResponseDoesNotMatchSwaggerSchema)
+    end
+
+    it "does not raise an exception when calling an undocumented method" do
+      expect { get :undocumented_method, {format: :json} }.not_to raise_error
+    end
+
+  end
+
+
+  describe "with array field" do
+    it "no error for valid response" do
+      response = get :returns_response_with_valid_array, {format: :json}
+      expect(response).to match_declared_responses
+    end
+
+    it "error if type of element in the array is wrong" do
+      response = get :returns_response_with_invalid_array, {format: :json}
+      expect(response).not_to match_declared_responses
+    end
+  end
+
+
+
+end