swagger-diff 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 638ec30e17eae19c41b449c5131505c8b3d8e5c9
-  data.tar.gz: 0b02d469a24f0900c609703adac3a799c27e30b4
+  metadata.gz: 7ae6fdf94f4dc25c8bfbf9f42bb07ff0ebba67af
+  data.tar.gz: 9e8f57a36a415c6b4fc81d0cb3c78d141aa99e8b
 SHA512:
-  metadata.gz: fb91efd6e75a08517c1ec0204e7af4cec68f0013d87d1e9ae185221a46fba51703383afe97a26af4659928958da4115040d2af37e5eaf2fe946004a3be53ae3b
-  data.tar.gz: 6c37666eb4bcfb96fb5b1863008f08099861463101b351af411296a530c9a8671ee3ac38b988ee6def1239ebfd6adaaf0237a6db6bfb139cd133501ebc1de182
+  metadata.gz: c00e84cc7383e90c6ef54c58b6f0223148bd7aed155fe5abaf8501620eea913fc8232cf51decf13fdbf05b309dba541db89e4d65b33cbf9a1c731b2cba78423a
+  data.tar.gz: fd40d8875ffd46534e3b1780290c8bef4beeb9f21280b862636225ccf954ac541c139d4286210b91653b7ac2e6c29f30a948a2defe68567c08d8c0b48bf6333e

data/.travis.yml

@@ -1,5 +1,2 @@
 language: ruby
 cache: bundler
-script:
-  - bundle exec rubocop
-  - bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 1.0.3 (2015-11-04)
+
+### Changes
+
+* Added a default Rake task to run Rubocop and RSpec
+* Added [CONTRIBUTING.md](CONTRIBUTING.md)
+
+### Bugs Fixed
+
+* [#8](https://github.com/civisanalytics/swagger-diff/pull/8)
+  fixed parsing of header and formData parameters
+* [#10](https://github.com/civisanalytics/swagger-diff/pull/10)
+  detect if a parameter's location (*i.e.*, `in` value) changes
+
 ## 1.0.2 (2015-10-08)
 
 ### Bugs Fixed

data/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing to Swagger::Diff
+
+We welcome pull requests from everyone!
+
+## Getting Started
+
+1. Fork it ( https://github.com/civisanalytics/swagger-diff/fork )
+2. Install the development dependencies (`bundle install`)
+3. Make sure you are able to run the test suite locally (`rake`)
+4. Create a feature branch (`git checkout -b my-new-feature`)
+5. Make your change. Don't forget tests
+6. Make sure the test suite, including your new tests, passes (`rake`)
+7. Commit your changes (`git commit -am 'Add some feature'`)
+8. Push to the branch (`git push origin my-new-feature`)
+9. Create a new pull request
+10. If the Travis build fails, address any issues
+
+## Tips
+
+- All pull requests must include test coverage. If you’re not sure how to test
+  your changes, feel free to ask for help.
+- Contributions must conform to the
+  [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
+- Don’t forget to add your change to the [CHANGELOG](CHANGELOG.md). See
+  [Keep a CHANGELOG](http://keepachangelog.com/) for guidelines.
+
+Thank you for taking the time to contribute to Swagger::Diff!

data/README.md

@@ -27,6 +27,8 @@ Specifications are considered backwards compatible if:
 - all response attributes in the old specification have the same type in the new
   one
 
+Read more on the [Civis Analytics blog](https://civisanalytics.com/blog/engineering/2015/10/02/using-swagger-to-detect-breaking-api-changes/).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -116,11 +118,7 @@ To release a new version, update the version number in `version.rb`, and then ru
 
 ## Contributing
 
-1. Fork it ( https://github.com/civisanalytics/swagger-diff/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
 

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/lib/swagger/diff/specification.rb

@@ -111,7 +111,7 @@ module Swagger
         if prefix == "#{name}/" || prefix =~ %r{/#{name}(\[\])?/}
           # Anonymizing the reference in case the name changed (e.g.,
           # generated Swagger).
-          { all: ["#{key} (type: reference)"] }
+          { all: ["#{key} (in: body, type: reference)"] }
         else
           refs(ref, "#{key}/")
         end
@@ -124,7 +124,7 @@ module Swagger
           merge_refs!(ret, nested(schema['$ref'], prefix, name, list))
         else
           ret[:required].add(key) if required && required.include?(name)
-          ret[:all].add("#{key} (type: #{schema.type}#{'[]' if list})")
+          ret[:all].add("#{key} (in: body, type: #{schema.type}#{'[]' if list})")
         end
         ret
       end
@@ -148,7 +148,7 @@ module Swagger
                      else
                        '*'
                      end
-              ret[:all].add("#{prefix}#{name} (type: Hash[string, #{type}])")
+              ret[:all].add("#{prefix}#{name} (in: body, type: Hash[string, #{type}])")
             end
           else
             merge_refs!(ret, properties_for_ref(prefix, name, schema, required))
@@ -161,11 +161,11 @@ module Swagger
         ret = { required: Set.new, all: Set.new }
         return ret if params.nil?
         params.each do |param|
-          if param.in == 'path' || param.in == 'query'
-            ret[:required].add(param.name) if param.required
-            ret[:all].add("#{param.name} (type: #{param.type})")
-          else
+          if param.in == 'body'
             merge_refs!(ret, refs(param.schema['$ref']))
+          else
+            ret[:required].add(param.name) if param.required
+            ret[:all].add("#{param.name} (in: #{param.in}, type: #{param.type})")
           end
         end
         ret

data/lib/swagger/diff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-diff
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jeff Cousens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swagger-core
@@ -154,6 +154,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -194,3 +195,4 @@ signing_key:
 specification_version: 4
 summary: Utility for comparing two Swagger specifications.
 test_files: []
+has_rdoc: