rspec-rails-api 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74591eecb7e2b200f536ca31e72097ed9921da563a87490288f536edec32f728
-  data.tar.gz: a5ec7199c37b2bf493eec385b3f294561acfa409c46dac9d744f1d7679a37f30
+  metadata.gz: 9090792ade8b44f18851585ce025a354fab47ff9cb7903ae61982507c34302bf
+  data.tar.gz: 26551e11739758d40987f7026cc556e475952f79419cb24abf5df4207ba40364
 SHA512:
-  metadata.gz: 4922b2a7257f432048f37cb9d73faf8b0b15a7750760429f3f29b657d282b5e556e9b380813843574d5be116ed040bd71a91ddb2301f0d65df6f38b70981204d
-  data.tar.gz: b82d1c509e096f1ac04bebe56dbed7a4ed9e49a9de47b525cae0bba2355033ed61a727a17fb9691701f10dc0ba36be4c00a9b62531c2621b302910a25d200511
+  metadata.gz: 4bc1803ab38dc596f0fbf3993da2f860e22849f1d2e9c68be91e860b36684ee3bf0129a98972afca1d7f65869531c6cc8aa0f36d66aa91d97f92ebbad69cfff1
+  data.tar.gz: b96392b596dd83d1de832b62a72d54afbed0f0a556c36bbf7627ed2fbec7c36d59c4d1d935186e3de62f72524243bf75f92a6429bc492cf559ebb22751e74dcc

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   Exclude:
     - dummy/**/*
     - vendor/bundle/**/*
+  NewCops: enable
 
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 All notable changes to this project will be documented in this file.
 
 ## Not released
+## 0.3.4 - 2021-10-20
+- Add the "required" attribute in parameters
+
+## 0.3.3 - 2021-06-02
+- Fix correct types on request parameters
+
+## 0.3.2 - 2021-03-09
+- Fix YAML rendering (ruby objects were sometimes rendered in documentation)
+- Render examples results as YAML/JSON objects instead of text blocks.
+
+## 0.3.1 - 2020-04-09
+- Add support for "test only" examples, allowing to write examples without documentation.
 
 ## 0.3.0 - 2019-12-26
 

data/README.md

@@ -380,7 +380,7 @@ on_post '/api/items' do
 end
 ```
 
-##### `for_code(http_status, description = nil, doc_only: false &block)`
+##### `for_code(http_status, description = nil, doc_only: false, test_only: false &block)`
 
 Describes the desired output for a precedently defined URL.
 
@@ -388,6 +388,9 @@ Block takes one required argument, that should be passed to `visit`.
 This argument will contain the block context and allow `visit` to access
 the metadatas.
 
+You can have only one documented code per action/url, unless you use
+`test_only`.
+
 - `http_status` is an integer representing an
   [HTTP status](https://httpstat.us/)
 - `description` should be some valid
@@ -395,6 +398,8 @@ the metadatas.
   translation of the `http_status` will be used.
 - `doc_only` can be set to true to temporarily disable block execution
   and only create the documentation (without examples).
+- `test_only` will omit the test from the documentation. Useful when you
+  need to test things _around_ the call (response content, db,...)
 - `block` where additional tests can be performed. If `visit()` is
   called within the block, its output will be used in documentation
   examples, and the response type and code will actually be tested.
@@ -412,6 +417,11 @@ Once again, you have to pass an argument to the block if you use
     visit url
     # ...
   end
+  
+  for_code 200, 'Side test', test_only: true do |url|
+    visit url
+    # ...
+  end
 # ...
 ```
 

data/lib/rspec/rails/api/dsl/example.rb

@@ -6,7 +6,7 @@ module RSpec
       module DSL
         # These methods will be available in examples (i.e.: 'for_code')
         module Example
