rswag-specs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf953519fd1b82b220dc55df8ac263dd12f260ad
+  data.tar.gz: 61696eb4201f033a4c39daba75d56eb2052b9ff8
+SHA512:
+  metadata.gz: ba2ae1c5751ec7ed740fd2572cb37e78b89c584c4fd42095f9a1c8076a3f72c49e2251905fbfd69fea7a3dd73dfa0a072299c09e21febc52574cca1224504929
+  data.tar.gz: e886995f37ced2fe10457c1a6d8df03a3106eb9f08408a00e776b007d0048ac082c9362445a34c48685b77c4c1b5f619027b3f816ffb5b254f40bbe3e036ddf8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 domaindrivendev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rswag-specs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/rswag/specs/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Adds swagger_helper to enable Swagger DSL in integration specs
+
+Example:
+    rails generate rswag:specs:install
+
+    This will create:
+        spec/swagger_helper.rb

data/lib/generators/rswag/specs/install/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module Rswag
+  module Specs
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def add_swagger_helper
+        template('swagger_helper.rb', 'spec/swagger_helper.rb')
+      end
+    end
+  end
+end

data/lib/generators/rswag/specs/install/templates/swagger_helper.rb

@@ -0,0 +1,25 @@
+require 'rails_helper'
+
+RSpec.configure do |config|
+  # Specify a root folder where Swagger JSON files are generated
+  # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
+  # to ensure that it's confiugred to server Swagger from the same folder
+  config.swagger_root = Rails.root.to_s + '/swagger'
+
+  # Define one or more Swagger documents and provide global metadata for each one
+  # When you run the 'rswag:specs:to_swagger' rake task, the complete Swagger will
+  # be generated at the provided relative path under swagger_root
+  # By default, the operations defined in spec files are added to the first
+  # document below. You can override this behavior by adding a swagger_doc tag to the
+  # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
+  config.swagger_docs = {
+    'v1/swagger.json' => {
+      swagger: '2.0',
+      info: {
+        title: 'API V1',
+        version: 'v1'
+      },
+      paths: {}
+    }
+  }
+end

data/lib/rswag/specs/example_group_helpers.rb

@@ -0,0 +1,80 @@
+module Rswag
+  module Specs
+    module ExampleGroupHelpers
+
+      def path(path, &block)
+        api_metadata = { path: path}
+        describe(path, api_metadata, &block)
+      end
+
+      [ :get, :post, :patch, :put, :delete, :head ].each do |verb|
+        define_method(verb) do |summary, &block|
+          api_metadata = { operation: { verb: verb, summary: summary } }
+          describe(verb, api_metadata, &block)
+        end
+      end
+
+      [ :operationId, :deprecated, :security ].each do |attr_name|
+        define_method(attr_name) do |value|
+          metadata[:operation][attr_name] = value
+        end
+      end
+
+      # NOTE: 'description' requires special treatment because ExampleGroup already
+      # defines a method with that name. Provide an override that supports the existing
+      # functionality while also setting the appropriate metadata if applicable
+      def description(value=nil)
+        return super() if value.nil?
+        metadata[:operation][:description] = value 
+      end
+
+      # These are array properties - note the splat operator
+      [ :tags, :consumes, :produces, :schemes ].each do |attr_name|
+        define_method(attr_name) do |*value|
+          metadata[:operation][attr_name] = value
+        end
+      end
+
+      def parameter(attributes)
+        attributes[:required] = true if attributes[:in].to_sym == :path
+        metadata[:operation][:parameters] ||= []
+        metadata[:operation][:parameters] << attributes
+      end
+
+      def response(code, description, &block)
+        api_metadata = { response: { code: code, description: description } }
+        context(description, api_metadata, &block)
+      end
+
+      def schema(value)
+        metadata[:response][:schema] = value
+      end
+
+      def header(name, attributes)
+        metadata[:response][:headers] ||= {}
+        metadata[:response][:headers][name] = attributes
+      end
+
+      def run_test!
+        # NOTE: rspec 2.x support
+        if RSPEC_VERSION < 3
+          before do
+            submit_request(example.metadata)
+          end
+
+          it "returns a #{metadata[:response][:code]} response" do
+            assert_response_matches_metadata(example.metadata)
+          end
+        else
+          before do |example|
+            submit_request(example.metadata)
+          end
+
+          it "returns a #{metadata[:response][:code]} response" do |example|
+            assert_response_matches_metadata(example.metadata)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rswag/specs/example_helpers.rb

@@ -0,0 +1,43 @@
+require 'rswag/specs/request_factory'
+require 'rswag/specs/response_validator'
+
+module Rswag
+  module Specs
+    module ExampleHelpers
+
+      def submit_request(api_metadata)
+        factory = RequestFactory.new(api_metadata, global_metadata(api_metadata[:swagger_doc]))
+
+        if RAILS_VERSION < 5
+          send(
+            api_metadata[:operation][:verb],
+            factory.build_fullpath(self),
+            factory.build_body(self),
+            factory.build_headers(self)
+          )
+        else
+          send(
+            api_metadata[:operation][:verb],
+            factory.build_fullpath(self),
+            {
+              params: factory.build_body(self),
+              headers: factory.build_headers(self)
+            }
+          )
+        end
+      end
+
+      def assert_response_matches_metadata(api_metadata)
+        validator = ResponseValidator.new(api_metadata, global_metadata(api_metadata[:swagger_doc]))
+        validator.validate!(response)
+      end
+
+      private
+
+      def global_metadata(swagger_doc)
+        swagger_docs = ::RSpec.configuration.swagger_docs
+        swagger_doc.nil? ? swagger_docs.values.first : swagger_docs[swagger_doc]
+      end
+    end
+  end
+end

