rspec-rails-api 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: df99a2088657641a87ec55c6159cdf7973d75863718f94aebef6cc70d7b4ac95
-  data.tar.gz: 4bf341e1fc70d6dfe760a531e43aec6c4c8002b3c1000fe83d1b2ae3cac3f3a0
+SHA1:
+  metadata.gz: '078c84277a76bd17ba55a74621786e39a5fc016c'
+  data.tar.gz: 8d9cb8744200020c3dbefb0936f56c761ac47d59
 SHA512:
-  metadata.gz: 42b42ba732de1383324dde829463f6a042289f184a959a9dc1c8ff727d8fd56699f7e97f40d215f184f724249517be826f5de4a66a5e684593a166ee25843624
-  data.tar.gz: 2daa6738912fcf4192e7c155a6744400420cabb5b1422de6dca77d34ece4dee59528d228b85af52fed0e5eaa17aebb4d14b06ca46e913a81c46318c8b11b67da
+  metadata.gz: 1831e37f21cde2aed080f9bc9f0e1b77e54a982cd7a75d8f78acdc0fd37159df82efae1d24c2fb2fa0d60566a0f753a5e1d7e03d98a89badb2aff0d8635153a4
+  data.tar.gz: 232482ef059cc827136d4d17b23fec9fe3baa113bf9c718c8573b18f9c6493d6f8cbba6bdb61e4b36651ab401107da450859332230215d97e7daa077a7b50114

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
   - rubocop-performance
 
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - dummy/**/*
     - vendor/bundle/**/*
@@ -17,11 +18,11 @@ Metrics/LineLength:
   Exclude:
     - spec/**/*_spec.rb
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - of
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
 

data/CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 ## Not released
 
+## 0.2.3 - 2019-12-04
+
+### Improved
+
+- Generated Swagger file now use the payloads of POST/PATCH/PUT requests.
+- Minimum Ruby version is now specified: Ruby 2.3.3.
+
 ## 0.2.1/0.2.2 - 2019-11-03
 
 _Version 0.2.1 was released and yanked by mistake. Version 0.2.2 is the exact

data/lib/rspec/rails/api/open_api_renderer.rb

@@ -142,7 +142,8 @@ module RSpec
             if path_config[:actions][action_config][:params].keys.count.positive?
               schema       = path_config[:actions][action_config][:params]
               schema_ref   = escape_operation_id("#{action_config}_#{path}")
-              request_body = process_request_body schema: schema, ref: schema_ref
+              examples     = process_examples(path_config[:actions][action_config][:statuses])
+              request_body = process_request_body schema: schema, ref: schema_ref, examples: examples
             end
           end
 
@@ -166,14 +167,15 @@ module RSpec
         end
         # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-        def process_request_body(schema: nil, ref: nil)
+        def process_request_body(schema: nil, ref: nil, examples: {})
           Utils.deep_set @api_components, "schemas.#{ref}", schema
           {
             # description: '',
             required: true,
             content:  {
               'application/json' => {
-                schema: { '$ref' => "#/components/schemas/#{ref}" },
+                schema:   { '$ref' => "#/components/schemas/#{ref}" },
+                examples: examples,
               },
             },
           }
@@ -184,7 +186,7 @@ module RSpec
             description: status_config[:description],
           }
 
-          return response unless status.to_s != '204' && content # No content
+          return response if status.to_s == '204' && content # No content
 
           response[:content] = {
             'application/json': {
@@ -195,6 +197,19 @@ module RSpec
           response
         end
 
+        def process_examples(statuses)
+          request_examples = {}
+
+          statuses.each do |code, request|
+            request_examples[code] = {
+              summary: "Example for a #{code} code",
+              value:   request[:example][:params],
+            }
+          end
+
+          request_examples
+        end
+
         def path_with_params(string)
           string.gsub(/(?::(\w*))/) do |e|
             "{#{e.sub(':', '')}}"

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.2.2'
+      VERSION = '0.2.3'
     end
   end
 end

data/rspec-rails-api.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.3.3'
+
   spec.add_development_dependency 'activesupport', '>= 5.2'
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'byebug'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-03 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Tests standard Rails API responses and generate doc