rename to rswag plus major refactor - almost a rewrite

rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb

@@ -0,0 +1,143 @@
+require 'rswag/specs/example_group_helpers'
+
+module Rswag
+  module Specs
+
+    describe ExampleGroupHelpers do
+      subject { double('example_group') }
+      let(:api_metadata) { {} }
+      before do
+        subject.extend ExampleGroupHelpers
+        allow(subject).to receive(:describe)
+        allow(subject).to receive(:context)
+        allow(subject).to receive(:metadata).and_return(api_metadata)
+      end
+
+      describe '#path(path)' do
+        before { subject.path('/blogs') }
+
+        it "delegates to 'describe' with 'path' metadata" do
+          expect(subject).to have_received(:describe).with(
+            '/blogs', path: '/blogs'
+          )
+        end
+      end
+
+      describe '#get|post|patch|put|delete|head(verb, summary)' do
+        before { subject.post('Creates a blog') }
+
+        it "delegates to 'describe' with 'operation' metadata" do
+          expect(subject).to have_received(:describe).with(
+            :post, operation: { verb: :post, summary: 'Creates a blog' }
+          )
+        end
+      end
+
+      describe '#tags|description|operationId|consumes|produces|schemes|deprecated(value)' do
+        let(:api_metadata) { { operation: {} } }
+        before do
+          subject.tags('Blogs', 'Admin')
+          subject.description('Some description')
+          subject.operationId('createBlog')
+          subject.consumes('application/json', 'application/xml')
+          subject.produces('application/json', 'application/xml')
+          subject.schemes('http', 'https')
+          subject.deprecated(true)
+        end
+
+        it "adds to the 'operation' metadata" do
+          expect(api_metadata[:operation]).to match(
+            tags: [ 'Blogs', 'Admin' ],
+            description: 'Some description',
+            operationId: 'createBlog',
+            consumes: [ 'application/json', 'application/xml' ],
+            produces: [ 'application/json', 'application/xml' ],
+            schemes: [ 'http', 'https' ],
+            deprecated: true
+          )
+        end
+      end
+
+      describe '#tags|description|operationId|consumes|produces|schemes|deprecated|security(value)' do
+        let(:api_metadata) { { operation: {} } }
+        before do
+          subject.tags('Blogs', 'Admin')
+          subject.description('Some description')
+          subject.operationId('createBlog')
+          subject.consumes('application/json', 'application/xml')
+          subject.produces('application/json', 'application/xml')
+          subject.schemes('http', 'https')
+          subject.deprecated(true)
+          subject.security(api_key: [])
+        end
+
+        it "adds to the 'operation' metadata" do
+          expect(api_metadata[:operation]).to match(
+            tags: [ 'Blogs', 'Admin' ],
+            description: 'Some description',
+            operationId: 'createBlog',
+            consumes: [ 'application/json', 'application/xml' ],
+            produces: [ 'application/json', 'application/xml' ],
+            schemes: [ 'http', 'https' ],
+            deprecated: true,
+            security: { api_key: [] }
+          )
+        end
+      end
+
+      describe '#parameter(attributes)' do
+        let(:api_metadata) { { operation: {} } }
+
+        context 'always' do 
+          before { subject.parameter(name: :blog, in: :body, schema: { type: 'object' }) }
+
+          it "adds to the 'operation parameters' metadata" do
+            expect(api_metadata[:operation][:parameters]).to match(
+              [ name: :blog, in: :body, schema: { type: 'object' } ]
+            )
+          end
+        end
+
+        context "'path' parameter" do
+          before { subject.parameter(name: :id, in: :path) }
+   
+          it "automatically sets the 'required' flag" do
+            expect(api_metadata[:operation][:parameters]).to match(
+              [ name: :id, in: :path, required: true ]
+            )
+          end
+        end
+      end
+
+      describe '#response(code, description)' do
+        before { subject.response('201', 'success') }
+
+        it "delegates to 'context' with 'response' metadata" do
+          expect(subject).to have_received(:context).with(
+            'success', response: { code: '201', description: 'success' }
+          )
+        end
+      end
+
+      describe '#schema(value)' do
+        let(:api_metadata) { { response: {} } }
+        before { subject.schema(type: 'object') }
+
+        it "adds to the 'response' metadata" do
+          expect(api_metadata[:response][:schema]).to match(type: 'object')
+        end
+      end
+
+      describe '#header(name, attributes)' do
+        let(:api_metadata) { { response: {} } }
+        before { subject.header('Date', type: 'string') }
+
+        it "adds to the 'response headers' metadata" do
+          expect(api_metadata[:response][:headers]).to match(
+            'Date' => { type: 'string' }
+          )
+        end
+      end
+    end
+  end
+end