data/lib/rswag/specs/railtie.rb

@@ -0,0 +1,10 @@
+module Rswag
+  module Specs
+    class Railtie < ::Rails::Railtie
+
+      rake_tasks do
+        load File.expand_path('../../../tasks/rswag-specs_tasks.rake', __FILE__)
+      end
+    end
+  end
+end

data/lib/rswag/specs/request_factory.rb

@@ -0,0 +1,70 @@
+require 'active_support/core_ext/hash/slice'
+require 'json'
+
+module Rswag
+  module Specs
+    class RequestFactory
+
+      def initialize(api_metadata, global_metadata)
+        @api_metadata = api_metadata
+        @global_metadata = global_metadata
+      end
+
+      def build_fullpath(example)
+        @api_metadata[:path].dup.tap do |t|
+          parameters_in(:path).each { |p| t.gsub!("{#{p[:name]}}", example.send(p[:name]).to_s) }
+          t.concat(build_query(example))
+          t.prepend(@global_metadata[:basePath] || '')
+        end
+      end
+
+      def build_query(example)
+        query_string = parameters_in(:query)
+          .map { |p| "#{p[:name]}=#{example.send(p[:name])}" }
+          .join('&')
+
+        query_string.empty? ? '' : "?#{query_string}"
+      end
+
+      def build_body(example)
+        body_parameter = parameters_in(:body).first
+        body_parameter.nil? ? '' : example.send(body_parameter[:name]).to_json
+      end
+
+      def build_headers(example)
+        headers = Hash[ parameters_in(:header).map { |p| [ p[:name], example.send(p[:name]).to_s ] } ]
+        headers.tap do |h|
+          produces = @api_metadata[:operation][:produces] || @global_metadata[:produces]
+          consumes = @api_metadata[:operation][:consumes] || @global_metadata[:consumes]
+          h['ACCEPT'] = produces.join(';') unless produces.nil?
+          h['CONTENT_TYPE'] = consumes.join(';') unless consumes.nil?
+        end
+      end
+
+      private
+
+      def parameters_in(location)
+        (@api_metadata[:operation][:parameters] || [])
+          .map { |p| p['$ref'] ? resolve_parameter(p['$ref']) : p } # resolve any references
+          .concat(resolve_api_key_parameters)
+          .select { |p| p[:in] == location }
+      end
+
+      def resolve_parameter(ref)
+        defined_params = @global_metadata[:parameters] 
+        key = ref.sub('#/parameters/', '')
+        raise "Referenced parameter '#{ref}' must be defined" unless defined_params && defined_params[key]
+        defined_params[key]
+      end
+
+      def resolve_api_key_parameters
+        @api_key_params ||= begin
+          global_requirements = (@global_metadata[:security] || {})
+          requirements = global_requirements.merge(@api_metadata[:operation][:security] || {})
+          definitions = (@global_metadata[:securityDefinitions] || {}).slice(*requirements.keys)
+          definitions.values.select { |d| d[:type] == :apiKey }
+        end
+      end
+    end
+  end
+end

data/lib/rswag/specs/response_validator.rb

@@ -0,0 +1,38 @@
+require 'json-schema'
+
+module Rswag
+  module Specs
+    class ResponseValidator
+
+      def initialize(api_metadata, global_metadata)
+        @api_metadata = api_metadata
+        @global_metadata = global_metadata
+      end
+
+      def validate!(response)
+        validate_code!(response.code)
+        validate_body!(response.body)
+      end
+
+      private
+
+      def validate_code!(code)
+        if code.to_s != @api_metadata[:response][:code].to_s
+          raise UnexpectedResponse, "Expected response code '#{code}' to match '#{@api_metadata[:response][:code]}'"
+        end
+      end
+
+      def validate_body!(body)
+        schema = @api_metadata[:response][:schema]
+        return if schema.nil?
+        begin
+          JSON::Validator.validate!(schema.merge(@global_metadata), body)
+        rescue JSON::Schema::ValidationError => ex
+          raise UnexpectedResponse, "Expected response body to match schema: #{ex.message}" 
+        end
+      end
+    end
+
+    class UnexpectedResponse < StandardError; end
+  end
+end

data/lib/rswag/specs/swagger_formatter.rb