-          def visit(example, path_params: {}, payload: {}, headers: {}) # rubocop:disable Metrics/AbcSize
+          def visit(example, path_params: {}, payload: {}, headers: {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
             raise 'Missing context. Call visit with for_code context.' unless example
 
             status_code = prepare_status_code example.class.description
@@ -21,6 +21,8 @@ module RSpec
 
             check_response(response, status_code)
 
+            return if example.class.description.match?(/-> test (\d+)(.*)/)
+
             set_request_example example.class.metadata[:rrad], request_params, status_code, response.body
           end
 
@@ -53,7 +55,7 @@ module RSpec
           end
 
           def prepare_request_params(description, request_params = {}, payload = {}, request_headers = {})
-            example_params = description.split ' '
+            example_params = description.split
 
             {
               action:      example_params[0].downcase,
@@ -86,7 +88,7 @@ module RSpec
           end
 
           def prepare_status_code(description)
-            code_match = /-> (\d+) - .*/.match description
+            code_match = /->(?: test)? (\d+) - .*/.match description
 
             raise 'Please provide a numerical code for the "for_code" block' unless code_match
 

data/lib/rspec/rails/api/dsl/example_group.rb

@@ -74,12 +74,12 @@ module RSpec
             describe("#{action.upcase} #{url}", &block)
           end
 
-          def for_code(status_code, description = nil, doc_only: false, &block)
+          def for_code(status_code, description = nil, doc_only: false, test_only: false, &block)
             description ||= Rack::Utils::HTTP_STATUS_CODES[status_code]
 
-            metadata[:rrad].add_status_code(status_code, description)
+            metadata[:rrad].add_status_code(status_code, description) unless test_only
 
-            describe "-> #{status_code} - #{description}" do
+            describe "->#{test_only ? ' test' : ''} #{status_code} - #{description}" do
               execute_for_code_block(status_code, doc_only, block)
             end
           end

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

@@ -11,7 +11,7 @@ module RSpec
       class FieldConfig
         attr_accessor :required, :type, :attributes, :description
 
-        def initialize(type:, required: true, description:, attributes: nil, of: nil)
+        def initialize(type:, description:, required: true, attributes: nil, of: nil)
           @required    = required
           @description = description
           raise "Field type not allowed: '#{type}'" unless Utils.check_attribute_type(type)
@@ -40,9 +40,10 @@ module RSpec
         private
 
         def define_attributes(attributes)
-          @attributes = if attributes.is_a? Hash
+          @attributes = case attributes
+                        when Hash
                           @attributes = EntityConfig.new attributes
-                        elsif attributes.is_a? Symbol
+                        when Symbol
                           attributes
                         end
         end

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

@@ -36,6 +36,9 @@ module RSpec
         def add_parameter(type, fields)
           raise "Parameter #{type} is already defined" if @parameters[type]
 
+          fields.each_value do |field|
+            field[:required] = true unless field[:required] == false
+          end
           @parameters[type] = fields
         end
 
@@ -87,7 +90,7 @@ module RSpec
           @current_method = method
         end
 
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         def add_status_code(status_code, description)
           check_current_context :resource, :url, :method
 
@@ -97,7 +100,7 @@ module RSpec
                          example:     { response: nil })
           @current_code = status_code
         end
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         # rubocop:disable Metrics/ParameterLists
         def add_request_example(url: nil, action: nil, status_code: nil, response: nil, path_params: nil, params: nil)
@@ -125,25 +128,14 @@ module RSpec
 
         private
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength, Style/GuardClause
-        def check_current_context(*scope)
+        def check_current_context(*scope) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           scope ||= []
-          if scope.include?(:resource)
-            raise 'No resource declared' unless @current_resource
-          end
-          if scope.include?(:method)
-            raise 'No action declared' unless @current_method
-          end
-          if scope.include?(:url)
-            raise 'No url declared' unless @current_url
-          end
-          if scope.include?(:code)
-            raise 'No status code declared' unless @current_code
-          end
+          raise 'No resource declared' if scope.include?(:resource) && !@current_resource
+          raise 'No action declared' if scope.include?(:method) && !@current_method
+          raise 'No url declared' if scope.include?(:url) && !@current_url
+          raise 'No status code declared' if scope.include?(:code) && !@current_code
         end
 
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength, Style/GuardClause
-
         def path_param_scope(url_chunks, name)
           if /:#{name}/.match?(url_chunks[0])
             :path
@@ -154,11 +146,12 @@ module RSpec
           end
         end
 
-        def organize_params(fields) # rubocop:disable Metrics/AbcSize
+        def organize_params(fields) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           out      = { properties: {} }
           required = []
+          allowed_types = %i[array object]
           fields.each do |name, field|
-            allowed_type = %i[array object].include?(field[:type]) || PARAM_TYPES.key?(field[:type])
+            allowed_type = allowed_types.include?(field[:type]) || PARAM_TYPES.key?(field[:type])
             raise "Field type not allowed: #{field[:type]}" unless allowed_type
 
             required.push name.to_s if field[:required]
@@ -174,7 +167,7 @@ module RSpec
             organize_params field[:properties]
           else
             properties = {
-              type:        field[:type].to_s,
+              type:        PARAM_TYPES[field[:type]][:type],
               description: field[:description] || nil,
             }
 

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

@@ -39,10 +39,12 @@ module RSpec
           content = prepare_metadata
           path ||= ::Rails.root.join('tmp', 'rspec_api_rails')
 
+          file_types = %i[yaml json]
+
           only.each do |type|
-            next unless %i[yaml json].include? type
+            next unless file_types.include? type
 
-            File.write "#{path}.#{type}", content.send("to_#{type}")
+            File.write "#{path}.#{type}", JSON.parse(JSON.pretty_generate(content)).send("to_#{type}")
           end
         end
 
@@ -89,13 +91,14 @@ module RSpec
         end
 
         def process_resource(resource: nil, resource_config: nil) # rubocop:disable Metrics/MethodLength
+          http_verbs = %i[get post put patch delete]
           resource_config[:paths].each do |path_key, path|
             url        = path_with_params path_key.to_s
             actions    = {}
             parameters = path.key?(:path_params) ? process_path_params(path[:path_params]) : []
 
             path[:actions].each_key do |action|
-              next unless %i[get post put patch delete].include? action
+              next unless http_verbs.include? action
 
               actions[action] = process_action resource:      resource,
                                                path:          path_key,
@@ -117,7 +120,7 @@ module RSpec
           parameters
         end
 
-        def process_path_param(name, param) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def process_path_param(name, param) # rubocop:disable Metrics/MethodLength
           parameter = {
             name:        name.to_s,
             description: param[:description],
@@ -138,13 +141,12 @@ module RSpec
           responses    = {}
           request_body = nil
 
-          if %i[post put patch].include? action_config
-            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}")
-              examples     = process_examples(path_config[:actions][action_config][:statuses])
-              request_body = process_request_body schema: schema, ref: schema_ref, examples: examples
-            end
+          if %i[post put
+                patch].include?(action_config) && path_config[:actions][action_config][:params].keys.count.positive?
+            schema = path_config[:actions][action_config][:params]
+            schema_ref   = escape_operation_id("#{action_config}_#{path}")
+            examples     = process_examples(path_config[:actions][action_config][:statuses])
+            request_body = process_request_body schema: schema, ref: schema_ref, examples: examples
           end
 
           path_config[:actions][action_config][:statuses].each do |status_key, status|
@@ -190,7 +192,7 @@ module RSpec
 
           response[:content] = {
             'application/json': {
-              examples: { default: { value: JSON.pretty_generate(JSON.parse(content)) } },
+              examples: { default: { value: JSON.parse(content) } },
             },
           }
 
@@ -220,7 +222,7 @@ module RSpec
           string.downcase.gsub(/[^\w]+/, '_')
         end
 
-        def api_infos # rubocop:disable Metrics/CyclomaticComplexity
+        def api_infos
           @api_infos = {
             title:   @api_title || 'Some sample app',
             version: @api_version || '1.0',

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

@@ -11,7 +11,7 @@ module RSpec
           path.split('.').inject(hash) do |sub_hash, key|
             return nil unless sub_hash.is_a?(Hash) && sub_hash.key?(key.to_sym)
 
-            sub_hash[key.to_sym]
+            sub_hash[key.to_sym] # rubocop:disable Lint/UnmodifiedReduceAccumulator
           end
         end
 
@@ -27,7 +27,7 @@ module RSpec
           hash
         end
 
-        def self.check_value_type(type, value) # rubocop:disable Metrics/CyclomaticComplexity
+        def self.check_value_type(type, value)
           return true if type == :boolean && (value.is_a?(TrueClass) || value.is_a?(FalseClass))
           return true if type == :array && value.is_a?(Array)
 

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

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.3.0'
+      VERSION = '0.3.4'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport