swagger-diff 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ae6fdf94f4dc25c8bfbf9f42bb07ff0ebba67af
-  data.tar.gz: 9e8f57a36a415c6b4fc81d0cb3c78d141aa99e8b
+  metadata.gz: 8152e95fa05dcd25376b7f726edab41888836072
+  data.tar.gz: 752d5db3f0c6410341336930e1b70a28ac524862
 SHA512:
-  metadata.gz: c00e84cc7383e90c6ef54c58b6f0223148bd7aed155fe5abaf8501620eea913fc8232cf51decf13fdbf05b309dba541db89e4d65b33cbf9a1c731b2cba78423a
-  data.tar.gz: fd40d8875ffd46534e3b1780290c8bef4beeb9f21280b862636225ccf954ac541c139d4286210b91653b7ac2e6c29f30a948a2defe68567c08d8c0b48bf6333e
+  metadata.gz: c3e70c465faaf5936d41ff58e6765ad841dd36c10037050fd3b6e274bf7c8cad23ad302400cf21468b8bb747eaaef0cf13e63831b72689a2e6ae34643fb6c0f4
+  data.tar.gz: d6456a1a767e7bcace9da7cda0f8de1b0c1542ab93b24ee977a846e5d2441f5c1ae43e680f540f9e9cc2d3a8e6d96bd0271fa2a2c36207d140f07877f20f8bf7

data/.travis.yml

@@ -1,2 +1,5 @@
 language: ruby
 cache: bundler
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 1.0.4 (2015-11-11)
+
+### Bugs Fixed
+
+* [#14](https://github.com/civisanalytics/swagger-diff/pull/14)
+  allow schema definitions without properties
+* [#15](https://github.com/civisanalytics/swagger-diff/pull/15)
+  parse non-ref response schemas (`allOf`, `properties`, and `items`)
+
 ## 1.0.3 (2015-11-04)
 
 ### Changes

data/README.md

@@ -57,8 +57,8 @@ Specifications can be any
   `http://host.domain/swagger.yml`)
 - a Hash containing a parsed Swagger specification (*e.g.*, the output of
   `JSON.parse`)
-- a string of JSON containing Swagger specification
-- a string of YAML containing Swagger specification
+- a string of JSON containing a Swagger specification
+- a string of YAML containing a Swagger specification
 
 ### RSpec
 
@@ -85,14 +85,14 @@ request parameters, and response attributes; *e.g.*,
 ```ruby
 { endpoints: ['put /a/{}'],
   request_params: {
-    'get /a/' => ['missing request param: limit (type: integer)'],
+    'get /a/' => ['missing request param: limit (in: query, type: integer)'],
     'post /a/' => ['new required request param: extra'],
     'put /b/{}' => ['new required request param: extra']
   },
   response_attributes: {
-    'post /a/' => ['missing attribute from 200 response: description (type: string)'],
-    'get /a/{}' => ['missing attribute from 200 response: description (type: string)'],
-    'put /b/{}' => ['missing attribute from 200 response: description (type: string)']
+    'post /a/' => ['missing attribute from 200 response: description (in: body, type: string)'],
+    'get /a/{}' => ['missing attribute from 200 response: description (in: body, type: string)'],
+    'put /b/{}' => ['missing attribute from 200 response: description (in: body, type: string)']
   }
 }
 ```

data/lib/swagger/diff/patch.rb

@@ -13,3 +13,17 @@ OAUTH2_PARAMS = [:flow, :authorizationUrl, :scopes]
 Swagger::V2::SecurityScheme.required_properties.reject! do |k, _|
   OAUTH2_PARAMS.include?(k)
 end
+
+# Workaround for Swagger::V2::Operation[1] not including deprecated. Patching
+# pending a merge/release of #11[2].
+#
+# [1] https://github.com/swagger-rb/swagger-rb/blob/master/lib/swagger/v2/operation.rb
+# [2] https://github.com/swagger-rb/swagger-rb/pull/12/files
+
+module Swagger
+  module V2
+    class Operation
+      field :deprecated, String
+    end
+  end
+end

data/lib/swagger/diff/specification.rb

@@ -84,22 +84,40 @@ module Swagger
       # parameter definitions (i.e., all parameters, including nested
       # parameters, are included in a single set).
       def refs(ref, prefix = '')
-        definitions = @parsed.definitions
         idx = ref.rindex('/')
         key = ref[idx + 1..-1]
-        ret = {}
-        if definitions[key].allOf
-          definitions[key].allOf.each do |schema|
-            if schema['$ref']
-              merge_refs!(ret, refs(schema['$ref'], prefix))
-            else
-              merge_refs!(ret, properties(schema.properties, schema.required, prefix))
-            end
+        schema(@parsed.definitions[key], prefix)
+      end
+
+      def all_of!(definitions, prefix, ret)
+        definitions.each do |s|
+          if s['$ref']
+            merge_refs!(ret, refs(s['$ref'], prefix))
+          else
+            merge_refs!(ret, schema(s, prefix))
           end
-        else
+        end
+        ret
+      end
+
+      def array?(definition)
+        definition.type && definition.type == 'array' && definition.items
+      end
+
+      def schema(definition, prefix = '')
+        ret = { required: Set.new, all: Set.new }
+        if definition.allOf
+          all_of!(definition.allOf, prefix, ret)
+        elsif definition['$ref']
+          merge_refs!(ret, refs(definition['$ref'], prefix))
+        elsif definition.properties
           merge_refs!(ret,
-                      properties(definitions[key].properties,
-                                 definitions[key].required, prefix))
+                      properties(definition.properties,
+                                 definition.required, prefix))
+        elsif array?(definition)
+          merge_refs!(ret, schema(definition.items, "#{prefix}[]/"))
+        elsif definition.type == 'object'
+          ret[:all].add(hash_property(definition, prefix))
         end
         ret
       end