@@ -0,0 +1,79 @@
+require 'active_support/core_ext/hash/deep_merge'
+require 'rspec/core/formatters/base_text_formatter'
+require 'swagger_helper'
+
+module Rswag
+  module Specs
+    class SwaggerFormatter
+
+      # NOTE: rspec 2.x support
+      if RSPEC_VERSION > 2
+        ::RSpec::Core::Formatters.register self, :example_group_finished, :stop
+      end
+
+      def initialize(output)
+        @output = output
+        @swagger_root = ::RSpec.configuration.swagger_root
+        raise ConfigurationError, 'Missing swagger_root. See swagger_helper.rb' if @swagger_root.nil?
+        @swagger_docs = ::RSpec.configuration.swagger_docs || []
+        raise ConfigurationError, 'Missing swagger_docs. See swagger_helper.rb' if @swagger_docs.empty?
+
+        @output.puts 'Generating Swagger docs ...'
+      end
+
+      def example_group_finished(notification)
+        # NOTE: rspec 2.x support
+        if RSPEC_VERSION > 2
+          metadata = notification.group.metadata
+        else
+          metadata = notification.metadata
+        end
+
+        return unless metadata.has_key?(:response)
+        swagger_doc = get_swagger_doc(metadata[:swagger_doc])
+        swagger_doc.deep_merge!(metadata_to_swagger(metadata))
+      end
+
+      def stop(notification=nil)
+        @swagger_docs.each do |url_path, doc|
+          file_path = File.join(@swagger_root, url_path)
+          dirname = File.dirname(file_path)
+          FileUtils.mkdir_p dirname unless File.exists?(dirname)
+
+          File.open(file_path, 'w') do |file|
+            file.write(JSON.pretty_generate(doc))
+          end
+
+          @output.puts "Swagger doc generated at #{file_path}"
+        end
+      end
+
+      private
+
+      def get_swagger_doc(tag)
+        return @swagger_docs.values.first if tag.nil?
+        raise ConfigurationError, "Unknown swagger_doc '#{tag}'" unless @swagger_docs.has_key?(tag)
+        @swagger_docs[tag]
+      end
+
+      def metadata_to_swagger(metadata)
+        response_code = metadata[:response][:code]
+        response = metadata[:response].reject { |k,v| k == :code }
+        verb = metadata[:operation][:verb]
+        operation = metadata[:operation]
+          .reject { |k,v| k == :verb }
+          .merge(responses: { response_code => response })
+
+        {
+          paths: {
+            metadata[:path] => {
+              verb => operation
+            }
+          }
+        }
+      end
+    end
+
+    class ConfigurationError < StandardError; end
+  end
+end

data/lib/rswag/specs/version.rb

@@ -0,0 +1,5 @@
+module Rswag
+  module Specs
+    VERSION = '1.0.0'
+  end
+end

data/lib/rswag/specs.rb

@@ -0,0 +1,22 @@
+require 'rspec/core'
+require 'rswag/specs/version'
+require 'rswag/specs/example_group_helpers'
+require 'rswag/specs/example_helpers'
+require 'rswag/specs/railtie' if defined?(Rails::Railtie)
+
+module Rswag
+  module Specs
+
+    # Extend RSpec with a swagger-based DSL
+    ::RSpec.configure do |c|
+      c.add_setting :swagger_root
+      c.add_setting :swagger_docs
+      c.extend ExampleGroupHelpers, type: :request
+      c.include ExampleHelpers, type: :request
+    end
+
+    # Support Rails 3+ and RSpec 2+ (sigh!)
+    RAILS_VERSION = Rails::VERSION::MAJOR
+    RSPEC_VERSION = RSpec::Core::Version::STRING.split('.').first.to_i
+  end
+end

data/lib/tasks/rswag-specs_tasks.rake

@@ -0,0 +1,18 @@
+require 'rspec/core/rake_task'
+
+namespace :rswag do
+  namespace :specs do
+
+    desc 'Generate Swagger JSON files from integration specs'
+    RSpec::Core::RakeTask.new('swaggerize') do |t|
+      t.pattern = 'spec/requests/**/*_spec.rb, spec/api/**/*_spec.rb, spec/integration/**/*_spec.rb'
+
+      # NOTE: rspec 2.x support
+      if Rswag::Specs::RSPEC_VERSION > 2
+        t.rspec_opts = [ '--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined' ]
+      else
+        t.rspec_opts = [ '--format Rswag::Specs::SwaggerFormatter', '--order defined' ]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rswag-specs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Richie Morris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Simplify API integration testing with a succinct rspec DSL and generate
+  Swagger files directly from your rspecs
+email:
+- domaindrivendev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/rswag/specs/install/USAGE
+- lib/generators/rswag/specs/install/install_generator.rb
+- lib/generators/rswag/specs/install/templates/swagger_helper.rb
+- lib/rswag/specs.rb
+- lib/rswag/specs/example_group_helpers.rb
+- lib/rswag/specs/example_helpers.rb
+- lib/rswag/specs/railtie.rb
+- lib/rswag/specs/request_factory.rb
+- lib/rswag/specs/response_validator.rb
+- lib/rswag/specs/swagger_formatter.rb
+- lib/rswag/specs/version.rb
+- lib/tasks/rswag-specs_tasks.rake
+homepage: https://github.com/domaindrivendev/rswag
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Swagger-based DSL for rspec-rails & accompanying rake task for generating
+  Swagger files
+test_files: []