apipie-rails 0.5.6 → 0.5.7

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+require "json-schema"
+
+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 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"])
+      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"])
+
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 description: Rails REST API documentation tool
 email:
 - pajkycz@gmail.com
@@ -210,6 +224,7 @@ files:
 - lib/apipie/routing.rb
 - lib/apipie/see_description.rb
 - lib/apipie/static_dispatcher.rb
+- lib/apipie/swagger_generator.rb
 - lib/apipie/validator.rb
 - lib/apipie/version.rb
 - lib/generators/apipie/install/README
@@ -279,6 +294,8 @@ files:
 - spec/lib/param_group_spec.rb
 - spec/lib/rake_spec.rb
 - spec/lib/resource_description_spec.rb
+- spec/lib/swagger/openapi_2_0_schema.json
+- spec/lib/swagger/rake_swagger_spec.rb
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
@@ -302,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool
@@ -366,6 +383,8 @@ test_files:
 - spec/lib/param_group_spec.rb
 - spec/lib/rake_spec.rb
 - spec/lib/resource_description_spec.rb
+- spec/lib/swagger/openapi_2_0_schema.json
+- spec/lib/swagger/rake_swagger_spec.rb
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb