swagger-diff 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ddac5fb36158431f343142208ecd61a858bd66cf
-  data.tar.gz: 74fab6bd47f4cf4c52865451bb25dc0fa082591b
+SHA256:
+  metadata.gz: 77e08e6693a59f44f05a4e2afad7ac7e6050d7b3991e5321ab600562676850ad
+  data.tar.gz: 5637e276a82f0db237e75cef473115016992303d5d80e1f369428bd1be3e4050
 SHA512:
-  metadata.gz: b23daecdda524a3181d6c321a73ddabcd6a1431320caccebd1fee8a17ff33c4cd5bc74385e1a97b268f7d2c02faecc87573ed1d8c60310076b707722b9db466b
-  data.tar.gz: 2213e486e794349ea51a0dc38fcd4d3f03748285a40050b0e1c4a070b75e22ffc65ad842742c44b1ce31576d2e3a558399dfe05238108167ec05e2887fc4aae4
+  metadata.gz: 35005cdb5e4fd49a87573d18609cbc6dbdbd7ddcd3f7034fa54ef2fd259ad08ebaba9927adfc066afb9e2d5908461110ef4664d4df8adf30fea3062ed1bab9f3
+  data.tar.gz: 3b84d0a98e462afc139976b855bbfde692bf96cc5bbb54e186d4e2d7f57cc3de2892a6d0d117769924a5953118d53f0f621c2731a2d5a1ef739db01163540331

data/.rubocop.yml

@@ -1,7 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Metrics/AbcSize:
@@ -15,7 +16,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 250
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
@@ -31,7 +32,7 @@ Security/YAMLLoad:
 Style/Documentation:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
 Style/FrozenStringLiteralComment:

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+3.2.1

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.7.7
+  - 3.0.5
+  - 3.1.3
+  - 3.2.1
 before_install:
   - gem update --system
   - rvm @global do gem install bundler

data/CHANGELOG.md

@@ -5,6 +5,24 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [2.0.0]
+
+### Changed
+
+* Bumped the Ruby version for development to 2.7.7
+* Bumped the RuboCop version for development to 1.48.0
+* Bumped the Travis matrix to 2.7.7, 3.0.5, 3.1.3, 3.2.1
+* Bumped the Pry version for development to 0.14.1
+* Bumped the VCR version for development to 6.1
+* RuboCop fixes
+
+## [1.1.2] - 2017-09-13
+
+### 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
@@ -97,7 +115,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 * Initial Release
 
-[Unreleased]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.1...HEAD
+[2.0.0]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.2...v2.0.0
+[1.1.2]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/civisanalytics/swagger-diff/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/civisanalytics/swagger-diff/compare/v1.0.5...v1.1.0
 [1.0.5]: https://github.com/civisanalytics/swagger-diff/compare/v1.0.4...v1.0.5

data/README.md