@@ -129,6 +147,28 @@ module Swagger
         ret
       end
 
+      def hash_property(definition, prefix, name = '')
+        # Swagger 2.0 doesn't appear to support non-string keys[1]. If
+        # this changes, this will need to be updated.
+        # [1] https://github.com/swagger-api/swagger-spec/issues/299
+        # TODO: this doesn't handle hashes of objects.
+        key = if name == ''
+                # Remove the trailing slash, if present and no name was
+                # specified (a prefix will always either be blank or end in a
+                # trailing slash).
+                prefix[0..-2]
+              else
+                "#{prefix}#{name}"
+              end
+        type = if definition.additionalProperties &&
+                  definition.additionalProperties.type
+                 definition.additionalProperties.type
+               else
+                 '*'
+               end
+        "#{key} (in: body, type: Hash[string, #{type}])"
+      end
+
       def properties(properties, required, prefix = '')
         ret = { required: Set.new, all: Set.new }
         properties.each do |name, schema|
@@ -138,17 +178,7 @@ module Swagger
             if schema.allOf
               # TODO: handle nested allOfs.
             else
-              # Swagger 2.0 doesn't appear to support non-string keys[1]. If
-              # this changes, this will need to be updated.
-              # [1] https://github.com/swagger-api/swagger-spec/issues/299
-              # TODO: this doesn't handle hashes of objects.
-              type = if schema.additionalProperties &&
-                        schema.additionalProperties.type
-                       schema.additionalProperties.type
-                     else
-                       '*'
-                     end
-              ret[:all].add("#{prefix}#{name} (in: body, type: Hash[string, #{type}])")
+              ret[:all].add(hash_property(schema, prefix, name))
             end
           else
             merge_refs!(ret, properties_for_ref(prefix, name, schema, required))
@@ -175,14 +205,7 @@ module Swagger
         ret = {}
         endpoint.responses.each do |code, response|
           if response.schema
-            if response.schema.include?('type') && response.schema.type == 'array'
-              ref = response.schema.items['$ref']
-              prefix = '[]/'
-            else
-              ref = response.schema['$ref']
-              prefix = ''
-            end
-            ret[code] = refs(ref, prefix)[:all]
+            ret[code] = schema(response.schema)[:all]
           else
             ret[code] = Set.new
           end

data/lib/swagger/diff/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Diff
-    VERSION = '1.0.3'
+    VERSION = '1.0.4'
   end
 end

data/swagger-diff.gemspec

@@ -28,7 +28,7 @@ and helper functions that can be used directly.'
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'pry', '~> 0.10.1'
-  spec.add_development_dependency 'rubocop', '~> 0.34.0'
-  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'rubocop', '~> 0.35.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.21'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-diff
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Jeff Cousens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swagger-core
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.0
+        version: 0.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.0
+        version: 0.35.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -195,4 +195,3 @@ signing_key:
 specification_version: 4
 summary: Utility for comparing two Swagger specifications.
 test_files: []
-has_rdoc: