rswag/lib/swagger_rails/rspec/dsl.rb

require 'swagger_rails/test_visitor'

module SwaggerRails
  module RSpec
    module DSL

      def path(path_template, &block)
        metadata = {
          path_template: path_template
        }
        describe(path_template, metadata, &block)
      end

      def operation(http_verb, summary=nil, &block)
        metadata = {
          http_verb: http_verb,
          summary: summary,
          parameters: []
        }
        describe(http_verb, metadata, &block)
      end

      def operation_description(message)
        metadata[:operation_description] = message
      end

      [ :get, :post, :patch, :put, :delete, :head ].each do |http_verb|
        define_method(http_verb) do |summary=nil, &block|
          operation(http_verb, summary, &block)
        end
      end

      def consumes(*mime_types)
        metadata[:consumes] = mime_types
      end

      def produces(*mime_types)
        metadata[:produces] = mime_types
      end

      # Accepts parameter objects:
      #    parameter :petId, in: :path, type: :integer, required: true
      # Or references:
      #    parameter ref: '#/parameters/Pet'
      def parameter(name, attributes={})
        metadata[:parameters] << if name.respond_to?(:has_key?)
          { '$ref': name.delete(:ref) || name.delete('ref') }
        else
          { name: name.to_s }.merge(attributes)
        end
      end

      def response(code, description, &block)
        metadata = {
          response_code: code,
          response: {
            description: description
          }
        }
        context(description, metadata, &block)
      end

      def run_test!
        if metadata.has_key?(:swagger_doc)
          swagger_doc = ::RSpec.configuration.swagger_docs[metadata[:swagger_doc]]
        else
          swagger_doc = ::RSpec.configuration.swagger_docs.values.first
        end

        test_visitor = SwaggerRails::TestVisitor.new(swagger_doc)

        before do |example|
          test_visitor.submit_request!(self, example.metadata)
        end

        it "returns a #{metadata[:response_code]} status" do |example|
          test_visitor.assert_response!(self, example.metadata)
        end
      end
    end
  end
end