@@ -2,7 +2,6 @@
 
 [![Build Status](https://travis-ci.org/civisanalytics/swagger-diff.svg?branch=master)](https://travis-ci.org/civisanalytics/swagger-diff)
 [![Gem Version](https://badge.fury.io/rb/swagger-diff.svg)](http://badge.fury.io/rb/swagger-diff)
-[![Dependency Status](https://gemnasium.com/civisanalytics/swagger-diff.svg)](https://gemnasium.com/civisanalytics/swagger-diff)
 
 ![Swagger::Diff in action](swagger-diff.gif)
 
@@ -31,7 +30,7 @@ Specifications are considered backwards compatible if:
 It can also be used to enumerate all changes between two specifications (*i.e.*,
 to generate a changelog).
 
-Read more on the [Civis Analytics blog](https://civisanalytics.com/blog/engineering/2015/10/02/using-swagger-to-detect-breaking-api-changes/).
+Read more on the [Civis Analytics blog](https://www.civisanalytics.com/blog/if-it-loses-its-quack-does-it-still-talk-like-a-duck-using-swagger-to-detect-breaking-api-changes/).
 
 ## Installation
 

data/lib/swagger/diff/diff.rb

@@ -133,6 +133,7 @@ module Swagger
       def new_child?(req, old)
         idx = req.rindex('/')
         return false unless idx
+
         key = req[0..idx]
         old.none? { |param| param.start_with?(key) }
       end
@@ -142,8 +143,10 @@ module Swagger
           from.request_params.each do |key, old_params|
             new_params = to.request_params[key]
             next if new_params.nil?
+
             (new_params[:required] - old_params[:required]).each do |req|
               next if new_child?(req, old_params[:all])
+
               yielder << [key, format(req_msg, req: req)]
             end
             (old_params[:all] - new_params[:all]).each do |req|
@@ -181,7 +184,8 @@ module Swagger
           from.response_attributes.each do |key, old_attributes|
             new_attributes = to.response_attributes[key]
             next if new_attributes.nil?
-            old_attributes.keys.each do |code|
+
+            old_attributes.each_key do |code|
               if new_attributes.key?(code)
                 (old_attributes[code] - new_attributes[code]).each do |resp|
                   yielder << [key, format(attr_msg, code: code, resp: resp)]

data/lib/swagger/diff/specification.rb

@@ -14,46 +14,48 @@ module Swagger
 
       def request_params
         @request_params ||= begin
-                              ret = {}
-                              @endpoint_hash.each do |key, endpoint|
-                                ret[key] = request_params_inner(params_or_nil(endpoint))
-                              end
-                              ret
-                            end
+          ret = {}
+          @endpoint_hash.each do |key, endpoint|
+            ret[key] = request_params_inner(params_or_nil(endpoint))
+          end
+          ret
+        end
       end
 
       def response_attributes
         @response_attributes ||= begin
-                                   ret = {}
-                                   @endpoint_hash.each do |key, endpoint|
-                                     ret[key] = response_attributes_inner(endpoint)
-                                   end
-                                   ret
-                                 end
+          ret = {}
+          @endpoint_hash.each do |key, endpoint|
+            ret[key] = response_attributes_inner(endpoint)
+          end
+          ret
+        end
       end
 
       private
 
-      def merge_refs!(h1, h2)
-        h2.each do |k, v|
-          if h1.include?(k)
-            h1[k] += h1[k].merge(v)
+      def merge_refs!(hash1, hash2)
+        hash2.each do |k, v|
+          if hash1.include?(k)
+            hash1[k] += hash1[k].merge(v)
           else
-            h1[k] = v
+            hash1[k] = v
           end
         end
       end
 
       def params_or_nil(endpoint)
-        endpoint && endpoint['parameters'] || nil
+        (endpoint && endpoint['parameters']) || nil
       end
 
       def parse_swagger(swagger)
         if swagger.is_a? Hash
           swagger
         else
-          if File.exist?(swagger) || swagger[0..7] =~ %r{^https?://}
-            swagger = open(swagger).read
+          if File.exist?(swagger)
+            swagger = File.read(swagger)
+          elsif swagger[0..7] =~ %r{^https?://}
+            swagger = URI.parse(swagger).read
           end
           begin
             JSON.parse(swagger)
@@ -104,7 +106,7 @@ module Swagger
                  {}
                end
         idx = ref.rindex('/')
-        key = ref[idx + 1..-1]
+        key = ref[idx + 1..]
         schema(defs.fetch(key, {}), prefix)
       end
 
@@ -150,7 +152,7 @@ module Swagger
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/AbcSize
 
-      def nested(ref, prefix, name, list = false)
+      def nested(ref, prefix, name, list: false)
         # Check for cycles by testing whether name was already added to
         # prefix.
         key = "#{prefix}#{name}#{'[]' if list}"
@@ -172,19 +174,24 @@ module Swagger
         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&.include?(name)
+        loc = schema['in'] || 'body'
+        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')
-          merge_refs!(ret, nested(schema['$ref'], prefix, name, list))
+        if schema['$ref']
+          merge_refs!(ret, nested(schema['$ref'], prefix, name, list: 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 +218,15 @@ module Swagger
         "#{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'
+            merge_refs!(ret, properties_for_ref(prefix, name, schema['items'], required, list: true))
+          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,11 +237,11 @@ module Swagger
         end
         ret
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       def request_params_inner(params)
         ret = { required: Set.new, all: Set.new }
         return ret if params.nil?
+
         params.each do |param|
           if param['in'] == 'body'
             merge_refs!(ret, schema(param['schema']))
@@ -280,6 +286,7 @@ module Swagger
         JSON::Validator.add_schema(json_schema)
         errors = JSON::Validator.fully_validate(schema_for('oai'), JSON.dump(@parsed))
         return if errors.empty?
+
         spec = if @spec.to_s.length > 80
                  "#{@spec.to_s[0..74]} ..."
                else

data/lib/swagger/diff/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Diff
-    VERSION = '1.1.1'.freeze
+    VERSION = '2.0.0'.freeze
   end
 end

data/swagger-diff.gemspec

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'swagger/diff/version'
 
@@ -27,15 +25,16 @@ 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.0'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_dependency 'json-schema', '~> 2.6'
+  spec.add_dependency 'json-schema', '~> 3.0'
   spec.add_dependency 'rspec-expectations', '~> 3.3'
-  spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'bundler', '~> 2.4.9'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'pry', '~> 0.10.1'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
-  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.48.1'
+  spec.add_development_dependency 'vcr', '~> 6.1'
   spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-diff
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeff Cousens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
@@ -44,84 +44,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.4.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: 2.4.9
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 1.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 1.48.1
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -176,24 +176,24 @@ files:
 homepage: https://github.com/civisanalytics/swagger-diff
 licenses:
 - BSD 3-Clause
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Utility for comparing two OAI (fka Swagger) specifications.