Merge pull request #475 from rswag/fix/workflow

Fix GH Actions being unable to bundle

.github/workflows/ruby.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7]
+        ruby: [2.6, 2.7, truffleruby-head]
         rails: [5.2.4.4, 6.0.3.4]
     env:
       RAILS_VERSION: ${{ matrix.rails }}
@@ -31,6 +31,7 @@ jobs:
 
     - name: Install dependencies
       run: |
+        gem update --system
         bundle install
         cd rswag-ui && npm install
 

CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Changed
+- Update swagger-ui to 3.52.5
+
+## [2.4.0] - 2021-02-09
+### Added
+- Added `SWAGGER_DRY_RUN` env variable [#274](https://github.com/rswag/rswag/pull/274)
+
 ## [2.3.3] - 2021-02-07
 
 ### Fixed

CONTRIBUTING.md

@@ -57,11 +57,11 @@ Push to your fork and [submit a Pull Request][pr].
 
 ## Updating Swagger UI
 
-Find the latest versions of swagger-ui here:  
+Find the latest versions of swagger-ui here:
 https://github.com/swagger-api/swagger-ui/releases
 
 Update the swagger-ui-dist version in the rswag-ui dependencies
-```  
+```
 ./rswag-ui/package.json
 ```
 

Gemfile

@@ -25,23 +25,25 @@ end
 gem 'rswag-api', path: './rswag-api'
 gem 'rswag-ui', path: './rswag-ui'
 
+group :development, :test do
+  gem 'rswag-specs', path: './rswag-specs'
+end
+
 group :test do
   gem 'capybara'
   gem 'geckodriver-helper'
   gem 'generator_spec'
   gem 'rspec-rails'
   gem 'selenium-webdriver'
-  gem 'rswag-specs', path: './rswag-specs'
   gem 'test-unit'
 end
 
 group :development do
-  gem 'rswag-specs', path: './rswag-specs'
   gem 'rubocop'
 end
 
 group :assets do
-  gem 'therubyracer'
+  gem 'mini_racer'
   gem 'uglifier'
 end
 

README.md

@@ -5,6 +5,8 @@ rswag
 
 OpenApi 3.0 and Swagger 2.0 compatible!
 
+Seeking maintainers! Got a pet-bug that needs fixing? Just let us know in your issue/pr that you'd like to step up to help.
+
 Rswag extends rspec-rails "request specs" with a Swagger-based DSL for describing and testing API operations. You describe your API operations with a succinct, intuitive syntax, and it automaticaly runs the tests. Once you have green tests, run a rake task to auto-generate corresponding Swagger files and expose them as YAML or JSON endpoints. Rswag also provides an embedded version of the awesome [swagger-ui](https://github.com/swagger-api/swagger-ui) that's powered by the exposed file. This toolchain makes it seamless to go from integration specs, which youre probably doing in some form already, to living documentation for your API consumers.
 
 Api Rswag creates [Swagger](http://swagger.io) tooling for Rails API's. Generate beautiful API documentation, including a UI to explore and test operations, directly from your rspec integration tests.
@@ -18,7 +20,7 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
 
 |Rswag Version|Swagger (OpenAPI) Spec.|swagger-ui|
 |----------|----------|----------|
-|[master](https://github.com/rswag/rswag/tree/master)|3.0.3|3.42.0|
+|[master](https://github.com/rswag/rswag/tree/master)|3.0.3|3.52.5|
 |[2.3.0](https://github.com/rswag/rswag/tree/2.3.0)|3.0.3|3.23.11|
 |[2.2.0](https://github.com/rswag/rswag/tree/2.2.0)|2.0|3.18.2|
 |[1.6.0](https://github.com/rswag/rswag/tree/1.6.0)|2.0|2.2.5|
@@ -136,7 +138,7 @@ There is also a generator which can help get you started `rails generate rspec:s
       path '/blogs/{id}' do
 
         get 'Retrieves a blog' do
-          tags 'Blogs'
+          tags 'Blogs', 'Another Tag'
           produces 'application/json', 'application/xml'
           parameter name: :id, in: :path, type: :string
 
@@ -616,15 +618,12 @@ after do |example|
 end
 ```
 
-You need to disable --dry-run option for Rspec > 3
+#### Dry Run Option ####
 
-<!-- This is now enabled by default in rswag.
-You need to set the ``` config.swagger_dry_run = false``` value in the spec/spec_helper.rb file.
-This is one of the more powerful features of rswag. When rswag runs your integration test suite via ```bundle exec rspec```, it will capture the request and response bodies and output those values in the examples section.
-These integration tests are usually written with ```let``` variables for post body parameters, and since its an integration test the service is returning actual values.
-We might as well re-use these values and embed them into the generated swagger to provide a more real world example for request/response examples. -->
+The `--dry-run` option is enabled by default for Rspec 3, but if you need to
+disable it you can use the environment varible `SWAGGER_DRY_RUN=0` during the
+generation command or add the following to your `config/environments/test.rb`:
 
-Add to config/environments/test.rb:
 ```ruby
 RSpec.configure do |config|
   config.swagger_dry_run = false

rswag-api/rswag-api.gemspec

@@ -15,5 +15,5 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile']
 
-  s.add_dependency 'railties', '>= 3.1', '< 7.0'
+  s.add_dependency 'railties', '>= 3.1', '< 7.1'
 end

rswag-specs/lib/rswag/specs/configuration.rb

@@ -28,9 +28,11 @@ module Rswag
       end
 
       def swagger_dry_run
-        @swagger_dry_run ||= begin
-          @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
+        return @swagger_dry_run if defined? @swagger_dry_run
+        if ENV.key?('SWAGGER_DRY_RUN')
+          @rspec_config.swagger_dry_run = ENV['SWAGGER_DRY_RUN'] == '1'
         end
+        @swagger_dry_run = @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
       end
 
       def swagger_format

rswag-specs/lib/rswag/specs/request_factory.rb

@@ -194,12 +194,36 @@ module Rswag
 
       def build_json_payload(parameters, example)
         body_param = parameters.select { |p| p[:in] == :body }.first
-        body_param ? example.send(body_param[:name]).to_json : nil
+
+        return nil unless body_param
+
+        raise(MissingParameterError, body_param[:name]) unless example.respond_to?(body_param[:name])
+
+        example.send(body_param[:name]).to_json
       end
 
       def doc_version(doc)
         doc[:openapi] || doc[:swagger] || '3'
       end
     end
+
+    class MissingParameterError < StandardError
+      attr_reader :body_param
+
+      def initialize(body_param)
+        @body_param = body_param
+      end
+
+      def message
+        <<~MSG
+          Missing parameter '#{body_param}'
+
+          Please check your spec. It looks like you defined a body parameter,
+          but did not declare usage via let. Try adding:
+
+              let(:#{body_param}) {}
+        MSG
+      end
+    end
   end
 end

rswag-specs/lib/rswag/specs/response_validator.rb

@@ -50,7 +50,11 @@ module Rswag
           .merge(schemas)
 
         errors = JSON::Validator.fully_validate(validation_schema, body)
-        raise UnexpectedResponse, "Expected response body to match schema: #{errors[0]}" if errors.any?
+        return unless errors.any?
+
+        raise UnexpectedResponse,
+              "Expected response body to match schema: #{errors[0]}\n" \
+              "Response body: #{JSON.pretty_generate(JSON.parse(body))}"
       end
 
       def definitions_or_component_schemas(swagger_doc, version)
@@ -62,7 +66,7 @@ module Rswag
             swagger_doc.slice(:definitions)
           else
             components = swagger_doc[:components] || {}
-            { components: { schemas: components[:schemas] } }
+            { components: components }
           end
         end
       end

rswag-specs/rswag-specs.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile']
 
-  s.add_dependency 'activesupport', '>= 3.1', '< 7.0'
-  s.add_dependency 'railties', '>= 3.1', '< 7.0'
+  s.add_dependency 'activesupport', '>= 3.1', '< 7.1'
+  s.add_dependency 'railties', '>= 3.1', '< 7.1'
   s.add_dependency 'json-schema', '~> 2.2'
 end

rswag-specs/spec/rswag/specs/request_factory_spec.rb

@@ -160,6 +160,21 @@ module Rswag
             end
           end
 
+          context 'missing body parameter' do
+            before do
+              metadata[:operation][:parameters] = [{ name: 'comment', in: :body, schema: { type: 'object' } }]
+              allow(example).to receive(:comment).and_raise(NoMethodError, "undefined method 'comment'")
+              allow(example).to receive(:respond_to?).with(:'Content-Type')
+              allow(example).to receive(:respond_to?).with('comment').and_return(false)
+            end
+
+            it 'uses the referenced metadata to build the request' do
+              expect do
+                request[:payload]
+              end.to raise_error(Rswag::Specs::MissingParameterError, /Missing parameter 'comment'/)
+            end
+          end
+
           context 'form payload' do
             before do
               metadata[:operation][:consumes] = ['multipart/form-data']

rswag-ui/package-lock.json

@@ -5,9 +5,9 @@
   "requires": true,
   "dependencies": {
     "swagger-ui-dist": {
-      "version": "3.42.0",
-      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.42.0.tgz",
-      "integrity": "sha512-hTNX6cX7KWtBZgk6ZQSOzsBJhqdCmD5NOIjb6dBPKSnYZidSkIXOcaPMR3+kwxLrj8bDC881bSDlNbLsHikacg=="
+      "version": "3.52.5",
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.52.5.tgz",
+      "integrity": "sha512-8z18eX8G/jbTXYzyNIaobrnD7PSN7yU/YkSasMmajrXtw0FGS64XjrKn5v37d36qmU3o1xLeuYnktshRr7uIFw=="
     }
   }
 }

rswag-ui/package.json

@@ -3,6 +3,6 @@
   "version": "1.0.0",
   "private": true,
   "dependencies": {
-    "swagger-ui-dist": "3.42.0"
+    "swagger-ui-dist": "3.52.5"
   }
 }

rswag-ui/rswag-ui.gemspec

@@ -15,6 +15,6 @@ Gem::Specification.new do |s|
 
   s.files = Dir.glob('{lib,node_modules}/**/*') + ['MIT-LICENSE', 'Rakefile' ]
 
-  s.add_dependency 'actionpack', '>=3.1', '< 7.0'
-  s.add_dependency 'railties', '>= 3.1', '< 7.0'
+  s.add_dependency 'actionpack', '>=3.1', '< 7.1'
+  s.add_dependency 'railties', '>= 3.1', '< 7.1'
 end