Merge pull request #56 from civisanalytics/ref_or_properties

Recursively parse non-ref response schemas

Author: jeffreyc

CHANGELOG.md

@@ -5,6 +5,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Fixed
+
+* [#56](https://github.com/civisanalytics/swagger-diff/pull/56)
+  recursively parse non-ref response schemas (`properties` and `items`)
+
 ## [1.1.1] - 2017-08-23
 
 ### Added

lib/swagger/diff/specification.rb

@@ -172,19 +172,28 @@ def properties_for_param(prefix, definition)
         properties_for_ref(prefix, definition['name'], definition, required)
       end
 
-      def properties_for_ref(prefix, name, schema, required, list = false)
+      # rubocop:disable Metrics/ParameterLists
+      def add_property(ret, prefix, name, schema, required, list)
         key = "#{prefix}#{name}"
+        ret[:required].add(key) if required && required.include?(name)
+        loc = if schema['in']
+                schema['in']
+              else
+                'body'
+              end
+        ret[:all].add("#{key} (in: #{loc}, type: #{schema['type']}#{'[]' if list})")
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def properties_for_ref(prefix, name, schema, required, list = false)
         ret = { required: Set.new, all: Set.new }
-        if schema.key?('$ref')
+        if schema['$ref']
           merge_refs!(ret, nested(schema['$ref'], prefix, name, list))
+        elsif schema['properties']
+          prefix = "#{name}#{'[]' if list}/"
+          merge_refs!(ret, properties(schema['properties'], schema['required'], prefix))
         else
-          ret[:required].add(key) if required && required.include?(name)
-          loc = if schema['in']
-                  schema['in']
-                else
-                  'body'
-                end
-          ret[:all].add("#{key} (in: #{loc}, type: #{schema['type']}#{'[]' if list})")
+          add_property(ret, prefix, name, schema, required, list)
         end
         ret
       end
@@ -211,16 +220,15 @@ def hash_property(definition, prefix, name = '')
         "#{key} (in: body, type: Hash[string, #{type}])"
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       def properties(properties, required, prefix = '')
         ret = { required: Set.new, all: Set.new }
         properties.each do |name, schema|
           if schema['type'] == 'array'
             merge_refs!(ret, properties_for_ref(prefix, name, schema['items'], required, true))
-          elsif schema['type'] == 'object'
+          elsif schema['type'] == 'object' || schema['properties']
             if schema['allOf']
               # TODO: handle nested allOfs.
-            elsif schema['type'] && schema['type'] == 'object' && schema['properties']
+            elsif schema['properties']
               merge_refs!(ret, properties(schema['properties'], required, "#{prefix}#{name}/"))
             else
               ret[:all].add(hash_property(schema, prefix, name))
@@ -231,7 +239,6 @@ def properties(properties, required, prefix = '')
         end
         ret
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       def request_params_inner(params)
         ret = { required: Set.new, all: Set.new }

spec/swagger/diff/specification_spec.rb

@@ -420,6 +420,37 @@
       end
     end
 
+    describe 'response properties' do
+      let(:paths) do
+        { '/a/' =>
+          { 'get' =>
+            { 'responses' =>
+              { '200' =>
+                { 'description' => 'A generic response',
+                  'schema' =>
+                  { 'properties' =>
+                    { 'data' =>
+                      { 'type' => 'array',
+                        'items' =>
+                        { 'properties' =>
+                          { 'obj' =>
+                            { 'properties' =>
+                              { 'id' => { 'type' => 'integer' },
+                                'name' => { 'type' => 'string' },
+                                'strings' =>
+                                { 'type' => 'array',
+                                  'items' => { 'type' => 'string' } } } } } } } } } } } } } }
+      end
+
+      it 'parses properties recursively' do
+        expect(spec.response_attributes)
+          .to eq('get /a/' =>
+                 { '200' => Set.new(['data[]/obj/id (in: body, type: integer)',
+                                     'data[]/obj/name (in: body, type: string)',
+                                     'data[]/obj/strings (in: body, type: string[])']) })
+      end
+    end
+
     describe 'response refs' do
       let(:paths) do
         { '/a/' =>